Known Direct Subclasses |
Parameters used as input for the PKIX CertPathValidator
algorithm.
A PKIX CertPathValidator
uses these parameters to
validate a CertPath
according to the PKIX certification path
validation algorithm.
To instantiate a PKIXParameters
object, an
application must specify one or more most-trusted CAs as defined by
the PKIX certification path validation algorithm. The most-trusted CAs
can be specified using one of two constructors. An application
can call PKIXParameters(Set)
,
specifying a Set
of TrustAnchor
objects, each
of which identify a most-trusted CA. Alternatively, an application can call
PKIXParameters(KeyStore)
, specifying a
KeyStore
instance containing trusted certificate entries, each
of which will be considered as a most-trusted CA.
Once a PKIXParameters
object has been created, other parameters
can be specified (by calling setInitialPolicies
or setDate
, for instance) and then the
PKIXParameters
is passed along with the CertPath
to be validated to CertPathValidator.validate
.
Any parameter that is not set (or is set to null
) will
be set to the default value for that parameter. The default value for the
date
parameter is null
, which indicates
the current time when the path is validated. The default for the
remaining parameters is the least constrained.
Concurrent Access
Unless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.
See Also
Public Constructor Summary
PKIXParameters(Set<TrustAnchor> trustAnchors)
Creates an instance of
PKIXParameters with the specified
Set of most-trusted CAs. |
|
PKIXParameters(KeyStore keystore)
Creates an instance of
PKIXParameters that
populates the set of most-trusted CAs from the trusted
certificate entries contained in the specified KeyStore . |
Public Method Summary
void |
addCertPathChecker(PKIXCertPathChecker checker)
Adds a
PKIXCertPathChecker to the list of certification
path checkers. |
void |
addCertStore(CertStore store)
Adds a
CertStore to the end of the list of
CertStore s used in finding certificates and CRLs. |
Object |
clone()
Makes a copy of this
PKIXParameters object. |
List<PKIXCertPathChecker> |
getCertPathCheckers()
Returns the
List of certification path checkers. |
List<CertStore> |
getCertStores()
Returns an immutable
List of CertStore s that
are used to find certificates and CRLs. |
Date |
getDate()
Returns the time for which the validity of the certification path
should be determined.
|
Set<String> |
getInitialPolicies()
Returns an immutable
Set of initial
policy identifiers (OID strings), indicating that any one of these
policies would be acceptable to the certificate user for the purposes of
certification path processing. |
boolean |
getPolicyQualifiersRejected()
Gets the PolicyQualifiersRejected flag.
|
String |
getSigProvider()
Returns the signature provider's name, or
null
if not set. |
CertSelector |
getTargetCertConstraints()
Returns the required constraints on the target certificate.
|
Set<TrustAnchor> |
getTrustAnchors()
Returns an immutable
Set of the most-trusted
CAs. |
boolean |
isAnyPolicyInhibited()
Checks whether the any policy OID should be processed if it
is included in a certificate.
|
boolean |
isExplicitPolicyRequired()
Checks if explicit policy is required.
|
boolean |
isPolicyMappingInhibited()
Checks if policy mapping is inhibited.
|
boolean |
isRevocationEnabled()
Checks the RevocationEnabled flag.
|
void |
setAnyPolicyInhibited(boolean val)
Sets state to determine if the any policy OID should be processed
if it is included in a certificate.
|
void |
setCertPathCheckers(List<PKIXCertPathChecker> checkers)
Sets a
List of additional certification path checkers. |
void |
setCertStores(List<CertStore> stores)
Sets the list of
CertStore s to be used in finding
certificates and CRLs. |
void | |
void |
setExplicitPolicyRequired(boolean val)
Sets the ExplicitPolicyRequired flag.
|
void |
setInitialPolicies(Set<String> initialPolicies)
Sets the
Set of initial policy identifiers
(OID strings), indicating that any one of these
policies would be acceptable to the certificate user for the purposes of
certification path processing. |
void |
setPolicyMappingInhibited(boolean val)
Sets the PolicyMappingInhibited flag.
|
void |
setPolicyQualifiersRejected(boolean qualifiersRejected)
Sets the PolicyQualifiersRejected flag.
|
void |
setRevocationEnabled(boolean val)
Sets the RevocationEnabled flag.
|
void | |
void |
setTargetCertConstraints(CertSelector selector)
Sets the required constraints on the target certificate.
|
void | |
String |
toString()
Returns a formatted string describing the parameters.
|
Inherited Method Summary
Public Constructors
public PKIXParameters (Set<TrustAnchor> 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 TrustAnchor s |
---|
Throws
InvalidAlgorithmParameterException | if the specified
Set is empty (trustAnchors.isEmpty() == true) |
---|---|
NullPointerException | if the specified Set is
null |
ClassCastException | if any of the elements in the Set
are not of type java.security.cert.TrustAnchor
|
public PKIXParameters (KeyStore keystore)
Creates an instance of PKIXParameters
that
populates the set of most-trusted CAs from the trusted
certificate entries contained in the specified KeyStore
.
Only keystore entries that contain trusted X509Certificates
are considered; all other certificate types are ignored.
Parameters
keystore | a KeyStore from which the set of
most-trusted CAs will be populated |
---|
Throws
KeyStoreException | if the keystore has not been initialized |
---|---|
InvalidAlgorithmParameterException | if the keystore does not contain at least one trusted certificate entry |
NullPointerException | if the keystore is null
|
Public Methods
public void addCertPathChecker (PKIXCertPathChecker checker)
Adds a PKIXCertPathChecker
to the list of certification
path checkers. See the setCertPathCheckers
method for more details.
Note that the PKIXCertPathChecker
is cloned to protect
against subsequent modifications.
Parameters
checker | a PKIXCertPathChecker to add to the list of
checks. If null , the checker is ignored (not added to list).
|
---|
public void addCertStore (CertStore store)
Adds a CertStore
to the end of the list of
CertStore
s used in finding certificates and CRLs.
Parameters
store | the CertStore to add. If null ,
the store is ignored (not added to list).
|
---|
public Object clone ()
Makes a copy of this PKIXParameters
object. Changes
to the copy will not affect the original and vice versa.
Returns
- a copy of this
PKIXParameters
object
public List<PKIXCertPathChecker> getCertPathCheckers ()
Returns the List
of certification path checkers.
The returned List
is immutable, and each
PKIXCertPathChecker
in the List
is cloned
to protect against subsequent modifications.
Returns
- an immutable
List
ofPKIXCertPathChecker
s (may be empty, but notnull
)
See Also
public List<CertStore> getCertStores ()
Returns an immutable List
of CertStore
s that
are used to find certificates and CRLs.
Returns
- an immutable
List
ofCertStore
s (may be empty, but nevernull
)
See Also
public Date getDate ()
Returns the time for which the validity of the certification path
should be determined. If null
, the current time is used.
Note that the Date
returned is copied to protect against
subsequent modifications.
Returns
- the
Date
, ornull
if not set
See Also
public Set<String> getInitialPolicies ()
Returns an immutable Set
of initial
policy identifiers (OID strings), indicating that any one of these
policies would be acceptable to the certificate user for the purposes of
certification path processing. The default return value is an empty
Set
, which is interpreted as meaning that any policy would
be acceptable.
Returns
- an immutable
Set
of initial policy OIDs inString
format, or an emptySet
(implying any policy is acceptable). Never returnsnull
.
See Also
public boolean getPolicyQualifiersRejected ()
Gets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis.
When a PKIXParameters
object is created, this flag is
set to true. This setting reflects the most common (and simplest)
strategy for processing policy qualifiers. Applications that want to use
a more sophisticated policy must set this flag to false.
Returns
- the current value of the PolicyQualifiersRejected flag
See Also
public String getSigProvider ()
Returns the signature provider's name, or null
if not set.
Returns
- the signature provider's name (or
null
)
See Also
public CertSelector getTargetCertConstraints ()
Returns the required constraints on the target certificate.
The constraints are returned as an instance of CertSelector
.
If null
, no constraints are defined.
Note that the CertSelector
returned is cloned
to protect against subsequent modifications.
Returns
- a
CertSelector
specifying the constraints on the target certificate (ornull
)
public Set<TrustAnchor> getTrustAnchors ()
Returns an immutable Set
of the most-trusted
CAs.
Returns
- an immutable
Set
ofTrustAnchor
s (nevernull
)
See Also
public boolean isAnyPolicyInhibited ()
Checks whether the any policy OID should be processed if it is included in a certificate.
Returns
true
if the any policy OID is inhibited,false
otherwise
public boolean isExplicitPolicyRequired ()
Checks if explicit policy is required. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false.
Returns
true
if explicit policy is required,false
otherwise
public boolean isPolicyMappingInhibited ()
Checks if policy mapping is inhibited. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false).
Returns
- true if policy mapping is inhibited, false otherwise
public boolean isRevocationEnabled ()
Checks the RevocationEnabled flag. If this flag is true, the default
revocation checking mechanism of the underlying PKIX service provider
will be used. If this flag is false, the default revocation checking
mechanism will be disabled (not used). See the setRevocationEnabled
method for more details on
setting the value of this flag.
Returns
- the current value of the RevocationEnabled flag
public void setAnyPolicyInhibited (boolean val)
Sets state to determine if the any policy OID should be processed
if it is included in a certificate. By default, the any policy OID
is not inhibited (isAnyPolicyInhibited()
returns false
).
Parameters
val | true if the any policy OID is to be
inhibited, false otherwise
|
---|
public void setCertPathCheckers (List<PKIXCertPathChecker> checkers)
Sets a List
of additional certification path checkers. If
the specified List
contains an object that is not a
PKIXCertPathChecker
, it is ignored.
Each PKIXCertPathChecker
specified implements
additional checks on a certificate. Typically, these are checks to
process and verify private extensions contained in certificates.
Each PKIXCertPathChecker
should be instantiated with any
initialization parameters needed to execute the check.
This method allows sophisticated applications to extend a PKIX
CertPathValidator
or CertPathBuilder
.
Each of the specified PKIXCertPathChecker
s will be called,
in turn, by a PKIX CertPathValidator
or
CertPathBuilder
for each certificate processed or
validated.
Regardless of whether these additional PKIXCertPathChecker
s
are set, a PKIX CertPathValidator
or
CertPathBuilder
must perform all of the required PKIX
checks on each certificate. The one exception to this rule is if the
RevocationEnabled flag is set to false (see the setRevocationEnabled
method).
Note that the List
supplied here is copied and each
PKIXCertPathChecker
in the list is cloned to protect
against subsequent modifications.
Parameters
checkers | a List of PKIXCertPathChecker s.
May be null , in which case no additional checkers will be
used. |
---|
Throws
ClassCastException | if any of the elements in the list
are not of type java.security.cert.PKIXCertPathChecker |
---|
See Also
public void setCertStores (List<CertStore> stores)
Sets the list of CertStore
s to be used in finding
certificates and CRLs. May be null
, in which case
no CertStore
s will be used. The first
CertStore
s in the list may be preferred to those that
appear later.
Note that the List
is copied to protect against
subsequent modifications.
Parameters
stores | a List of CertStore s (or
null ) |
---|
Throws
ClassCastException | if any of the elements in the list are
not of type java.security.cert.CertStore |
---|
See Also
public void setDate (Date date)
Sets the time for which the validity of the certification path
should be determined. If null
, the current time is used.
Note that the Date
supplied here is copied to protect
against subsequent modifications.
Parameters
date | the Date , or null for the
current time |
---|
See Also
public void setExplicitPolicyRequired (boolean val)
Sets the ExplicitPolicyRequired flag. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false.
Parameters
val | true if explicit policy is to be required,
false otherwise
|
---|
public void setInitialPolicies (Set<String> initialPolicies)
Sets the Set
of initial policy identifiers
(OID strings), indicating that any one of these
policies would be acceptable to the certificate user for the purposes of
certification path processing. By default, any policy is acceptable
(i.e. all policies), so a user that wants to allow any policy as
acceptable does not need to call this method, or can call it
with an empty Set
(or null
).
Note that the Set
is copied to protect against
subsequent modifications.
Parameters
initialPolicies | a Set of initial policy
OIDs in String format (or null ) |
---|
Throws
ClassCastException | if any of the elements in the set are
not of type String |
---|
See Also
public void setPolicyMappingInhibited (boolean val)
Sets the PolicyMappingInhibited flag. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false).
Parameters
val | true if policy mapping is to be inhibited,
false otherwise
|
---|
public void setPolicyQualifiersRejected (boolean qualifiersRejected)
Sets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis.
When a PKIXParameters
object is created, this flag is
set to true. This setting reflects the most common (and simplest)
strategy for processing policy qualifiers. Applications that want to use
a more sophisticated policy must set this flag to false.
Note that the PKIX certification path validation algorithm specifies that any policy qualifier in a certificate policies extension that is marked critical must be processed and validated. Otherwise the certification path must be rejected. If the policyQualifiersRejected flag is set to false, it is up to the application to validate all policy qualifiers in this manner in order to be PKIX compliant.
Parameters
qualifiersRejected | the new value of the PolicyQualifiersRejected flag |
---|
public void setRevocationEnabled (boolean val)
Sets the RevocationEnabled flag. If this flag is true, the default revocation checking mechanism of the underlying PKIX service provider will be used. If this flag is false, the default revocation checking mechanism will be disabled (not used).
When a PKIXParameters
object is created, this flag is set
to true. This setting reflects the most common strategy for checking
revocation, since each service provider must support revocation
checking to be PKIX compliant. Sophisticated applications should set
this flag to false when it is not practical to use a PKIX service
provider's default revocation checking mechanism or when an alternative
revocation checking mechanism is to be substituted (by also calling the
addCertPathChecker
or setCertPathCheckers
methods).
Parameters
val | the new value of the RevocationEnabled flag |
---|
public void setSigProvider (String sigProvider)
Sets the signature provider's name. The specified provider will be
preferred when creating Signature
objects. If null
or not set, the first provider found
supporting the algorithm will be used.
Parameters
sigProvider | the signature provider's name (or null ) |
---|
See Also
public void setTargetCertConstraints (CertSelector selector)
Sets the required constraints on the target certificate.
The constraints are specified as an instance of
CertSelector
. If null
, no constraints are
defined.
Note that the CertSelector
specified is cloned
to protect against subsequent modifications.
Parameters
selector | a CertSelector specifying the constraints
on the target certificate (or null ) |
---|
See Also
public void setTrustAnchors (Set<TrustAnchor> trustAnchors)
Sets the Set
of most-trusted CAs.
Note that the Set
is copied to protect against
subsequent modifications.
Parameters
trustAnchors | a Set of TrustAnchor s |
---|
Throws
InvalidAlgorithmParameterException | if the specified
Set is empty (trustAnchors.isEmpty() == true) |
---|---|
NullPointerException | if the specified Set is
null |
ClassCastException | if any of the elements in the set
are not of type java.security.cert.TrustAnchor |
See Also
public String toString ()
Returns a formatted string describing the parameters.
Returns
- a formatted string describing the parameters.