TChilkatPem Delphi ActiveX Reference Documentation

TChilkatPem

Current Version: 9.5.0.73

For creating, loading, parsing, converting, and saving in the PEM format.

Note: There are many types of objects that can be stored in PEM format. Chilkat supports certificates, private keys, and public keys. There is still much more to do. If there is a need to support a particular type of content, contact Chilkat (support@chilkatsoft.com).

Importing the Chilkat ActiveX into Delphi

Important: When 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. See also: ActiveX Registration Tutorial
  3. 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) should 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: TChilkatPem;
...
begin
obj := TChilkatPem.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

AppendMode
property AppendMode: Integer
Introduced in version 9.5.0.49

When set to 1, each of the Load* methods appends to the current contents of this PEM object. When set to 0, a Load* method replaces the contents of this PEM object. The default is 0.

top
DebugLogFilePath
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.

top
HeartbeatMs
property HeartbeatMs: Integer
Introduced in version 9.5.0.49

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any event-enabled methods prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

top
LastBinaryResult
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).

top
LastErrorHtml
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.

top
LastErrorText
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.

top
LastErrorXml
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.

top
LastMethodSuccess
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.

top
LastStringResult
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).

top
LastStringResultLen
property LastStringResultLen: Integer readonly
Introduced in version 9.5.0.53

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

top
NumCerts
property NumCerts: Integer readonly
Introduced in version 9.5.0.49

The number of certificates in the loaded PEM. To get the 1st certificate, call GetCert(0).

More Information and Examples
top
NumCsrs
property NumCsrs: Integer readonly
Introduced in version 9.5.0.50

The number of certificate signing requests (CSRs) in the loaded PEM.

top
NumPrivateKeys
property NumPrivateKeys: Integer readonly
Introduced in version 9.5.0.49

The number of private keys in the loaded PEM. To get the 1st private key, call GetPrivateKey(0).

More Information and Examples
top
NumPublicKeys
property NumPublicKeys: Integer readonly
Introduced in version 9.5.0.49

The number of public keys in the loaded PEM. To get the 1st public key, call GetPublicKey(0).

top
PrivateKeyFormat
property PrivateKeyFormat: WideString
Introduced in version 9.5.0.49

Controls the format to be used for unencrypted private keys when writing a PEM. Possible values are "pkcs1" and "pkcs8". (OpenSSL typically uses the "pkcs8" format.) When writing encrypted private keys to PEM, the format is always PKCS8, and the PEM header is "BEGIN ENCRYPTED PRIVATE KEY". The default is "pkcs8".

The PKCS1 format uses the PEM header: BEGIN RSA PRIVATE KEY.
The PKCS8 format uses the PEM header: BEGIN PRIVATE KEY.

top
PublicKeyFormat
property PublicKeyFormat: WideString
Introduced in version 9.5.0.49

Controls the format to be used for public keys when writing a PEM. Possible values are "pkcs1" and "pkcs8". (OpenSSL typically uses the "pkcs8" format.) The default is "pkcs8".

The PKCS1 format uses the PEM header: BEGIN RSA PUBLIC KEY.
The PKCS8 format uses the PEM header: BEGIN PUBLIC KEY.

More Information and Examples
top
VerboseLogging
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.

top
Version
property Version: WideString readonly

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

top

Methods

AddCert
function AddCert(cert: TChilkatCert; includeChain: Integer): Integer;
Introduced in version 9.5.0.49

Adds a certificate, and potentially the certs in its chain of authentication to the PEM. If includeChain is 1, then certificates in the cert's chain of authentication up to and including the root are automatically added.

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddItem
function AddItem(itemType: WideString; encoding: WideString; itemData: WideString): Integer;
Introduced in version 9.5.0.59

Adds a certificate, private key, public key, or csr to the PEM. The possible values for itemType are "certificate" (or "cert"), "privateKey", "publicKey", or "csr". The encoding can be "Base64", "modBase64", "Base32", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "url_oauth", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The itemData contains the ASN.1 data in string format according to the encoding specified in encoding.

Returns 1 for success, 0 for failure.

top
AddPrivateKey
function AddPrivateKey(privateKey: TPrivateKey): Integer;
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns 1 for success, 0 for failure.

top
AddPrivateKey2
function AddPrivateKey2(privKey: TPrivateKey; certChain: TChilkatCertChain): Integer;
Introduced in version 9.5.0.49

Adds a private key and it's associated certificate chain to the PEM object.

Returns 1 for success, 0 for failure.

top
AddPublicKey
function AddPublicKey(pubkey: TPublicKey): Integer;
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns 1 for success, 0 for failure.

