JavaKeyStore C Reference Documentation

JavaKeyStore

Current Version: 9.5.0.73

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);
HCkJavaKeyStore CkJavaKeyStore_Create(void);

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.

void CkJavaKeyStore_Dispose(HCkJavaKeyStore handle);

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_getDebugLogFilePath(HCkJavaKeyStore cHandle, HCkString retval);
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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void CkJavaKeyStore_getLastErrorHtml(HCkJavaKeyStore cHandle, HCkString retval);
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.

top
LastErrorText
void CkJavaKeyStore_getLastErrorText(HCkJavaKeyStore cHandle, HCkString retval);
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.

top
LastErrorXml
void CkJavaKeyStore_getLastErrorXml(HCkJavaKeyStore cHandle, HCkString retval);
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.

top
LastMethodSuccess
BOOL CkJavaKeyStore_getLastMethodSuccess(HCkJavaKeyStore cHandle);
void CkJavaKeyStore_putLastMethodSuccess(HCkJavaKeyStore cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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.

top
NumPrivateKeys
int CkJavaKeyStore_getNumPrivateKeys(HCkJavaKeyStore cHandle);
Introduced in version 9.5.0.44

The number of private keys contained within the keystore. Each private key has an alias and certificate chain associated with it.

top
NumSecretKeys
int CkJavaKeyStore_getNumSecretKeys(HCkJavaKeyStore cHandle);
Introduced in version 9.5.0.66

The number of secret keys (such as AES keys) contained within the keystore. Each secret key can have an alias associated with it.

More Information and Examples
top
NumTrustedCerts
int CkJavaKeyStore_getNumTrustedCerts(HCkJavaKeyStore cHandle);
Introduced in version 9.5.0.44

The number of trusted certificates contained within the keystore. Each certificate has an alias (identifying string) associated with it.

top
RequireCompleteChain
BOOL CkJavaKeyStore_getRequireCompleteChain(HCkJavaKeyStore cHandle);
void CkJavaKeyStore_putRequireCompleteChain(HCkJavaKeyStore cHandle, BOOL newVal);
Introduced in version 9.5.0.44

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.

top
Utf8
BOOL CkJavaKeyStore_getUtf8(HCkJavaKeyStore cHandle);
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.

top
VerboseLogging
BOOL CkJavaKeyStore_getVerboseLogging(HCkJavaKeyStore cHandle);
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.

top
VerifyKeyedDigest
BOOL CkJavaKeyStore_getVerifyKeyedDigest(HCkJavaKeyStore cHandle);
void CkJavaKeyStore_putVerifyKeyedDigest(HCkJavaKeyStore cHandle, BOOL newVal);
Introduced in version 9.5.0.44

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.

top
Version
void CkJavaKeyStore_getVersion(HCkJavaKeyStore cHandle, HCkString retval);
const char *CkJavaKeyStore_version(HCkJavaKeyStore cHandle);

Version of the component/library, such as "9.5.0.63"

top

Methods

AddPfx
BOOL CkJavaKeyStore_AddPfx(HCkJavaKeyStore cHandle, HCkPfx pfx, const char *alias, const char *password);
Introduced in version 9.5.0.44

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:

  1. Certificate's subject common name
  2. Certificate's subject email address
  3. Certificate's friendly name found in the PKCS9 attributes of the PKCS12
  4. 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.

top
AddPrivateKey
BOOL CkJavaKeyStore_AddPrivateKey(HCkJavaKeyStore cHandle, HCkCert cert, const char *alias, const char *password);
Introduced in version 9.5.0.44

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:

  1. Certificate's subject common name
  2. Certificate's subject email address
  3. 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.

top
AddSecretKey
BOOL CkJavaKeyStore_AddSecretKey(HCkJavaKeyStore cHandle, const char *encodedKeyBytes, const char *encoding, const char *algorithm, const char *alias, const char *password);
Introduced in version 9.5.0.66

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.

More Information and Examples
top
AddTrustedCert
BOOL CkJavaKeyStore_AddTrustedCert(HCkJavaKeyStore cHandle, HCkCert cert, const char *alias);
Introduced in version 9.5.0.44

Adds a trusted certificate to the Java keystore object.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
ChangePassword
BOOL CkJavaKeyStore_ChangePassword(HCkJavaKeyStore cHandle, int index, const char *oldPassword, const char *newPassword);
Introduced in version 9.5.0.44

Changes the password for a private key.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
FindCertChain
HCkCertChain CkJavaKeyStore_FindCertChain(HCkJavaKeyStore cHandle, const char *alias, BOOL caseSensitive);
Introduced in version 9.5.0.44

Finds and returns the certificate chain for the private key with the specified alias.

Returns NULL on failure

top
FindPrivateKey
HCkPrivateKey CkJavaKeyStore_FindPrivateKey(HCkJavaKeyStore cHandle, const char *password, const char *alias, BOOL caseSensitive);
Introduced in version 9.5.0.44

Finds and returns the private key with the specified alias.

Returns NULL on failure

top
FindTrustedCert
HCkCert CkJavaKeyStore_FindTrustedCert(HCkJavaKeyStore cHandle, const char *alias, BOOL caseSensitive);
Introduced in version 9.5.0.44

Finds and returns the trusted certificate with the specified alias.

Returns NULL on failure

top
GetCertChain
HCkCertChain CkJavaKeyStore_GetCertChain(HCkJavaKeyStore cHandle, int index);
Introduced in version 9.5.0.44

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

top
GetPrivateKey
HCkPrivateKey CkJavaKeyStore_GetPrivateKey(HCkJavaKeyStore cHandle, const char *password, int index);
Introduced in version 9.5.0.44

Returns the Nth private key contained within the keystore. The 1st private key is at index 0.

Returns NULL on failure

top
GetPrivateKeyAlias
BOOL CkJavaKeyStore_GetPrivateKeyAlias(HCkJavaKeyStore cHandle, int index, HCkString outStr);
const char *CkJavaKeyStore_getPrivateKeyAlias(HCkJavaKeyStore cHandle, int index);
Introduced in version 9.5.0.44

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.

top
GetSecretKey
BOOL CkJavaKeyStore_GetSecretKey(HCkJavaKeyStore cHandle, const char *password, int index, const char *encoding, HCkString outStr);
const char *CkJavaKeyStore_getSecretKey(HCkJavaKeyStore cHandle, const char *password, int index, const char *encoding);
Introduced in version 9.5.0.66

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.

More Information and Examples
top
GetSecretKeyAlias
BOOL CkJavaKeyStore_GetSecretKeyAlias(HCkJavaKeyStore cHandle, int index, HCkString outStr);
const char *CkJavaKeyStore_getSecretKeyAlias(HCkJavaKeyStore cHandle, int index);
Introduced in version 9.5.0.66

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.

More Information and Examples
top
GetTrustedCert
HCkCert CkJavaKeyStore_GetTrustedCert(HCkJavaKeyStore cHandle, int index);
Introduced in version 9.5.0.44

Returns the Nth trusted certificate contained within the keystore. The 1st certificate is at index 0.

Returns NULL on failure

top
GetTrustedCertAlias
BOOL CkJavaKeyStore_GetTrustedCertAlias(HCkJavaKeyStore cHandle, int index, HCkString outStr);
const char *CkJavaKeyStore_getTrustedCertAlias(HCkJavaKeyStore cHandle, int index);
Introduced in version 9.5.0.44

Returns the Nth trusted certificate alias contained within the keystore. The 1st certificate is at index 0.

Returns TRUE for success, FALSE for failure.

top
LoadBinary
BOOL CkJavaKeyStore_LoadBinary(HCkJavaKeyStore cHandle, const char *password, HCkByteData jksData);
Introduced in version 9.5.0.44

Loads a Java keystore from in-memory byte data.

Returns TRUE for success, FALSE for failure.

top
LoadEncoded
BOOL CkJavaKeyStore_LoadEncoded(HCkJavaKeyStore cHandle, const char *password, const char *jksEncData, const char *encoding);
Introduced in version 9.5.0.44

Loads a Java keystore from an encoded string (such as base64, hex, etc.)

Returns TRUE for success, FALSE for failure.

top
LoadFile
BOOL CkJavaKeyStore_LoadFile(HCkJavaKeyStore cHandle, const char *password, const char *path);
Introduced in version 9.5.0.44

Loads a Java keystore from a file.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
LoadJwkSet
BOOL CkJavaKeyStore_LoadJwkSet(HCkJavaKeyStore cHandle, const char *password, HCkJsonObject jwkSet);
Introduced in version 9.5.0.66

Loads the Java KeyStore from a JSON Web Key (JWK) Set.

Returns TRUE for success, FALSE for failure.

top
RemoveEntry
BOOL CkJavaKeyStore_RemoveEntry(HCkJavaKeyStore cHandle, int entryType, int index);
Introduced in version 9.5.0.44

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.

top
SaveLastError
BOOL CkJavaKeyStore_SaveLastError(HCkJavaKeyStore cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top
SetAlias
BOOL CkJavaKeyStore_SetAlias(HCkJavaKeyStore cHandle, int entryType, int index, const char *alias);
Introduced in version 9.5.0.44

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.

top
ToBinary
BOOL CkJavaKeyStore_ToBinary(HCkJavaKeyStore cHandle, const char *password, HCkByteData outBytes);
Introduced in version 9.5.0.44

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.

top
ToEncodedString
BOOL CkJavaKeyStore_ToEncodedString(HCkJavaKeyStore cHandle, const char *password, const char *encoding, HCkString outStr);
const char *CkJavaKeyStore_toEncodedString(HCkJavaKeyStore cHandle, const char *password, const char *encoding);
Introduced in version 9.5.0.44

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.

top
ToFile
BOOL CkJavaKeyStore_ToFile(HCkJavaKeyStore cHandle, const char *password, const char *path);
Introduced in version 9.5.0.44

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.

top
ToJwkSet
BOOL CkJavaKeyStore_ToJwkSet(HCkJavaKeyStore cHandle, const char *password, HCkStringBuilder sbJwkSet);
Introduced in version 9.5.0.66

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.

top
ToPem
HCkPem CkJavaKeyStore_ToPem(HCkJavaKeyStore cHandle, const char *password);
Introduced in version 9.5.0.49

Returns the Java KeyStore as a Pem object.

Returns NULL on failure

top
ToPfx
HCkPfx CkJavaKeyStore_ToPfx(HCkJavaKeyStore cHandle, const char *password);
Introduced in version 9.5.0.49

Returns the Java KeyStore as a Pfx object.

Returns NULL on failure

top
UnlockComponent
BOOL CkJavaKeyStore_UnlockComponent(HCkJavaKeyStore cHandle, const char *unlockCode);
Introduced in version 9.5.0.44

Unlocks the component allowing for the full functionality to be used. If a purchased unlock code is passed, there is no expiration. Any other string automatically begins a fully-functional 30-day trial the first time UnlockComponent is called.

Returns TRUE for success, FALSE for failure.

top
UseCertVault
BOOL CkJavaKeyStore_UseCertVault(HCkJavaKeyStore cHandle, HCkXmlCertVault vault);
Introduced in version 9.5.0.44

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