public class

ExtendedPKIXParameters

extends PKIXParameters
java.lang.Object
   ↳ java.security.cert.PKIXParameters
     ↳ org.bouncycastle.x509.ExtendedPKIXParameters
Known Direct Subclasses

Class Overview

This class extends the PKIXParameters with a validity model parameter.

Summary

Constants
int CHAIN_VALIDITY_MODEL This model uses the following validity model.
int PKIX_VALIDITY_MODEL This is the default PKIX validity model.
Public Constructors
ExtendedPKIXParameters(Set trustAnchors)
Creates an instance of PKIXParameters with the specified Set of most-trusted CAs.
Public Methods
void addAddionalStore(Store store)
This method is deprecated. No replacement.
void addAdditionalStore(Store store)
Adds an additional Bouncy Castle Store to find CRLs, certificates, attribute certificates or cross certificates.
void addStore(Store store)
Adds a Bouncy Castle Store to find CRLs, certificates, attribute certificates or cross certificates.
Object clone()
List getAdditionalStores()
Returns an immutable List of additional Bouncy Castle Stores used for finding CRLs, certificates, attribute certificates or cross certificates.
Set getAttrCertCheckers()
Returns the attribute certificate checker.
static ExtendedPKIXParameters getInstance(PKIXParameters pkixParams)
Returns an instance with the parameters of a given PKIXParameters object.
Set getNecessaryACAttributes()
Returns the neccessary attributes which must be contained in an attribute certificate.
Set getProhibitedACAttributes()
Returns the attribute certificates which are not allowed.
List getStores()
Returns an immutable List of Bouncy Castle Stores used for finding CRLs, certificates, attribute certificates or cross certificates.
Selector getTargetConstraints()
Returns the required constraints on the target certificate or attribute certificate.
Set getTrustedACIssuers()
Returns the trusted attribute certificate issuers.
int getValidityModel()
boolean isAdditionalLocationsEnabled()
Returns if additional X509Stores for locations like LDAP found in certificates or CRLs should be used.
boolean isUseDeltasEnabled()
Defaults to false.
void setAdditionalLocationsEnabled(boolean enabled)
Sets if additional X509Stores for locations like LDAP found in certificates or CRLs should be used.
void setAttrCertCheckers(Set attrCertCheckers)
Sets the attribute certificate checkers.
void setCertStores(List stores)
Sets the Java CertStore to this extended PKIX parameters.
void setNecessaryACAttributes(Set necessaryACAttributes)
Sets the neccessary which must be contained in an attribute certificate.
void setProhibitedACAttributes(Set prohibitedACAttributes)
Sets the attribute certificates which are not allowed.
void setStores(List stores)
Sets the Bouncy Castle Stores for finding CRLs, certificates, attribute certificates or cross certificates.
void setTargetCertConstraints(CertSelector selector)
Sets the required constraints on the target certificate.
void setTargetConstraints(Selector selector)
Sets the required constraints on the target certificate or attribute certificate.
void setTrustedACIssuers(Set trustedACIssuers)
Sets the trusted attribute certificate issuers.
void setUseDeltasEnabled(boolean useDeltas)
Sets if delta CRLs should be used for checking the revocation status.
void setValidityModel(int validityModel)
Protected Methods
void setParams(PKIXParameters params)
Method to support clone() under J2ME.
[Expand]
Inherited Methods
From class java.security.cert.PKIXParameters
From class java.lang.Object
From interface java.security.cert.CertPathParameters

Constants

public static final int CHAIN_VALIDITY_MODEL

This model uses the following validity model. Each certificate must have been valid at the moment where is was used. That means the end certificate must have been valid at the time the signature was done. The CA certificate which signed the end certificate must have been valid, when the end certificate was signed. The CA (or Root CA) certificate must have been valid, when the CA certificate was signed and so on. So the setDate(java.util.Date) method sets the time, when the end certificate must have been valid.

It is used e.g. in the German signature law.

Constant Value: 1 (0x00000001)

public static final int PKIX_VALIDITY_MODEL

This is the default PKIX validity model. Actually there are two variants of this: The PKIX model and the modified PKIX model. The PKIX model verifies that all involved certificates must have been valid at the current time. The modified PKIX model verifies that all involved certificates were valid at the signing time. Both are indirectly choosen with the setDate(java.util.Date) method, so this methods sets the Date when all certificates must have been valid.

Constant Value: 0 (0x00000000)

Public Constructors

public ExtendedPKIXParameters (Set trustAnchors)

Creates an instance of PKIXParameters with the specified Set of most-trusted CAs. Each element of the set is a TrustAnchor.

Note that the Set is copied to protect against subsequent modifications.

Parameters
trustAnchors a Set of TrustAnchors
Throws
InvalidAlgorithmParameterException if the specified Set is empty.
NullPointerException if the specified Set is null
ClassCastException if any of the elements in the Set is not of type java.security.cert.TrustAnchor

Public Methods

public void addAddionalStore (Store store)

This method is deprecated.
No replacement.

public void addAdditionalStore (Store store)

Adds an additional Bouncy Castle Store to find CRLs, certificates, attribute certificates or cross certificates.

You should not use this method. This method is used for adding additional X.509 stores, which are used to add (remote) locations, e.g. LDAP, found during X.509 object processing, e.g. in certificates or CRLs. This method is used in PKIX certification path processing.

If store is null it is ignored.

Parameters
store The store to add.
See Also

public void addStore (Store store)

Adds a Bouncy Castle Store to find CRLs, certificates, attribute certificates or cross certificates.

This method should be used to add local stores, like collection based X.509 stores, if available. Local stores should be considered first, before trying to use additional (remote) locations, because they do not need possible additional network traffic.

If store is null it is ignored.

