@chilkat/react-native 11.6.1

package/src/specs/XmlCertVault.nitro.ts

@@ -0,0 +1,259 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { Cert } from './Cert.nitro'
+import type { CertChain } from './CertChain.nitro'
+import type { Pfx } from './Pfx.nitro'
+
+/**
+ * Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.
+ *
+ * `XmlCertVault` stores certificates and private-key
+ * material in a portable XML-based certificate vault. It can add individual
+ * certificates, certificate chains, DER or encoded certificates, PEM files,
+ * certificate strings, and PFX/PKCS12 data from files, memory, encoded text, or
+ * existing Chilkat objects. The vault can then be exported as XML, loaded from
+ * XML, or saved to an XML file for later reuse by other Chilkat certificate and
+ * TLS workflows.
+ *
+ * **Add certificates**
+ *
+ * Add certificates from `Cert` objects, files, PEM strings,
+ * binary DER bytes, or encoded data such as Base64 or hex.
+ *
+ * **Add certificate chains**
+ *
+ * Import an entire `CertChain` when related issuer and
+ * intermediate certificates should be kept together in the vault.
+ *
+ * **Add PEM content**
+ *
+ * Load PEM files containing one or more certificates and/or private keys,
+ * including encrypted PEM content when a password is supplied.
+ *
+ * **Add PFX / PKCS12**
+ *
+ * Add PFX data from a `Pfx` object, file, byte array, or encoded
+ * string, using the PFX password to import private-key material.
+ *
+ * **Master password protection**
+ *
+ * Use `MasterPassword` to protect access to private keys stored
+ * in the vault.
+ *
+ * **Load and save XML**
+ *
+ * Export the vault with `GetXml`, load it with
+ * `LoadXml` or `LoadXmlFile`, and persist it with
+ * `SaveXml`.
+ *
+ * **Common pattern:**
+ * Create an `XmlCertVault`, set `MasterPassword` when the
+ * vault will contain private keys, add certificates or PFX/PEM material, then
+ * save the vault with `SaveXml` or keep the XML string from
+ * `GetXml`. Later, reload the same vault with `LoadXml`
+ * or `LoadXmlFile` and provide the same master password before using
+ * private keys.
+ *
+ * **Security note:**
+ * Certificates are stored unencrypted, but private keys are stored using
+ * 256-bit AES encryption. The individual PFX passwords are also stored
+ * encrypted with the vault's `MasterPassword`, which is required to
+ * access any private keys contained in the XML vault.
+ *
+ * Each `XmlCertVault` 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 XmlCertVault()`.
+ */
+export interface XmlCertVault 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
+
+  /**
+   * The master password for the vault. Certificates are stored unencrypted, but private keys are
+   * stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored
+   * 256-bit AES encrypted using the master password. The master password is required to acces any
+   * of the private keys stored within the XML vault.
+   */
+  masterPassword: string
+
+  // ---- Methods ----
+
+  /**
+   * Adds a certificate to the XML vault.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addCert(cert: Cert): void
+
+  /**
+   * Adds a chain of certificates  to the XML vault.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addCertChain(certChain: CertChain): void
+
+  /**
+   * Adds a certificate to the XML vault where certificate is passed directly from encoded bytes
+   * (such as Base64, Hex, etc.). The encoding is indicated by `encoding`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addCertEncoded(encodedBytes: string, encoding: string): void
+
+  /**
+   * Adds a certificate to the XML vault.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addCertFile(path: string): void
+
+  /**
+   * Adds a certificate from any string representation format such as PEM.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addCertString(certData: string): void
+
+  /**
+   * Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may
+   * contain one or more certificates and/or private keys. The password is optional and only
+   * required if the PEM file contains encrypted content that requires a password.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addPemFile(path: string, password: string): void
+
+  /**
+   * Adds a PFX (PKCS12)  to the XML vault.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addPfx(pfx: Pfx): void
+
+  /**
+   * Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64,
+   * Hex, etc.). The encoding is indicated by `encoding`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addPfxEncoded(encodedBytes: string, encoding: string, password: string): void
+
+  /**
+   * Adds a PFX file to the XML vault.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  addPfxFile(path: string, password: string): void
+
+  /**
+   * Returns the contents of the cert vault as an XML string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  getXml(): string
+
+  /**
+   * Loads from an XML string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  loadXml(xml: string): void
+
+  /**
+   * Loads from an XML file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  loadXmlFile(path: string): void
+
+  /**
+   * Saves the contents to an XML file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link XmlCertVault.lastErrorText}.
+   */
+  saveXml(path: string): void
+}