Pem Chilkat2 Perl Reference Documentation
Chilkat2::Pem
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Pem
Load PEM-encoded certificates, keys, CSRs, and PKCS#7 certificate data
from files, strings, or memory.
Add certificates, private keys, public keys, CSRs, and certificate chains
into a single PEM container.
Extract selected certificates, keys, CSRs, or chains for use with
Choose PKCS#1 or PKCS#8 private-key output depending on the format
required by the target system.
Export private-key material with password-based encryption when PEM data
must be stored or transferred securely.
Convert PEM certificates and keys into PFX/P12 or Java KeyStore objects
when another platform or API requires those container formats.
For an extended overview, see
Pem Class Overview.
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
Collect certs and keys
Retrieve individual items
Cert, PrivateKey, PublicKey, or
related Chilkat classes.
Private-key format control
Encrypted PEM output
Convert to PFX or JKS
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.
Object Creation
use Chilkat2;
my $pem = Chilkat2::Pem->new;
# or set properties (and RaiseError) at creation:
# my $pem = Chilkat2::Pem->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/Pem.pm file holds only this class's documentation (perldoc Chilkat2::Pem).
Perl frees the object when its last reference goes (undef $pem, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::Pem';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::Pem'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
AppendMode
my $boolVal = $pem->AppendMode;
$pem->AppendMode($boolVal);
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.
DebugLogFilePath
my $strVal = $pem->DebugLogFilePath;
$pem->DebugLogFilePath($strVal);
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.
HeartbeatMs
my $intVal = $pem->HeartbeatMs;
$pem->HeartbeatMs($intVal);
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.
LastErrorHtml
my $strVal = $pem->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.
topLastErrorText
my $strVal = $pem->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.
LastErrorXml
my $strVal = $pem->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.
topLastMethodSuccess
my $boolVal = $pem->LastMethodSuccess;
$pem->LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
NumCerts
my $intVal = $pem->NumCerts;
The number of certificates in the loaded PEM. To get the 1st certificate, call GetCert(0).
NumCrls
my $intVal = $pem->NumCrls;
The number of certificate revocation lists (CRLs) in the loaded PEM.
NumCsrs
my $intVal = $pem->NumCsrs;
The number of certificate signing requests (CSRs) in the loaded PEM.
topNumPrivateKeys
my $intVal = $pem->NumPrivateKeys;
The number of private keys in the loaded PEM. To get the 1st private key, call GetPrivateKey(0).
NumPublicKeys
my $intVal = $pem->NumPublicKeys;
The number of public keys in the loaded PEM. To get the 1st public key, call GetPublicKey(0).
topPrivateKeyFormat
my $strVal = $pem->PrivateKeyFormat;
$pem->PrivateKeyFormat($strVal);
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
my $strVal = $pem->PublicKeyFormat;
$pem->PublicKeyFormat($strVal);
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.
VerboseLogging
my $boolVal = $pem->VerboseLogging;
$pem->VerboseLogging($boolVal);
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.
Version
my $strVal = $pem->Version;
Methods
AddCert
# $includeChain is a boolean
# $success is true or false
my $success = $pem->AddCert($cert, $includeChain);
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 true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddItem
# $encoding is a string
# $itemData is a string
# $success is true or false
my $success = $pem->AddItem($itemType, $encoding, $itemData);
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 on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddP7b
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 on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddPrivateKey
# $success is true or false
my $success = $pem->AddPrivateKey($privateKey);
Adds a private key to the PEM object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddPrivateKey2
# $certChain is a Chilkat2::CertChain
# $success is true or false
my $success = $pem->AddPrivateKey2($privKey, $certChain);
Adds a private key and it's associated certificate chain to the PEM object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddPublicKey
# $success is true or false
my $success = $pem->AddPublicKey($pubkey);
Adds a public key to the PEM object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
CertAt
# $cert is a Chilkat2::Cert
# $success is true or false
my $success = $pem->CertAt($index, $cert);
Returns in $cert the Nth certificate from the PEM. The first certificate is at index 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Clear
my $success = $pem->Clear();
Removes all content from this PEM object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetEncodedItem
# $itemSubType is a string
# $encoding is a string
# $index is an integer
# $str is a string or undef
my $str = $pem->GetEncodedItem($itemType, $itemSubType, $encoding, $index);
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 undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadP7bFile
# $success is true or false
my $success = $pem->LoadP7bFile($path);
Loads the contents of a PKCS7 container (.p7b file).
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadPem
# $password is a string
# $success is true or false
my $success = $pem->LoadPem($pemContent, $password);
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 on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadPemFile
# $password is a string
# $success is true or false
my $success = $pem->LoadPemFile($path, $password);
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 on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
PrivateKeyAt
# $privKey is a Chilkat2::PrivateKey
# $success is true or false
my $success = $pem->PrivateKeyAt($index, $privKey);
Returns in $privKey the Nth private key from the PEM. The first private key is at index 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
PublicKeyAt
# $pubKey is a Chilkat2::PublicKey
# $success is true or false
my $success = $pem->PublicKeyAt($index, $pubKey);
Returns in $pubKey the Nth public key from the PEM. The first public key is at index 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveCert
# $success is true or false
my $success = $pem->RemoveCert($index);
Removes the Nth certificate from the PEM. The first certificate is at index 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemovePrivateKey
# $success is true or false
my $success = $pem->RemovePrivateKey($index);
Removes the Nth private key from the PEM. The first private key is at index 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToJksObj
# $password is a string
# $jksObj is a Chilkat2::JavaKeyStore
# $success is true or false
my $success = $pem->ToJksObj($aliasName, $password, $jksObj);
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.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToPem
my $str = $pem->ToPem();
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 undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToPemEx
# $noKeys is a boolean
# $noCerts is a boolean
# $noCaCerts is a boolean
# $encryptAlg is a string
# $password is a string
# $str is a string or undef
my $str = $pem->ToPemEx($extendedAttrs, $noKeys, $noCerts, $noCaCerts, $encryptAlg, $password);
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 undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToPfxObj
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 on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.