Pem C Reference Documentation

Pem

Current Version: 11.0.0

Requires Chilkat Bundle License

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

HCkPem instance = CkPem_Create();
// ...
CkPem_Dispose(instance);

HCkPem CkPem_Create(void);

Creates an instance of the HCkPem object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkPem_Dispose(HCkPem handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkPem_Dispose.

Properties

AppendMode

BOOL CkPem_getAppendMode(HCkPem cHandle);
void CkPem_putAppendMode(HCkPem cHandle, BOOL newVal);

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.

DebugLogFilePath

void CkPem_getDebugLogFilePath(HCkPem cHandle, HCkString retval);
void CkPem_putDebugLogFilePath(HCkPem cHandle, const char *newVal);
const char *CkPem_debugLogFilePath(HCkPem cHandle);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

int CkPem_getHeartbeatMs(HCkPem cHandle);
void CkPem_putHeartbeatMs(HCkPem cHandle, int newVal);

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.

LastErrorHtml

void CkPem_getLastErrorHtml(HCkPem cHandle, HCkString retval);
const char *CkPem_lastErrorHtml(HCkPem cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void CkPem_getLastErrorText(HCkPem cHandle, HCkString retval);
const char *CkPem_lastErrorText(HCkPem cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkPem_getLastErrorXml(HCkPem cHandle, HCkString retval);
const char *CkPem_lastErrorXml(HCkPem cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

BOOL CkPem_getLastMethodSuccess(HCkPem cHandle);
void CkPem_putLastMethodSuccess(HCkPem cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumCerts

int CkPem_getNumCerts(HCkPem cHandle);

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

Iterate Keys and Certs in PEM

NumCrls

int CkPem_getNumCrls(HCkPem cHandle);

Introduced in version 9.5.0.77

The number of certificate revocation lists (CRLs) in the loaded PEM.

More Information and Examples

Convert CRL PEM to XML

NumCsrs

int CkPem_getNumCsrs(HCkPem cHandle);

Introduced in version 9.5.0.50

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

NumPrivateKeys

int CkPem_getNumPrivateKeys(HCkPem cHandle);

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

Iterate Keys and Certs in PEM

NumPublicKeys

int CkPem_getNumPublicKeys(HCkPem cHandle);

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

PrivateKeyFormat

void CkPem_getPrivateKeyFormat(HCkPem cHandle, HCkString retval);
void CkPem_putPrivateKeyFormat(HCkPem cHandle, const char *newVal);
const char *CkPem_privateKeyFormat(HCkPem cHandle);

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.

PublicKeyFormat

void CkPem_getPublicKeyFormat(HCkPem cHandle, HCkString retval);
void CkPem_putPublicKeyFormat(HCkPem cHandle, const char *newVal);
const char *CkPem_publicKeyFormat(HCkPem cHandle);

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

Write PKCS1 or PKCS8 Public Key PEM

Utf8

BOOL CkPem_getUtf8(HCkPem cHandle);
void CkPem_putUtf8(HCkPem cHandle, BOOL newVal);

When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.

VerboseLogging

BOOL CkPem_getVerboseLogging(HCkPem cHandle);
void CkPem_putVerboseLogging(HCkPem 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.

Version

void CkPem_getVersion(HCkPem cHandle, HCkString retval);
const char *CkPem_version(HCkPem cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddCert

BOOL CkPem_AddCert(HCkPem cHandle, HCkCert cert, BOOL includeChain);

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

Add Private Key and Certificate to a PEM

AddItem

BOOL CkPem_AddItem(HCkPem cHandle, const char *itemType, const char *encoding, const char *itemData);

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.

AddP7b

BOOL CkPem_AddP7b(HCkPem cHandle, HCkBinData bd);

Introduced in version 11.0.0

Loads the PEM from the contents of an PKCS7 container (.p7b) contained in bd.

A .p7b (or .p7c) file contains a PKCS#7 container, which may include:

One or more X.509 certificates (a certificate chain)
Optionally, CRLs (Certificate Revocation Lists)
No private key

Common Use: Used to bundle intermediate and root certificates for things like SSL certificate chains.

Returns TRUE for success, FALSE for failure.

AddPrivateKey

BOOL CkPem_AddPrivateKey(HCkPem cHandle, HCkPrivateKey privateKey);

Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Add Private Key and Certificate to a PEM Duplicate openssl pkcs12 –export –in certfile.cer –inkey certfile.key –out certfile.pfx

AddPrivateKey2

BOOL CkPem_AddPrivateKey2(HCkPem cHandle, HCkPrivateKey privKey, HCkCertChain certChain);

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.

AddPublicKey

BOOL CkPem_AddPublicKey(HCkPem cHandle, HCkPublicKey pubkey);

Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns TRUE for success, FALSE for failure.

CertAt

BOOL CkPem_CertAt(HCkPem cHandle, int index, HCkCert cert);

Introduced in version 11.0.0

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

Returns TRUE for success, FALSE for failure.

Clear

BOOL CkPem_Clear(HCkPem cHandle);

Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns TRUE for success, FALSE for failure.

GetEncodedItem

BOOL CkPem_GetEncodedItem(HCkPem cHandle, const char *itemType, const char *itemSubType, const char *encoding, int index, HCkString outStr);
const char *CkPem_getEncodedItem(HCkPem cHandle, const char *itemType, const char *itemSubType, const char *encoding, int index);

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.

LoadP7b Deprecated

BOOL CkPem_LoadP7b(HCkPem cHandle, HCkByteData p7bData);

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.

LoadP7bFile

BOOL CkPem_LoadP7bFile(HCkPem cHandle, const char *path);

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

Load P7B and List Certificates

LoadPem

BOOL CkPem_LoadPem(HCkPem cHandle, const char *pemContent, const char *password);

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.

LoadPemFile

BOOL CkPem_LoadPemFile(HCkPem cHandle, const char *path, const char *password);

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

Load PEM and List Certificates

LoadTaskCaller

BOOL CkPem_LoadTaskCaller(HCkPem cHandle, HCkTask task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

PrivateKeyAt

BOOL CkPem_PrivateKeyAt(HCkPem cHandle, int index, HCkPrivateKey privKey);

Introduced in version 11.0.0

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

Returns TRUE for success, FALSE for failure.

PublicKeyAt

BOOL CkPem_PublicKeyAt(HCkPem cHandle, int index, HCkPublicKey pubKey);

Introduced in version 11.0.0

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

Returns TRUE for success, FALSE for failure.

RemoveCert

BOOL CkPem_RemoveCert(HCkPem cHandle, int index);

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.

RemovePrivateKey

BOOL CkPem_RemovePrivateKey(HCkPem cHandle, int index);

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.

ToJksObj

BOOL CkPem_ToJksObj(HCkPem cHandle, const char *alias, const char *password, HCkJavaKeyStore jksObj);

Introduced in version 11.0.0

This function converts this PEM to a Java KeyStore (JKS) object and stores it in jksObj. If alias is provided, it will be used as the alias for the first object in the PEM (either a private key or certificate), while subsequent objects will receive autogenerated aliases. The resulting JKS will be encrypted with password, unless the PEM contains only certificates, in which case password is not used.

Returns TRUE for success, FALSE for failure.

ToPem

BOOL CkPem_ToPem(HCkPem cHandle, HCkString outStr);
const char *CkPem_toPem(HCkPem cHandle);

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.

ToPemEx

BOOL CkPem_ToPemEx(HCkPem cHandle, BOOL extendedAttrs, BOOL noKeys, BOOL noCerts, BOOL noCaCerts, const char *encryptAlg, const char *password, HCkString outStr);
const char *CkPem_toPemEx(HCkPem cHandle, BOOL extendedAttrs, BOOL noKeys, BOOL noCerts, BOOL noCaCerts, const char *encryptAlg, const char *password);

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.

ToPfxObj

BOOL CkPem_ToPfxObj(HCkPem cHandle, HCkPfx pfxObj);

Introduced in version 11.0.0

Converts this PEM object, which must contain at least one private key, to PKCS12 and returns the PFX in pfxObj. Typically, a PKCS12 file includes one private key, its associated certificate, and the certificate chain.

Returns TRUE for success, FALSE for failure.

Deprecated

GetCert

HCkCert CkPem_GetCert(HCkPem cHandle, int index);

Introduced in version 9.5.0.49

This method is deprecated.

This method is deprecated. Applications should instead call CertAt.

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

Returns NULL on failure

More Information and Examples

Load Encrypted PEM Containing ECC Private Key and Certs and Examine Contents

GetPrivateKey

HCkPrivateKey CkPem_GetPrivateKey(HCkPem cHandle, int index);

Introduced in version 9.5.0.49

This method is deprecated.

This method is deprecated. Applications should instead call PrivateKeyAt.

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

Returns NULL on failure

More Information and Examples

Load Encrypted PEM Containing ECC Private Key and Certs and Examine Contents

GetPublicKey

HCkPublicKey CkPem_GetPublicKey(HCkPem cHandle, int index);

Introduced in version 9.5.0.49

This method is deprecated.

This method is deprecated. Applications should instead call PublicKeyAt.

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

Returns NULL on failure

ToJks

HCkJavaKeyStore CkPem_ToJks(HCkPem cHandle, const char *alias, const char *password);

Introduced in version 9.5.0.49

This method is deprecated.

Applications should instead call ToJksObj.

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

More Information and Examples

Convert PEM to JKS (Java KeyStore)

ToPfx

HCkPfx CkPem_ToPfx(HCkPem cHandle);

Introduced in version 9.5.0.49

This method is deprecated.

Applications should instead call ToPfxObj.

Converts this PEM object, which must contain at least one private key, to PKCS12 and returns the PFX object. Typically, a PKCS12 file includes one private key, its associated certificate, and the certificate chain.

Returns NULL on failure

More Information and Examples

Convert PEM to PKCS12 / PFX