Bouncy Castle Library 1.77.0 API Specification: Class X509CertSelector

Overview

Package

Class

Tree

Deprecated

Index

Help

Bouncy Castle Cryptography Library 1.77.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.bouncycastle.jce.cert
Class X509CertSelector

java.lang.Object
  |
  +--org.bouncycastle.jce.cert.X509CertSelector

All Implemented Interfaces:: CertSelector, java.lang.Cloneable

Direct Known Subclasses:: X509CertStoreSelector

public class X509CertSelector
extends java.lang.Object
implements CertSelector

A CertSelector that selects X509Certificates that match all specified criteria. This class is particularly useful when selecting certificates from a CertStore to build a PKIX-compliant certification path.

When first constructed, an X509CertSelector has no criteria enabled and each of the get methods return a default value ( null, or -1 for the getBasicConstraints() method). Therefore, the match(java.security.cert.Certificate) method would return true for any X509Certificate. Typically, several criteria are enabled (by calling setIssuer(java.lang.String) or setKeyUsage(boolean[]), for instance) and then the X509CertSelector is passed to CertStore.getCertificates(org.bouncycastle.jce.cert.CertSelector) or some similar method.

Several criteria can be enabled (by calling setIssuer(java.lang.String) and setSerialNumber(java.math.BigInteger), for example) such that the match method usually uniquely matches a single X509Certificate. We say usually, since it is possible for two issuing CAs to have the same distinguished name and each issue a certificate with the same serial number. Other unique combinations include the issuer, subject, subjectKeyIdentifier and/or the subjectPublicKey criteria.

Please refer to RFC 2459 for definitions of the X.509 certificate extensions mentioned below.

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.

TODO: implement name constraints TODO: implement match check for path to names

Uses ASN1InputStream, ASN1Sequence, ASN1ObjectIdentifier, DEROutputStream, ASN1Object, OIDTokenizer, X509Name, X509Extensions, ExtendedKeyUsage, KeyPurposeId, SubjectPublicKeyInfo, AlgorithmIdentifier

Constructor Summary

X509CertSelector()
          Creates an X509CertSelector.

Method Summary

void addPathToName(int type, byte[] name)
          Adds a name to the pathToNames criterion.

void addPathToName(int type, java.lang.String name)
          Adds a name to the pathToNames criterion.

void addSubjectAlternativeName(int type, byte[] name)
          Adds a name to the subjectAlternativeNames criterion.

void addSubjectAlternativeName(int type, java.lang.String name)
          Adds a name to the subjectAlternativeNames criterion.

java.lang.Object clone()
          Returns a copy of this object.

byte[] getAuthorityKeyIdentifier()
          Returns the authorityKeyIdentifier criterion.

int getBasicConstraints()
          Returns the basic constraints constraint.

java.security.cert.X509Certificate getCertificate()
          Returns the certificateEquals criterion.

java.util.Date getCertificateValid()
          Returns the certificateValid criterion.

java.util.Set getExtendedKeyUsage()
          Returns the extendedKeyUsage criterion.

byte[] getIssuerAsBytes()
          Returns the issuer criterion as a byte array.

java.lang.String getIssuerAsString()
          Returns the issuer criterion as a String.

boolean[] getKeyUsage()
          Returns the keyUsage criterion.

boolean getMatchAllSubjectAltNames()
          Indicates if the X509Certificate must contain all or at least one of the subjectAlternativeNames specified in the setSubjectAlternativeNames or addSubjectAlternativeName methods.

byte[] getNameConstraints()
          Returns the name constraints criterion.

java.util.Collection getPathToNames()
          Returns a copy of the pathToNames criterion.

java.util.Set getPolicy()
          Returns the policy criterion.

java.util.Date getPrivateKeyValid()
          Returns the privateKeyValid criterion.

java.math.BigInteger getSerialNumber()
          Returns the serialNumber criterion.

java.util.Collection getSubjectAlternativeNames()
          Returns a copy of the subjectAlternativeNames criterion.

byte[] getSubjectAsBytes()
          Returns the subject criterion as a byte array.

java.lang.String getSubjectAsString()
          Returns the subject criterion as a String.

byte[] getSubjectKeyIdentifier()
          Returns the subjectKeyIdentifier criterion.

java.security.PublicKey getSubjectPublicKey()
          Returns the subjectPublicKey criterion.

java.lang.String getSubjectPublicKeyAlgID()
          Returns the subjectPublicKeyAlgID criterion.

boolean match(java.security.cert.Certificate cert)
          Decides whether a Certificate should be selected.

TODO: implement missing tests (name constraints and path to names)

Uses ASN1InputStream, ASN1Sequence, ASN1ObjectIdentifier, ASN1Object, DERGeneralizedTime, X509Name, X509Extensions, ExtendedKeyUsage, KeyPurposeId, SubjectPublicKeyInfo, AlgorithmIdentifier to access X509 extensions

void setAuthorityKeyIdentifier(byte[] authorityKeyID)
          Sets the authorityKeyIdentifier criterion.

void setBasicConstraints(int minMaxPathLen)
          Sets the basic constraints constraint.

void setCertificate(java.security.cert.X509Certificate cert)
          Sets the certificateEquals criterion.

void setCertificateValid(java.util.Date certValid)
          Sets the certificateValid criterion.

void setExtendedKeyUsage(java.util.Set keyPurposeSet)
          Sets the extendedKeyUsage criterion.

void setIssuer(byte[] issuerDN)
          Sets the issuer criterion.

void setIssuer(java.lang.String issuerDN)
          Sets the issuer criterion.

void setKeyUsage(boolean[] keyUsage)
          Sets the keyUsage criterion.

void setMatchAllSubjectAltNames(boolean matchAllNames)
          Enables/disables matching all of the subjectAlternativeNames specified in the setSubjectAlternativeNames or addSubjectAlternativeName methods.

void setNameConstraints(byte[] bytes)
          Sets the name constraints criterion.

