Pem Dart Reference Documentation
CkPem
Current Version: 11.6.1
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
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final pem = CkPem();
// ... the native object is released when `pem` is garbage collected, or now with pem.dispose().Creates the underlying native Chilkat object. Use a CkPem only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
pem.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkPem.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
AppendMode
bool get appendMode
set appendMode(bool value)
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
String get debugLogFilePath
set debugLogFilePath(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.
HeartbeatMs
int get heartbeatMs
set heartbeatMs(int value)
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
String get 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
String get 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
String get 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
bool get lastMethodSuccess
set lastMethodSuccess(bool 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.
NumCerts
int get numCerts
The number of certificates in the loaded PEM. To get the 1st certificate, call GetCert(0).
NumCrls
int get numCrls
The number of certificate revocation lists (CRLs) in the loaded PEM.
NumCsrs
int get numCsrs
The number of certificate signing requests (CSRs) in the loaded PEM.
topNumPrivateKeys
int get numPrivateKeys
The number of private keys in the loaded PEM. To get the 1st private key, call GetPrivateKey(0).
NumPublicKeys
int get numPublicKeys
The number of public keys in the loaded PEM. To get the 1st public key, call GetPublicKey(0).
topPrivateKeyFormat
String get privateKeyFormat
set privateKeyFormat(String value)
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
String get publicKeyFormat
set publicKeyFormat(String value)
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
bool get verboseLogging
set verboseLogging(bool 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.
Version
String get 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 normally on success; throws a ChilkatException on failure.
AddItem
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 normally on success; throws a ChilkatException on failure.
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 normally on success; throws a ChilkatException on failure.
AddPrivateKey
Adds a private key to the PEM object.
Returns normally on success; throws a ChilkatException on failure.
AddPrivateKey2
Adds a private key and it's associated certificate chain to the PEM object.
Returns normally on success; throws a ChilkatException on failure.
AddPublicKey
Adds a public key to the PEM object.
Returns normally on success; throws a ChilkatException on failure.
CertAt
Returns in cert the Nth certificate from the PEM. The first certificate is at index 0.
Returns normally on success; throws a ChilkatException on failure.
Clear
Removes all content from this PEM object.
Returns normally on success; throws a ChilkatException on failure.
GetEncodedItem
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 a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
LoadP7bFile
Loads the contents of a PKCS7 container (.p7b file).
Returns normally on success; throws a ChilkatException on failure.
LoadPem
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 normally on success; throws a ChilkatException on failure.
LoadPemFile
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 normally on success; throws a ChilkatException on failure.
PrivateKeyAt
Returns in privKey the Nth private key from the PEM. The first private key is at index 0.
Returns normally on success; throws a ChilkatException on failure.
PublicKeyAt
Returns in pubKey the Nth public key from the PEM. The first public key is at index 0.
Returns normally on success; throws a ChilkatException on failure.
RemoveCert
Removes the Nth certificate from the PEM. The first certificate is at index 0.
Returns normally on success; throws a ChilkatException on failure.
RemovePrivateKey
Removes the Nth private key from the PEM. The first private key is at index 0.
Returns normally on success; throws a ChilkatException on failure.
ToJksObj
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 normally on success; throws a ChilkatException 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-----
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
ToPemEx
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 a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
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 normally on success; throws a ChilkatException on failure.