Parameters
store The store to add.
See Also

public Object clone ()

public List getAdditionalStores ()

Returns an immutable List of additional Bouncy Castle Stores used for finding CRLs, certificates, attribute certificates or cross certificates.

Returns
  • an immutable List of additional Bouncy Castle Stores. Never null.
See Also

public Set getAttrCertCheckers ()

Returns the attribute certificate checker. The returned set contains PKIXAttrCertCheckers and is immutable.

Returns
  • Returns the attribute certificate checker. Is never null.

public static ExtendedPKIXParameters getInstance (PKIXParameters pkixParams)

Returns an instance with the parameters of a given PKIXParameters object.

Parameters
pkixParams The given PKIXParameters
Returns
  • an extended PKIX params object

public Set getNecessaryACAttributes ()

Returns the neccessary attributes which must be contained in an attribute certificate.

The returned Set is immutable and contains Strings with the OIDs.

Returns
  • Returns the necessary AC attributes.

public Set getProhibitedACAttributes ()

Returns the attribute certificates which are not allowed.

The returned Set is immutable and contains Strings with the OIDs.

Returns
  • Returns the prohibited AC attributes. Is never null.

public List getStores ()

Returns an immutable List of Bouncy Castle Stores used for finding CRLs, certificates, attribute certificates or cross certificates.

Returns
  • an immutable List of Bouncy Castle Stores. Never null.
See Also

public Selector getTargetConstraints ()

Returns the required constraints on the target certificate or attribute certificate. The constraints are returned as an instance of Selector. If null, no constraints are defined.

The target certificate in a PKIX path may be a certificate or an attribute certificate.

Note that the Selector returned is cloned to protect against subsequent modifications.

Returns
  • a Selector specifying the constraints on the target certificate or attribute certificate (or null)
See Also

public Set getTrustedACIssuers ()

Returns the trusted attribute certificate issuers. If attribute certificates is verified the trusted AC issuers must be set.

The returned Set consists of TrustAnchors.

The returned Set is immutable. Never null

Returns
  • Returns an immutable set of the trusted AC issuers.

public int getValidityModel ()

Returns
  • Returns the validity model.
See Also

public boolean isAdditionalLocationsEnabled ()

Returns if additional X509Stores for locations like LDAP found in certificates or CRLs should be used.

Returns
  • Returns true if additional stores are used.

public boolean isUseDeltasEnabled ()

Defaults to false.

Returns
  • Returns if delta CRLs should be used.

public void setAdditionalLocationsEnabled (boolean enabled)

Sets if additional X509Stores for locations like LDAP found in certificates or CRLs should be used.

Parameters
enabled true if additional stores are used.

public void setAttrCertCheckers (Set attrCertCheckers)

Sets the attribute certificate checkers.

All elements in the Set must a PKIXAttrCertChecker.

The given set is cloned.

Parameters
attrCertCheckers The attribute certificate checkers to set. Is never null.
Throws
ClassCastException if an element of attrCertCheckers is not a PKIXAttrCertChecker.

public void setCertStores (List stores)

Sets the Java CertStore to this extended PKIX parameters.

Throws
ClassCastException if an element of stores is not a CertStore.

public void setNecessaryACAttributes (Set necessaryACAttributes)

Sets the neccessary which must be contained in an attribute certificate.

The Set must contain Strings with the OIDs.

The set is cloned.

Parameters
necessaryACAttributes The necessary AC attributes to set.
Throws
ClassCastException if an element of necessaryACAttributes is not a String.

public void setProhibitedACAttributes (Set prohibitedACAttributes)

Sets the attribute certificates which are not allowed.

The Set must contain Strings with the OIDs.

The set is cloned.

Parameters
prohibitedACAttributes The prohibited AC attributes to set.
Throws
ClassCastException if an element of prohibitedACAttributes is not a String.

public void setStores (List stores)

Sets the Bouncy Castle Stores for finding CRLs, certificates, attribute certificates or cross certificates.

The List is cloned.

Parameters
stores A list of stores to use.
Throws
ClassCastException if an element of stores is not a Store.
See Also

public void setTargetCertConstraints (CertSelector selector)

Sets the required constraints on the target certificate. The constraints are specified as an instance of X509CertSelector. If null, no constraints are defined.

This method wraps the given X509CertSelector into a X509CertStoreSelector.

Note that the X509CertSelector specified is cloned to protect against subsequent modifications.

Parameters
selector a X509CertSelector specifying the constraints on the target certificate (or null)
See Also

public void setTargetConstraints (Selector selector)

Sets the required constraints on the target certificate or attribute certificate. The constraints are specified as an instance of Selector. If null, no constraints are defined.

The target certificate in a PKIX path may be a certificate or an attribute certificate.

Note that the Selector specified is cloned to protect against subsequent modifications.

Parameters
selector a Selector specifying the constraints on the target certificate or attribute certificate (or null)
See Also

public void setTrustedACIssuers (Set trustedACIssuers)

Sets the trusted attribute certificate issuers. If attribute certificates is verified the trusted AC issuers must be set.

The trustedACIssuers must be a Set of TrustAnchor

The given set is cloned.

Parameters
trustedACIssuers The trusted AC issuers to set. Is never null.
Throws
ClassCastException if an element of stores is not a TrustAnchor.

public void setUseDeltasEnabled (boolean useDeltas)

Sets if delta CRLs should be used for checking the revocation status.

Parameters
useDeltas true if delta CRLs should be used.

public void setValidityModel (int validityModel)

Parameters
validityModel The validity model to set.
See Also

Protected Methods

protected void setParams (PKIXParameters params)

Method to support clone() under J2ME. super.clone() does not exist and fields are not copied.

Parameters
params Parameters to set. If this are ExtendedPKIXParameters they are copied to.