com.netscape.cms.policy.extensions
Class KeyUsageExt

java.lang.Object
  extended by com.netscape.cms.policy.APolicyRule
      extended by com.netscape.cms.policy.extensions.KeyUsageExt
All Implemented Interfaces:
IExtendedPluginInfo, IEnrollmentPolicy, IPolicyRule, IPolicy

Deprecated.

public class KeyUsageExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Policy to add Key Usage Extension. Adds the key usage extension based on what's requested.

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

Version:
$Revision: 1226 $, $Date: 2010-08-19 14:16:41 -0700 (Thu, 19 Aug 2010) $

Field Summary
protected static boolean[] DEF_BITS
          Deprecated.  
protected  int mCAPathLen
          Deprecated.  
protected  IConfigStore mConfig
          Deprecated.  
protected  boolean mCritical
          Deprecated.  
protected  java.lang.String mCrlSign
          Deprecated.  
protected  java.lang.String mDataEncipherment
          Deprecated.  
protected  java.lang.String mDecipherOnly
          Deprecated.  
protected  java.lang.String mDigitalSignature
          Deprecated.  
protected  java.lang.String mEncipherOnly
          Deprecated.  
protected  java.lang.String mKeyAgreement
          Deprecated.  
protected  java.lang.String mKeyCertsign
          Deprecated.  
protected  java.lang.String mKeyEncipherment
          Deprecated.  
protected  netscape.security.x509.KeyUsageExtension mKeyUsage
          Deprecated.  
protected  java.lang.String mNonRepudiation
          Deprecated.  
protected static java.lang.String PROP_CRITICAL
          Deprecated.  
protected static java.lang.String PROP_CRL_SIGN
          Deprecated.  
protected static java.lang.String PROP_DATA_ENCIPHERMENT
          Deprecated.  
protected static java.lang.String PROP_DECIPHER_ONLY
          Deprecated.  
protected static java.lang.String PROP_DIGITAL_SIGNATURE
          Deprecated.  
protected static java.lang.String PROP_ENCIPHER_ONLY
          Deprecated.  
protected static java.lang.String PROP_KEY_AGREEMENT
          Deprecated.  
protected static java.lang.String PROP_KEY_CERTSIGN
          Deprecated.  
protected static java.lang.String PROP_KEY_ENCIPHERMENT
          Deprecated.  
protected static java.lang.String PROP_NON_REPUDIATION
          Deprecated.  
 
Fields inherited from class com.netscape.cms.policy.APolicyRule
DESC, mFilterExp, mInstanceName, mLogger, NAME
 
Fields inherited from interface com.netscape.certsrv.policy.IPolicyRule
PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE
 
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
 
Constructor Summary
KeyUsageExt()
          Deprecated.  
 
Method Summary
 PolicyResult apply(IRequest req)
          Deprecated. Adds the key usage extension if not set already.
 PolicyResult applyCert(IRequest req, netscape.security.x509.X509CertInfo certInfo)
          Deprecated.  
 java.util.Vector getDefaultParams()
          Deprecated. Return default parameters for a policy implementation.
 java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
          Deprecated. This method returns an array of strings.
 java.util.Vector getInstanceParams()
          Deprecated. Return configured parameters for a policy rule instance.
 void init(ISubsystem owner, IConfigStore config)
          Deprecated. Initializes this policy rule.
 
Methods inherited from class com.netscape.cms.policy.APolicyRule
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, log, setError, setError, setError, setInstanceName, setPolicyException, setPolicyException, setPredicate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.netscape.certsrv.policy.IPolicyRule
getDescription, getInstanceName, getName, getPredicate, setError, setInstanceName, setPolicyException, setPredicate
 

Field Detail

DEF_BITS

protected static final boolean[] DEF_BITS
Deprecated. 

mCAPathLen

protected int mCAPathLen
Deprecated. 

mConfig

protected IConfigStore mConfig
Deprecated. 

PROP_CRITICAL

protected static final java.lang.String PROP_CRITICAL
Deprecated. 
See Also:
Constant Field Values

PROP_DIGITAL_SIGNATURE

