Pem Rust Reference Documentation

Pem

Current Version: 11.6.1
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

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::Pem;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let pem = Pem::new();
// ... the native object is freed when `pem` goes out of scope.
pub fn new() -> Pem

Creates the underlying native Chilkat object (Pem also implements Default). Every method takes &self, so the object never needs to be declared mut. A Pem is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for Pem

The native object is freed when the Pem is dropped — when it goes out of scope, or explicitly with drop(pem). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Pem>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match pem.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

AppendMode
// read/write
pub fn append_mode(&self) -> bool
pub fn set_append_mode(&self, value: bool)
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
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)

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
pub fn heartbeat_ms(&self) -> i32
pub fn set_heartbeat_ms(&self, value: i32)
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
pub fn last_error_html(&self) -> String

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
pub fn last_error_text(&self) -> String

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
pub fn last_error_xml(&self) -> String

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
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)

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
pub fn num_certs(&self) -> i32
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
pub fn num_crls(&self) -> i32
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
pub fn num_csrs(&self) -> i32
Introduced in version 9.5.0.50

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

top
NumPrivateKeys
// read-only
pub fn num_private_keys(&self) -> i32
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
pub fn num_public_keys(&self) -> i32
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
pub fn private_key_format(&self) -> String
pub fn set_private_key_format(&self, value: &str)
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
pub fn public_key_format(&self) -> String
pub fn set_public_key_format(&self, value: &str)
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
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)

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
pub fn version(&self) -> String

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
pub fn add_cert(&self, cert: &Cert, include_chain: bool) -> Result<()>
Introduced in version 9.5.0.49

Adds a certificate, and potentially the certs in its chain of authentication to the PEM. If include_chain is true, then certificates in the cert's chain of authentication up to and including the root are automatically added.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

More Information and Examples
Add Private Key and Certificate to a PEM
top
AddItem
pub fn add_item(&self, item_type: &str, encoding: &str, item_data: &str) -> Result<()>
Introduced in version 9.5.0.59

Adds a certificate, private key, public key, or csr to the PEM. The possible values for item_type 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 item_data contains the ASN.1 data in string format according to the encoding specified in encoding.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
AddP7b
pub fn add_p7b(&self, bd: &BinData) -> Result<()>
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 Ok(()) for success, Err(chilkat::Error) for failure.

top
AddPrivateKey
pub fn add_private_key(&self, private_key: &PrivateKey) -> Result<()>
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

More Information and Examples
Add Private Key and Certificate to a PEM
top
AddPrivateKey2
pub fn add_private_key2(&self, priv_key: &PrivateKey, cert_chain: &CertChain) -> Result<()>
Introduced in version 9.5.0.49

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

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
AddPublicKey
pub fn add_public_key(&self, pubkey: &PublicKey) -> Result<()>
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
CertAt
pub fn cert_at(&self, index: i32, cert: &Cert) -> Result<()>
Introduced in version 11.0.0

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

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
Clear
pub fn clear(&self) -> Result<()>
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
GetEncodedItem
pub fn get_encoded_item(&self, item_type: &str, item_sub_type: &str, encoding: &str, index: i32) -> Result<String>
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 item_type are certificate (or cert), privateKey, publicKey, or csr. Input string args are case-insensitive. If the item_type is privateKey, the item_sub_type may be der or pkcs8. If the item_type is publicKey, the item_sub_type may be der or pkcs1. The item_sub_type is ignored for other values of item_type. 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 Err(chilkat::Error) on failure.

top
LoadP7bFile
pub fn load_p7b_file(&self, path: &str) -> Result<()>
Introduced in version 9.5.0.49

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

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
LoadPem
pub fn load_pem(&self, pem_content: &str, password: &str) -> Result<()>
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 Ok(()) for success, Err(chilkat::Error) for failure.

top
LoadPemFile
pub fn load_pem_file(&self, path: &str, password: &str) -> Result<()>
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 Ok(()) for success, Err(chilkat::Error) for failure.

top
PrivateKeyAt
pub fn private_key_at(&self, index: i32, priv_key: &PrivateKey) -> Result<()>
Introduced in version 11.0.0

Returns in priv_key the Nth private key from the PEM. The first private key is at index 0.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
PublicKeyAt
pub fn public_key_at(&self, index: i32, pub_key: &PublicKey) -> Result<()>
Introduced in version 11.0.0

Returns in pub_key the Nth public key from the PEM. The first public key is at index 0.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
RemoveCert
pub fn remove_cert(&self, index: i32) -> Result<()>
Introduced in version 9.5.0.49

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

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
RemovePrivateKey
pub fn remove_private_key(&self, index: i32) -> Result<()>
Introduced in version 9.5.0.49

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

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top
ToJksObj
pub fn to_jks_obj(&self, alias_name: &str, password: &str, jks_obj: &JavaKeyStore) -> Result<()>
Introduced in version 11.0.0

This function converts this PEM to a Java KeyStore (JKS) object and stores it in jks_obj. If alias_name 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 Ok(()) for success, Err(chilkat::Error) for failure.

top
ToPem
pub fn to_pem(&self) -> Result<String>
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 Err(chilkat::Error) on failure.

top
ToPemEx
pub fn to_pem_ex(&self, extended_attrs: bool, no_keys: bool, no_certs: bool, no_ca_certs: bool, encrypt_alg: &str, password: &str) -> Result<String>
Introduced in version 9.5.0.49

Write the PFX to a PEM formatted string. If extended_attrs is true, then extended properties (Bag Attributes and Key Attributes) are output. If no_keys is true, then no private keys are output. If no_certs is true, then no certificates are output. If no_ca_certs is true, then no CA certs or intermediate CA certs are output. If encrypt_alg 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 encrypt_alg 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 Err(chilkat::Error) on failure.

top
ToPfxObj
pub fn to_pfx_obj(&self, pfx_obj: &Pfx) -> Result<()>
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 pfx_obj. Typically, a PKCS12 file includes one private key, its associated certificate, and the certificate chain.

Returns Ok(()) for success, Err(chilkat::Error) for failure.

top