Index
A
actionRequest() -
Method in interface com.ibm.security.certclient.PkEeTransaction
Actions the constructed transaction.
addExtKeyUsage(List<String>) -
Method in interface com.ibm.security.certclient.PkEeCertReqTransaction
Merges the provided extended key usages to those already existing if any.
addKeyUsage(List<String>) -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Merges the provided key usages to those already existing if any.
C
CA_DN -
Static variable in class com.ibm.security.certclient.PkEeFactory
caDn -
Static variable in class com.ibm.security.certclient.PkEeFactory
caPort -
Static variable in class com.ibm.security.certclient.PkEeFactory
cmpEvntFmt -
Static variable in class com.ibm.security.certclient.PkEeFactory
com.ibm.security.certclient - package com.ibm.security.certclient
A set of classes to generate a CertificateRequest, submit a request to a CA
via Java PKI to sign a certificate and then receive the signed certificate, and
revoke a signed certificate.
com.ibm.security.certclient.util - package com.ibm.security.certclient.util
A set of classes to generate self-signed certificates or create a personal certificate
signed with the supplied signer key.
com.ibm.security.keystoreski - package com.ibm.security.keystoreski
A package that provides utilities for extracting information from a
KeyStore
given a Subject
Key Identifier.
com.ibm.security.keystoreutil - package com.ibm.security.keystoreutil
A package that provides utilities for converting between different KeyStore formats
and importing/exporting Certificates from/to streams.
D
destroyParameters() -
Method in interface com.ibm.security.keystoreutil.KeyStoreTranslatorParameters
Destroys all cashed passwords.
E
exportCertificate(OutputStream, KeyStore, String, boolean) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Export the Certificate that is associated with
alias
in the KeyStore store
to the Output Stream output
.
G
getAlias(String, SKIDefinition) -
Method in interface com.ibm.security.keystoreski.KeyStoreSKI
Returns the first instance of the alias associated with a certificate in a
KeyStore
that has a subject key identifier matches subjectKeyIdentifier
.
getCA_DN() -
Static method in class com.ibm.security.certclient.PkEeFactory
getCaDn() -
Static method in class com.ibm.security.certclient.PkEeFactory
getCaPort() -
Static method in class com.ibm.security.certclient.PkEeFactory
getCertificate() -
Method in interface com.ibm.security.certclient.util.Pk10Certificate
Extract the X509 certificate
getCertificate() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the self-signed Certificate
getCertificate(String, SKIDefinition) -
Method in interface com.ibm.security.keystoreski.KeyStoreSKI
Returns the first instance of the certificate in a
KeyStore
that has a subject key identifier matches subjectKeyIdentifier
.
getCertificateChain() -
Method in interface com.ibm.security.certclient.PkEeReqTransaction
Fetch the certificate chain which was returned from the CA.
getCertificateChain() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the personal Certificate chain
getCmpFmt() -
Static method in class com.ibm.security.certclient.PkEeFactory
getKey() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the private key for the personal certificate
getKey() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the private key for the self-signed certificate
getKeyPair() -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Fetch the keyPair that was created for this
certificate request.
getKeyProtectionPassword(String) -
Method in interface com.ibm.security.keystoreutil.KeyStoreTranslatorParameters
Returns the protection password of a the key that is associated with
alias
.
getKeyStoreAccessPassword() -
Method in interface com.ibm.security.keystoreutil.KeyStoreTranslatorParameters
Returns the KeyStore access password.
getKeystoreFilename() -
Static method in class com.ibm.security.certclient.PkEeFactory
getKeyStoreType() -
Static method in class com.ibm.security.certclient.PkEeFactory
getPKCS10CertReq() -
Method in interface com.ibm.security.certclient.PkEeReqTransaction
creates the DER encoded PKCS10 form of the certificate request
from the parameters provided
getPrivateKey() -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Fetch the private key that was created for this
certificate request.
getPrivateKey(String, SKIDefinition, char[]) -
Method in interface com.ibm.security.keystoreski.KeyStoreSKI
Returns the first instance of a private key that has an end entity certificate in a
KeyStore
that has a subject key identifier matches subjectKeyIdentifier
.
getProvider() -
Static method in class com.ibm.security.certclient.PkEeFactory
getPublicKey() -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Fetch the public key that was created for this
certificate request.
getPublicKey() -
Method in interface com.ibm.security.certclient.util.Pk10Certificate
Extract the X509 certificate's public key
getPublicKey() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the public key
getPublicKey() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the public key
getSigAlg() -
Method in interface com.ibm.security.certclient.util.Pk10Certificate
Extract the X509 certificate's signature algorithm
getSigAlg() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the signature algorithm
getSigAlg() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the signature algorithm
getSignedCert() -
Method in interface com.ibm.security.certclient.PkEeReqTransaction
Fetch the signed certificate which was returned from the CA.
getSourceKeyStore() -
Method in interface com.ibm.security.keystoreutil.KeyStoreTranslatorParameters
Returns the encapsulated KeyStore instance.
getSubjectKeyIdentifier() -
Method in interface com.ibm.security.certclient.util.Pk10Certificate
Extract the X509 certificate's subject public key identifier
getSubjectKeyIdentifier() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the subject public key identifier
getSubjectKeyIdentifier() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the subject public key identifier
getSubjectKeyIdentifier(X509Certificate) -
Method in interface com.ibm.security.keystoreski.SKIDefinition
Returns the Subject Key Identifier for a certificate or
null
if the subject key identifier cannot
be determined.
getSubjectName() -
Method in interface com.ibm.security.certclient.util.Pk10Certificate
Extract the X509 certificate's subject name
getSubjectName() -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Extract the subject name
getSubjectName() -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Extract the subject name
I
importCertificate(InputStream, KeyStore, String) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Import a certificate from an input stream into a KeyStore.
importCertificates(InputStream, KeyStore) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Import a set of certificates, that are encoded in PKCS#7 format, from an input stream
into a KeyStore.
K
keystoreFilename -
Static variable in class com.ibm.security.certclient.PkEeFactory
keystorePwd -
Static variable in class com.ibm.security.certclient.PkEeFactory
KeyStoreSKI - Interface in com.ibm.security.keystoreski
Provides the ability to extract information from a
KeyStore
given a Subject Key Identifier
(SKI).
KeyStoreSKIFactory - Class in com.ibm.security.keystoreski
Constructs and returns instances of
KeyStoreSKI
that provide
implementations to search through a key store based on a Subject Key
Identifier.
KeyStoreTranslator - Interface in com.ibm.security.keystoreutil
This interface is used to copy the contents of one KeyStore to a different
KeyStore format.
KeyStoreTranslatorParameters - Interface in com.ibm.security.keystoreutil
Encapsulates the parameters needed to do a KeyStore conversion to a different format.
keyStoreType -
Static variable in class com.ibm.security.certclient.PkEeFactory
KeyStoreUtil - Class in com.ibm.security.keystoreutil
KeyStore utility class to help accomplish different type of operations on
KeyStore.
N
newCert(String, Date, int, X509Certificate, PrivateKey) -
Static method in class com.ibm.security.certclient.util.Pk10CertFactory
Deprecated.
newCert(byte[], Date, int, X509Certificate, PrivateKey) -
Static method in class com.ibm.security.certclient.util.Pk10CertFactory
Deprecated.
newCert(String, Date, int, X509Certificate, PrivateKey, String) -
Static method in class com.ibm.security.certclient.util.Pk10CertFactory
Create a personal certificate from the PKCS10 certificate request file and sign it with the specified private key.
newCert(byte[], Date, int, X509Certificate, PrivateKey, String) -
Static method in class com.ibm.security.certclient.util.Pk10CertFactory
Create a personal certificate from the DER encoded PKCS10 certificate request and sign it with the specified private key.
newCert(String, X509Certificate[], PrivateKey) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Most simple way to generate a personal certificate signed by a
signing certificate.
newCert(int, String, int, Date, boolean, String, X509Certificate[], PrivateKey) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Create a personal certificate without any supplied extensions
newCert(int, String, int, Date, boolean, String, KeyPair, X509Certificate[], PrivateKey) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Create a personal certificate without any supplied extensions
newCert(int, String, int, Date, boolean, List<String>, List<String>, List<String>, String, X509Certificate[], PrivateKey) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Create a personal certificate with supplied extensions
newCert(int, String, int, Date, boolean, List<String>, List<String>, List<String>, String, KeyPair, X509Certificate[], PrivateKey) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Create a personal certificate with supplied extensions
newCert(int, String, int, Date, boolean, List<String>, List<String>, List<String>, String, KeyPair, X509Certificate[], PrivateKey, boolean) -
Static method in class com.ibm.security.certclient.util.PkNewCertFactory
Create a personal certificate with supplied extensions
newCertRequest(int, String, int, boolean, boolean, List<String>, List<String>, List<String>, String, String, String) -
Static method in class com.ibm.security.certclient.PkEeCertReqFactory
Deprecated.
newCertRequest(int, String, int, String, String, boolean, List<String>, List<String>, List<String>, String, String, String) -
Static method in class com.ibm.security.certclient.PkEeCertReqFactory
newCertRequest(int, String, int, boolean, boolean, List<String>, List<String>, List<String>, String, String, String, KeyPair) -
Static method in class com.ibm.security.certclient.PkEeCertReqFactory
Deprecated.
newCertRequest(int, String, int, String, String, boolean, List<String>, List<String>, List<String>, String, String, String, KeyPair) -
Static method in class com.ibm.security.certclient.PkEeCertReqFactory
Initialise a certificate request to the supplied CA.
newCertRequest(String, String, String, String) -
Static method in class com.ibm.security.certclient.PkEeCertReqFactory
Deprecated.
newCertRequestPKCS10(String, String, String) -
Static method in class com.ibm.security.certclient.PkEeCertReq10Factory
Initiate a certificate request using an already created PKCS10 request.
newCompositeSKIDefinition(SKIDefinition...) -
Static method in class com.ibm.security.keystoreski.SKIDefinitionFactory
Returns a new Subject Key Identifier definition that calculates the Subject Key Identifier by obtaining the
Subject Key Identifier from the passed
SKIDefinition
implementations.
newKeyStoreSKI(KeyStore) -
Static method in class com.ibm.security.keystoreski.KeyStoreSKIFactory
Returns a new instance of
KeyStoreSKI
that provides operations
that can be performed on the given key store instance.
newRevoke(String, String, String, String) -
Static method in class com.ibm.security.certclient.PkEeRevokeFactory
Initiate a certificate revocation request to the supplied CA.
newSHA1PublicKeySKIDefinition() -
Static method in class com.ibm.security.keystoreski.SKIDefinitionFactory
Returns a new Subject Key Identifier definition that calculates the SHA-1 hash of the associate public key of the
certificate to generate the Subject Key Identifier.
newSHA1PublicKeyTruncatedSKIDefinition() -
Static method in class com.ibm.security.keystoreski.SKIDefinitionFactory
Returns a new Subject Key Identifier definition that calculates the SHA-1 hash of the associate public key of the
certificate and truncates it to generate the Subject Key Identifier.
newSsCert(String) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(String, Date) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, boolean, boolean, String) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, Date, boolean, boolean, String) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, boolean, boolean, String, KeyPair) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, Date, boolean, boolean, String, KeyPair) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, boolean, boolean, List<String>, List<String>, List<String>, String) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, Date, boolean, boolean, List<String>, List<String>, List<String>, String) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, boolean, boolean, List<String>, List<String>, List<String>, String, KeyPair) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, Date, boolean, boolean, List<String>, List<String>, List<String>, String, KeyPair) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, int, Date, boolean, boolean, List<String>, List<String>, List<String>, String, KeyPair, boolean) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Deprecated.
newSsCert(int, String, String, String, int, Date, boolean, List<String>, List<String>, List<String>, String, KeyPair, boolean) -
Static method in class com.ibm.security.certclient.util.PkSsCertFactory
Create a self-signed certificate with supplied extensions
newTranslator(String) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Creates a KeyStore translator to a given type.
newTranslator(String, Provider) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Creates a KeyStore translator to a given type using a specific provider.
newTranslator(String, String) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Creates a KeyStore translator to a given type using a specific provider.
newTranslatorParameters(KeyStore, char[], Map<String, char[]>) -
Static method in class com.ibm.security.keystoreutil.KeyStoreUtil
Creates an instance of
KeyStoreTranslatorParameters
which
can be used as parameter when calling KeyStoreTranslator.translateStore(KeyStoreTranslatorParameters)
method.
newX509ExtensionSKIDefinition() -
Static method in class com.ibm.security.keystoreski.SKIDefinitionFactory
Returns a new Subject Key Identifier definition that inspects the extensions of the certificate for the Subject
Key Identifier (2.5.29.14).
P
Pk10CertFactory - Class in com.ibm.security.certclient.util
Generate a certificate from a PKCS10 certificate request and sign it with the provided signer key.
Pk10Certificate - Interface in com.ibm.security.certclient.util
This interface describes the Pk10Certificate object that is returned from
the Pk10CertificateFactory class.
PkEeBuiltReqTransaction - Interface in com.ibm.security.certclient
Built version of the certificate request.
PkEeCertReq10Factory - Class in com.ibm.security.certclient
Produce a certificate request transaction using an existing PKCS10 formatted
request as the data source.
PkEeCertReqFactory - Class in com.ibm.security.certclient
Produce an initial certificate request transaction.
PkEeCertReqTransaction - Interface in com.ibm.security.certclient
Complete certificate request transaction for initial request for
a key pair
PkEeFactory - Class in com.ibm.security.certclient
Class to maintain EE configuration values.
PkEeFactory() -
Constructor for class com.ibm.security.certclient.PkEeFactory
PkEeReqTransaction - Interface in com.ibm.security.certclient
Interface specific to all certificate request transactions
PkEeRevokeFactory - Class in com.ibm.security.certclient
Revoke a signed certificate kept in the end entity's keystore
PkEeTransaction - Interface in com.ibm.security.certclient
Basic end-entity interface
PkNewCertFactory - Class in com.ibm.security.certclient.util
Generate a certificate signed with specified signing certificate.
PkNewCertificate - Interface in com.ibm.security.certclient.util
This interface allows an End Entity to create a personal certificate with selected
extensions signed by the specified signing certificate.
PkSsCertFactory - Class in com.ibm.security.certclient.util
Generate a self-signed certificate.
PkSsCertificate - Interface in com.ibm.security.certclient.util
This interface allows an End Entity to create self-signed certificates with selected
extensions.
provider -
Static variable in class com.ibm.security.certclient.PkEeFactory
S
setCA_DN(String) -
Static method in class com.ibm.security.certclient.PkEeFactory
setCaDn(String) -
Static method in class com.ibm.security.certclient.PkEeFactory
setCaPort(int) -
Static method in class com.ibm.security.certclient.PkEeFactory
setKeySize(int) -
Method in interface com.ibm.security.certclient.PkEeCertReqTransaction
Set the length of the key in bits.
setKeystoreFilename(String) -
Static method in class com.ibm.security.certclient.PkEeFactory
setKeystorePwd(char[]) -
Static method in class com.ibm.security.certclient.PkEeFactory
setKeyStoreType(String) -
Static method in class com.ibm.security.certclient.PkEeFactory
setKeyType(String) -
Method in interface com.ibm.security.certclient.PkEeCertReqTransaction
Set the key type to be generated for this request.
setProvider(String) -
Static method in class com.ibm.security.certclient.PkEeFactory
setSubjectAltNames(List<String>) -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Adds the provided alternate names to the certificate request.
setSubjectKeyIdShort(boolean) -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Determines if the short form of the subjectKey identifier is
required as defined in RFC3280
setToKeyStore(String, String, KeyStore) -
Method in interface com.ibm.security.certclient.util.PkNewCertificate
Store this personal certificate in a keystore
setToKeyStore(String, String, KeyStore) -
Method in interface com.ibm.security.certclient.util.PkSsCertificate
Store this self-signed certificate in a keystore
setValidity(int) -
Method in interface com.ibm.security.certclient.PkEeBuiltReqTransaction
Set the validity period for the key.
SKIDefinition - Interface in com.ibm.security.keystoreski
Defines the process of extracting a Subject Key Identifier from a
Certificate
.
SKIDefinitionFactory - Class in com.ibm.security.keystoreski
Constructs and returns instances of
SKIDefinition
that provides implementations which are typically based on
definitions of Subject Key Identifier from RFC 3280 Section 4.2.1.2.
storeNewEntry(String, String) -
Method in interface com.ibm.security.certclient.PkEeCertReqTransaction
Add the signed certificate into the EE keystore.
T
translateStore(KeyStoreTranslatorParameters) -
Method in interface com.ibm.security.keystoreutil.KeyStoreTranslator
Translate a KeyStore into a different format.