org.bouncycastle.x509

Class PKIXCertPathReviewer

java.lang.Object

org.bouncycastle.x509.PKIXCertPathReviewer

public class PKIXCertPathReviewer
extends Object

PKIXCertPathReviewer
Validation of X.509 Certificate Paths. Tries to find as much errors in the Path as possible.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANY_POLICY
protected static String	AUTHORITY_KEY_IDENTIFIER
protected static String	BASIC_CONSTRAINTS
protected static String	CERTIFICATE_POLICIES
protected CertPath	certPath
protected List	certs
protected static String	CRL_DISTRIBUTION_POINTS
protected static String	CRL_NUMBER
protected static int	CRL_SIGN
protected static org.bouncycastle.x509.PKIXCRLUtil	CRL_UTIL
protected static String[]	crlReasons
protected static String	DELTA_CRL_INDICATOR
protected List[]	errors
protected static String	FRESHEST_CRL
protected static String	INHIBIT_ANY_POLICY
protected static String	ISSUING_DISTRIBUTION_POINT
protected static int	KEY_CERT_SIGN
protected static String	KEY_USAGE
protected int	n
protected static String	NAME_CONSTRAINTS
protected List[]	notifications
protected PKIXParameters	pkixParams
protected static String	POLICY_CONSTRAINTS
protected static String	POLICY_MAPPINGS
protected PolicyNode	policyTree
protected static String	SUBJECT_ALTERNATIVE_NAME
protected PublicKey	subjectPublicKey
protected TrustAnchor	trustAnchor
protected Date	validDate

Constructor Summary

Constructors

Constructor and Description
PKIXCertPathReviewer() Creates an empty PKIXCertPathReviewer.
PKIXCertPathReviewer(CertPath certPath, PKIXParameters params) Creates a PKIXCertPathReviewer and initializes it with the given CertPath and PKIXParameters params

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addAdditionalStoreFromLocation(String location, ExtendedPKIXParameters pkixParams)
protected static void	addAdditionalStoresFromAltNames(X509Certificate cert, ExtendedPKIXParameters pkixParams)
protected static void	addAdditionalStoresFromCRLDistributionPoint(CRLDistPoint crldp, ExtendedPKIXParameters pkixParams)
protected void	addError(ErrorBundle msg)
protected void	addError(ErrorBundle msg, int index)
protected void	addNotification(ErrorBundle msg)
protected void	addNotification(ErrorBundle msg, int index)
protected void	checkCRLs(PKIXParameters paramsPKIX, X509Certificate cert, Date validDate, X509Certificate sign, PublicKey workingPublicKey, Vector crlDistPointUrls, int index)
protected void	checkRevocation(PKIXParameters paramsPKIX, X509Certificate cert, Date validDate, X509Certificate sign, PublicKey workingPublicKey, Vector crlDistPointUrls, Vector ocspUrls, int index)
protected void	doChecks()
protected static Collection	findCertificates(PKIXCertStoreSelector certSelect, List certStores)
protected static Collection	findCertificates(X509AttributeCertStoreSelector certSelect, List certStores)
protected static Collection	findCertificates(X509CertStoreSelector certSelect, List certStores) Return a Collection of all certificates or attribute certificates found in the X509Store's that are matching the certSelect criteriums.
protected static TrustAnchor	findTrustAnchor(X509Certificate cert, Set trustAnchors) Search the given Set of TrustAnchor's for one that is the issuer of the given X509 certificate.
protected static TrustAnchor	findTrustAnchor(X509Certificate cert, Set trustAnchors, String sigProvider) Search the given Set of TrustAnchor's for one that is the issuer of the given X509 certificate.
protected static AlgorithmIdentifier	getAlgorithmIdentifier(PublicKey key)
CertPath	getCertPath()
int	getCertPathSize()
protected static void	getCertStatus(Date validDate, X509CRL crl, Object cert, org.bouncycastle.x509.CertStatus certStatus)
protected static Set	getCompleteCRLs(DistributionPoint dp, Object cert, Date currentDate, ExtendedPKIXParameters paramsPKIX) Fetches complete CRLs according to RFC 3280.
protected Vector	getCRLDistUrls(CRLDistPoint crlDistPoints)
protected static void	getCRLIssuersFromDistributionPoint(DistributionPoint dp, Collection issuerPrincipals, X509CRLSelector selector, ExtendedPKIXParameters pkixParams) Add the CRL issuers from the cRLIssuer field of the distribution point or from the certificate if not given to the issuer criterion of the selector.
protected static Set	getDeltaCRLs(Date currentDate, ExtendedPKIXParameters paramsPKIX, X509CRL completeCRL) Fetches delta CRLs according to RFC 3280 section 5.2.4.
protected static X500Principal	getEncodedIssuerPrincipal(Object cert) Returns the issuer of an attribute certificate or certificate.
List[]	getErrors() Returns an Array of Lists which contains a List of global error messages and a List of error messages for each certificate in the path.
List	getErrors(int index) Returns an List of error messages for the certificate at the given index in the CertPath.
protected static ASN1Primitive	getExtensionValue(X509Extension ext, String oid) Extract the value of the given extension, if it exists.
protected static X500Principal	getIssuerPrincipal(X509CRL crl)
protected static PublicKey	getNextWorkingKey(List certs, int index) Return the next working key inheriting DSA parameters if necessary.
List[]	getNotifications() Returns an Array of Lists which contains a List of global notification messages and a List of botification messages for each certificate in the path.
List	getNotifications(int index) Returns an List of notification messages for the certificate at the given index in the CertPath.
protected Vector	getOCSPUrls(AuthorityInformationAccess authInfoAccess)
PolicyNode	getPolicyTree()
protected static Set	getQualifierSet(ASN1Sequence qualifiers)
protected static X500Principal	getSubjectPrincipal(X509Certificate cert)
PublicKey	getSubjectPublicKey()
TrustAnchor	getTrustAnchor()
protected Collection	getTrustAnchors(X509Certificate cert, Set trustanchors)
protected static Date	getValidCertDateFromValidityModel(ExtendedPKIXParameters paramsPKIX, CertPath certPath, int index)
protected static Date	getValidDate(PKIXParameters paramsPKIX)
void	init(CertPath certPath, PKIXParameters params) Initializes the PKIXCertPathReviewer with the given CertPath and PKIXParameters params
protected static boolean	isAnyPolicy(Set policySet)
protected static boolean	isSelfIssued(X509Certificate cert)
boolean	isValidCertPath()
protected static void	prepareNextCertB1(int i, List[] policyNodes, String id_p, Map m_idp, X509Certificate cert)
protected static PKIXPolicyNode	prepareNextCertB2(int i, List[] policyNodes, String id_p, PKIXPolicyNode validPolicyTree)
protected static boolean	processCertD1i(int index, List[] policyNodes, ASN1ObjectIdentifier pOid, Set pq)
protected static void	processCertD1ii(int index, List[] policyNodes, ASN1ObjectIdentifier _poid, Set _pq)
protected static PKIXPolicyNode	removePolicyNode(PKIXPolicyNode validPolicyTree, List[] policyNodes, PKIXPolicyNode _node)
protected static void	verifyX509Certificate(X509Certificate cert, PublicKey publicKey, String sigProvider)

