com.itextpdf.signatures.validation.extensions

Class KeyUsageExtension

java.lang.Object

com.itextpdf.signatures.validation.extensions.CertificateExtension

com.itextpdf.signatures.validation.extensions.KeyUsageExtension

public class KeyUsageExtension
extends CertificateExtension

Class representing "Key Usage" extenstion.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTUAL_VALUE
static String	EXPECTED_VALUE
static String	MISSING_VALUE

Fields inherited from class com.itextpdf.signatures.validation.extensions.CertificateExtension

EXCEPTION_OCCURRED, EXPECTED_EXTENSION_ID_AND_VALUE, EXTENSION_NOT_FOUND, FOUND_VALUE

Constructor Summary

Constructors

Constructor and Description
KeyUsageExtension(int keyUsage) Create new KeyUsageExtension instance using provided int flag.
KeyUsageExtension(int keyUsage, boolean resultOnMissingExtension) Create new KeyUsageExtension instance using provided int flag.
KeyUsageExtension(KeyUsage keyUsageValue) Create new KeyUsageExtension instance using provided single key usage enum value.
KeyUsageExtension(KeyUsage keyUsageValue, boolean resultOnMissingExtension) Create new KeyUsageExtension instance using provided single key usage enum value.
KeyUsageExtension(List<KeyUsage> keyUsages) Create new KeyUsageExtension instance using provided key usage enum list.
KeyUsageExtension(List<KeyUsage> keyUsages, boolean resultOnMissingExtension) Create new KeyUsageExtension instance using provided key usage enum list.

Method Summary

Modifier and Type	Method and Description
boolean	existsInCertificate(X509Certificate certificate) Check if this extension is present in the provided certificate.
String	getMessage() Returns a message with extra information about the check.

Methods inherited from class com.itextpdf.signatures.validation.extensions.CertificateExtension

equals, getExtensionOid, getExtensionValue, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

EXPECTED_VALUE

public static final String EXPECTED_VALUE

See Also:

Constant Field Values

ACTUAL_VALUE

public static final String ACTUAL_VALUE

See Also:

Constant Field Values

MISSING_VALUE

public static final String MISSING_VALUE

See Also:

Constant Field Values

Constructor Detail

KeyUsageExtension

public KeyUsageExtension(int keyUsage)

Create new KeyUsageExtension instance using provided int flag.

Parameters:

keyUsage - int flag which represents bit values for key usage value bit strings are stored with the big-endian byte order and padding on the end, the big endian notation causes a shift in actual integer values for bits 1-8 becoming 0-7 and bit 1 the 7 bits padding makes for bit 0 to become bit 7 of the first byte

KeyUsageExtension

public KeyUsageExtension(int keyUsage,
                         boolean resultOnMissingExtension)

Create new KeyUsageExtension instance using provided int flag.

Parameters:

keyUsage - int flag which represents bit values for key usage value bit strings are stored with the big-endian byte order and padding on the end, the big endian notation causes a shift in actual integer values for bits 1-8 becoming 0-7 and bit 1 the 7 bits padding makes for bit 0 to become bit 7 of the first byte

resultOnMissingExtension - parameter which represents return value for existsInCertificate(X509Certificate) method in case of the extension not being present in a certificate

KeyUsageExtension

public KeyUsageExtension(List<KeyUsage> keyUsages)

Create new KeyUsageExtension instance using provided key usage enum list.

Parameters:

keyUsages - key usages List which represents key usage values

KeyUsageExtension

public KeyUsageExtension(List<KeyUsage> keyUsages,
                         boolean resultOnMissingExtension)

Create new KeyUsageExtension instance using provided key usage enum list.

Parameters:

keyUsages - key usages List which represents key usage values

resultOnMissingExtension - parameter which represents return value for existsInCertificate(X509Certificate) method in case of the extension not being present in a certificate

KeyUsageExtension

public KeyUsageExtension(KeyUsage keyUsageValue)

Create new KeyUsageExtension instance using provided single key usage enum value.

Parameters:

keyUsageValue - KeyUsage which represents single key usage enum value

KeyUsageExtension

public KeyUsageExtension(KeyUsage keyUsageValue,
                         boolean resultOnMissingExtension)

Create new KeyUsageExtension instance using provided single key usage enum value.

Parameters:

keyUsageValue - KeyUsage which represents single key usage enum value

resultOnMissingExtension - parameter which represents return value for existsInCertificate(X509Certificate) method in case of the extension not being present in a certificate

Method Detail

existsInCertificate

public boolean existsInCertificate(X509Certificate certificate)

Check if this extension is present in the provided certificate. In case of KeyUsageExtension, check if this key usage bit values are present in certificate. Other values may be present as well.

Overrides:

existsInCertificate in class CertificateExtension

Parameters:

certificate - X509Certificate in which this extension shall be present

Returns:

true if this key usage bit values are present in certificate, false otherwise

getMessage

public String getMessage()

Description copied from class: CertificateExtension

Returns a message with extra information about the check.

Overrides:

getMessage in class CertificateExtension

Returns:

a message with extra information about the check.