void setPathToNames(java.util.Collection names)
          Sets the pathToNames criterion.

void setPolicy(java.util.Set certPolicySet)
          Sets the policy constraint.

void setPrivateKeyValid(java.util.Date privateKeyValid)
          Sets the privateKeyValid criterion.

void setSerialNumber(java.math.BigInteger serial)
          Sets the serialNumber criterion.

void setSubject(byte[] subjectDN)
          Sets the subject criterion.

void setSubject(java.lang.String subjectDN)
          Sets the subject criterion.

void setSubjectAlternativeNames(java.util.Collection names)
          Sets the subjectAlternativeNames criterion.

void setSubjectKeyIdentifier(byte[] subjectKeyID)
          Sets the subjectKeyIdentifier criterion.

void setSubjectPublicKey(byte[] key)
          Sets the subjectPublicKey criterion.

void setSubjectPublicKey(java.security.PublicKey key)
          Sets the subjectPublicKey criterion.

void setSubjectPublicKeyAlgID(java.lang.String oid)
          Sets the subjectPublicKeyAlgID criterion.

java.lang.String toString()
          Return a printable representation of the CertSelector.

TODO: implement output for currently unsupported options(name constraints)

Uses ASN1InputStream, ASN1Object, KeyPurposeId

Methods inherited from class java.lang.Object

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

Constructor Detail

X509CertSelector

public X509CertSelector()

Creates an X509CertSelector. Initially, no criteria are set so any X509Certificate will match.

Method Detail

setCertificate

public void setCertificate(java.security.cert.X509Certificate cert)

Sets the certificateEquals criterion. The specified X509Certificate must be equal to the X509Certificate passed to the match method. If null, then this check is not applied.

This method is particularly useful when it is necessary to match a single certificate. Although other criteria can be specified in conjunction with the certificateEquals criterion, it is usually not practical or necessary.

Parameters:: cert - the X509Certificate to match (or null)
See Also:: getCertificate()

setSerialNumber

public void setSerialNumber(java.math.BigInteger serial)

Sets the serialNumber criterion. The specified serial number must match the certificate serial number in the X509Certificate. If null, any certificate serial number will do.

Parameters:: serial - the certificate serial number to match (or null)
See Also:: getSerialNumber()

setIssuer

public void setIssuer(java.lang.String issuerDN)
               throws java.io.IOException

Sets the issuer criterion. The specified distinguished name must match the issuer distinguished name in the X509Certificate. If null, any issuer distinguished name will do.

If issuerDN is not null, it should contain a distinguished name, in RFC 2253 format.

Uses X509Name for parsing the issuerDN.

Parameters:: issuerDN - a distinguished name in RFC 2253 format (or null)
Throws:: java.io.IOException - if a parsing error occurs (incorrect form for DN)

setIssuer

public void setIssuer(byte[] issuerDN)
               throws java.io.IOException

Sets the issuer criterion. The specified distinguished name must match the issuer distinguished name in the X509Certificate. If null is specified, the issuer criterion is disabled and any issuer distinguished name will do.

If issuerDN is not null, it should contain a single DER encoded distinguished name, as defined in X.501. The ASN.1 notation for this structure is as follows.

Name ::= CHOICE { RDNSequence } RDNSequence ::= SEQUENCE OF RDN RDN ::= SET SIZE (1 .. MAX) OF AttributeTypeAndValue AttributeTypeAndValue ::= SEQUENCE { type AttributeType, value AttributeValue } AttributeType ::= OBJECT IDENTIFIER AttributeValue ::= ANY DEFINED BY AttributeType []. DirectoryString ::= CHOICE { teletexString TeletexString (SIZE (1..MAX)), printableString PrintableString (SIZE (1..MAX)), universalString UniversalString (SIZE (1..MAX)), utf8String UTF8String (SIZE (1.. MAX)), bmpString BMPString (SIZE (1..MAX)) }

Note that the byte array specified here is cloned to protect against subsequent modifications.

Uses ASN1InputStream, ASN1Object, ASN1Sequence, X509Name

Parameters:: issuerDN - - a byte array containing the distinguished name in ASN.1 DER encoded form (or null)
Throws:: java.io.IOException - if an encoding error occurs (incorrect form for DN)

setSubject

public void setSubject(java.lang.String subjectDN)
                throws java.io.IOException

Sets the subject criterion. The specified distinguished name must match the subject distinguished name in the X509Certificate. If null, any subject distinguished name will do.

If subjectDN is not null, it should contain a distinguished name, in RFC 2253 format.

Uses X509Name for parsing the subjectDN.

Parameters:: subjectDN - a distinguished name in RFC 2253 format (or null)
Throws:: java.io.IOException - if a parsing error occurs (incorrect form for DN)

setSubject

public void setSubject(byte[] subjectDN)
                throws java.io.IOException

Sets the subject criterion. The specified distinguished name must match the subject distinguished name in the X509Certificate. If null, any subject distinguished name will do.

If subjectDN is not null, it should contain a single DER encoded distinguished name, as defined in X.501. For the ASN.1 notation for this structure, see setIssuer(byte [] issuerDN).

Uses ASN1InputStream, ASN1Object, ASN1Sequence, X509Name

Parameters:: subjectDN - a byte array containing the distinguished name in ASN.1 DER format (or null)
Throws:: java.io.IOException - if an encoding error occurs (incorrect form for DN)

setSubjectKeyIdentifier

public void setSubjectKeyIdentifier(byte[] subjectKeyID)

Sets the subjectKeyIdentifier criterion. The X509Certificate must contain a SubjectKeyIdentifier extension for which the contents of the extension matches the specified criterion value. If the criterion value is null, no subjectKeyIdentifier check will be done.

If subjectKeyID is not null, it should contain a single DER encoded value corresponding to the contents of the extension value (not including the object identifier, criticality setting, and encapsulating OCTET STRING) for a SubjectKeyIdentifier extension. The ASN.1 notation for this structure follows.

