Class ManualAuthentication

java.lang.Object

org.dogtagpki.legacy.server.policy.APolicyRule

org.dogtagpki.legacy.server.policy.constraints.ManualAuthentication

All Implemented Interfaces:

IPolicy, IEnrollmentPolicy, IPolicyRule

public class ManualAuthentication
extends APolicyRule
implements IEnrollmentPolicy

ManualAuthentication is an enrollment policy that queues all requests for issuing agent's approval if no authentication is present. The policy rejects a request if any of the auth tokens indicates authentication failure.

NOTE:  The Policy Framework has been replaced by the Profile Framework.

Version:

$Revision$, $Date$

Field Summary

Fields inherited from class APolicyRule

DESC, logger, mFilterExp, mInstanceName, NAME

Modifier and Type	Field	Description
protected String	DESC
static org.slf4j.Logger	logger
protected IExpression	mFilterExp
protected String	mInstanceName
protected String	NAME

Fields inherited from interface IPolicyRule

PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE

Modifier and Type	Field	Description
static final String	PROP_ENABLE
static final String	PROP_IMPLNAME
static final String	PROP_PREDICATE

Constructor Summary

Constructors

Constructor	Description
ManualAuthentication()

Method Summary

Modifier and Type	Method	Description
PolicyResult	apply(IRequest req)	Applies the policy on the given Request.
Vector<String>	getDefaultParams()	Return default parameters for a policy implementation.
Vector<String>	getInstanceParams()	Return configured parameters for a policy rule instance.
void	init(IPolicyProcessor owner, IConfigStore config)	Initializes this policy rule.

Methods inherited from class APolicyRule

agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, setError, setError, setError, setInstanceName, setPolicyException, setPolicyException, setPredicate

Modifier and Type	Method	Description
protected boolean	agentApproved(IRequest req)	request has previously been approved by an agent
static org.mozilla.jss.netscape.security.x509.KeyIdentifier	createKeyIdentifier(org.mozilla.jss.netscape.security.x509.X509Key key)
protected PolicyResult	deferred(IRequest req)	determines whether a DEFERRED policy result should be returned by checking the contents of the AgentApprovals attribute.
protected org.mozilla.jss.netscape.security.x509.KeyIdentifier	formSHA1KeyId(org.mozilla.jss.netscape.security.x509.X509CertInfo certInfo)	Form a byte array of octet string key identifier from the sha-1 hash of the Subject Public Key BIT STRING.
protected org.mozilla.jss.netscape.security.x509.KeyIdentifier	formSpkiSHA1KeyId(org.mozilla.jss.netscape.security.x509.X509CertInfo certInfo)	Form a byte array of octet string key identifier from the sha-1 hash of the Subject Public Key INFO.
String	getDescription()	Gets the description for this policy rule.
String	getInstanceName()	Returns the name of the policy rule instance.
String	getName()	Returns the name of the policy rule.
IExpression	getPredicate()	Returns the predicate expression for the rule.
void	setError(IRequest req, String format, Object[] params)
void	setError(IRequest req, String format, String arg)
void	setError(IRequest req, String format, String arg1, String arg2)
void	setInstanceName(String instanceName)	Sets the instance name for a policy rule.
void	setPolicyException(IRequest req, EBaseException ex)
void	setPolicyException(IRequest req, String format, Object[] params)
void	setPredicate(IExpression exp)	Sets a predicate expression for rule matching.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ManualAuthentication

public ManualAuthentication()

Method Details

init

public void init(IPolicyProcessor owner,
 IConfigStore config)
          throws EPolicyException

Initializes this policy rule.

The entries may be of the form: ra.Policy.rule..implName=ManualAuthentication ra.Policy.rule..enable=true ra.Policy.rule..predicate= ou == engineering AND o == netscape.com

Specified by:

init in interface IPolicyRule

Specified by:

init in class APolicyRule

Parameters:

config - The config store reference

Throws:

EPolicyException

apply

public PolicyResult apply(IRequest req)

Applies the policy on the given Request.

Specified by:

apply in interface IPolicy

Specified by:

apply in interface IPolicyRule

Specified by:

apply in class APolicyRule

Parameters:

req - The request on which to apply policy.

Returns:

The policy result object.

getInstanceParams

public Vector<String> getInstanceParams()

Return configured parameters for a policy rule instance.

Specified by:

getInstanceParams in interface IPolicyRule

Specified by:

getInstanceParams in class APolicyRule

Returns:

nvPairs A Vector of name/value pairs.

getDefaultParams

public Vector<String> getDefaultParams()

Return default parameters for a policy implementation.

Specified by:

getDefaultParams in interface IPolicyRule

Specified by:

getDefaultParams in class APolicyRule

Returns:

nvPairs A Vector of name/value pairs.