CertPathValidator

open class CertPathValidator
kotlin.Any
   ↳ java.security.cert.CertPathValidator

A class for validating certification paths (also known as certificate chains).

This class uses a provider-based architecture. To create a CertPathValidator, call one of the static getInstance methods, passing in the algorithm name of the CertPathValidator desired and optionally the name of the provider desired.

Once a CertPathValidator object has been created, it can be used to validate certification paths by calling the validate method and passing it the CertPath to be validated and an algorithm-specific set of parameters. If successful, the result is returned in an object that implements the CertPathValidatorResult interface.

The #getRevocationChecker method allows an application to specify additional algorithm-specific parameters and options used by the CertPathValidator when checking the revocation status of certificates. Here is an example demonstrating how it is used with the PKIX algorithm:

 CertPathValidator cpv = CertPathValidator.getInstance("PKIX"); PKIXRevocationChecker rc = (PKIXRevocationChecker)cpv.getRevocationChecker(); rc.setOptions(EnumSet.of(Option.SOFT_FAIL)); params.addCertPathChecker(rc); CertPathValidatorResult cpvr = cpv.validate(path, params); 

Android provides the following CertPathValidator algorithms:

Algorithm Supported API Levels PKIX 1+ This algorithm is described in the CertPathValidator section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Concurrent Access

The static methods of this class are guaranteed to be thread-safe. Multiple threads may concurrently invoke the static methods defined in this class with no ill effects.

However, this is not true for the non-static methods defined by this class. Unless otherwise documented by a specific provider, threads that need to access a single CertPathValidator instance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a different CertPathValidator instance need not synchronize.

Summary

Protected constructors
<init>(validatorSpi: CertPathValidatorSpi!, provider: Provider!, algorithm: String!)

Creates a CertPathValidator object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.

Public methods
CertPathValidatorResult!
validate(certPath: CertPath!, params: CertPathParameters!)

Validates the specified certification path using the specified algorithm parameter set.

String!

Returns the algorithm name of this CertPathValidator.

Provider!

Returns the Provider of this CertPathValidator.

CertPathChecker!

Returns a CertPathChecker that the encapsulated CertPathValidatorSpi implementation uses to check the revocation status of certificates.

open static CertPathValidator!
getInstance(algorithm: String!)

Returns a CertPathValidator object that implements the specified algorithm.

open static CertPathValidator!
getInstance(algorithm: String!, provider: String!)

Returns a CertPathValidator object that implements the specified algorithm.

open static CertPathValidator!
getInstance(algorithm: String!, provider: Provider!)

Returns a CertPathValidator object that implements the specified algorithm.

static String!

Returns the default CertPathValidator type as specified by the certpathvalidator.type security property, or the string "PKIX" if no such property exists.

Protected constructors

<init>

protected CertPathValidator(validatorSpi: CertPathValidatorSpi!, provider: Provider!, algorithm: String!)

Creates a CertPathValidator object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.

Parameters
validatorSpi CertPathValidatorSpi!: the provider implementation
provider CertPathValidatorSpi!: the provider
algorithm CertPathValidatorSpi!: the algorithm name

Public methods

validate

fun validate(certPath: CertPath!, params: CertPathParameters!): CertPathValidatorResult!

Validates the specified certification path using the specified algorithm parameter set.

The CertPath specified must be of a type that is supported by the validation algorithm, otherwise an InvalidAlgorithmParameterException will be thrown. For example, a CertPathValidator that implements the PKIX algorithm validates CertPath objects of type X.509.

Parameters
certPath CertPath!: the CertPath to be validated
params CertPath!: the algorithm parameters
Return
CertPathValidatorResult!: the result of the validation algorithm
Exceptions
CertPathValidatorException if the CertPath does not validate
InvalidAlgorithmParameterException if the specified parameters or the type of the specified CertPath are inappropriate for this CertPathValidator

getAlgorithm

fun getAlgorithm(): String!

Returns the algorithm name of this CertPathValidator.

Return
String!: the algorithm name of this CertPathValidator

getProvider

fun getProvider(): Provider!

Returns the Provider of this CertPathValidator.

Return
Provider!: the Provider of this CertPathValidator

getRevocationChecker

added in API level 1.8
fun getRevocationChecker(): CertPathChecker!

Returns a CertPathChecker that the encapsulated CertPathValidatorSpi implementation uses to check the revocation status of certificates. A PKIX implementation returns objects of type PKIXRevocationChecker. Each invocation of this method returns a new instance of CertPathChecker.

The primary purpose of this method is to allow callers to specify additional input parameters and options specific to revocation checking. See the class description for an example.
Requires API level 24 (Android 7.0, Nougat)

Return
CertPathChecker!: a CertPathChecker
Exceptions
UnsupportedOperationException if the service provider does not support this method

getInstance

open static fun getInstance(algorithm: String!): CertPathValidator!

Returns a CertPathValidator object that implements the specified algorithm.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathValidator object encapsulating the CertPathValidatorSpi implementation from the first Provider that supports the specified algorithm is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
algorithm String!: the name of the requested CertPathValidator algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
Return
CertPathValidator!: a CertPathValidator object that implements the specified algorithm.
Exceptions
NoSuchAlgorithmException if no Provider supports a CertPathValidatorSpi implementation for the specified algorithm.

getInstance

open static fun getInstance(algorithm: String!, provider: String!): CertPathValidator!

Returns a CertPathValidator object that implements the specified algorithm.

A new CertPathValidator object encapsulating the CertPathValidatorSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
algorithm String!: the name of the requested CertPathValidator algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
provider String!: the name of the provider.
Return
CertPathValidator!: a CertPathValidator object that implements the specified algorithm.
Exceptions
NoSuchAlgorithmException if a CertPathValidatorSpi implementation for the specified algorithm is not available from the specified provider.
NoSuchProviderException if the specified provider is not registered in the security provider list.
IllegalArgumentException if the provider is null or empty.

getInstance

open static fun getInstance(algorithm: String!, provider: Provider!): CertPathValidator!

Returns a CertPathValidator object that implements the specified algorithm.

A new CertPathValidator object encapsulating the CertPathValidatorSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

Parameters
algorithm String!: the name of the requested CertPathValidator algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
provider String!: the provider.
Return
CertPathValidator!: a CertPathValidator object that implements the specified algorithm.
Exceptions
NoSuchAlgorithmException if a CertPathValidatorSpi implementation for the specified algorithm is not available from the specified Provider object.
IllegalArgumentException if the provider is null.

getDefaultType

static fun getDefaultType(): String!

Returns the default CertPathValidator type as specified by the certpathvalidator.type security property, or the string "PKIX" if no such property exists.

The default CertPathValidator type can be used by applications that do not want to use a hard-coded type when calling one of the getInstance methods, and want to provide a default type in case a user does not specify its own.

The default CertPathValidator type can be changed by setting the value of the certpathvalidator.type security property to the desired type.

Return
String!: the default CertPathValidator type as specified by the certpathvalidator.type security property, or the string "PKIX" if no such property exists.