Pem Ruby 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
obj = Chilkat::CkPem.new()
Properties
AppendMode
boolVal = pem.get_AppendMode();
pem.put_AppendMode(boolVal);
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
# 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: 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
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.
VerboseLogging
boolVal = pem.get_VerboseLogging();
pem.put_VerboseLogging(boolVal);
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
Methods
AddCert
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.
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 true for success, false for failure.
topAddP7b
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.
topAddPrivateKey
Adds a private key to the PEM object.
Returns true for success, false 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 true for success, false for failure.
topAddPublicKey
CertAt
Returns in cert the Nth certificate from the PEM. The first certificate is at index 0.
Returns true for success, false for failure.
topClear
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 true for success, false for failure.
topLoadP7b Deprecated
Loads the PEM from the contents of an in-memory PKCS7 container (.p7b).
Returns true for success, false for failure.
topLoadP7bFile
status = pem.LoadP7bFile(path);
Loads the contents of a PKCS7 container (.p7b file).
Returns true for success, false for failure.
LoadPem
# 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 true for success, false for 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 true for success, false for failure.
LoadTaskCaller
PrivateKeyAt
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.
topPublicKeyAt
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.
topRemoveCert
status = pem.RemoveCert(index);
Removes the Nth certificate from the PEM. The first certificate is at index 0.
Returns true for success, false for failure.
topRemovePrivateKey
status = pem.RemovePrivateKey(index);
Removes the Nth private key from the PEM. The first private key is at index 0.
Returns true for success, false for failure.
topToJksObj
# password is a string
# jksObj is a CkJavaKeyStore
status = pem.ToJksObj(alias, password, jksObj);
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.
topToPem
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.
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 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.
topToPfxObj
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.
topDeprecated
GetCert
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
GetPrivateKey
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
GetPublicKey
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
ToJks
# alias is a string
# password is a string
ret_javaKeyStore = pem.ToJks(alias, password);
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
ToPfx
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