Pem Java Reference Documentation

CkPem

Current Version: 11.0.0

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

Object Creation

CkPem obj = new CkPem();

Properties

AppendMode
boolean get_AppendMode();
void put_AppendMode(boolean 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.

top
DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

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.

top
HeartbeatMs
int get_HeartbeatMs();
void put_HeartbeatMs(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.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

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.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

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.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

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.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean 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.

top
NumCerts
int get_NumCerts();
Introduced in version 9.5.0.49

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

top
NumCrls
int get_NumCrls();
Introduced in version 9.5.0.77

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

top
NumCsrs
int get_NumCsrs();
Introduced in version 9.5.0.50

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

top
NumPrivateKeys
int get_NumPrivateKeys();
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).

top
NumPublicKeys
int get_NumPublicKeys();
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
void get_PrivateKeyFormat(CkString str);
String privateKeyFormat();
void put_PrivateKeyFormat(String newVal);
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
void get_PublicKeyFormat(CkString str);
String publicKeyFormat();
void put_PublicKeyFormat(String newVal);
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.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean 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
Version
void get_Version(CkString str);
String version();

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

top

Methods

AddCert
boolean AddCert(CkCert cert, boolean 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.

top
AddItem
boolean AddItem(String itemType, String encoding, String 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.

top
AddP7b
boolean AddP7b(CkBinData 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.

top
AddPrivateKey
boolean AddPrivateKey(CkPrivateKey privateKey);
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns true for success, false for failure.

top
AddPrivateKey2
boolean AddPrivateKey2(CkPrivateKey privKey, CkCertChain 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.

top
AddPublicKey
boolean AddPublicKey(CkPublicKey pubkey);
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns true for success, false for failure.

top
CertAt
boolean CertAt(int index, CkCert 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.

top
Clear
boolean Clear();
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns true for success, false for failure.

top
GetEncodedItem
boolean GetEncodedItem(String itemType, String itemSubType, String encoding, int index, CkString outStr);
String getEncodedItem(String itemType, String itemSubType, String 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.

top
LoadP7b Deprecated
boolean LoadP7b(CkByteData 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.

top
LoadP7bFile
boolean LoadP7bFile(String path);
Introduced in version 9.5.0.49

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

Returns true for success, false for failure.

top
LoadPem
boolean LoadPem(String pemContent, String 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.

top
LoadPemFile
boolean LoadPemFile(String path, String 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.

top
LoadTaskCaller
boolean LoadTaskCaller(CkTask task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
PrivateKeyAt
boolean PrivateKeyAt(int index, CkPrivateKey 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.

top
PublicKeyAt
boolean PublicKeyAt(int index, CkPublicKey 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.

top
RemoveCert
boolean RemoveCert(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.

top
RemovePrivateKey
boolean RemovePrivateKey(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.

top
ToJksObj
boolean ToJksObj(String alias, String password, CkJavaKeyStore 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.

top
ToPem
boolean ToPem(CkString outStr);
String toPem();
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
boolean ToPemEx(boolean extendedAttrs, boolean noKeys, boolean noCerts, boolean noCaCerts, String encryptAlg, String password, CkString outStr);
String toPemEx(boolean extendedAttrs, boolean noKeys, boolean noCerts, boolean noCaCerts, String encryptAlg, String 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.

top
ToPfxObj
boolean ToPfxObj(CkPfx 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.

top

Deprecated

GetCert
CkCert GetCert(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 nil on failure

top
GetPrivateKey
CkPrivateKey GetPrivateKey(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 nil on failure

top
GetPublicKey
CkPublicKey GetPublicKey(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 nil on failure

top
ToJks
CkJavaKeyStore ToJks(String alias, String 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 nil on failure

top
ToPfx
CkPfx ToPfx();
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 nil on failure

top