Pem Delphi DLL Reference Documentation

Pem

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

Create/Dispose

var
myObject: HCkPem;

begin
myObject := CkPem_Create();

// ...

CkPem_Dispose(myObject);
end;
function CkPem_Create: HCkPem; stdcall;

Creates an instance of the HCkPem object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkPem_Dispose(handle: HCkPem); stdcall;

Objects created by calling CkPem_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AppendMode
function CkPem_getAppendMode(objHandle: HCkPem): wordbool; stdcall;
procedure CkPem_putAppendMode(objHandle: HCkPem; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.49

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

top
DebugLogFilePath
procedure CkPem_getDebugLogFilePath(objHandle: HCkPem; outPropVal: HCkString); stdcall;
procedure CkPem_putDebugLogFilePath(objHandle: HCkPem; newPropVal: PWideChar); stdcall;
function CkPem__debugLogFilePath(objHandle: HCkPem): PWideChar; stdcall;

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
procedure CkPem_getLastErrorHtml(objHandle: HCkPem; outPropVal: HCkString); stdcall;
function CkPem__lastErrorHtml(objHandle: HCkPem): PWideChar; stdcall;

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
procedure CkPem_getLastErrorText(objHandle: HCkPem; outPropVal: HCkString); stdcall;
function CkPem__lastErrorText(objHandle: HCkPem): PWideChar; stdcall;

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
procedure CkPem_getLastErrorXml(objHandle: HCkPem; outPropVal: HCkString); stdcall;
function CkPem__lastErrorXml(objHandle: HCkPem): PWideChar; stdcall;

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
function CkPem_getLastMethodSuccess(objHandle: HCkPem): wordbool; stdcall;
procedure CkPem_putLastMethodSuccess(objHandle: HCkPem; newPropVal: wordbool); stdcall;
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
NumCerts
function CkPem_getNumCerts(objHandle: HCkPem): Integer; stdcall;
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
function CkPem_getNumCsrs(objHandle: HCkPem): Integer; stdcall;
Introduced in version 9.5.0.50

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

top
NumPrivateKeys
function CkPem_getNumPrivateKeys(objHandle: HCkPem): Integer; stdcall;
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
function CkPem_getNumPublicKeys(objHandle: HCkPem): Integer; stdcall;
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
procedure CkPem_getPrivateKeyFormat(objHandle: HCkPem; outPropVal: HCkString); stdcall;
procedure CkPem_putPrivateKeyFormat(objHandle: HCkPem; newPropVal: PWideChar); stdcall;
function CkPem__privateKeyFormat(objHandle: HCkPem): PWideChar; stdcall;
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
procedure CkPem_getPublicKeyFormat(objHandle: HCkPem; outPropVal: HCkString); stdcall;
procedure CkPem_putPublicKeyFormat(objHandle: HCkPem; newPropVal: PWideChar); stdcall;
function CkPem__publicKeyFormat(objHandle: HCkPem): PWideChar; stdcall;
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
function CkPem_getVerboseLogging(objHandle: HCkPem): wordbool; stdcall;
procedure CkPem_putVerboseLogging(objHandle: HCkPem; newPropVal: wordbool); stdcall;

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
Version
procedure CkPem_getVersion(objHandle: HCkPem; outPropVal: HCkString); stdcall;
function CkPem__version(objHandle: HCkPem): PWideChar; stdcall;

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

top

Methods

AddCert
function CkPem_AddCert(objHandle: HCkPem;
    cert: HCkCert;
    includeChain: wordbool): wordbool; stdcall;
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 True, then certificates in the cert's chain of authentication up to and including the root are automatically added.

Returns True for success, False for failure.

More Information and Examples
top
AddItem
function CkPem_AddItem(objHandle: HCkPem;
    itemType: PWideChar;
    encoding: PWideChar;
    itemData: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AddPrivateKey
function CkPem_AddPrivateKey(objHandle: HCkPem;
    privateKey: HCkPrivateKey): wordbool; stdcall;
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns True for success, False for failure.

top
AddPrivateKey2
function CkPem_AddPrivateKey2(objHandle: HCkPem;
    privKey: HCkPrivateKey;
    certChain: HCkCertChain): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
AddPublicKey
function CkPem_AddPublicKey(objHandle: HCkPem;
    pubkey: HCkPublicKey): wordbool; stdcall;
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns True for success, False for failure.

top
Clear
function CkPem_Clear(objHandle: HCkPem): wordbool; stdcall;
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns True for success, False for failure.

top
GetCert
function CkPem_GetCert(objHandle: HCkPem;
    index: Integer): HCkCert; stdcall;
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 CkPem_GetEncodedItem(objHandle: HCkPem;
    itemType: PWideChar;
    itemSubType: PWideChar;
    encoding: PWideChar;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkPem__getEncodedItem(objHandle: HCkPem;
    itemType: PWideChar;
    itemSubType: PWideChar;
    encoding: PWideChar;
    index: Integer): PWideChar; stdcall;
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 True for success, False for failure.

top
GetPrivateKey
function CkPem_GetPrivateKey(objHandle: HCkPem;
    index: Integer): HCkPrivateKey; stdcall;
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 CkPem_GetPublicKey(objHandle: HCkPem;
    index: Integer): HCkPublicKey; stdcall;
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 CkPem_LoadP7b(objHandle: HCkPem;
    p7bData: HCkByteData): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
LoadP7bAsync (1)
function CkPem_LoadP7bAsync(objHandle: HCkPem;
    p7bData: HCkByteData): HCkTask; stdcall;
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.)

Returns nil on failure

top
LoadP7bFile
function CkPem_LoadP7bFile(objHandle: HCkPem;
    path: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

More Information and Examples
top
LoadP7bFileAsync (1)
function CkPem_LoadP7bFileAsync(objHandle: HCkPem;
    path: PWideChar): HCkTask; stdcall;
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.)

Returns nil on failure

top
LoadPem
function CkPem_LoadPem(objHandle: HCkPem;
    pemContent: PWideChar;
    password: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
LoadPemAsync (1)
function CkPem_LoadPemAsync(objHandle: HCkPem;
    pemContent: PWideChar;
    password: PWideChar): HCkTask; stdcall;
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.)

Returns nil on failure

top
LoadPemFile
function CkPem_LoadPemFile(objHandle: HCkPem;
    path: PWideChar;
    password: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

More Information and Examples
top
LoadPemFileAsync (1)
function CkPem_LoadPemFileAsync(objHandle: HCkPem;
    path: PWideChar;
    password: PWideChar): HCkTask; stdcall;
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.)

Returns nil on failure

top
RemoveCert
function CkPem_RemoveCert(objHandle: HCkPem;
    index: Integer): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
RemovePrivateKey
function CkPem_RemovePrivateKey(objHandle: HCkPem;
    index: Integer): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
SaveLastError
function CkPem_SaveLastError(objHandle: HCkPem;
    path: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
ToJks
function CkPem_ToJks(objHandle: HCkPem;
    alias: PWideChar;
    password: PWideChar): HCkJavaKeyStore; stdcall;
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 CkPem_ToPem(objHandle: HCkPem;
    outStr: HCkString): wordbool; stdcall;
function CkPem__toPem(objHandle: HCkPem): PWideChar; stdcall;
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 True for success, False for failure.

top
ToPemEx
function CkPem_ToPemEx(objHandle: HCkPem;
    extendedAttrs: wordbool;
    noKeys: wordbool;
    noCerts: wordbool;
    noCaCerts: wordbool;
    encryptAlg: PWideChar;
    password: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkPem__toPemEx(objHandle: HCkPem;
    extendedAttrs: wordbool;
    noKeys: wordbool;
    noCerts: wordbool;
    noCaCerts: wordbool;
    encryptAlg: PWideChar;
    password: PWideChar): PWideChar; stdcall;
Introduced in version 9.5.0.49

Write the PFX to a PEM formatted string. If extendedAttrs is True, then extended properties (Bag Attributes and Key Attributes) are output. If noKeys is True, then no private keys are output. If noCerts is True, then no certificates are output. If noCaCerts is True, 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 True for success, False for failure.

top
ToPfx
function CkPem_ToPfx(objHandle: HCkPem): HCkPfx; stdcall;
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