java.security.cert
Class PKIXParameters
- java.lang.Object
java.security.cert.PKIXParameters
- public class PKIXParameters
- extends Object
- implements CertPathParameters
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.
Constructor Summary
Constructor and Description |
---|
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 .
|
PKIXParameters(Set<TrustAnchor> trustAnchors)
Creates an instance of
PKIXParameters with the specified
Set of most-trusted CAs.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
addCertPathChecker(PKIXCertPathChecker checker)
Adds a
PKIXCertPathChecker to the list of certification
path checkers.
|
|
addCertStore(CertStore store)
Adds a
CertStore to the end of the list of CertStore s used
in finding certificates and CRLs.
|
clone()
Makes a copy of this
PKIXParameters object.
|
|
getCertPathCheckers()
Returns the
List of certification path checkers.
|
|
getCertStores()
Gets an immutable copy of the list of
CertStore s to be
used in finding certificates and CRLs.
|
|
getDate()
Returns the time for which the validity of the certification path
should be determined.
|
|
getInitialPolicies()
Returns the immutable
Set of one or more certificate
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.
|
|
|
getPolicyQualifiersRejected()
Gets the PolicyQualifiersRejected flag.
|
getSigProvider()
Returns the signature provider's name, or
null if not set.
|
|
getTargetCertConstraints()
Returns the required constraints on the target certificate.
|
|
getTrustAnchors()
Returns an immutable
Set of the most-trusted CAs.
|
|
|
isAnyPolicyInhibited()
Checks whether the any policy OID should be processed if it
is included in a certificate.
|
|
isExplicitPolicyRequired()
Checks if explicit policy is required.
|
|
isPolicyMappingInhibited()
Checks if policy mapping is inhibited.
|
|
isRevocationEnabled()
Checks the RevocationEnabled flag.
|
|
setAnyPolicyInhibited(boolean val)
Sets state to determine if the any policy OID should be processed
if it is included in a certificate.
|
|
setCertPathCheckers(List<PKIXCertPathChecker> checkers)
Sets a
List of additional certification path checkers.
|
|
setCertStores(List<CertStore> stores)
Sets the list of
CertStore s to be used in
finding certificates and CRLs.
|
|
setDate(Date date)
Sets the time for which the validity of the certification path
should be determined.
|
|
setExplicitPolicyRequired(boolean val)
Sets the ExplicitPolicyRequired flag.
|
|
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.
|
|
setPolicyMappingInhibited(boolean val)
Sets the PolicyMappingInhibited flag.
|
|
setPolicyQualifiersRejected(boolean qualifiersRejected)
Sets the PolicyQualifiersRejected flag.
|
|
setRevocationEnabled(boolean val)
Sets the RevocationEnabled flag.
|
|
setSigProvider(String sigProvider)
Sets the signature provider's name.
|
|
setTargetCertConstraints(CertSelector selector)
Sets the required constraints on the target certificate.
|
|
setTrustAnchors(Set<TrustAnchor> trustAnchors)
Sets the
Set of most-trusted CAs
|
toString()
Returns a formatted string describing the parameters.
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail
PKIXParameters
- public PKIXParameters(Set<TrustAnchor> trustAnchors)
- throws InvalidAlgorithmParameterException
trustAnchors
- a Set
of TrustAnchor
s ClassCastException
- if any of the elements in the Set
are not of type java.security.cert.TrustAnchor
PKIXParameters
- public PKIXParameters(KeyStore keystore)
- throws KeyStoreException
- InvalidAlgorithmParameterException
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.
keystore
- a KeyStore
from which the set of
most-trusted CAs will be populated 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
InvalidAlgorithmParameterException
- if the keystore is empty Method Detail
clone
- public Object clone()
PKIXParameters
object. Changes to the copy
will not affect the original and vice versa.
PKIXParameters
object getTargetCertConstraints
- public CertSelector getTargetCertConstraints( )
CertSelector
. If null
, no constraints
are defined.
Note that the CertSelector
returned is cloned to protect against
subsequent modifications.
CertSelector
specifying the constraints on the target
certificate (or null
) setTargetCertConstraints
- public void setTargetCertConstraints( CertSelector selector)
CertSelector
. If null
, no constraints
are defined.
Note that the CertSelector
specified is cloned to protect against
subsequent modifications.
selector
- a CertSelector
specifying the constraints getTrustAnchors
- public Set<TrustAnchor> getTrustAnchors( )
Set
of the most-trusted CAs.
Set
of TrustAnchor
s setTrustAnchors
- public void setTrustAnchors(Set<TrustAnchor> trustAnchors)
- throws InvalidAlgorithmParameterException
Set
of most-trusted CAs
Note that the Set
is copied to protect against subsequent modifications.
trustAnchors
- the Set
of TrustAnchor
s NullPointerException
- if the trustedCerts is null ClassCastException
- if any of the elements in the set are
not of type java.security.cert.TrustAnchor
getInitialPolicies
Set
of one or more certificate
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.
Set
of initial policy OIDs in
String
format,
or an empty Set
(implying any policy is acceptable).
Never returns null
. setInitialPolicies
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.
initialPolicies
- the Set
of initial policy
OIDs in String
format (or null
) ClassCastException
- if any of the elements in the set are not
of type String
setCertStores
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.
stores
- a List
of CertStore
s (or null
) ClassCastException
- if any of the elements in the list are
not of type java.security.cert.CertStore
addCertStore
- public void addCertStore(CertStore store)
CertStore
to the end of the list of CertStore
s used
in finding certificates and CRLs.
store
- the CertStore
to add. If null
,
the store is ignored (not added to list). getCertStores
CertStore
s to be
used in finding certificates and CRLs.
CertStore
s (maybe empty, but
never null
) setRevocationEnabled
- public void setRevocationEnabled( boolean val)
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).
val
- the new value of the RevocationEnabled flag isRevocationEnabled
- public boolean isRevocationEnabled( )
setRevocationEnabled
method for more details on
setting the value of this flag.
setExplicitPolicyRequired
- public void setExplicitPolicyRequired( boolean val)
val
- true
if explicit policy is to be required,
false
otherwise isExplicitPolicyRequired
- public boolean isExplicitPolicyRequired( )
true
if explicit policy is required,
false
otherwise setPolicyMappingInhibited
- public void setPolicyMappingInhibited( boolean val)
val
- true
if policy mapping is to be inhibited,
false
otherwise isPolicyMappingInhibited
- public boolean isPolicyMappingInhibited( )
setAnyPolicyInhibited
- public void setAnyPolicyInhibited( boolean val)
isAnyPolicyInhibited()
returns false
).
val
- true
if the any policy OID is to be
inhibited, false
otherwise isAnyPolicyInhibited
- public boolean isAnyPolicyInhibited( )
true
if the any policy OID is inhibited,
false
otherwise setPolicyQualifiersRejected
- public void setPolicyQualifiersRejected( boolean qualifiersRejected)
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.
qualifiersRejected
- the new value of the PolicyQualifiersRejected
flag getPolicyQualifiersRejected
- public boolean getPolicyQualifiersRejected( )
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.
getDate
- public Date getDate()
null
, the current time is used.
Note that the Date
returned is copied to protect against
subsequent modifications.
null
if not set setDate
- public void setDate(Date date)
null
, the current time is used.
Note that the Date
supplied here is copied to protect
against subsequent modifications.
setCertPathCheckers
- public void setCertPathCheckers( List<PKIXCertPathChecker> checkers)
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.
checkers
- a List
of PKIXCertPathChecker
s.
May be null
, in which case no additional checkers will be
used. ClassCastException
- if any of the elements in the list
are not of type java.security.cert.PKIXCertPathChecker
getCertPathCheckers
- public List<PKIXCertPathChecker> getCertPathCheckers( )
List
of certification path checkers.
The returned List
is immutable, and each
PKIXCertPathChecker
in the List
is cloned
to protect against subsequent modifications.
List
of
PKIXCertPathChecker
s (may be empty, but not
null
) addCertPathChecker
- public void addCertPathChecker( PKIXCertPathChecker checker)
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.
checker
- a PKIXCertPathChecker
to add to the list of
checks. If null
, the checker is ignored (not added to list). getSigProvider
- public String getSigProvider()
null
if not set.
setSigProvider
- public void setSigProvider(String sigProvider)
Signature
objects. If null
or not set, the first provider found
supporting the algorithm will be used.
toString
- public String toString()
PKIXParameters
with the specifiedSet
of most-trusted CAs. Each element of the set is aTrustAnchor
.Note that the
Set
is copied to protect against subsequent modifications.