top
Clear
function Clear(): Integer;
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns 1 for success, 0 for failure.

top
GetCert
function GetCert(index: Integer): TChilkatCert;
Introduced in version 9.5.0.49

Returns the Nth certificate from the PEM. The first certificate is at index 0.

Returns nil on failure

top
GetEncodedItem
function GetEncodedItem(itemType: WideString; itemSubType: WideString; encoding: WideString; index: Integer): WideString;
Introduced in version 9.5.0.50

Returns the encoded contents of the Nth item of a particular type (0-based index). The possible values for itemType are "certificate" (or "cert"), "privateKey", "publicKey", or "csr". Input string args are case-insensitive. If the itemType is "privateKey", the itemSubType may be "der" or "pkcs8". If the itemType is "publicKey", the itemSubType may be "der" or "pkcs1". The itemSubType is ignored for other values of itemType. The valid encoding modes are "Base64", "modBase64", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "url_oauth", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns a zero-length WideString on failure

top
GetPrivateKey
function GetPrivateKey(index: Integer): TPrivateKey;
Introduced in version 9.5.0.49

Returns the Nth private key from the PEM. The first private key is at index 0.

Returns nil on failure

top
GetPublicKey
function GetPublicKey(index: Integer): TPublicKey;
Introduced in version 9.5.0.49

Returns the Nth public key from the PEM. The first public key is at index 0.

Returns nil on failure

top
LoadP7b
function LoadP7b(p7bData: OleVariant): Integer;
Introduced in version 9.5.0.49

Loads the PEM from the contents of an in-memory PKCS7 container (.p7b).

Returns 1 for success, 0 for failure.

top
LoadP7bAsync (1)
function LoadP7bAsync(p7bData: OleVariant): TChilkatTask;
Introduced in version 9.5.0.49

Creates an asynchronous task to call the LoadP7b method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
LoadP7bFile
function LoadP7bFile(path: WideString): Integer;
Introduced in version 9.5.0.49

Loads the contents of a PKCS7 container (.p7b file).

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadP7bFileAsync (1)
function LoadP7bFileAsync(path: WideString): TChilkatTask;
Introduced in version 9.5.0.49

Creates an asynchronous task to call the LoadP7bFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
LoadPem
function LoadPem(pemContent: WideString; password: WideString): Integer;
Introduced in version 9.5.0.49

Loads the PEM from a PEM string. If encrypted, then the password is required for decryption. Otherwise, an empty string (or any string) may be passed for the password.

Returns 1 for success, 0 for failure.

top
LoadPemAsync (1)
function LoadPemAsync(pemContent: WideString; password: WideString): TChilkatTask;
Introduced in version 9.5.0.49

Creates an asynchronous task to call the LoadPem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
LoadPemFile
function LoadPemFile(path: WideString; password: WideString): Integer;
Introduced in version 9.5.0.49

Loads the PEM from a PEM file. If encrypted, then the password is required for decryption. Otherwise, an empty string (or any string) may be passed for the password.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadPemFileAsync (1)
function LoadPemFileAsync(path: WideString; password: WideString): TChilkatTask;
Introduced in version 9.5.0.49

Creates an asynchronous task to call the LoadPemFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
RemoveCert
function RemoveCert(index: Integer): Integer;
Introduced in version 9.5.0.49

Removes the Nth certificate from the PEM. The first certificate is at index 0.

Returns 1 for success, 0 for failure.

top
RemovePrivateKey
function RemovePrivateKey(index: Integer): Integer;
Introduced in version 9.5.0.49

Removes the Nth private key from the PEM. The first private key is at index 0.

Returns 1 for success, 0 for failure.

top
ToJks
function ToJks(alias: WideString; password: WideString): TChilkatJavaKeyStore;
Introduced in version 9.5.0.49

Converts the PEM to JKS and returns the Java KeyStore object. If the alias is non-empty, the 1st object (private key or certificate) will use the alias, and all others (if any) will receive auto-generated aliases. The JKS returned will be encrypted using the provided password. If the PEM contains only certificates (no private keys), then the password is unused.

Returns nil on failure

More Information and Examples
top
ToPem
function ToPem(): WideString;
Introduced in version 9.5.0.47

Write the PFX to a PEM formatted string. The resultant PEM will contain the private key, as well as the certs in the chain of authentication (or whatever certs are available in the PFX). For example:

 -----BEGIN RSA PRIVATE KEY-----
...
... the private key associated with the main certificate.
...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
...
... the main certificate
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... an intermediate CA certificate (if present)
...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...
... the root CA certificate
...
-----END CERTIFICATE----- 

