TChilkatJavaKeyStore Delphi ActiveX Reference Documentation

TChilkatJavaKeyStore

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.

Importing the Chilkat ActiveX into Delphi

Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) will be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatJavaKeyStore;
...
begin
obj := TChilkatJavaKeyStore.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

property DebugLogFilePath: WideString

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.

property LastBinaryResult: OleVariant readonly

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

property LastErrorHtml: WideString readonly

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.

property LastErrorText: WideString readonly

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.

Concept of LastErrorText

LastErrorText Standard Information

property LastErrorXml: WideString readonly

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.

property LastMethodSuccess: Integer

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

property LastStringResult: WideString readonly

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

property LastStringResultLen: Integer readonly

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

property NumPrivateKeys: Integer readonly

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.

property NumSecretKeys: Integer readonly

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.

Read JCEKS Containing Secret Keys

property NumTrustedCerts: Integer readonly

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.

property RequireCompleteChain: Integer

Introduced in version 9.5.0.44

If 1, 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 0, then incomplete certificate chains are allowed. The default value is 1.

property VerboseLogging: Integer

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

property VerifyKeyedDigest: Integer

Introduced in version 9.5.0.44

If 1, 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 0, 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 1.

property Version: WideString readonly

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

Methods

function AddPfx(pfx: TChilkatPfx; alias: WideString; password: WideString): Integer;

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 1, 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 1 for success, 0 for failure.

function AddPrivateKey(cert: TChilkatCert; alias: WideString; password: WideString): Integer;

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 1, 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 1 for success, 0 for failure.

function AddSecretKey(encodedKeyBytes: WideString; encoding: WideString; algorithm: WideString; alias: WideString; password: WideString): Integer;

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 1 for success, 0 for failure.

Create JCEKS Containing Secret Keys

function AddTrustedCert(cert: TChilkatCert; alias: WideString): Integer;

Introduced in version 9.5.0.44

Adds a trusted certificate to the Java keystore object.

Returns 1 for success, 0 for failure.

Load Particular CA Certs into a Java KeyStore

function ChangePassword(index: Integer; oldPassword: WideString; newPassword: WideString): Integer;

Introduced in version 9.5.0.44

Changes the password for a private key.

Returns 1 for success, 0 for failure.

Change Password for Java KeyStore File

function FindCertChain(alias: WideString; caseSensitive: Integer): TChilkatCertChain;

Introduced in version 9.5.0.44

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

Returns nil on failure

function FindPrivateKey(password: WideString; alias: WideString; caseSensitive: Integer): TPrivateKey;

Introduced in version 9.5.0.44

Finds and returns the private key with the specified alias.

Returns nil on failure

RSA SHA256 Signature using Private Key from Java Keystore

function FindTrustedCert(alias: WideString; caseSensitive: Integer): TChilkatCert;

Introduced in version 9.5.0.44

Finds and returns the trusted certificate with the specified alias.

Returns nil on failure

function GetCertChain(index: Integer): TChilkatCertChain;

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 nil on failure

function GetPrivateKey(password: WideString; index: Integer): TPrivateKey;

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 nil on failure

function GetPrivateKeyAlias(index: Integer): WideString;

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 a zero-length WideString on failure

function GetSecretKey(password: WideString; index: Integer; encoding: WideString): WideString;

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 a zero-length WideString on failure

Read JCEKS Containing Secret Keys

function GetSecretKeyAlias(index: Integer): WideString;

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 a zero-length WideString on failure

Read JCEKS Containing Secret Keys

function GetTrustedCert(index: Integer): TChilkatCert;

Introduced in version 9.5.0.44

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

Returns nil on failure

function GetTrustedCertAlias(index: Integer): WideString;

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 a zero-length WideString on failure

function LoadBinary(password: WideString; jksData: OleVariant): Integer;

Introduced in version 9.5.0.44

Loads a Java keystore from in-memory byte data.

Returns 1 for success, 0 for failure.

function LoadEncoded(password: WideString; jksEncData: WideString; encoding: WideString): Integer;

Introduced in version 9.5.0.44

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

Returns 1 for success, 0 for failure.

function LoadFile(password: WideString; path: WideString): Integer;

Introduced in version 9.5.0.44

Loads a Java keystore from a file.

Returns 1 for success, 0 for failure.

Load Java KeyStore and List Contents

function LoadJwkSet(password: WideString; jwkSet: TChilkatJsonObject): Integer;

Introduced in version 9.5.0.66

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

Returns 1 for success, 0 for failure.

Load a JWK Set into a Java KeyStore (JKS/JCEKS)

Load a JWK Set into a JCEKS (Convert JWK Set to JCEKS)

function RemoveEntry(entryType: Integer; index: Integer): Integer;

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 1 for success, 0 for failure.

function SetAlias(entryType: Integer; index: Integer; alias: WideString): Integer;

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 1 for success, 0 for failure.

function ToBinary(password: WideString): OleVariant;

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 a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

function ToEncodedString(password: WideString; encoding: WideString): WideString;

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 a zero-length WideString on failure

function ToFile(password: WideString; path: WideString): Integer;

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 1 for success, 0 for failure.

Convert Java KeyStore to PKCS12 / PFX

Convert Java KeyStore to PEM

Load Particular CA Certs into a Java KeyStore

function ToJwkSet(password: WideString; sbJwkSet: TChilkatStringBuilder): Integer;

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 1 for success, 0 for failure.

Export Private Keys from Java KeyStore to JWK Set

Convert PFX to JWK Set

Convert JCEKS to JWK Set (JSON Web Key Set)

function ToPem(password: WideString): TChilkatPem;

Introduced in version 9.5.0.49

Returns the Java KeyStore as a Pem object.

Returns nil on failure

function ToPfx(password: WideString): TChilkatPfx;

Introduced in version 9.5.0.49

Returns the Java KeyStore as a Pfx object.

Returns nil on failure

function UnlockComponent(unlockCode: WideString): Integer;

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 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

function UseCertVault(vault: TChilkatXmlCertVault): Integer;

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 1 for success, 0 for failure.