X509CertSelector
open class X509CertSelector : CertSelector
kotlin.Any | |
↳ | java.security.cert.X509CertSelector |
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
method would return true
for any X509Certificate
. Typically, several criteria are enabled (by calling #setIssuer or setKeyUsage
, for instance) and then the X509CertSelector
is passed to CertStore.getCertificates
or some similar method.
Several criteria can be enabled (by calling #setIssuer and setSerialNumber
, 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 5280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile 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.
Summary
Public constructors | |
---|---|
Creates an |
Public methods | |
---|---|
open Unit |
addPathToName(type: Int, name: String!) Adds a name to the pathToNames criterion. |
open Unit |
addPathToName(type: Int, name: ByteArray!) Adds a name to the pathToNames criterion. |
open Unit |
addSubjectAlternativeName(type: Int, name: String!) Adds a name to the subjectAlternativeNames criterion. |
open Unit |
addSubjectAlternativeName(type: Int, name: ByteArray!) Adds a name to the subjectAlternativeNames criterion. |
open Any |
clone() Returns a copy of this object. |
open ByteArray! |
Returns the authorityKeyIdentifier criterion. |
open Int |
Returns the basic constraints constraint. |
open X509Certificate! |
Returns the certificateEquals criterion. |
open Date! |
Returns the certificateValid criterion. |
open MutableSet<String!>! |
Returns the extendedKeyUsage criterion. |
open X500Principal! |
Returns the issuer criterion as an |
open ByteArray! |
Returns the issuer criterion as a byte array. |
open String! |
Denigrated, use getIssuer() or getIssuerAsBytes() instead. |
open BooleanArray! |
Returns the keyUsage criterion. |
open Boolean |
Indicates if the |
open ByteArray! |
Returns the name constraints criterion. |
open MutableCollection<MutableList<*>!>! |
Returns a copy of the pathToNames criterion. |
open MutableSet<String!>! |
Returns the policy criterion. |
open Date! |
Returns the privateKeyValid criterion. |
open BigInteger! |
Returns the serialNumber criterion. |
open X500Principal! |
Returns the subject criterion as an |
open MutableCollection<MutableList<*>!>! |
Returns a copy of the subjectAlternativeNames criterion. |
open ByteArray! |
Returns the subject criterion as a byte array. |
open String! |
Denigrated, use getSubject() or getSubjectAsBytes() instead. |
open ByteArray! |
Returns the subjectKeyIdentifier criterion. |
open PublicKey! |
Returns the subjectPublicKey criterion. |
open String! |
Returns the subjectPublicKeyAlgID criterion. |
open Boolean |
match(cert: Certificate!) Decides whether a |
open Unit |
setAuthorityKeyIdentifier(authorityKeyID: ByteArray!) Sets the authorityKeyIdentifier criterion. |
open Unit |
setBasicConstraints(minMaxPathLen: Int) Sets the basic constraints constraint. |
open Unit |
setCertificate(cert: X509Certificate!) Sets the certificateEquals criterion. |
open Unit |
setCertificateValid(certValid: Date!) Sets the certificateValid criterion. |
open Unit |
setExtendedKeyUsage(keyPurposeSet: MutableSet<String!>!) Sets the extendedKeyUsage criterion. |
open Unit |
setIssuer(issuer: X500Principal!) Sets the issuer criterion. |
open Unit |
Denigrated, use setIssuer(javax.security.auth.x500.X500Principal) or setIssuer(byte[]) instead. |
open Unit |
Sets the issuer criterion. |
open Unit |
setKeyUsage(keyUsage: BooleanArray!) Sets the keyUsage criterion. |
open Unit |
setMatchAllSubjectAltNames(matchAllNames: Boolean) Enables/disables matching all of the subjectAlternativeNames specified in the |
open Unit |
setNameConstraints(bytes: ByteArray!) Sets the name constraints criterion. |
open Unit |
setPathToNames(names: MutableCollection<MutableList<*>!>!) Sets the pathToNames criterion. |
open Unit |
setPolicy(certPolicySet: MutableSet<String!>!) Sets the policy constraint. |
open Unit |
setPrivateKeyValid(privateKeyValid: Date!) Sets the privateKeyValid criterion. |
open Unit |
setSerialNumber(serial: BigInteger!) Sets the serialNumber criterion. |
open Unit |
setSubject(subject: X500Principal!) Sets the subject criterion. |
open Unit |
setSubject(subjectDN: String!) Denigrated, use setSubject(javax.security.auth.x500.X500Principal) or setSubject(byte[]) instead. |
open Unit |
setSubject(subjectDN: ByteArray!) Sets the subject criterion. |
open Unit |
setSubjectAlternativeNames(names: MutableCollection<MutableList<*>!>!) Sets the subjectAlternativeNames criterion. |
open Unit |
setSubjectKeyIdentifier(subjectKeyID: ByteArray!) Sets the subjectKeyIdentifier criterion. |
open Unit |
setSubjectPublicKey(key: PublicKey!) Sets the subjectPublicKey criterion. |
open Unit |
setSubjectPublicKey(key: ByteArray!) Sets the subjectPublicKey criterion. |
open Unit |
setSubjectPublicKeyAlgID(oid: String!) Sets the subjectPublicKeyAlgID criterion. |
open String |
toString() Return a printable representation of the |
Public constructors
X509CertSelector
X509CertSelector()
Creates an X509CertSelector
. Initially, no criteria are set so any X509Certificate
will match.
Public methods
addPathToName
open fun addPathToName(
type: Int,
name: String!
): Unit
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 5280). 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.
Note: for distinguished names, use addPathToName(int,byte[]) instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
Parameters | |
---|---|
type |
Int: the name type (0-8, as specified in RFC 5280, section 4.2.1.6) |
name |
String!: the name in string form |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
addPathToName
open fun addPathToName(
type: Int,
name: ByteArray!
): Unit
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 5280 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.
Parameters | |
---|---|
type |
Int: the name type (0-8, as specified in RFC 5280, section 4.2.1.6) |
name |
ByteArray!: a byte array containing the name in ASN.1 DER encoded form |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
addSubjectAlternativeName
open fun addSubjectAlternativeName(
type: Int,
name: String!
): Unit
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
).
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 5280). 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.
Note: for distinguished names, use addSubjectAlternativeName(int,byte[]) instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
Parameters | |
---|---|
type |
Int: the name type (0-8, as specified in RFC 5280, section 4.2.1.6) |
name |
String!: the name in string form (not null ) |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
addSubjectAlternativeName
open fun addSubjectAlternativeName(
type: Int,
name: ByteArray!
): Unit
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
).
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 5280 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.
<code>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} </code>
Note that the byte array supplied here is cloned to protect against subsequent modifications.
Parameters | |
---|---|
type |
Int: the name type (0-8, as listed above) |
name |
ByteArray!: a byte array containing the name in ASN.1 DER encoded form |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
clone
open fun clone(): Any
Returns a copy of this object.
Return | |
---|---|
Any |
the copy |
Exceptions | |
---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
getAuthorityKeyIdentifier
open fun getAuthorityKeyIdentifier(): ByteArray!
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.
Return | |
---|---|
ByteArray! |
the key identifier (or null ) |
See Also
getBasicConstraints
open fun getBasicConstraints(): Int
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.
Return | |
---|---|
Int |
the value for the basic constraints constraint |
See Also
getCertificate
open fun getCertificate(): X509Certificate!
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.
Return | |
---|---|
X509Certificate! |
the X509Certificate to match (or null ) |
See Also
getCertificateValid
open fun getCertificateValid(): Date!
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.
Return | |
---|---|
Date! |
the Date to check (or null ) |
See Also
getExtendedKeyUsage
open fun getExtendedKeyUsage(): MutableSet<String!>!
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.
Return | |
---|---|
MutableSet<String!>! |
an immutable Set of key purpose OIDs in string format (or null ) |
See Also
getIssuer
open fun getIssuer(): X500Principal!
Returns the issuer criterion as an X500Principal
. 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.
Return | |
---|---|
X500Principal! |
the required issuer distinguished name as X500Principal (or null ) |
getIssuerAsBytes
open fun getIssuerAsBytes(): ByteArray!
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.
Return | |
---|---|
ByteArray! |
a byte array containing the required issuer distinguished name in ASN.1 DER format (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if an encoding error occurs |
getIssuerAsString
open fun getIssuerAsString(): String!
Denigrated, use getIssuer() or getIssuerAsBytes() instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
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.
Return | |
---|---|
String! |
the required issuer distinguished name in RFC 2253 format (or null ) |
getKeyUsage
open fun getKeyUsage(): BooleanArray!
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.
Return | |
---|---|
BooleanArray! |
a boolean array in the same format as the boolean array returned by X509Certificate.getKeyUsage() . Or null . |
See Also
getMatchAllSubjectAltNames
open fun getMatchAllSubjectAltNames(): Boolean
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.
Return | |
---|---|
Boolean |
true if the flag is enabled; false if the flag is disabled. The flag is true by default. |
See Also
getNameConstraints
open fun getNameConstraints(): ByteArray!
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 5280 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.
Return | |
---|---|
ByteArray! |
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. |
See Also
getPathToNames
open fun getPathToNames(): MutableCollection<MutableList<*>!>!
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.
Return | |
---|---|
MutableCollection<MutableList<*>!>! |
a Collection of names (or null ) |
See Also
getPolicy
open fun getPolicy(): MutableSet<String!>!
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.
Return | |
---|---|
MutableSet<String!>! |
an immutable Set of certificate policy OIDs in string format (or null ) |
See Also
getPrivateKeyValid
open fun getPrivateKeyValid(): Date!
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.
Return | |
---|---|
Date! |
the Date to check (or null ) |
See Also
getSerialNumber
open fun getSerialNumber(): BigInteger!
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.
Return | |
---|---|
BigInteger! |
the certificate serial number to match (or null ) |
See Also
getSubject
open fun getSubject(): X500Principal!
Returns the subject criterion as an X500Principal
. 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.
Return | |
---|---|
X500Principal! |
the required subject distinguished name as X500Principal (or null ) |
getSubjectAlternativeNames
open fun getSubjectAlternativeNames(): MutableCollection<MutableList<*>!>!
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.
Return | |
---|---|
MutableCollection<MutableList<*>!>! |
a Collection of names (or null ) |
See Also
getSubjectAsBytes
open fun getSubjectAsBytes(): ByteArray!
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.
Return | |
---|---|
ByteArray! |
a byte array containing the required subject distinguished name in ASN.1 DER format (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if an encoding error occurs |
getSubjectAsString
open fun getSubjectAsString(): String!
Denigrated, use getSubject() or getSubjectAsBytes() instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
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.
Return | |
---|---|
String! |
the required subject distinguished name in RFC 2253 format (or null ) |
getSubjectKeyIdentifier
open fun getSubjectKeyIdentifier(): ByteArray!
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.
Return | |
---|---|
ByteArray! |
the key identifier (or null ) |
See Also
getSubjectPublicKey
open fun getSubjectPublicKey(): PublicKey!
Returns the subjectPublicKey criterion. The X509Certificate
must contain the specified subject public key. If null
, no subjectPublicKey check will be done.
Return | |
---|---|
PublicKey! |
the subject public key to check for (or null ) |
See Also
getSubjectPublicKeyAlgID
open fun getSubjectPublicKeyAlgID(): String!
Returns the subjectPublicKeyAlgID criterion. The X509Certificate
must contain a subject public key with the specified algorithm. If null
, no subjectPublicKeyAlgID check will be done.
Return | |
---|---|
String! |
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
match
open fun match(cert: Certificate!): Boolean
Decides whether a Certificate
should be selected.
Parameters | |
---|---|
cert |
Certificate!: the Certificate to be checked |
Return | |
---|---|
Boolean |
true if the Certificate should be selected, false otherwise |
setAuthorityKeyIdentifier
open fun setAuthorityKeyIdentifier(authorityKeyID: ByteArray!): Unit
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.
<code>AuthorityKeyIdentifier ::= SEQUENCE { keyIdentifier [0] KeyIdentifier OPTIONAL, authorityCertIssuer [1] GeneralNames OPTIONAL, authorityCertSerialNumber [2] CertificateSerialNumber OPTIONAL } KeyIdentifier ::= OCTET STRING </code>
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(<SubjectKeyIdentifier Object Identifier>)
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 |
ByteArray!: the authority key identifier (or null ) |
See Also
setBasicConstraints
open fun setBasicConstraints(minMaxPathLen: Int): Unit
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 |
Int: the value for the basic constraints constraint |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the value is less than -2 |
See Also
setCertificate
open fun setCertificate(cert: X509Certificate!): Unit
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 |
X509Certificate!: the X509Certificate to match (or null ) |
See Also
setCertificateValid
open fun setCertificateValid(certValid: Date!): Unit
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 |
Date!: the Date to check (or null ) |
See Also
setExtendedKeyUsage
open fun setExtendedKeyUsage(keyPurposeSet: MutableSet<String!>!): Unit
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.
Parameters | |
---|---|
keyPurposeSet |
MutableSet<String!>!: a Set of key purpose OIDs in string format (or null ). Each OID is represented by a set of nonnegative integers separated by periods. |
Exceptions | |
---|---|
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
setIssuer
open fun setIssuer(issuer: X500Principal!): Unit
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.
Parameters | |
---|---|
issuer |
X500Principal!: a distinguished name as X500Principal (or null ) |
setIssuer
open fun setIssuer(issuerDN: String!): Unit
Denigrated, use setIssuer(javax.security.auth.x500.X500Principal) or setIssuer(byte[]) instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
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.
Parameters | |
---|---|
issuerDN |
String!: a distinguished name in RFC 2253 format (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs (incorrect form for DN) |
setIssuer
open fun setIssuer(issuerDN: ByteArray!): Unit
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.
<code>Name ::= CHOICE { RDNSequence } RDNSequence ::= SEQUENCE OF RelativeDistinguishedName RelativeDistinguishedName ::= 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)) } </code>
Note that the byte array specified here is cloned to protect against subsequent modifications.
Parameters | |
---|---|
issuerDN |
ByteArray!: a byte array containing the distinguished name in ASN.1 DER encoded form (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if an encoding error occurs (incorrect form for DN) |
setKeyUsage
open fun setKeyUsage(keyUsage: BooleanArray!): Unit
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 |
BooleanArray!: a boolean array in the same format as the boolean array returned by X509Certificate.getKeyUsage() . Or null . |
See Also
setMatchAllSubjectAltNames
open fun setMatchAllSubjectAltNames(matchAllNames: Boolean): Unit
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 |
Boolean: if true , the flag is enabled; if false , the flag is disabled. |
See Also
setNameConstraints
open fun setNameConstraints(bytes: ByteArray!): Unit
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 5280 and X.509. The ASN.1 definition of this structure appears below.
<code>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} </code>
Note that the byte array supplied here is cloned to protect against subsequent modifications.
Parameters | |
---|---|
bytes |
ByteArray!: 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. |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
See Also
setPathToNames
open fun setPathToNames(names: MutableCollection<MutableList<*>!>!): Unit
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: for distinguished names, specify the byte array form instead of the String form. See the note in addPathToName(int,java.lang.String)
for more information.
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.
Parameters | |
---|---|
names |
MutableCollection<MutableList<*>!>!: a Collection with one entry per name (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
See Also
setPolicy
open fun setPolicy(certPolicySet: MutableSet<String!>!): Unit
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.
Parameters | |
---|---|
certPolicySet |
MutableSet<String!>!: a Set of certificate policy OIDs in string format (or null ). Each OID is represented by a set of nonnegative integers separated by periods. |
Exceptions | |
---|---|
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
setPrivateKeyValid
open fun setPrivateKeyValid(privateKeyValid: Date!): Unit
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 |
Date!: the Date to check (or null ) |
See Also
setSerialNumber
open fun setSerialNumber(serial: BigInteger!): Unit
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 |
BigInteger!: the certificate serial number to match (or null ) |
See Also
setSubject
open fun setSubject(subject: X500Principal!): Unit
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.
Parameters | |
---|---|
subject |
X500Principal!: a distinguished name as X500Principal (or null ) |
setSubject
open fun setSubject(subjectDN: String!): Unit
Denigrated, use setSubject(javax.security.auth.x500.X500Principal) or setSubject(byte[]) instead. This method should not be relied on as it can fail to match some certificates because of a loss of encoding information in the RFC 2253 String form of some distinguished names.
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.
Parameters | |
---|---|
subjectDN |
String!: a distinguished name in RFC 2253 format (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs (incorrect form for DN) |
setSubject
open fun setSubject(subjectDN: ByteArray!): Unit
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).
Parameters | |
---|---|
subjectDN |
ByteArray!: a byte array containing the distinguished name in ASN.1 DER format (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if an encoding error occurs (incorrect form for DN) |
setSubjectAlternativeNames
open fun setSubjectAlternativeNames(names: MutableCollection<MutableList<*>!>!): Unit
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
).
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: for distinguished names, specify the byte array form instead of the String form. See the note in addSubjectAlternativeName(int,java.lang.String)
for more information.
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 |
MutableCollection<MutableList<*>!>!: a Collection of names (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if a parsing error occurs |
See Also
setSubjectKeyIdentifier
open fun setSubjectKeyIdentifier(subjectKeyID: ByteArray!): Unit
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.
<code>SubjectKeyIdentifier ::= KeyIdentifier KeyIdentifier ::= OCTET STRING </code>
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 |
ByteArray!: the subject key identifier (or null ) |
See Also
setSubjectPublicKey
open fun setSubjectPublicKey(key: PublicKey!): Unit
Sets the subjectPublicKey criterion. The X509Certificate
must contain the specified subject public key. If null
, no subjectPublicKey check will be done.
Parameters | |
---|---|
key |
PublicKey!: the subject public key to check for (or null ) |
See Also
setSubjectPublicKey
open fun setSubjectPublicKey(key: ByteArray!): Unit
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.
<code>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 </code>
Note that the byte array supplied here is cloned to protect against subsequent modifications.
Parameters | |
---|---|
key |
ByteArray!: a byte array containing the subject public key in ASN.1 DER form (or null ) |
Exceptions | |
---|---|
java.io.IOException |
if an encoding error occurs (incorrect form for subject public key) |
See Also
setSubjectPublicKeyAlgID
open fun setSubjectPublicKeyAlgID(oid: String!): Unit
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 |
String!: 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. |
Exceptions | |
---|---|
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
toString
open fun toString(): String
Return a printable representation of the CertSelector
.
Return | |
---|---|
String |
a String describing the contents of the CertSelector |