JavaKeyStore C Reference Documentation
JavaKeyStore
Current Version: 10.1.0
API to read, write, access, and update Java key stores (JKS format).
This class also supports the JCEKS format starting in Chilkat v9.5.0.66.
Create/Dispose
HCkJavaKeyStore instance = CkJavaKeyStore_Create(); // ... CkJavaKeyStore_Dispose(instance);
Creates an instance of the HCkJavaKeyStore object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkJavaKeyStore_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkJavaKeyStore_Dispose.
Properties
DebugLogFilePath
void CkJavaKeyStore_putDebugLogFilePath(HCkJavaKeyStore cHandle, const char *newVal);
const char *CkJavaKeyStore_debugLogFilePath(HCkJavaKeyStore cHandle);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
const char *CkJavaKeyStore_lastErrorHtml(HCkJavaKeyStore cHandle);
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
const char *CkJavaKeyStore_lastErrorText(HCkJavaKeyStore cHandle);
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
const char *CkJavaKeyStore_lastErrorXml(HCkJavaKeyStore cHandle);
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
void CkJavaKeyStore_putLastMethodSuccess(HCkJavaKeyStore cHandle, BOOL newVal);
Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumPrivateKeys
The number of private keys contained within the keystore. Each private key has an alias and certificate chain associated with it.
topNumSecretKeys
The number of secret keys (such as AES keys) contained within the keystore. Each secret key can have an alias associated with it.
NumTrustedCerts
The number of trusted certificates contained within the keystore. Each certificate has an alias (identifying string) associated with it.
topRequireCompleteChain
void CkJavaKeyStore_putRequireCompleteChain(HCkJavaKeyStore cHandle, BOOL newVal);
If TRUE, then adding a private key to the JKS only succeeds if the certificate chain can be completed to the root certificate. A root certificate is either a trusted CA root or a self-signed certificate. If FALSE, then incomplete certificate chains are allowed. The default value is TRUE.
topUtf8
void CkJavaKeyStore_putUtf8(HCkJavaKeyStore cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkJavaKeyStore_putVerboseLogging(HCkJavaKeyStore cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVerifyKeyedDigest
void CkJavaKeyStore_putVerifyKeyedDigest(HCkJavaKeyStore cHandle, BOOL newVal);
If TRUE, then the keystore's keyed digest is required to pass validation (password required) for any of the load methods (such as LoadFile, LoadBinary, or LoadEncoded). If FALSE, then a keystore may be loaded into memory without password validation (if a null or empty string is passed to the load method). The default value of this property is TRUE.
topVersion
const char *CkJavaKeyStore_version(HCkJavaKeyStore cHandle);
Methods
AddPfx
Adds the contents of a PFX or PKCS #12 (.p12) to the Java keystore object. One JKS entry per private key found in the PKCS12 is added. The certs found within the PCKS12 are used to build the certificate chains for each private key. (A typical PFX file contains a single private key along with its associated certificate, and the certificates in the chain of authentication to the root CA cert.)
This method does not add trusted certificate entries to the JKS.
The specified alias is applied to the 1st private key found. If the alias is empty, then the alias is obtained from the cert/PFX in the following order of preference:
- Certificate's subject common name
- Certificate's subject email address
- Certificate's friendly name found in the PKCS9 attributes of the PKCS12
- Certificate's serial number
If multiple private keys are found in the PKCS12, then all but the first will automaticallly be assigned aliases using the preference just described.
The UseCertVault method may be called to provide additional certificates for the automatic construction of the certificate chains. If the RequireCompleteChain property is set to TRUE, then this method will fail if any certificate chain is not completed to the root. The TrustedRoots class may be used to provide a source for obtaining trusted CA roots if these are not already present within the PKCS12.
Returns TRUE for success, FALSE for failure.
topAddPrivateKey
Adds a private key entry to the JKS. Both the private key and certificate chain are obtained from the certificate object that is passed in the 1st argument.
If the alias is empty, then the alias is automatically chosen based on the certificate's information, in the following order of preference:
- Certificate's subject common name
- Certificate's subject email address
- Certificate's serial number
The UseCertVault method may be called to provide additional certificates for the automatic construction of the certificate chains. If the RequireCompleteChain property is set to TRUE, then this method will fail if the certificate chain is not completed to the root. The TrustedRoots class may be used to provide a source for obtaining trusted CA roots.
Returns TRUE for success, FALSE for failure.
topAddSecretKey
Adds a secret (symmetric) key entry to the JKS. This adds a symmetric key, which is simply a number of binary bytes (such as 16 bytes for a 128-bit AES key). The encodedKeyBytes provides the actual bytes of the symmetric key, in an encoded string form. The encoding indicates the encoding of encodedKeyBytes (such as "base64", "hex", "base64url", etc.) The algorithm describes the symmetric algorithm, such as "AES". The alias is the password used to seal (encrypt) the key bytes.
Note: The algorithm describes the usage of the encodedKeyBytes. For example, if encodedKeyBytes contains the 16 bytes of a 128-bit AES key, then algorithm should be set to "AES". The actual encryption algorithm used to seal the key within the JCEKS is PBEWithMD5AndTripleDES, which is part of the JCEKS specification.
Returns TRUE for success, FALSE for failure.
AddTrustedCert
Adds a trusted certificate to the Java keystore object.
Returns TRUE for success, FALSE for failure.
ChangePassword
Changes the password for a private key.
Returns TRUE for success, FALSE for failure.
FindCertChain
Finds and returns the certificate chain for the private key with the specified alias.
Returns NULL on failure
topFindPrivateKey
Finds and returns the private key with the specified alias.
Returns NULL on failure
FindTrustedCert
GetCertChain
Returns the certificate chain associated with the Nth private key contained within the keystore. The 1st private key is at index 0.
Returns NULL on failure
GetPrivateKey
Returns the Nth private key contained within the keystore. The 1st private key is at index 0.
Returns NULL on failure
topGetPrivateKeyAlias
const char *CkJavaKeyStore_getPrivateKeyAlias(HCkJavaKeyStore cHandle, int index);
Returns the Nth private key alias contained within the keystore. The 1st private key is at index 0.
Returns TRUE for success, FALSE for failure.
topGetSecretKey
const char *CkJavaKeyStore_getSecretKey(HCkJavaKeyStore cHandle, const char *password, int index, const char *encoding);
Returns the Nth secret key contained within the keystore. The 1st secret key is at index 0. The bytes of the secret key are returned in the specified encoding. (such as hex, base64, base64url, etc.)
Returns TRUE for success, FALSE for failure.
GetSecretKeyAlias
const char *CkJavaKeyStore_getSecretKeyAlias(HCkJavaKeyStore cHandle, int index);
Returns the Nth secret key alias contained within the keystore. The 1st secret key is at index 0.
Returns TRUE for success, FALSE for failure.
GetTrustedCert
Returns the Nth trusted certificate contained within the keystore. The 1st certificate is at index 0.
Returns NULL on failure
topGetTrustedCertAlias
const char *CkJavaKeyStore_getTrustedCertAlias(HCkJavaKeyStore cHandle, int index);
Returns the Nth trusted certificate alias contained within the keystore. The 1st certificate is at index 0.
Returns TRUE for success, FALSE for failure.
topLoadBd
LoadBinary
LoadEncoded
Loads a Java keystore from an encoded string (such as base64, hex, etc.)
Returns TRUE for success, FALSE for failure.
topLoadFile
Loads a Java keystore from a file.
Returns TRUE for success, FALSE for failure.
LoadJwkSet
Loads the Java KeyStore from a JSON Web Key (JWK) Set.
Returns TRUE for success, FALSE for failure.
RemoveEntry
Removes the Nth trusted certificate or private key entry from the keystore. The entryType indicates whether it is a trusted root or private key entry (1 = trusted certificate entry, 2 = private key entry). The 1st entry is at index 0.
Returns TRUE for success, FALSE for failure.
topSetAlias
Sets the alias name for a trusted certificate or private key entry. The entryType indicates whether it is a trusted root or private key entry (1 = trusted certificate entry, 2 = private key entry). The 1st entry is at index 0.
Returns TRUE for success, FALSE for failure.
topToBinary
Writes the key store to in-memory bytes. The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns TRUE for success, FALSE for failure.
topToEncodedString
const char *CkJavaKeyStore_toEncodedString(HCkJavaKeyStore cHandle, const char *password, const char *encoding);
Writes the key store to an encoded string. The encoding can be any encoding such as "base64" or "hex". The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns TRUE for success, FALSE for failure.
topToFile
Writes the key store to a file. The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns TRUE for success, FALSE for failure.
ToJwkSet
Returns the private keys in JSON JWK Set format. The JWK identifier (kid) will be set from the key alias in the store.
Returns TRUE for success, FALSE for failure.
ToPem
ToPfx
UseCertVault
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains to a root certificate.
Returns TRUE for success, FALSE for failure.
top