Pem Perl Reference Documentation
CkPem
Current Version: 10.1.2
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 ([email protected]).
Object Creation
$obj = chilkat::CkPem->new();
Properties
AppendMode
$boolVal = $pem->get_AppendMode();
$pem->put_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.
topDebugLogFilePath
# $ckStr is a CkString
$pem->get_DebugLogFilePath($ckStr);
$strVal = $pem->debugLogFilePath();
$pem->put_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.
LastErrorHtml
# $ckStr is a CkString
$pem->get_LastErrorHtml($ckStr);
$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
# $ckStr is a CkString
$pem->get_LastErrorText($ckStr);
$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
# $ckStr is a CkString
$pem->get_LastErrorXml($ckStr);
$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
$boolVal = $pem->get_LastMethodSuccess();
$pem->put_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.
topNumCerts
$intVal = $pem->get_NumCerts();
The number of certificates in the loaded PEM. To get the 1st certificate, call GetCert(0).
NumCrls
$intVal = $pem->get_NumCrls();
The number of certificate revocation lists (CRLs) in the loaded PEM.
NumCsrs
$intVal = $pem->get_NumCsrs();
The number of certificate signing requests (CSRs) in the loaded PEM.
topNumPrivateKeys
$intVal = $pem->get_NumPrivateKeys();
The number of private keys in the loaded PEM. To get the 1st private key, call GetPrivateKey(0).
NumPublicKeys
$intVal = $pem->get_NumPublicKeys();
The number of public keys in the loaded PEM. To get the 1st public key, call GetPublicKey(0).
topPrivateKeyFormat
# $ckStr is a CkString
$pem->get_PrivateKeyFormat($ckStr);
$strVal = $pem->privateKeyFormat();
$pem->put_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
# $ckStr is a CkString
$pem->get_PublicKeyFormat($ckStr);
$strVal = $pem->publicKeyFormat();
$pem->put_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.
Utf8
$boolVal = $pem->get_Utf8();
$pem->put_Utf8($boolVal);
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
$boolVal = $pem->get_VerboseLogging();
$pem->put_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.
topVersion
Methods
AddCert
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 1 for success, 0 for failure.
AddItem
# $encoding is a string
# $itemData is a string
$status = $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 1 for success, 0 for failure.
topAddPrivateKey
Adds a private key to the PEM object.
Returns 1 for success, 0 for failure.
AddPrivateKey2
# $certChain is a CkCertChain
$status = $pem->AddPrivateKey2($privKey, $certChain);
Adds a private key and it's associated certificate chain to the PEM object.
Returns 1 for success, 0 for failure.
topAddPublicKey
Clear
GetCert
Returns the Nth certificate from the PEM. The first certificate is at index 0.
Returns null on failure
GetEncodedItem
# $itemSubType is a string
# $encoding is a string
# $index is an integer
# $outStr is a CkString (output)
$status = $pem->GetEncodedItem($itemType, $itemSubType, $encoding, $index, $outStr);
$retStr = $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 1 for success, 0 for failure.
topGetPrivateKey
Returns the Nth private key from the PEM. The first private key is at index 0.
Returns null on failure
GetPublicKey
Returns the Nth public key from the PEM. The first public key is at index 0.
Returns null on failure
topLoadP7b
Loads the PEM from the contents of an in-memory PKCS7 container (.p7b).
Returns 1 for success, 0 for failure.
topLoadP7bAsync (1)
Creates an asynchronous task to call the LoadP7b method with the arguments provided.
Returns null on failure
topLoadP7bFile
$status = $pem->LoadP7bFile($path);
Loads the contents of a PKCS7 container (.p7b file).
Returns 1 for success, 0 for failure.
LoadP7bFileAsync (1)
Creates an asynchronous task to call the LoadP7bFile method with the arguments provided.
Returns null on failure
topLoadPem
# $password is a string
$status = $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 1 for success, 0 for failure.
topLoadPemAsync (1)
# $pemContent is a string
# $password is a string
$ret_task = $pem->LoadPemAsync($pemContent, $password);
Creates an asynchronous task to call the LoadPem method with the arguments provided.
Returns null on failure
topLoadPemFile
# $password is a string
$status = $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 1 for success, 0 for failure.
LoadPemFileAsync (1)
# $path is a string
# $password is a string
$ret_task = $pem->LoadPemFileAsync($path, $password);
Creates an asynchronous task to call the LoadPemFile method with the arguments provided.
Returns null on failure
topLoadTaskCaller
RemoveCert
$status = $pem->RemoveCert($index);
Removes the Nth certificate from the PEM. The first certificate is at index 0.
Returns 1 for success, 0 for failure.
topRemovePrivateKey
$status = $pem->RemovePrivateKey($index);
Removes the Nth private key from the PEM. The first private key is at index 0.
Returns 1 for success, 0 for failure.
topToJks
# $alias is a string
# $password is a string
$ret_javaKeyStore = $pem->ToJks($alias, $password);
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
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 1 for success, 0 for failure.
topToPemEx
# $noKeys is a boolean
# $noCerts is a boolean
# $noCaCerts is a boolean
# $encryptAlg is a string
# $password is a string
# $outStr is a CkString (output)
$status = $pem->ToPemEx($extendedAttrs, $noKeys, $noCerts, $noCaCerts, $encryptAlg, $password, $outStr);
$retStr = $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 1 for success, 0 for failure.
topToPfx
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 null on failure