Methods inherited from class java.lang.Object

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

Field Detail

certPath

protected CertPath certPath

pkixParams

protected PKIXParameters pkixParams

validDate

protected Date validDate

certs

protected List certs

n

protected int n

notifications

protected List[] notifications

errors

protected List[] errors

trustAnchor

protected TrustAnchor trustAnchor

subjectPublicKey

protected PublicKey subjectPublicKey

policyTree

protected PolicyNode policyTree

CRL_UTIL

protected static final org.bouncycastle.x509.PKIXCRLUtil CRL_UTIL

CERTIFICATE_POLICIES

protected static final String CERTIFICATE_POLICIES

BASIC_CONSTRAINTS

protected static final String BASIC_CONSTRAINTS

POLICY_MAPPINGS

protected static final String POLICY_MAPPINGS

SUBJECT_ALTERNATIVE_NAME

protected static final String SUBJECT_ALTERNATIVE_NAME

NAME_CONSTRAINTS

protected static final String NAME_CONSTRAINTS

KEY_USAGE

protected static final String KEY_USAGE

INHIBIT_ANY_POLICY

protected static final String INHIBIT_ANY_POLICY

ISSUING_DISTRIBUTION_POINT

protected static final String ISSUING_DISTRIBUTION_POINT

DELTA_CRL_INDICATOR

protected static final String DELTA_CRL_INDICATOR

POLICY_CONSTRAINTS

protected static final String POLICY_CONSTRAINTS

FRESHEST_CRL

protected static final String FRESHEST_CRL

CRL_DISTRIBUTION_POINTS

protected static final String CRL_DISTRIBUTION_POINTS

AUTHORITY_KEY_IDENTIFIER

