Pem Chilkat2 Java Reference Documentation

Pem

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

Requires Chilkat Bundle License

Chilkat.Pem

Load, inspect, assemble, export, and convert PEM certificate and key material.

Chilkat.Pem is the Chilkat class for handling PEM-formatted certificate and key material. It can load PEM and PKCS#7 data, add certificates, private keys, public keys, CSRs, and certificate chains, retrieve individual items, remove content, control PKCS#1 vs. PKCS#8 private key output, export PEM with optional encryption and extended attributes, and convert PEM material to PFX or Java KeyStore objects.

Load PEM and PKCS#7

Load PEM-encoded certificates, keys, CSRs, and PKCS#7 certificate data from files, strings, or memory.

Collect certs and keys

Add certificates, private keys, public keys, CSRs, and certificate chains into a single PEM container.

Retrieve individual items

Extract selected certificates, keys, CSRs, or chains for use with Cert, PrivateKey, PublicKey, or related Chilkat classes.

Private-key format control

Choose PKCS#1 or PKCS#8 private-key output depending on the format required by the target system.

Encrypted PEM output

Export private-key material with password-based encryption when PEM data must be stored or transferred securely.

Convert to PFX or JKS

Convert PEM certificates and keys into PFX/P12 or Java KeyStore objects when another platform or API requires those container formats.

Common pattern: Use Pem when certificate and key material is packaged as one or more PEM blocks. Load the PEM, inspect or retrieve the needed items, add or remove entries as needed, then export the result as PEM, PFX/P12, or Java KeyStore data. Use Chilkat.Cert, PrivateKey, and PublicKey when working directly with individual objects.

For an extended overview, see Pem Class Overview.

Object Creation

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Pem;

try (Pem pem = new Pem()) {
    // ... use pem ...
} catch (ChilkatException e) {
    System.out.println(e.getMessage());          // "Pem.someMethod failed: <reason>"
    System.out.println(e.getLastErrorText());    // the full log of the failed call
}
public Pem()

Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).

public void close()

Releases the native object (Pem is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.

public boolean isClosed()

Returns true once close() has been called.

Errors

A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.

A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.

Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.

Properties

AppendMode
// read/write
boolean getAppendMode()
void setAppendMode(boolean value)
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
// read/write
String getDebugLogFilePath()
void setDebugLogFilePath(String value)

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.
top
HeartbeatMs
// read/write
int getHeartbeatMs()
void setHeartbeatMs(int value)
Introduced in version 9.5.0.49

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples
Event Callback Examples
top
LastErrorHtml
// read-only
String getLastErrorHtml()

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
// read-only
String getLastErrorText()

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 LastErrorTextLastErrorText Standard Information
top
LastErrorXml
// read-only
String getLastErrorXml()

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
// read/write
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)

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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
NumCerts
// read-only
int getNumCerts()
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
top
NumCrls
// read-only
int getNumCrls()
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
top
NumCsrs
// read-only
int getNumCsrs()
Introduced in version 9.5.0.50

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

top
NumPrivateKeys
// read-only
int getNumPrivateKeys()
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
top
NumPublicKeys
// read-only
int getNumPublicKeys()
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
// read/write
String getPrivateKeyFormat()
void setPrivateKeyFormat(String value)
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
// read/write
String getPublicKeyFormat()
void setPublicKeyFormat(String value)
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
top
VerboseLogging
// read/write
boolean getVerboseLogging()
void setVerboseLogging(boolean value)

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
// read-only
String getVersion()

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AddCert
void addCert(Cert 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

More Information and Examples
Add Private Key and Certificate to a PEM
top
AddItem
void 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
AddP7b
void addP7b(BinData 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
AddPrivateKey
void addPrivateKey(PrivateKey privateKey)
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

More Information and Examples
Add Private Key and Certificate to a PEM
top
AddPrivateKey2
void addPrivateKey2(PrivateKey privKey, CertChain certChain)
Introduced in version 9.5.0.49

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

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
AddPublicKey
void addPublicKey(PublicKey pubkey)
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
CertAt
void certAt(int index, Cert cert)
Introduced in version 11.0.0

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

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
Clear
void clear()
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

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

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
LoadP7bFile
void loadP7bFile(String path)
Introduced in version 9.5.0.49

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

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
LoadPem
void 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
LoadPemFile
void 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
PrivateKeyAt
void privateKeyAt(int index, PrivateKey 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
PublicKeyAt
void publicKeyAt(int index, PublicKey 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
RemoveCert
void removeCert(int index)
Introduced in version 9.5.0.49

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

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
RemovePrivateKey
void 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
ToJksObj
void toJksObj(String aliasName, String password, JavaKeyStore jksObj)
Introduced in version 11.0.0

This function converts this PEM to a Java KeyStore (JKS) object and stores it in jksObj. If aliasName 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
ToPem
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-----

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
ToPemEx
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-----

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
ToPfxObj
void toPfxObj(Pfx 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.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top