SubjectKeyIdentifier ::= KeyIdentifier KeyIdentifier ::= OCTET STRING

Since the format of subject key identifiers is not mandated by any standard, subject key identifiers are not parsed by the X509CertSelector. Instead, the values are compared using a byte-by-byte comparison.

Note that the byte array supplied here is cloned to protect against subsequent modifications.

Parameters:: subjectKeyID - - the subject key identifier (or null)
See Also:: getSubjectKeyIdentifier()

setAuthorityKeyIdentifier

public void setAuthorityKeyIdentifier(byte[] authorityKeyID)

Sets the authorityKeyIdentifier criterion. The X509Certificate must contain an AuthorityKeyIdentifier extension for which the contents of the extension value matches the specified criterion value. If the criterion value is null, no authorityKeyIdentifier check will be done.

If authorityKeyID is not null, it should contain a single DER encoded value corresponding to the contents of the extension value (not including the object identifier, criticality setting, and encapsulating OCTET STRING) for an AuthorityKeyIdentifier extension. The ASN.1 notation for this structure follows.

AuthorityKeyIdentifier ::= SEQUENCE { keyIdentifier [0] KeyIdentifier OPTIONAL, authorityCertIssuer [1] GeneralNames OPTIONAL, authorityCertSerialNumber [2] CertificateSerialNumber OPTIONAL } KeyIdentifier ::= OCTET STRING

Authority key identifiers are not parsed by the X509CertSelector. Instead, the values are compared using a byte-by-byte comparison.

When the keyIdentifier field of AuthorityKeyIdentifier is populated, the value is usually taken from the SubjectKeyIdentifier extension in the issuer's certificate. Note, however, that the result of X509Certificate.getExtensionValue() on the issuer's certificate may NOT be used directly as the input to setAuthorityKeyIdentifier. This is because the SubjectKeyIdentifier contains only a KeyIdentifier OCTET STRING, and not a SEQUENCE of KeyIdentifier, GeneralNames, and CertificateSerialNumber. In order to use the extension value of the issuer certificate's SubjectKeyIdentifier extension, it will be necessary to extract the value of the embedded KeyIdentifier OCTET STRING, then DER encode this OCTET STRING inside a SEQUENCE. For more details on SubjectKeyIdentifier, see setSubjectKeyIdentifier(byte[] subjectKeyID ).

Note also that the byte array supplied here is cloned to protect against subsequent modifications.

Parameters:: authorityKeyID - the authority key identifier (or null)
See Also:: getAuthorityKeyIdentifier()

setCertificateValid

public void setCertificateValid(java.util.Date certValid)

Sets the certificateValid criterion. The specified date must fall within the certificate validity period for the X509Certificate. If null, no certificateValid check will be done.

Note that the Date supplied here is cloned to protect against subsequent modifications.

Parameters:: certValid - the Date to check (or null)
See Also:: getCertificateValid()

setPrivateKeyValid

public void setPrivateKeyValid(java.util.Date privateKeyValid)

Sets the privateKeyValid criterion. The specified date must fall within the private key validity period for the X509Certificate. If null, no privateKeyValid check will be done.

Note that the Date supplied here is cloned to protect against subsequent modifications.

Parameters:: privateKeyValid - the Date to check (or null)
See Also:: getPrivateKeyValid()

setSubjectPublicKeyAlgID

public void setSubjectPublicKeyAlgID(java.lang.String oid)
                              throws java.io.IOException

Sets the subjectPublicKeyAlgID criterion. The X509Certificate must contain a subject public key with the specified algorithm. If null, no subjectPublicKeyAlgID check will be done.

Parameters:: oid - The object identifier (OID) of the algorithm to check for (or null). An OID is represented by a set of nonnegative integers separated by periods.
Throws:: java.io.IOException - if the OID is invalid, such as the first component being not 0, 1 or 2 or the second component being greater than 39.
See Also:: getSubjectPublicKeyAlgID()

setSubjectPublicKey

public void setSubjectPublicKey(java.security.PublicKey key)

Sets the subjectPublicKey criterion. The X509Certificate must contain the specified subject public key. If null, no subjectPublicKey check will be done.

Parameters:: key - the subject public key to check for (or null)
See Also:: getSubjectPublicKey()

setSubjectPublicKey

public void setSubjectPublicKey(byte[] key)
                         throws java.io.IOException

Sets the subjectPublicKey criterion. The X509Certificate must contain the specified subject public key. If null, no subjectPublicKey check will be done.

Because this method allows the public key to be specified as a byte array, it may be used for unknown key types.

If key is not null, it should contain a single DER encoded SubjectPublicKeyInfo structure, as defined in X.509. The ASN.1 notation for this structure is as follows.

SubjectPublicKeyInfo ::= SEQUENCE { algorithm AlgorithmIdentifier, subjectPublicKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL } -- contains a value of the type -- registered for use with the -- algorithm object identifier value

Note that the byte array supplied here is cloned to protect against subsequent modifications.

Parameters:: key - a byte array containing the subject public key in ASN.1 DER form (or null)
Throws:: java.io.IOException - if an encoding error occurs (incorrect form for subject public key)
See Also:: getSubjectPublicKey()

setKeyUsage

public void setKeyUsage(boolean[] keyUsage)

Sets the keyUsage criterion. The X509Certificate must allow the specified keyUsage values. If null, no keyUsage check will be done. Note that an X509Certificate that has no keyUsage extension implicitly allows all keyUsage values.

Note that the boolean array supplied here is cloned to protect against subsequent modifications.

Parameters:: keyUsage - a boolean array in the same format as the boolean array returned by X509Certificate.getKeyUsage(). Or null.
See Also:: getKeyUsage()

setExtendedKeyUsage

public void setExtendedKeyUsage(java.util.Set keyPurposeSet)
                         throws java.io.IOException