protected static final String AUTHORITY_KEY_IDENTIFIER

ANY_POLICY

protected static final String ANY_POLICY

See Also:

Constant Field Values

CRL_NUMBER

protected static final String CRL_NUMBER

KEY_CERT_SIGN

protected static final int KEY_CERT_SIGN

See Also:

Constant Field Values

CRL_SIGN

protected static final int CRL_SIGN

See Also:

Constant Field Values

crlReasons

protected static final String[] crlReasons

Constructor Detail

PKIXCertPathReviewer

public PKIXCertPathReviewer(CertPath certPath,
                    PKIXParameters params)
                     throws CertPathReviewerException

Creates a PKIXCertPathReviewer and initializes it with the given CertPath and PKIXParameters params

Parameters:

certPath - the CertPath to validate

params - the PKIXParameters to use

Throws:

CertPathReviewerException - if the certPath is empty

PKIXCertPathReviewer

public PKIXCertPathReviewer()

Creates an empty PKIXCertPathReviewer. Don't forget to call init() to initialize the object.

Method Detail

init

public void init(CertPath certPath,
        PKIXParameters params)
          throws CertPathReviewerException

Initializes the PKIXCertPathReviewer with the given CertPath and PKIXParameters params

Parameters:

certPath - the CertPath to validate

params - the PKIXParameters to use

Throws:

CertPathReviewerException - if the certPath is empty

IllegalStateException - if the PKIXCertPathReviewer is already initialized

getCertPath

public CertPath getCertPath()

Returns:

the CertPath that was validated

getCertPathSize

public int getCertPathSize()

Returns:

the size of the CertPath

getErrors

public List[] getErrors()

Returns an Array of Lists which contains a List of global error messages and a List of error messages for each certificate in the path. The global error List is at index 0. The error lists for each certificate at index 1 to n. The error messages are of type.

Returns:

the Array of Lists which contain the error messages

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getErrors

public List getErrors(int index)

Returns an List of error messages for the certificate at the given index in the CertPath. If index == -1 then the list of global errors is returned with errors not specific to a certificate.

Parameters:

index - the index of the certificate in the CertPath

Returns:

List of error messages for the certificate

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getNotifications

public List[] getNotifications()

Returns an Array of Lists which contains a List of global notification messages and a List of botification messages for each certificate in the path. The global notificatio List is at index 0. The notification lists for each certificate at index 1 to n. The error messages are of type.

Returns:

the Array of Lists which contain the notification messages

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getNotifications

public List getNotifications(int index)

Returns an List of notification messages for the certificate at the given index in the CertPath. If index == -1 then the list of global notifications is returned with notifications not specific to a certificate.

Parameters:

index - the index of the certificate in the CertPath

Returns:

List of notification messages for the certificate

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getPolicyTree

public PolicyNode getPolicyTree()

Returns:

the valid policy tree, null if no valid policy exists.

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getSubjectPublicKey

public PublicKey getSubjectPublicKey()

Returns:

the PublicKey if the last certificate in the CertPath

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

getTrustAnchor

public TrustAnchor getTrustAnchor()

Returns:

the TrustAnchor for the CertPath, null if no valid TrustAnchor was found.

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

isValidCertPath

public boolean isValidCertPath()

Returns:

if the CertPath is valid

Throws:

IllegalStateException - if the PKIXCertPathReviewer was not initialized

addNotification

protected void addNotification(ErrorBundle msg)

addNotification

protected void addNotification(ErrorBundle msg,
                   int index)

addError

protected void addError(ErrorBundle msg)

addError

protected void addError(ErrorBundle msg,
            int index)

doChecks

protected void doChecks()

checkRevocation

protected void checkRevocation(PKIXParameters paramsPKIX,
                   X509Certificate cert,
                   Date validDate,
                   X509Certificate sign,
                   PublicKey workingPublicKey,
                   Vector crlDistPointUrls,
                   Vector ocspUrls,
                   int index)
                        throws CertPathReviewerException

Throws:

CertPathReviewerException

checkCRLs

protected void checkCRLs(PKIXParameters paramsPKIX,
             X509Certificate cert,
             Date validDate,
             X509Certificate sign,
             PublicKey workingPublicKey,
             Vector crlDistPointUrls,
             int index)
                  throws CertPathReviewerException

Throws:

CertPathReviewerException

getCRLDistUrls

protected Vector getCRLDistUrls(CRLDistPoint crlDistPoints)

getOCSPUrls

protected Vector getOCSPUrls(AuthorityInformationAccess authInfoAccess)