Returns a zero-length WideString on failure

top
ToPemEx
function ToPemEx(extendedAttrs: Integer; noKeys: Integer; noCerts: Integer; noCaCerts: Integer; encryptAlg: WideString; password: WideString): WideString;
Introduced in version 9.5.0.49

Write the PFX to a PEM formatted string. If extendedAttrs is 1, then extended properties (Bag Attributes and Key Attributes) are output. If noKeys is 1, then no private keys are output. If noCerts is 1, then no certificates are output. If noCaCerts is 1, then no CA certs or intermediate CA certs are output. If encryptAlg is not empty, it indicates the encryption algorithm to be used for encrypting the private keys (otherwise the private keys are output unencrypted). The possible choices for the encryptAlg are "des3", "aes128", "aes192", and "aes256". (All encryption algorithm choices use CBC mode.) If the private keys are to be encrypted, then password is the password to be used. Otherwise, password may be left empty. For example:

Bag Attributes
    Microsoft Local Key set: <No Values>
    localKeyID: 01 00 00 00 
    friendlyName: le-2b09a3d2-9037-4a05-95cc-4d44518e8607
    Microsoft CSP Name: Microsoft RSA SChannel Cryptographic Provider
Key Attributes
    X509v3 Key Usage: 10 
 -----BEGIN RSA PRIVATE KEY-----
...
... the private key associated with the main certificate.
...
-----END RSA PRIVATE KEY-----
Bag Attributes
    localKeyID: 01 00 00 00 
    1.3.6.1.4.1.311.17.3.92: 00 08 00 00 
    1.3.6.1.4.1.311.17.3.20: C2 53 54 F3 ...
    1.3.6.1.4.1.311.17.3.71: 49 00 43 00 ...
    1.3.6.1.4.1.311.17.3.75: 31 00 42 00 ...
subject=/OU=Domain Control Validated/OU=PositiveSSL/CN=something.com
issuer=/C=GB/ST=Greater Manchester/L=Salford/O=COMODO CA Limited/CN=COMODO RSA Domain Validation Secure Server CA
-----BEGIN CERTIFICATE-----
...
... the main certificate
...
-----END CERTIFICATE-----
...
-----BEGIN CERTIFICATE-----
...
... an intermediate CA certificate (if present)
...
-----END CERTIFICATE-----
...
-----BEGIN CERTIFICATE-----
...
... the root CA certificate
...
-----END CERTIFICATE----- 

Returns a zero-length WideString on failure

top
ToPfx
function ToPfx(): TChilkatPfx;
Introduced in version 9.5.0.49

Converts the PEM to PKCS12 and returns the PFX object. The PFX object has method for saving to a file, exporting to an encoded string, converting to a JKS (Java Keystore), or even converting back to PEM.

Note: The PEM must contain at least one private key to convert to PKCS12. The typical case is that a PKCS12 contains a single private key, along with the associated certificate and the certificates in the chain of authentication.

Returns nil on failure

More Information and Examples
top

Events

AbortCheck
procedure AbortCheck(ASender: TObject; out abort: Integer);

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Delphi ActiveX Event callback implementation:

procedure TForm1.pemENTRY_NAME(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  pem: TChilkatPem;

begin
  pem := TChilkatPem.Create(Self);
  pem.OnAbortCheck := pemAbortCheck;
  // ...
top
PercentDone
procedure PercentDone(ASender: TObject; pctDone: Integer; out abort: Integer);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

Delphi ActiveX Event callback implementation:

procedure TForm1.pemENTRY_NAME(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  pem: TChilkatPem;

begin
  pem := TChilkatPem.Create(Self);
  pem.OnPercentDone := pemPercentDone;
  // ...
top
ProgressInfo
procedure ProgressInfo(ASender: TObject; const name: WideString; const value: WideString);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Delphi ActiveX Event callback implementation:

procedure TForm1.pemENTRY_NAME(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  pem: TChilkatPem;

begin
  pem := TChilkatPem.Create(Self);
  pem.OnProgressInfo := pemProgressInfo;
  // ...
top
TaskCompleted
procedure TaskCompleted(ASender: TObject; const task: IChilkatTask);

Called in the background thread when an asynchronous task completes.

More Information and Examples

Delphi ActiveX Event callback implementation:

procedure TForm1.pemENTRY_NAME(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  pem: TChilkatPem;

begin
  pem := TChilkatPem.Create(Self);
  pem.OnTaskCompleted := pemTaskCompleted;
  // ...
top