Sets the extendedKeyUsage criterion. The X509Certificate must allow the specified key purposes in its extended key usage extension. If keyPurposeSet is empty or null, no extendedKeyUsage check will be done. Note that an X509Certificate that has no extendedKeyUsage extension implicitly allows all key purposes.

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

Uses KeyPurposeId

Parameters:: keyPurposeSet - a Set of key purpose OIDs in string format (or null). Each OID is represented by a set of nonnegative integers separated by periods.
Throws:: java.io.IOException - if the OID is invalid, such as the first component being not 0, 1 or 2 or the second component being greater than 39.
See Also:: getExtendedKeyUsage()

setMatchAllSubjectAltNames

public void setMatchAllSubjectAltNames(boolean matchAllNames)

Enables/disables matching all of the subjectAlternativeNames specified in the setSubjectAlternativeNames or addSubjectAlternativeName methods. If enabled, the X509Certificate must contain all of the specified subject alternative names. If disabled, the X509Certificate must contain at least one of the specified subject alternative names.

The matchAllNames flag is true by default.

Parameters:: matchAllNames - if true, the flag is enabled; if false, the flag is disabled.
See Also:: getMatchAllSubjectAltNames()

setSubjectAlternativeNames

public void setSubjectAlternativeNames(java.util.Collection names)
                                throws java.io.IOException

Sets the subjectAlternativeNames criterion. The X509Certificate must contain all or at least one of the specified subjectAlternativeNames, depending on the value of the matchAllNames flag (see setMatchAllSubjectAltNames(boolean)).

This method allows the caller to specify, with a single method call, the complete set of subject alternative names for the subjectAlternativeNames criterion. The specified value replaces the previous value for the subjectAlternativeNames criterion.

The names parameter (if not null) is a Collection with one entry for each name to be included in the subject alternative name criterion. Each entry is a List whose first entry is an Integer (the name type, 0-8) and whose second entry is a String or a byte array (the name, in string or ASN.1 DER encoded form, respectively). There can be multiple names of the same type. If null is supplied as the value for this argument, no subjectAlternativeNames check will be performed.

Each subject alternative name in the Collection may be specified either as a String or as an ASN.1 encoded byte array. For more details about the formats used, see addSubjectAlternativeName(int type, String name) and addSubjectAlternativeName(int type, byte [] name).

Note that the names parameter can contain duplicate names (same name and name type), but they may be removed from the Collection of names returned by the getSubjectAlternativeNames() method.

Note that a deep copy is performed on the Collection to protect against subsequent modifications.

Parameters:: names - - a Collection of names (or null)
Throws:: java.io.IOException - if a parsing error occurs
See Also:: getSubjectAlternativeNames()

addSubjectAlternativeName

public void addSubjectAlternativeName(int type,
                                      java.lang.String name)
                               throws java.io.IOException

Adds a name to the subjectAlternativeNames criterion. The X509Certificate must contain all or at least one of the specified subjectAlternativeNames, depending on the value of the matchAllNames flag (see setMatchAllSubjectAltNames(boolean)).

This method allows the caller to add a name to the set of subject alternative names. The specified name is added to any previous value for the subjectAlternativeNames criterion. If the specified name is a duplicate, it may be ignored.

The name is provided in string format. RFC 822, DNS, and URI names use the well-established string formats for those types (subject to the restrictions included in RFC 2459). IPv4 address names are supplied using dotted quad notation. OID address names are represented as a series of nonnegative integers separated by periods. And directory names (distinguished names) are supplied in RFC 2253 format. No standard string format is defined for otherNames, X.400 names, EDI party names, IPv6 address names, or any other type of names. They should be specified using the addSubjectAlternativeName(int type, byte [] name) method.

Parameters:: type - the name type (0-8, as specified in RFC 2459, section 4.2.1.7); name - - the name in string form (not null)
Throws:: java.io.IOException - if a parsing error occurs

addSubjectAlternativeName

public void addSubjectAlternativeName(int type,
                                      byte[] name)
                               throws java.io.IOException

Adds a name to the subjectAlternativeNames criterion. The X509Certificate must contain all or at least one of the specified subjectAlternativeNames, depending on the value of the matchAllNames flag (see setMatchAllSubjectAltNames(boolean)).

This method allows the caller to add a name to the set of subject alternative names. The specified name is added to any previous value for the subjectAlternativeNames criterion. If the specified name is a duplicate, it may be ignored.

The name is provided as a byte array. This byte array should contain the DER encoded name, as it would appear in the GeneralName structure defined in RFC 2459 and X.509. The encoded byte array should only contain the encoded value of the name, and should not include the tag associated with the name in the GeneralName structure. The ASN.1 definition of this structure appears below.

GeneralName ::= CHOICE { otherName [0] OtherName, rfc822Name [1] IA5String, dNSName [2] IA5String, x400Address [3] ORAddress, directoryName [4] Name, ediPartyName [5] EDIPartyName, uniformResourceIdentifier [6] IA5String, iPAddress [7] OCTET STRING, registeredID [8] OBJECT IDENTIFIER}

Note that the byte array supplied here is cloned to protect against subsequent modifications.

TODO: check encoded format

Parameters:: type - the name type (0-8, as listed above); name - a byte array containing the name in ASN.1 DER encoded form
Throws:: java.io.IOException - if a parsing error occurs

setNameConstraints

public void setNameConstraints(byte[] bytes)
                        throws java.io.IOException

Sets the name constraints criterion. The X509Certificate must have subject and subject alternative names that meet the specified name constraints.

The name constraints are specified as a byte array. This byte array should contain the DER encoded form of the name constraints, as they would appear in the NameConstraints structure defined in RFC 2459 and X.509. The ASN.1 definition of this structure appears below.