getTrustAnchors

protected Collection getTrustAnchors(X509Certificate cert,
                         Set trustanchors)
                              throws CertPathReviewerException

Throws:

CertPathReviewerException

findTrustAnchor

protected static TrustAnchor findTrustAnchor(X509Certificate cert,
                          Set trustAnchors)
                                      throws AnnotatedException

Search the given Set of TrustAnchor's for one that is the issuer of the given X509 certificate. Uses the default provider for signature verification.

Parameters:

cert - the X509 certificate

trustAnchors - a Set of TrustAnchor's

Returns:

the TrustAnchor object if found or null if not.

Throws:

AnnotatedException - if a TrustAnchor was found but the signature verification on the given certificate has thrown an exception.

findTrustAnchor

protected static TrustAnchor findTrustAnchor(X509Certificate cert,
                          Set trustAnchors,
                          String sigProvider)
                                      throws AnnotatedException

Search the given Set of TrustAnchor's for one that is the issuer of the given X509 certificate. Uses the specified provider for signature verification, or the default provider if null.

Parameters:

cert - the X509 certificate

trustAnchors - a Set of TrustAnchor's

sigProvider - the provider to use for signature verification

Returns:

the TrustAnchor object if found or null if not.

Throws:

AnnotatedException - if a TrustAnchor was found but the signature verification on the given certificate has thrown an exception.

addAdditionalStoresFromAltNames

protected static void addAdditionalStoresFromAltNames(X509Certificate cert,
                                   ExtendedPKIXParameters pkixParams)
                                               throws CertificateParsingException

Throws:

CertificateParsingException

getEncodedIssuerPrincipal

protected static X500Principal getEncodedIssuerPrincipal(Object cert)

Returns the issuer of an attribute certificate or certificate.

Parameters:

cert - The attribute certificate or certificate.

Returns:

The issuer as X500Principal.

getValidDate

protected static Date getValidDate(PKIXParameters paramsPKIX)

getSubjectPrincipal

protected static X500Principal getSubjectPrincipal(X509Certificate cert)

isSelfIssued

protected static boolean isSelfIssued(X509Certificate cert)

getExtensionValue

protected static ASN1Primitive getExtensionValue(X509Extension ext,
                              String oid)
                                          throws AnnotatedException

Extract the value of the given extension, if it exists.

Parameters:

ext - The extension object.

oid - The object identifier to obtain.

Throws:

AnnotatedException - if the extension cannot be read.

getIssuerPrincipal

protected static X500Principal getIssuerPrincipal(X509CRL crl)

getAlgorithmIdentifier

protected static AlgorithmIdentifier getAlgorithmIdentifier(PublicKey key)
                                                     throws CertPathValidatorException

Throws:

CertPathValidatorException

getQualifierSet

protected static final Set getQualifierSet(ASN1Sequence qualifiers)
                                    throws CertPathValidatorException

Throws:

CertPathValidatorException

removePolicyNode

protected static PKIXPolicyNode removePolicyNode(PKIXPolicyNode validPolicyTree,
                              List[] policyNodes,
                              PKIXPolicyNode _node)

processCertD1i

protected static boolean processCertD1i(int index,
                     List[] policyNodes,
                     ASN1ObjectIdentifier pOid,
                     Set pq)

processCertD1ii

protected static void processCertD1ii(int index,
                   List[] policyNodes,
                   ASN1ObjectIdentifier _poid,
                   Set _pq)

prepareNextCertB1

protected static void prepareNextCertB1(int i,
                     List[] policyNodes,
                     String id_p,
                     Map m_idp,
                     X509Certificate cert)
                                 throws AnnotatedException,
                                        CertPathValidatorException

Throws:

AnnotatedException

CertPathValidatorException

prepareNextCertB2

protected static PKIXPolicyNode prepareNextCertB2(int i,
                               List[] policyNodes,
                               String id_p,
                               PKIXPolicyNode validPolicyTree)

isAnyPolicy

protected static boolean isAnyPolicy(Set policySet)

addAdditionalStoreFromLocation

protected static void addAdditionalStoreFromLocation(String location,
                                  ExtendedPKIXParameters pkixParams)

findCertificates

protected static Collection findCertificates(X509CertStoreSelector certSelect,
                          List certStores)
                                      throws AnnotatedException

Return a Collection of all certificates or attribute certificates found in the X509Store's that are matching the certSelect criteriums.

Parameters:

certSelect - a Selector object that will be used to select the certificates