protected static final java.lang.String PROP_DIGITAL_SIGNATURE
Deprecated. 
See Also:
Constant Field Values

PROP_NON_REPUDIATION

protected static final java.lang.String PROP_NON_REPUDIATION
Deprecated. 
See Also:
Constant Field Values

PROP_KEY_ENCIPHERMENT

protected static final java.lang.String PROP_KEY_ENCIPHERMENT
Deprecated. 
See Also:
Constant Field Values

PROP_DATA_ENCIPHERMENT

protected static final java.lang.String PROP_DATA_ENCIPHERMENT
Deprecated. 
See Also:
Constant Field Values

PROP_KEY_AGREEMENT

protected static final java.lang.String PROP_KEY_AGREEMENT
Deprecated. 
See Also:
Constant Field Values

PROP_KEY_CERTSIGN

protected static final java.lang.String PROP_KEY_CERTSIGN
Deprecated. 
See Also:
Constant Field Values

PROP_CRL_SIGN

protected static final java.lang.String PROP_CRL_SIGN
Deprecated. 
See Also:
Constant Field Values

PROP_ENCIPHER_ONLY

protected static final java.lang.String PROP_ENCIPHER_ONLY
Deprecated. 
See Also:
Constant Field Values

PROP_DECIPHER_ONLY

protected static final java.lang.String PROP_DECIPHER_ONLY
Deprecated. 
See Also:
Constant Field Values

mCritical

protected boolean mCritical
Deprecated. 

mDigitalSignature

protected java.lang.String mDigitalSignature
Deprecated. 

mNonRepudiation

protected java.lang.String mNonRepudiation
Deprecated. 

mKeyEncipherment

protected java.lang.String mKeyEncipherment
Deprecated. 

mDataEncipherment

protected java.lang.String mDataEncipherment
Deprecated. 

mKeyAgreement

protected java.lang.String mKeyAgreement
Deprecated. 

mKeyCertsign

protected java.lang.String mKeyCertsign
Deprecated. 

mCrlSign

protected java.lang.String mCrlSign
Deprecated. 

mEncipherOnly

protected java.lang.String mEncipherOnly
Deprecated. 

mDecipherOnly

protected java.lang.String mDecipherOnly
Deprecated. 

mKeyUsage

protected netscape.security.x509.KeyUsageExtension mKeyUsage
Deprecated. 
Constructor Detail

KeyUsageExt

public KeyUsageExt()
Deprecated. 
Method Detail

init

public void init(ISubsystem owner,
                 IConfigStore config)
          throws EBaseException
Deprecated. 
Initializes this policy rule.

The entries may be of the form: ca.Policy.rule..implName=KeyUsageExt ca.Policy.rule..enable=true ca.Policy.rule..

Specified by:
init in interface IPolicyRule
Specified by:
init in class APolicyRule
Parameters:
config - The config store reference
Throws:
EBaseException

apply

public PolicyResult apply(IRequest req)
Deprecated. 
Adds the key usage extension if not set already. (CRMF, agent, authentication (currently) or PKCS#10 (future) or RA could have set the extension.) If not set, set from http input parameters or use default if no http input parameters are set. Note: this allows any bits requested - does not check if user authenticated is allowed to have a Key Usage Extension with those bits. Unless the CA's certificate path length is 0, then we do not allow CA sign or CRL sign bits in any request.

Specified by:
apply in interface IPolicyRule
Specified by:
apply in interface IPolicy
Specified by:
apply in class APolicyRule
Parameters:
req - The request on which to apply policy.
Returns:
The policy result object.

applyCert

public PolicyResult applyCert(IRequest req,
                              netscape.security.x509.X509CertInfo certInfo)
Deprecated. 

getInstanceParams

public java.util.Vector getInstanceParams()
Deprecated. 
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.

getExtendedPluginInfo

public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
Deprecated. 
Description copied from interface: IExtendedPluginInfo
This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name ;[,required];;... Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"

Specified by:
getExtendedPluginInfo in interface IExtendedPluginInfo

getDefaultParams

public java.util.Vector getDefaultParams()
Deprecated. 
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.