com.cleo.lexicom.certmgr.external

Class CertificateInfo

java.lang.Object

com.cleo.lexicom.certmgr.external.CertificateInfo

public class CertificateInfo
extends java.lang.Object

Certificate information for generating a self-signed user certificate and private key. Refer to ICertManagerRunTime.generateUserCertKey(String,CertificateInfo,String,boolean).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CertificateInfo.PubKeyAlg Enum to identify public key algorithms.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MD5
static int	SHA1
static int	SHA256
static int	SHA384
static int	SHA512

Constructor Summary

Constructors

Constructor and Description
CertificateInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommonName() Get the certificate subject's common name.
java.lang.String	getCountry() Get the certificate subject's country.
java.lang.String	getCrlDistributionPoint() Get the certificate CRL Distribution Point URI.
java.lang.String	getEmailAddress() Get the certificate subject's email address.
java.lang.String	getLocality() Get the certificate subject's locality.
java.lang.String	getOrganization() Get the certificate subject's organization.
java.lang.String	getOrganizationalUnit() Get the certificate subject's organizational unit.
CertificateInfo.PubKeyAlg	getPublicKeyAlgorithm() Get public key algorithm.
int	getSignatureAlgorithm() Get the signature algorithm.
java.lang.String	getStateOrProvince() Get the certificate subject's state or province.
int	getStrength() Get the private key strength in bytes
int	getValidFor() Get the certificate's validity period in months.
boolean	isAddCrlDistributionPoint() Indicates whether the certificate should include a CRL Distribution Points extension.
boolean	isAuthorityKeyIdentifier() Indicates whether the certificate should include the Authority Key Identifier extension.
boolean	isClientAuth() Indicates whether the certificate's key usage should include client authentication.
boolean	isCrlSign() Indicates whether the certificate's key usage should include CRL signing.
boolean	isDigitalSignature() Indicates whether the certificate's key usage should include digital signatures.
boolean	isKeyCertSign() Indicates whether the certificate's key usage should include key signing.
boolean	isKeyEncipherment() Indicates whether the certificate's key usage should include key encipherment.
boolean	isServerAuth() Indicates whether the certificate's key usage should include server authentication.
boolean	isSubjectKeyIdentifier() Indicates whether the certificate should include the Subject Key Identifier extension.
void	setAddCrlDistributionPoint(boolean addCrlDistributionPoint) Sets the indicator as to whether the certificate should include a CRL Distribution Points extension.
void	setAuthorityKeyIdentifier(boolean authorityKeyIdentifier) Set the certificate's Authority Key Identifier extension as a means of identifying the public key corresponding to the private key used to sign a certificate.
void	setClientAuth(boolean clientAuth) Set the certificate's extended key usage to include client authentication.
void	setCommonName(java.lang.String commonName) Set the certificate subject's common name.
void	setCountry(java.lang.String country) Set the certificate subject's country.
void	setCrlDistributionPoint(java.lang.String crlDistributionPoint) Set the CRL Distribution Point URI to be added to certificate extension.
void	setCrlSign(boolean crlSign) Set the certificate's key usage to include CRL signing.
void	setDigitalSignature(boolean digitalSignature) Set the certificate's key usage to include digital signatures.
void	setEmailAddress(java.lang.String emailAddress) Set the certificate subject's email address.
void	setKeyCertSign(boolean keyCertSign) Set the certificate's key usage to include key signing - used when creating a CA certificate.
void	setKeyEncipherment(boolean keyEncipherment) Set the certificate's key usage to include key encipherment.
void	setLocality(java.lang.String locality) Set the certificate subject's locality (e.g. city).
void	setOrganization(java.lang.String organization) Set the certificate subject's organization.
void	setOrganizationalUnit(java.lang.String organizationalUnit) Set the certificate subject's organizational unit.
void	setPublicKeyAlgorithm(CertificateInfo.PubKeyAlg publicKeyAlgorithm) Set public key algorithm
void	setServerAuth(boolean serverAuth) Set the certificate's extended key usage to include server authentication.
void	setSignatureAlgorithm(int signatureAlgorithm) Set the signature algorithm.
void	setStateOrProvince(java.lang.String stateOrProvince) Set the certificate subject's state or province.
void	setStrength(int strength) Set the private key strength in bytes.
void	setSubjectKeyIdentifier(boolean subjectKeyIdentifier) Set the certificate's Subject Key Identifier extension as a means of identifying the particular public key being used.
void	setValidFor(int validFor) Set the certificate's validity period in months.