certStores - a List containing only X509Store objects. These are used to search for certificates.

Returns:

a Collection of all found X509Certificate or X509AttributeCertificate objects. May be empty but never null.

Throws:

AnnotatedException

findCertificates

protected static Collection findCertificates(PKIXCertStoreSelector certSelect,
                          List certStores)
                                      throws AnnotatedException

Throws:

AnnotatedException

findCertificates

protected static Collection findCertificates(X509AttributeCertStoreSelector certSelect,
                          List certStores)
                                      throws AnnotatedException

Throws:

AnnotatedException

addAdditionalStoresFromCRLDistributionPoint

protected static void addAdditionalStoresFromCRLDistributionPoint(CRLDistPoint crldp,
                                               ExtendedPKIXParameters pkixParams)
                                                           throws AnnotatedException

Throws:

AnnotatedException

getCRLIssuersFromDistributionPoint

protected static void getCRLIssuersFromDistributionPoint(DistributionPoint dp,
                                      Collection issuerPrincipals,
                                      X509CRLSelector selector,
                                      ExtendedPKIXParameters pkixParams)
                                                  throws AnnotatedException

Add the CRL issuers from the cRLIssuer field of the distribution point or from the certificate if not given to the issuer criterion of the selector.

The issuerPrincipals are a collection with a single X500Principal for X509Certificates. For X509AttributeCertificates the issuer may contain more than one X500Principal.

Parameters:

dp - The distribution point.

issuerPrincipals - The issuers of the certificate or attribute certificate which contains the distribution point.

selector - The CRL selector.

pkixParams - The PKIX parameters containing the cert stores.

Throws:

AnnotatedException - if an exception occurs while processing.

ClassCastException - if issuerPrincipals does not contain only X500Principals.

getCertStatus

protected static void getCertStatus(Date validDate,
                 X509CRL crl,
                 Object cert,
                 org.bouncycastle.x509.CertStatus certStatus)
                             throws AnnotatedException

Throws:

AnnotatedException

getDeltaCRLs

protected static Set getDeltaCRLs(Date currentDate,
               ExtendedPKIXParameters paramsPKIX,
               X509CRL completeCRL)
                           throws AnnotatedException

Fetches delta CRLs according to RFC 3280 section 5.2.4.

Parameters:

currentDate - The date for which the delta CRLs must be valid.

paramsPKIX - The extended PKIX parameters.

completeCRL - The complete CRL the delta CRL is for.

Returns:

A Set of X509CRLs with delta CRLs.

Throws:

AnnotatedException - if an exception occurs while picking the delta CRLs.

getCompleteCRLs

protected static Set getCompleteCRLs(DistributionPoint dp,
                  Object cert,
                  Date currentDate,
                  ExtendedPKIXParameters paramsPKIX)
                              throws AnnotatedException

Fetches complete CRLs according to RFC 3280.

Parameters:

dp - The distribution point for which the complete CRL

cert - The X509Certificate or X509AttributeCertificate for which the CRL should be searched.

currentDate - The date for which the delta CRLs must be valid.

paramsPKIX - The extended PKIX parameters.

Returns:

A Set of X509CRLs with complete CRLs.

Throws:

AnnotatedException - if an exception occurs while picking the CRLs or no CRLs are found.

getValidCertDateFromValidityModel

protected static Date getValidCertDateFromValidityModel(ExtendedPKIXParameters paramsPKIX,
                                     CertPath certPath,
                                     int index)
                                                 throws AnnotatedException

Throws:

AnnotatedException

getNextWorkingKey

protected static PublicKey getNextWorkingKey(List certs,
                          int index)
                                      throws CertPathValidatorException

Return the next working key inheriting DSA parameters if necessary.

This methods inherits DSA parameters from the indexed certificate or previous certificates in the certificate chain to the returned PublicKey. The list is searched upwards, meaning the end certificate is at position 0 and previous certificates are following.

If the indexed certificate does not contain a DSA key this method simply returns the public key. If the DSA key already contains DSA parameters the key is also only returned.

Parameters:

certs - The certification path.

index - The index of the certificate which contains the public key which should be extended with DSA parameters.

Returns:

The public key of the certificate in list position index extended with DSA parameters if applicable.

Throws:

AnnotatedException - if DSA parameters cannot be inherited.

CertPathValidatorException

verifyX509Certificate

protected static void verifyX509Certificate(X509Certificate cert,
                         PublicKey publicKey,
                         String sigProvider)
                                     throws GeneralSecurityException

Throws:

GeneralSecurityException