NameConstraints ::= SEQUENCE { permittedSubtrees [0] GeneralSubtrees OPTIONAL, excludedSubtrees [1] GeneralSubtrees OPTIONAL } GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree GeneralSubtree ::= SEQUENCE { base GeneralName, minimum [0] BaseDistance DEFAULT 0, maximum [1] BaseDistance OPTIONAL } BaseDistance ::= INTEGER (0..MAX) GeneralName ::= CHOICE { otherName [0] OtherName, rfc822Name [1] IA5String, dNSName [2] IA5String, x400Address [3] ORAddress, directoryName [4] Name, ediPartyName [5] EDIPartyName, uniformResourceIdentifier [6] IA5String, iPAddress [7] OCTET STRING, registeredID [8] OBJECT IDENTIFIER}

Note that the byte array supplied here is cloned to protect against subsequent modifications.

TODO: implement this

Parameters:: bytes - a byte array containing the ASN.1 DER encoding of a NameConstraints extension to be used for checking name constraints. Only the value of the extension is included, not the OID or criticality flag. Can be null, in which case no name constraints check will be performed
Throws:: java.io.IOException - if a parsing error occurs; UnsupportedOperationException - because this method is not supported
See Also:: getNameConstraints()

setBasicConstraints

public void setBasicConstraints(int minMaxPathLen)

Sets the basic constraints constraint. If the value is greater than or equal to zero, X509Certificates must include a basicConstraints extension with a pathLen of at least this value. If the value is -2, only end-entity certificates are accepted. If the value is -1, no check is done.

