Pem React Native Reference Documentation

Pem

Current Version: 11.6.1

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.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, Pem } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const pem = new Pem()
// ... the native object is released when `pem` is garbage collected, or now with pem.dispose()
new Pem()

Creates the underlying native Chilkat object. Pem is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: 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 error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  pem.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // Pem.someMethod(...): <reason>
  console.log(pem.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await pem.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // Pem.someMethodAsync: <reason>
}

Properties

AppendMode
// read/write
appendMode: boolean
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
debugLogFilePath: string

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
top
HeartbeatMs
// read/write
heartbeatMs: number
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
top
LastErrorHtml
// read-only
readonly lastErrorHtml: 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
readonly lastErrorText: 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.

top
LastErrorXml
// read-only
readonly lastErrorXml: 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
lastMethodSuccess: boolean

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
readonly numCerts: number
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
top
NumCrls
// read-only
readonly numCrls: number
Introduced in version 9.5.0.77

The number of certificate revocation lists (CRLs) in the loaded PEM.

More Information and Examples
top
NumCsrs
// read-only
readonly numCsrs: number
Introduced in version 9.5.0.50

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

top
NumPrivateKeys
// read-only
readonly numPrivateKeys: number
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
top
NumPublicKeys
// read-only
readonly numPublicKeys: number
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
privateKeyFormat: string
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
publicKeyFormat: string
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
top
VerboseLogging
// read/write
verboseLogging: boolean

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
readonly version: string

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddCert
addCert(cert: Cert, includeChain: boolean): void
Introduced in version 9.5.0.49

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 an Error on failure.

More Information and Examples
top
AddItem
addItem(itemType: string, encoding: string, itemData: string): void
Introduced in version 9.5.0.59

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 an Error on failure.

top
AddP7b
addP7b(bd: BinData): void
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 normally on success; throws an Error on failure.

top
AddPrivateKey
addPrivateKey(privateKey: PrivateKey): void
Introduced in version 9.5.0.49

Adds a private key to the PEM object.

Returns normally on success; throws an Error on failure.

More Information and Examples
top
AddPrivateKey2
addPrivateKey2(privKey: PrivateKey, certChain: CertChain): void
Introduced in version 9.5.0.49

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

Returns normally on success; throws an Error on failure.

top
AddPublicKey
addPublicKey(pubkey: PublicKey): void
Introduced in version 9.5.0.49

Adds a public key to the PEM object.

Returns normally on success; throws an Error on failure.

top
CertAt
certAt(index: number, cert: Cert): void
Introduced in version 11.0.0

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

Returns normally on success; throws an Error on failure.

top
Clear
clear(): void
Introduced in version 9.5.0.49

Removes all content from this PEM object.

Returns normally on success; throws an Error on failure.

top
GetEncodedItem
getEncodedItem(itemType: string, itemSubType: string, encoding: string, index: number): 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 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 an Error on failure (where the description says null is returned, the method throws instead).

top
LoadP7bFile
loadP7bFile(path: string): void
Introduced in version 9.5.0.49

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

Returns normally on success; throws an Error on failure.

top
LoadPem
loadPem(pemContent: string, password: string): void
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 normally on success; throws an Error on failure.

top
LoadPemFile
loadPemFile(path: string, password: string): void
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 normally on success; throws an Error on failure.

top
PrivateKeyAt
privateKeyAt(index: number, privKey: PrivateKey): void
Introduced in version 11.0.0

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

Returns normally on success; throws an Error on failure.

top
PublicKeyAt
publicKeyAt(index: number, pubKey: PublicKey): void
Introduced in version 11.0.0

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

Returns normally on success; throws an Error on failure.

top
RemoveCert
removeCert(index: number): void
Introduced in version 9.5.0.49

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

Returns normally on success; throws an Error on failure.

top
RemovePrivateKey
removePrivateKey(index: number): void
Introduced in version 9.5.0.49

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

Returns normally on success; throws an Error on failure.

top
ToJksObj
toJksObj(aliasName: string, password: string, jksObj: JavaKeyStore): void
Introduced in version 11.0.0

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 an Error on failure.

top
ToPem
toPem(): 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----- 

Throws an Error on failure (where the description says null is returned, the method throws instead).

top
ToPemEx
toPemEx(extendedAttrs: boolean, noKeys: boolean, noCerts: boolean, noCaCerts: boolean, encryptAlg: string, password: string): string
Introduced in version 9.5.0.49

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 an Error on failure (where the description says null is returned, the method throws instead).

top
ToPfxObj
toPfxObj(pfxObj: Pfx): void
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 pfxObj. Typically, a PKCS12 file includes one private key, its associated certificate, and the certificate chain.

Returns normally on success; throws an Error on failure.

top