Methods inherited from class java.lang.Object

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

Field Detail

MD5

public static final int MD5

See Also:

Constant Field Values

SHA1

public static final int SHA1

See Also:

Constant Field Values

SHA256

public static final int SHA256

See Also:

Constant Field Values

SHA384

public static final int SHA384

See Also:

Constant Field Values

SHA512

public static final int SHA512

See Also:

Constant Field Values

Constructor Detail

CertificateInfo

public CertificateInfo()

Method Detail

setCommonName

public void setCommonName(java.lang.String commonName)

Set the certificate subject's common name. This is the only subject field required; emailAddress, organizationalUnit, organization, locality, stateOrProvince, and country are all optional.

Parameters:

commonName - the certificate subject's common name

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

Set the certificate subject's email address. This is optional.

Parameters:

emailAddress - the certificate subject's email address

setOrganizationalUnit

public void setOrganizationalUnit(java.lang.String organizationalUnit)

Set the certificate subject's organizational unit. This is optional.

Parameters:

organizationalUnit - the certificate subject's organizational unit

setOrganization

public void setOrganization(java.lang.String organization)

Set the certificate subject's organization. This is optional.

Parameters:

organization - the certificate subject's organization

setLocality

public void setLocality(java.lang.String locality)

Set the certificate subject's locality (e.g. city). This is optional.

Parameters:

locality - the certificate subject's locality

setStateOrProvince

public void setStateOrProvince(java.lang.String stateOrProvince)

Set the certificate subject's state or province. This is optional.

Parameters:

stateOrProvince - the certificate subject's state or province

setCountry

public void setCountry(java.lang.String country)

Set the certificate subject's country. This is optional.

Parameters:

country - the certificate subject's country

setCrlDistributionPoint

public void setCrlDistributionPoint(java.lang.String crlDistributionPoint)

Set the CRL Distribution Point URI to be added to certificate extension. This is optional.

Parameters:

crlDistributionPoint - the CRL distribution point URL

setValidFor

public void setValidFor(int validFor)

Set the certificate's validity period in months. Must be between 1 and 96 months. Defaults to 6 months.

Parameters:

validFor - the certificate's validity period in months

setSignatureAlgorithm

public void setSignatureAlgorithm(int signatureAlgorithm)

Set the signature algorithm.

Parameters:

signatureAlgorithm - the signature algorithm, either MD5 (default), SHA1, SHA256, SHA384, or SHA512

setDigitalSignature

public void setDigitalSignature(boolean digitalSignature)

Set the certificate's key usage to include digital signatures. If the user certificate is going to be used for an SSL client or for S/MIME (AS2) signing, the key usage should include digital signatures.

Parameters:

digitalSignature - true if the certificate's key usage should include digital signatures

setKeyEncipherment

public void setKeyEncipherment(boolean keyEncipherment)

Set the certificate's key usage to include key encipherment. If the user certificate is going to be used for an SSL server or for S/MIME (AS2) encryption, the key usage should include key encipherment.

Parameters:

keyEncipherment - true if the certificate's key usage should include key encipherment

setServerAuth

public void setServerAuth(boolean serverAuth)

Set the certificate's extended key usage to include server authentication. If the user certificate is going to be used for a TLS server, the extended key usage should include server authentication.

Parameters:

serverAuth - true if the certificate's extended key usage should include server authentication

setClientAuth

public void setClientAuth(boolean clientAuth)

Set the certificate's extended key usage to include client authentication. If the user certificate is going to be used for a TLS client, the extended key usage should include client authentication.

Parameters:

clientAuth - true if the certificate's extended key usage should include client authentication

setSubjectKeyIdentifier

public void setSubjectKeyIdentifier(boolean subjectKeyIdentifier)

Set the certificate's Subject Key Identifier extension as a means of identifying the particular public key being used.

Parameters:

subjectKeyIdentifier - true if the certificate should include the Subject Key Identifier extension

setAuthorityKeyIdentifier

public void setAuthorityKeyIdentifier(boolean authorityKeyIdentifier)

Set the certificate's Authority Key Identifier extension as a means of identifying the public key corresponding to the private key used to sign a certificate. (Internal Use Only!)

Parameters:

authorityKeyIdentifier - true if the certificate should include the Authority Key Identifier extension

setCrlSign

public void setCrlSign(boolean crlSign)

Set the certificate's key usage to include CRL signing. (Internal Use Only!)

Parameters:

