@chilkat/react-native 11.6.1

package/src/specs/Pem.nitro.ts

@@ -0,0 +1,484 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { Cert } from './Cert.nitro'
+import type { CertChain } from './CertChain.nitro'
+import type { JavaKeyStore } from './JavaKeyStore.nitro'
+import type { Pfx } from './Pfx.nitro'
+import type { PrivateKey } from './PrivateKey.nitro'
+import type { PublicKey } from './PublicKey.nitro'
+
+/**
+ * Load, inspect, assemble, export, and convert PEM certificate and key material.
+ *
+ * `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](https://www.chilkatsoft.com/pem_class_overview.asp).
+ *
+ * Each `Pem` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new Pem()`.
+ */
+export interface Pem extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: 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.
+   */
+  debugLogFilePath: string
+
+  /**
+   * 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.
+   */
+  verboseLogging: 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.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * 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`.
+   */
+  appendMode: boolean
+
+  /**
+   * 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.**
+   */
+  heartbeatMs: number
+
+  /**
+   * The number of certificates in the loaded PEM.  To get the 1st certificate, call GetCert(0).
+   *
+   * This property is read-only.
+   */
+  readonly numCerts: number
+
+  /**
+   * The number of certificate signing requests (CSRs)  in the loaded PEM.
+   *
+   * This property is read-only.
+   */
+  readonly numCsrs: number
+
+  /**
+   * The number of private keys in the loaded PEM. To get the 1st private key, call
+   * GetPrivateKey(0).
+   *
+   * This property is read-only.
+   */
+  readonly numPrivateKeys: number
+
+  /**
+   * The number of public keys in the loaded PEM.  To get the 1st public key, call GetPublicKey(0).
+   *
+   * This property is read-only.
+   */
+  readonly numPublicKeys: number
+
+  /**
+   * 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.
+   */
+  privateKeyFormat: string
+
+  /**
+   * 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.
+   */
+  publicKeyFormat: string
+
+  /**
+   * The number of certificate revocation lists (CRLs)  in the loaded PEM.
+   *
+   * This property is read-only.
+   */
+  readonly numCrls: number
+
+  // ---- Methods ----
+
+  /**
+   * 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.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addCert(cert: Cert, includeChain: boolean): void
+
+  /**
+   * Adds a private key to the PEM object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addPrivateKey(privateKey: PrivateKey): void
+
+  /**
+   * Adds a private key and it's associated certificate chain to the PEM object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addPrivateKey2(privKey: PrivateKey, certChain: CertChain): void
+
+  /**
+   * Adds a public key to the PEM object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addPublicKey(pubkey: PublicKey): void
+
+  /**
+   * Removes all content from this PEM object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  clear(): void
+
+  /**
+   * 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 Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  getEncodedItem(itemType: string, itemSubType: string, encoding: string, index: number): string
+
+  /**
+   * Loads the contents of a PKCS7 container (.p7b file).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  loadP7bFile(path: string): void
+
+  /**
+   * 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`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  loadPem(pemContent: string, password: string): void
+
+  /**
+   * 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`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  loadPemFile(path: string, password: string): void
+
+  /**
+   * Removes  the Nth certificate from the PEM.  The first certificate is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  removeCert(index: number): void
+
+  /**
+   * Removes  the Nth private key from the PEM.  The first private key is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  removePrivateKey(index: number): void
+
+  /**
+   * 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 Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  toPem(): string
+
+  /**
+   * 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:
+   *     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 Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  toPemEx(extendedAttrs: boolean, noKeys: boolean, noCerts: boolean, noCaCerts: boolean, encryptAlg: string, password: string): string
+
+  /**
+   * 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`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addItem(itemType: string, encoding: string, itemData: string): void
+
+  /**
+   * Returns in `cert` the Nth certificate from the PEM.  The first certificate is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  certAt(index: number, cert: Cert): void
+
+  /**
+   * Returns in `privKey` the Nth private key from the PEM.  The first private key is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  privateKeyAt(index: number, privKey: PrivateKey): void
+
+  /**
+   * Returns in `pubKey` the Nth public key  from the PEM.  The first public key is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  publicKeyAt(index: number, pubKey: PublicKey): void
+
+  /**
+   * 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.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  toJksObj(aliasName: string, password: string, jksObj: JavaKeyStore): void
+
+  /**
+   * 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.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  toPfxObj(pfxObj: Pfx): void
+
+  /**
+   * 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.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Pem.lastErrorText}.
+   */
+  addP7b(bd: BinData): void
+}