This constraint is useful when building a certification path forward (from the target toward the trust anchor. If a partial path has been built, any candidate certificate must have a maxPathLen value greater than or equal to the number of certificates in the partial path.

Parameters:: minMaxPathLen - the value for the basic constraints constraint
Throws:: java.lang.IllegalArgumentException - if the value is less than -2
See Also:: getBasicConstraints()

setPolicy

public void setPolicy(java.util.Set certPolicySet)
               throws java.io.IOException

Sets the policy constraint. The X509Certificate must include at least one of the specified policies in its certificate policies extension. If certPolicySet is empty, then the X509Certificate must include at least some specified policy in its certificate policies extension. If certPolicySet is null, no policy check will be performed.

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

TODO: implement match check for this

Parameters:: certPolicySet - a Set of certificate policy OIDs in string format (or null). Each OID is represented by a set of nonnegative integers separated by periods.
Throws:: java.io.IOException - if a parsing error occurs on the OID such as the first component is not 0, 1 or 2 or the second component is greater than 39.
See Also:: getPolicy()

setPathToNames

public void setPathToNames(java.util.Collection names)
                    throws java.io.IOException

Sets the pathToNames criterion. The X509Certificate must not include name constraints that would prohibit building a path to the specified names.

This method allows the caller to specify, with a single method call, the complete set of names which the X509Certificates's name constraints must permit. The specified value replaces the previous value for the pathToNames criterion.

This constraint is useful when building a certification path forward (from the target toward the trust anchor. If a partial path has been built, any candidate certificate must not include name constraints that would prohibit building a path to any of the names in the partial path.

The names parameter (if not null) is a Collection with one entry for each name to be included in the pathToNames criterion. Each entry is a List whose first entry is an Integer (the name type, 0-8) and whose second entry is a String or a byte array (the name, in string or ASN.1 DER encoded form, respectively). There can be multiple names of the same type. If null is supplied as the value for this argument, no pathToNames check will be performed.

Each name in the Collection may be specified either as a String or as an ASN.1 encoded byte array. For more details about the formats used, see addPathToName(int type, String name) and addPathToName(int type, byte [] name).

Note that the names parameter can contain duplicate names (same name and name type), but they may be removed from the Collection of names returned by the getPathToNames() method.

Note that a deep copy is performed on the Collection to protect against subsequent modifications.

TODO: implement this match check for this

Parameters:: names - a Collection with one entry per name (or null)
Throws:: java.io.IOException - if a parsing error occurs; UnsupportedOperationException - because this method is not supported
See Also:: getPathToNames()

addPathToName

public void addPathToName(int type,
                          java.lang.String name)
                   throws java.io.IOException

Adds a name to the pathToNames criterion. The X509Certificate must not include name constraints that would prohibit building a path to the specified name.

This method allows the caller to add a name to the set of names which the X509Certificates's name constraints must permit. The specified name is added to any previous value for the pathToNames criterion. If the name is a duplicate, it may be ignored.

The name is provided in string format. RFC 822, DNS, and URI names use the well-established string formats for those types (subject to the restrictions included in RFC 2459). IPv4 address names are supplied using dotted quad notation. OID address names are represented as a series of nonnegative integers separated by periods. And directory names (distinguished names) are supplied in RFC 2253 format. No standard string format is defined for otherNames, X.400 names, EDI party names, IPv6 address names, or any other type of names. They should be specified using the addPathToName(int type, byte [] name) method.

TODO: implement this match check for this

Parameters:: type - the name type (0-8, as specified in RFC 2459, section 4.2.1.7); name - the name in string form

addPathToName

public void addPathToName(int type,
                          byte[] name)
                   throws java.io.IOException

Adds a name to the pathToNames criterion. The X509Certificate must not include name constraints that would prohibit building a path to the specified name.

This method allows the caller to add a name to the set of names which the X509Certificates's name constraints must permit. The specified name is added to any previous value for the pathToNames criterion. If the name is a duplicate, it may be ignored.

The name is provided as a byte array. This byte array should contain the DER encoded name, as it would appear in the GeneralName structure defined in RFC 2459 and X.509. The ASN.1 definition of this structure appears in the documentation for addSubjectAlternativeName(int type, byte[] name).

Note that the byte array supplied here is cloned to protect against subsequent modifications.

TODO: implement this match check for this

Parameters:: type - the name type (0-8, as specified in RFC 2459, section 4.2.1.7); name - a byte array containing the name in ASN.1 DER encoded form
Throws:: java.io.IOException - if a parsing error occurs

getCertificate

public java.security.cert.X509Certificate getCertificate()

Returns the certificateEquals criterion. The specified X509Certificate must be equal to the X509Certificate passed to the match method. If null, this check is not applied.

See Also:: setCertificate(java.security.cert.X509Certificate)

getSerialNumber

public java.math.BigInteger getSerialNumber()

Returns the serialNumber criterion. The specified serial number must match the certificate serial number in the X509Certificate. If null, any certificate serial number will do.

Returns:: the certificate serial number to match (or null)
See Also:: setSerialNumber(java.math.BigInteger)

getIssuerAsString

public java.lang.String getIssuerAsString()

Returns the issuer criterion as a String. This distinguished name must match the issuer distinguished name in the X509Certificate. If null, the issuer criterion is disabled and any issuer distinguished name will do.

If the value returned is not null, it is a distinguished name, in RFC 2253 format.

Uses X509Name for formatiing byte[] issuerDN to String.

Returns:: the required issuer distinguished name in RFC 2253 format (or null)

getIssuerAsBytes

public byte[] getIssuerAsBytes()
                        throws java.io.IOException

Returns the issuer criterion as a byte array. This distinguished name must match the issuer distinguished name in the X509Certificate. If null, the issuer criterion is disabled and any issuer distinguished name will do.

If the value returned is not null, it is a byte array containing a single DER encoded distinguished name, as defined in X.501. The ASN.1 notation for this structure is supplied in the documentation for setIssuer(byte [] issuerDN).

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

Uses DEROutputStream, X509Name to gnerate byte[] output for String issuerDN.

Returns:: a byte array containing the required issuer distinguished name in ASN.1 DER format (or null)
Throws:: java.io.IOException - if an encoding error occurs

getSubjectAsString

public java.lang.String getSubjectAsString()

Returns the subject criterion as a String. This distinguished name must match the subject distinguished name in the X509Certificate. If null, the subject criterion is disabled and any subject distinguished name will do.

If the value returned is not null, it is a distinguished name, in RFC 2253 format.

Uses X509Name for formatiing byte[] subjectDN to String.

Returns:: the required subject distinguished name in RFC 2253 format (or null)

getSubjectAsBytes

public byte[] getSubjectAsBytes()
                         throws java.io.IOException

Returns the subject criterion as a byte array. This distinguished name must match the subject distinguished name in the X509Certificate. If null, the subject criterion is disabled and any subject distinguished name will do.

If the value returned is not null, it is a byte array containing a single DER encoded distinguished name, as defined in X.501. The ASN.1 notation for this structure is supplied in the documentation for setSubject(byte [] subjectDN).

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

Uses DEROutputStream, X509Name to gnerate byte[] output for String subjectDN.

Returns:: a byte array containing the required subject distinguished name in ASN.1 DER format (or null)
Throws:: java.io.IOException - if an encoding error occurs

getSubjectKeyIdentifier

public byte[] getSubjectKeyIdentifier()

Returns the subjectKeyIdentifier criterion. The X509Certificate must contain a SubjectKeyIdentifier extension with the specified value. If null, no subjectKeyIdentifier check will be done.

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

Returns:: the key identifier (or null)
See Also:: setSubjectKeyIdentifier(byte[])

getAuthorityKeyIdentifier

public byte[] getAuthorityKeyIdentifier()

Returns the authorityKeyIdentifier criterion. The X509Certificate must contain a AuthorityKeyIdentifier extension with the specified value. If null, no authorityKeyIdentifier check will be done.

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

Returns:: the key identifier (or null)
See Also:: setAuthorityKeyIdentifier(byte[])

getCertificateValid

public java.util.Date getCertificateValid()

Returns the certificateValid criterion. The specified date must fall within the certificate validity period for the X509Certificate. If null, no certificateValid check will be done.

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

Returns:: the Date to check (or null)
See Also:: setCertificateValid(java.util.Date)

getPrivateKeyValid

public java.util.Date getPrivateKeyValid()

Returns the privateKeyValid criterion. The specified date must fall within the private key validity period for the X509Certificate. If null, no privateKeyValid check will be done.

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

Returns:: the Date to check (or null)
See Also:: setPrivateKeyValid(java.util.Date)

getSubjectPublicKeyAlgID

public java.lang.String getSubjectPublicKeyAlgID()

Returns the subjectPublicKeyAlgID criterion. The X509Certificate must contain a subject public key with the specified algorithm. If null, no subjectPublicKeyAlgID check will be done.

Returns:: the object identifier (OID) of the signature algorithm to check for (or null). An OID is represented by a set of nonnegative integers separated by periods.
See Also:: setSubjectPublicKeyAlgID(java.lang.String)

getSubjectPublicKey

public java.security.PublicKey getSubjectPublicKey()

Returns the subjectPublicKey criterion. The X509Certificate must contain the specified subject public key. If null, no subjectPublicKey check will be done.

Returns:: the subject public key to check for (or null)
See Also:: setSubjectPublicKey(java.security.PublicKey)

getKeyUsage

public boolean[] getKeyUsage()

Returns the keyUsage criterion. The X509Certificate must allow the specified keyUsage values. If null, no keyUsage check will be done.

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

Returns:: a boolean array in the same format as the boolean array returned by X509Certificate.getKeyUsage(). Or null.
See Also:: setKeyUsage(boolean[])

getExtendedKeyUsage

public java.util.Set getExtendedKeyUsage()

Returns the extendedKeyUsage criterion. The X509Certificate must allow the specified key purposes in its extended key usage extension. If the keyPurposeSet returned is empty or null, no extendedKeyUsage check will be done. Note that an X509Certificate that has no extendedKeyUsage extension implicitly allows all key purposes.

Returns:: an immutable Set of key purpose OIDs in string format (or null)
See Also:: setExtendedKeyUsage(java.util.Set)

getMatchAllSubjectAltNames

public boolean getMatchAllSubjectAltNames()

Indicates if the X509Certificate must contain all or at least one of the subjectAlternativeNames specified in the setSubjectAlternativeNames or addSubjectAlternativeName methods. If true, the X509Certificate must contain all of the specified subject alternative names. If false, the X509Certificate must contain at least one of the specified subject alternative names.

Returns:: true if the flag is enabled; false if the flag is disabled. The flag is true by default.
See Also:: setMatchAllSubjectAltNames(boolean)

getSubjectAlternativeNames

public java.util.Collection getSubjectAlternativeNames()

Returns a copy of the subjectAlternativeNames criterion. The X509Certificate must contain all or at least one of the specified subjectAlternativeNames, depending on the value of the matchAllNames flag (see getMatchAllSubjectAltNames). If the value returned is null, no subjectAlternativeNames check will be performed.

If the value returned is not null, it is a Collection with one entry for each name to be included in the subject alternative name criterion. Each entry is a List whose first entry is an Integer (the name type, 0-8) and whose second entry is a String or a byte array (the name, in string or ASN.1 DER encoded form, respectively). There can be multiple names of the same type. Note that the Collection returned may contain duplicate names (same name and name type).

Each subject alternative name in the Collection may be specified either as a String or as an ASN.1 encoded byte array. For more details about the formats used, see addSubjectAlternativeName(int type, String name) and addSubjectAlternativeName(int type, byte [] name).

Note that a deep copy is performed on the Collection to protect against subsequent modifications.

Returns:: a Collection of names (or null)
See Also:: setSubjectAlternativeNames(java.util.Collection)

getNameConstraints

public byte[] getNameConstraints()

Returns the name constraints criterion. The X509Certificate must have subject and subject alternative names that meet the specified name constraints.

The name constraints are returned as a byte array. This byte array contains the DER encoded form of the name constraints, as they would appear in the NameConstraints structure defined in RFC 2459 and X.509. The ASN.1 notation for this structure is supplied in the documentation for setNameConstraints(byte [] bytes).

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

TODO: implement this

Returns:: a byte array containing the ASN.1 DER encoding of a NameConstraints extension used for checking name constraints. null if no name constraints check will be performed.
Throws:: UnsupportedOperationException - because this method is not supported
See Also:: setNameConstraints(byte[])

getBasicConstraints

public int getBasicConstraints()

Returns the basic constraints constraint. If the value is greater than or equal to zero, the X509Certificates must include a basicConstraints extension with a pathLen of at least this value. If the value is -2, only end-entity certificates are accepted. If the value is -1, no basicConstraints check is done.

Returns:: the value for the basic constraints constraint
See Also:: setBasicConstraints(int)

getPolicy

public java.util.Set getPolicy()

Returns the policy criterion. The X509Certificate must include at least one of the specified policies in its certificate policies extension. If the Set returned is empty, then the X509Certificate must include at least some specified policy in its certificate policies extension. If the Set returned is null, no policy check will be performed.

Returns:: an immutable Set of certificate policy OIDs in string format (or null)
See Also:: setPolicy(java.util.Set)

getPathToNames

public java.util.Collection getPathToNames()

Returns a copy of the pathToNames criterion. The X509Certificate must not include name constraints that would prohibit building a path to the specified names. If the value returned is null, no pathToNames check will be performed.

If the value returned is not null, it is a Collection with one entry for each name to be included in the pathToNames criterion. Each entry is a List whose first entry is an Integer (the name type, 0-8) and whose second entry is a String or a byte array (the name, in string or ASN.1 DER encoded form, respectively). There can be multiple names of the same type. Note that the Collection returned may contain duplicate names (same name and name type).

Each name in the Collection may be specified either as a String or as an ASN.1 encoded byte array. For more details about the formats used, see addPathToName(int type, String name) and

addPathToName(int type,
 byte [] name)

.

Note that a deep copy is performed on the Collection to protect against subsequent modifications.

Returns:: a Collection of names (or null)
See Also:: setPathToNames(java.util.Collection)

toString

public java.lang.String toString()

Return a printable representation of the CertSelector.

TODO: implement output for currently unsupported options(name constraints)

Uses ASN1InputStream, ASN1Object, KeyPurposeId

Overrides:: toString in class java.lang.Object

Returns:: a String describing the contents of the CertSelector

match

public boolean match(java.security.cert.Certificate cert)

Decides whether a Certificate should be selected.

TODO: implement missing tests (name constraints and path to names)

Uses ASN1InputStream, ASN1Sequence, ASN1ObjectIdentifier, ASN1Object, DERGeneralizedTime, X509Name, X509Extensions, ExtendedKeyUsage, KeyPurposeId, SubjectPublicKeyInfo, AlgorithmIdentifier to access X509 extensions

Specified by:: match in interface CertSelector

Parameters:: cert - the Certificate to be checked
Returns:: true if the Certificate should be selected, false otherwise

clone

public java.lang.Object clone()

Returns a copy of this object.

Specified by:: clone in interface CertSelector
Overrides:: clone in class java.lang.Object

Returns:: the copy

Overview

Package

Class

Tree

Deprecated

Index

Help

Bouncy Castle Cryptography Library 1.77.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Constructor Summary
`X509CertSelector()` Creates an X509CertSelector.

Method Summary
`void`	`addPathToName(int type, byte[] name)` Adds a name to the pathToNames criterion.
`void`	`addPathToName(int type, java.lang.String name)` Adds a name to the pathToNames criterion.
`void`	`addSubjectAlternativeName(int type, byte[] name)` Adds a name to the subjectAlternativeNames criterion.
`void`	`addSubjectAlternativeName(int type, java.lang.String name)` Adds a name to the subjectAlternativeNames criterion.
`java.lang.Object`	`clone()` Returns a copy of this object.
`byte[]`	`getAuthorityKeyIdentifier()` Returns the authorityKeyIdentifier criterion.
`int`	`getBasicConstraints()` Returns the basic constraints constraint.
`java.security.cert.X509Certificate`	`getCertificate()` Returns the certificateEquals criterion.
`java.util.Date`	`getCertificateValid()` Returns the certificateValid criterion.
`java.util.Set`	`getExtendedKeyUsage()` Returns the extendedKeyUsage criterion.
`byte[]`	`getIssuerAsBytes()` Returns the issuer criterion as a byte array.
`java.lang.String`	`getIssuerAsString()` Returns the issuer criterion as a String.
`boolean[]`	`getKeyUsage()` Returns the keyUsage criterion.
`boolean`	`getMatchAllSubjectAltNames()` Indicates if the X509Certificate must contain all or at least one of the subjectAlternativeNames specified in the `setSubjectAlternativeNames` or `addSubjectAlternativeName` methods.
`byte[]`	`getNameConstraints()` Returns the name constraints criterion.
`java.util.Collection`	`getPathToNames()` Returns a copy of the pathToNames criterion.
`java.util.Set`	`getPolicy()` Returns the policy criterion.
`java.util.Date`	`getPrivateKeyValid()` Returns the privateKeyValid criterion.
`java.math.BigInteger`	`getSerialNumber()` Returns the serialNumber criterion.
`java.util.Collection`	`getSubjectAlternativeNames()` Returns a copy of the subjectAlternativeNames criterion.
`byte[]`	`getSubjectAsBytes()` Returns the subject criterion as a byte array.
`java.lang.String`	`getSubjectAsString()` Returns the subject criterion as a String.
`byte[]`	`getSubjectKeyIdentifier()` Returns the subjectKeyIdentifier criterion.
`java.security.PublicKey`	`getSubjectPublicKey()` Returns the subjectPublicKey criterion.
`java.lang.String`	`getSubjectPublicKeyAlgID()` Returns the subjectPublicKeyAlgID criterion.
`boolean`	`match(java.security.cert.Certificate cert)` Decides whether a Certificate should be selected. TODO: implement missing tests (name constraints and path to names) Uses `ASN1InputStream`, `ASN1Sequence`, `ASN1ObjectIdentifier`, `ASN1Object`, `DERGeneralizedTime`, `X509Name`, `X509Extensions`, `ExtendedKeyUsage`, `KeyPurposeId`, `SubjectPublicKeyInfo`, `AlgorithmIdentifier` to access X509 extensions
`void`	`setAuthorityKeyIdentifier(byte[] authorityKeyID)` Sets the authorityKeyIdentifier criterion.
`void`	`setBasicConstraints(int minMaxPathLen)` Sets the basic constraints constraint.
`void`	`setCertificate(java.security.cert.X509Certificate cert)` Sets the certificateEquals criterion.
`void`	`setCertificateValid(java.util.Date certValid)` Sets the certificateValid criterion.
`void`	`setExtendedKeyUsage(java.util.Set keyPurposeSet)` Sets the extendedKeyUsage criterion.
`void`	`setIssuer(byte[] issuerDN)` Sets the issuer criterion.
`void`	`setIssuer(java.lang.String issuerDN)` Sets the issuer criterion.
`void`	`setKeyUsage(boolean[] keyUsage)` Sets the keyUsage criterion.
`void`	`setMatchAllSubjectAltNames(boolean matchAllNames)` Enables/disables matching all of the subjectAlternativeNames specified in the `setSubjectAlternativeNames` or `addSubjectAlternativeName` methods.
`void`	`setNameConstraints(byte[] bytes)` Sets the name constraints criterion.
`void`	`setPathToNames(java.util.Collection names)` Sets the pathToNames criterion.
`void`	`setPolicy(java.util.Set certPolicySet)` Sets the policy constraint.
`void`	`setPrivateKeyValid(java.util.Date privateKeyValid)` Sets the privateKeyValid criterion.
`void`	`setSerialNumber(java.math.BigInteger serial)` Sets the serialNumber criterion.
`void`	`setSubject(byte[] subjectDN)` Sets the subject criterion.
`void`	`setSubject(java.lang.String subjectDN)` Sets the subject criterion.
`void`	`setSubjectAlternativeNames(java.util.Collection names)` Sets the subjectAlternativeNames criterion.
`void`	`setSubjectKeyIdentifier(byte[] subjectKeyID)` Sets the subjectKeyIdentifier criterion.
`void`	`setSubjectPublicKey(byte[] key)` Sets the subjectPublicKey criterion.
`void`	`setSubjectPublicKey(java.security.PublicKey key)` Sets the subjectPublicKey criterion.
`void`	`setSubjectPublicKeyAlgID(java.lang.String oid)` Sets the subjectPublicKeyAlgID criterion.
`java.lang.String`	`toString()` Return a printable representation of the CertSelector. TODO: implement output for currently unsupported options(name constraints) Uses `ASN1InputStream`, `ASN1Object`, `KeyPurposeId`

org.bouncycastle.jce.cert Class X509CertSelector

X509CertSelector

setCertificate

setSerialNumber

setIssuer

setIssuer

setSubject

setSubject

setSubjectKeyIdentifier

setAuthorityKeyIdentifier

setCertificateValid

setPrivateKeyValid

setSubjectPublicKeyAlgID

setSubjectPublicKey

setSubjectPublicKey

setKeyUsage

setExtendedKeyUsage

setMatchAllSubjectAltNames

setSubjectAlternativeNames

addSubjectAlternativeName

addSubjectAlternativeName

setNameConstraints

setBasicConstraints

setPolicy

setPathToNames

addPathToName

addPathToName

getCertificate

getSerialNumber

getIssuerAsString

getIssuerAsBytes

getSubjectAsString

getSubjectAsBytes

getSubjectKeyIdentifier

getAuthorityKeyIdentifier

getCertificateValid

getPrivateKeyValid

getSubjectPublicKeyAlgID

getSubjectPublicKey

getKeyUsage

getExtendedKeyUsage

getMatchAllSubjectAltNames

getSubjectAlternativeNames

getNameConstraints

getBasicConstraints

getPolicy

getPathToNames

toString

match

clone

org.bouncycastle.jce.cert
Class X509CertSelector