crlSign - true if the certificate's key usage should include CRL signing.

setKeyCertSign

public void setKeyCertSign(boolean keyCertSign)

Set the certificate's key usage to include key signing - used when creating a CA certificate. (Internal Use Only!)

Parameters:

keyCertSign - true if the certificate's key usage should include key signing.

setAddCrlDistributionPoint

public void setAddCrlDistributionPoint(boolean addCrlDistributionPoint)

Sets the indicator as to whether the certificate should include a CRL Distribution Points extension. (Internal Use Only!)

Parameters:

addCrlDistributionPoint - true if the certificate should include the CRL Distribution Points extension

setStrength

public void setStrength(int strength)

Set the private key strength in bytes. Can be either 512, 1024, 2048, 3072 or 4096 bytes. Defaults to 1024 bytes.

Parameters:

strength - the private key strength

getCommonName

public java.lang.String getCommonName()

Get the certificate subject's common name.

Returns:

the certificate subject's common name

getEmailAddress

public java.lang.String getEmailAddress()

Get the certificate subject's email address.

Returns:

the certificate subject's email address

getOrganizationalUnit

public java.lang.String getOrganizationalUnit()

Get the certificate subject's organizational unit.

Returns:

the certificate subject's organizational unit.

getOrganization

public java.lang.String getOrganization()

Get the certificate subject's organization.

Returns:

the certificate subject's organization

getLocality

public java.lang.String getLocality()

Get the certificate subject's locality.

Returns:

the certificate subject's locality

getStateOrProvince

public java.lang.String getStateOrProvince()

Get the certificate subject's state or province.

Returns:

the certificate subject's state or province

getCountry

public java.lang.String getCountry()

Get the certificate subject's country.

Returns:

the certificate subject's country

getCrlDistributionPoint

public java.lang.String getCrlDistributionPoint()

Get the certificate CRL Distribution Point URI. (Internal Use Only!)

Returns:

the certificate CRL Distribution Point

getValidFor

public int getValidFor()

Get the certificate's validity period in months.

Returns:

the certificate's validity period

getSignatureAlgorithm

public int getSignatureAlgorithm()

Get the signature algorithm.

Returns:

the signature algorithm, either MD5 (default), SHA1, SHA256, SHA384, or SHA512

isDigitalSignature

public boolean isDigitalSignature()

Indicates whether the certificate's key usage should include digital signatures.

Returns:

true if the certificate's key usage should include digital signatures

isKeyEncipherment

public boolean isKeyEncipherment()

Indicates whether the certificate's key usage should include key encipherment.

Returns:

true if the certificate's key usage should include key encipherment

isServerAuth

public boolean isServerAuth()

Indicates whether the certificate's key usage should include server authentication.

Returns:

true if the certificate's key usage should include server authentication

isClientAuth

public boolean isClientAuth()

Indicates whether the certificate's key usage should include client authentication.

Returns:

true if the certificate's key usage should include client authentication

isSubjectKeyIdentifier

public boolean isSubjectKeyIdentifier()

Indicates whether the certificate should include the Subject Key Identifier extension.

Returns:

true if the certificate should include the Subject Key Identifier extension

isAuthorityKeyIdentifier

public boolean isAuthorityKeyIdentifier()

Indicates whether the certificate should include the Authority Key Identifier extension. (Internal Use Only!)

Returns:

true if the certificate should include the Authority Key Identifier extension

isCrlSign

public boolean isCrlSign()

Indicates whether the certificate's key usage should include CRL signing. (Internal Use Only!)

Returns:

true if the certificate's key usage should include CRL signing

isKeyCertSign

public boolean isKeyCertSign()

Indicates whether the certificate's key usage should include key signing. (Internal Use Only!)

Returns:

true if the certificate's key usage should include key signing

isAddCrlDistributionPoint

public boolean isAddCrlDistributionPoint()

Indicates whether the certificate should include a CRL Distribution Points extension. (Internal Use Only!)

Returns:

true if the certificate should include the CRL Distribution Points extension

getStrength

public int getStrength()

Get the private key strength in bytes

Returns:

the private key strength

getPublicKeyAlgorithm

public CertificateInfo.PubKeyAlg getPublicKeyAlgorithm()

Get public key algorithm.

Returns:

public key algorithm

setPublicKeyAlgorithm

public void setPublicKeyAlgorithm(CertificateInfo.PubKeyAlg publicKeyAlgorithm)

Set public key algorithm

Parameters:

publicKeyAlgorithm - public key algorithm