@chilkat/react-native 11.6.1

package/src/specs/DtObj.nitro.ts

@@ -0,0 +1,198 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Represent a date/time as simple editable fields.
+ *
+ * `DtObj` is a lightweight date/time value object used by
+ * Chilkat methods that need to pass or return individual date and time fields.
+ * It stores values such as year, month, day, hour, minute, and second, along
+ * with a flag indicating whether the value represents UTC or local time. It
+ * also provides a compact serialization format for saving and restoring the
+ * date/time value.
+ *
+ * **Simple date fields**
+ *
+ * Store and edit the year, month, day, hour, minute, and second as
+ * individual properties.
+ *
+ * **UTC or local time**
+ *
+ * Use the UTC flag to indicate whether the stored fields represent UTC or
+ * local time.
+ *
+ * **Struct tm compatibility**
+ *
+ * Use alternate month and year properties when working with
+ * `struct tm`-style date/time conventions.
+ *
+ * **Serialize and restore**
+ *
+ * Save and restore the object using Chilkat's compact internal serialized
+ * date/time representation.
+ *
+ * **Used by other classes**
+ *
+ * Pass `DtObj` values to Chilkat methods that require explicit
+ * date/time fields or return date/time information.
+ *
+ * **Small and focused**
+ *
+ * Use this class as a simple container rather than a full date/time
+ * calculation or timezone-conversion engine.
+ *
+ * **Common pattern:**
+ * Create or receive a `DtObj`, set or read the individual date/time
+ * fields, check whether the value is UTC or local time, and pass the object to
+ * another Chilkat method. Use serialization only when the date/time value needs
+ * to be saved and restored in Chilkat's compact internal format.
+ *
+ * For an extended overview, see
+ * [DtObj Class Overview](https://www.chilkatsoft.com/dtobj_class_overview.asp).
+ *
+ * Each `DtObj` 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 DtObj()`.
+ */
+export interface DtObj 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 day of the month. The valid values for this member are 1 through 31.
+   */
+  day: number
+
+  /**
+   * The hour. The valid values for this member are 0 through 23.
+   */
+  hour: number
+
+  /**
+   * The minute. The valid values for this member are 0 through 59.
+   */
+  minute: number
+
+  /**
+   * The month. The valid values for this member are 1 through 12 where 1 = January and 12 =
+   * December.
+   */
+  month: number
+
+  /**
+   * The second. The valid values for this member are 0 through 59.
+   */
+  second: number
+
+  /**
+   * The month. The valid values for this member are 0 through 11 where 0 = January and 11 =
+   * December.
+   */
+  structTmMonth: number
+
+  /**
+   * The year represented as the number of years since 1900.
+   */
+  structTmYear: number
+
+  /**
+   * `true` if this is a UTC time, otherwise `false` if this is a local time.
+   */
+  utc: boolean
+
+  /**
+   * The year, such as 2012.
+   */
+  year: number
+
+  // ---- Methods ----
+
+  /**
+   * Loads the date/time with a string having the format as produced by the Serialize method, which
+   * is a string of SPACE separated integers containing (in this order) year, month, day, hour,
+   * minutes, seconds, and a UTC flag having the value of 1/0.
+   */
+  deSerialize(serializedDtObj: string): void
+
+  /**
+   * Serializes the date/time to a us-ascii string that can be imported at a later time via the
+   * DeSerialize method. The format of the string returned by this method is not intended to match
+   * any published standard. It is formatted to a string with SPACE separated integers containing
+   * (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of
+   * 1/0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link DtObj.lastErrorText}.
+   */
+  serialize(): string
+}

package/src/specs/Ecc.nitro.ts

@@ -0,0 +1,375 @@
+// 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 { PrivateKey } from './PrivateKey.nitro'
+import type { Prng } from './Prng.nitro'
+import type { PublicKey } from './PublicKey.nitro'
+
+/**
+ * Generate EC keys, create ECDSA signatures, verify signatures, and compute shared secrets.
+ *
+ * `Ecc` is the Chilkat class for direct elliptic-curve
+ * cryptographic operations. It can generate EC private keys, sign hashes or
+ * data using ECDSA, verify ECDSA signatures, sign through ECDSA certificates,
+ * and compute encoded shared secrets from compatible EC key pairs. It is used
+ * when an application needs explicit control over elliptic-curve keys,
+ * signatures, signature encoding, or key-agreement output.
+ *
+ * **Generate EC private keys**
+ *
+ * Create elliptic-curve private keys for supported curves and use the
+ * resulting key with Chilkat signing, verification, or key-agreement APIs.
+ *
+ * **ECDSA signing**
+ *
+ * Sign hashes or input data using an EC private key, producing ECDSA
+ * signatures in the configured output format.
+ *
+ * **ECDSA verification**
+ *
+ * Verify ECDSA signatures using the matching EC public key and the original
+ * hash or data.
+ *
+ * **Certificate-based signing**
+ *
+ * Sign with an ECDSA certificate when the certificate has access to its
+ * associated private key.
+ *
+ * **Shared-secret calculation**
+ *
+ * Compute an encoded shared secret from compatible EC private and public
+ * keys for key-agreement workflows.
+ *
+ * **Signature format control**
+ *
+ * Use `AsnFormat` to control whether ECDSA signatures are
+ * encoded as ASN.1/DER or as raw `r || s` values.
+ *
+ * **Common pattern:**
+ * Generate or load an EC key, choose the required signature format with
+ * `AsnFormat`, then sign or verify using the method that matches the
+ * input form: hash, data, key, or certificate. For shared-secret workflows,
+ * compute the ECDH-style secret and pass the result through the key derivation
+ * or encoding step required by the protocol.
+ *
+ * For an extended overview, see
+ * [Ecc Class Overview](https://www.chilkatsoft.com/ecc_class_overview.asp).
+ *
+ * Each `Ecc` 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 Ecc()`.
+ */
+export interface Ecc 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
+
+  /**
+   * Controls the binary layout of ECDSA signatures created by this object. The default is `true`.
+   *
+   * ValueSignature layout
+   *
+   * | `true` | | ASN.1 DER: a `SEQUENCE` containing the two INTEGER values `r` and `s`. Its encoded
+   * length can vary because DER INTEGER values may require leading sign-padding bytes. |
+   *
+   * | `false` | | Raw format: fixed-width, unsigned big-endian `r` followed immediately by
+   * fixed-width `s`, commonly written `r || s`. |
+   *
+   * **Signing versus verification:** This property controls generated signatures. Chilkat
+   * verification methods automatically recognize both ASN.1 DER and raw `r || s` signatures.
+   *
+   * **Protocol compatibility:** Neither format is universally interchangeable. Use the layout
+   * required by the receiving protocol or file format.
+   */
+  asnFormat: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Computes an elliptic-curve Diffie-Hellman shared secret from the private key in `privKey` and
+   * the peer's public key in `pubKey`. `encoding` specifies how the resulting bytes are encoded in
+   * the returned string, such as `hex` or `base64`.
+   *
+   * Two parties obtain the same result when each combines its own private key with the other
+   * party's corresponding public key. Both keys must use the same named curve and must be suitable
+   * EC keys.
+   *
+   * **Do not use the raw result directly as a long-term encryption key:** A shared secret is
+   * normally passed through the key-derivation function required by the surrounding protocol,
+   * together with any required context, salt, or transcript information. Key agreement by itself
+   * also does not authenticate the peer; an unauthenticated exchange is vulnerable to a
+   * man-in-the-middle attack.
+   *
+   * **ECDH, not ECDSA:** ECDSA is a signature algorithm. This method performs ECDH-style key
+   * agreement.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  sharedSecretENC(privKey: PrivateKey, pubKey: PublicKey, encoding: string): string
+
+  /**
+   * Creates an ECDSA signature over a digest that has already been computed by the application.
+   * `encodedHash` contains the digest encoded using the binary encoding named by `encoding`, such
+   * as `hex` or `base64`. `privkey` supplies the EC private key, and `prng` supplies the random
+   * source used during signature generation.
+   *
+   * The returned signature uses the same textual encoding named by `encoding`. Its binary layout is
+   * controlled by {@link Ecc.asnFormat}: ASN.1 DER when `true`, or raw `r || s` when `false`.
+   *
+   * **No hashing is performed:** `encodedHash` must be the exact digest required by the protocol.
+   * The verifier must use the same digest bytes and the matching public key.
+   *
+   * **ECDSA nonce safety:** Every signature requires a secret per-signature value. It must be
+   * generated securely and must never be reused with the same private key, because nonce reuse or
+   * predictability can reveal the private key. Supply a properly initialized cryptographic `Prng`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  signHashENC(encodedHash: string, encoding: string, privkey: PrivateKey, prng: Prng): string
+
+  /**
+   * Verifies an ECDSA signature over a digest that was computed by the application. `encodedHash`
+   * is the encoded digest, `encodedSig` is the encoded signature, `encoding` names the binary
+   * encoding used by both strings, and `pubkey` supplies the matching EC public key.
+   *
+   * Chilkat automatically recognizes both supported ECDSA signature layouts: ASN.1 DER and
+   * fixed-width raw `r || s`. The {@link Ecc.asnFormat} property therefore does not need to match
+   * the signature being verified.
+   *
+   * ReturnMeaning
+   *
+   * | `1` |  | The signature is valid for the supplied digest and public key. |
+   *
+   * | `0` |  | The method ran successfully, but the signature is not valid. |
+   *
+   * | `-1` | | The verification operation could not be completed because of malformed input, an
+   * unsuitable key, an unsupported encoding, or another error. Examine `LastErrorText`. |
+   *
+   * **Digest-level verification:** This method does not hash the original message. It verifies only
+   * the digest bytes supplied in `encodedHash`.
+   */
+  verifyHashENC(encodedHash: string, encodedSig: string, encoding: string, pubkey: PublicKey): number
+
+  /**
+   * Hashes the bytes currently contained in `bdData` and creates an ECDSA signature with the EC
+   * private key in `privKey`. `hashAlg` selects the hash algorithm and may be `sha256`, `sha384`,
+   * or `sha512`. `encoding` selects the textual encoding of the returned signature, such as `hex`
+   * or `base64`. `prng` supplies the random source used during ECDSA signature generation.
+   *
+   * The signature's binary layout is controlled by {@link Ecc.asnFormat}. The contents of the
+   * `BinData` object are read but not modified.
+   *
+   * **Sign the exact bytes:** Verification succeeds only when the verifier hashes the same byte
+   * sequence with the same hash algorithm and uses the public key corresponding to `privKey`.
+   *
+   * **Protect the signing nonce:** Use a cryptographically secure `Prng`. Reusing or predicting an
+   * ECDSA nonce can expose the private key.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  signBd(bdData: BinData, hashAlg: string, encoding: string, privKey: PrivateKey, prng: Prng): string
+
+  /**
+   * Hashes the bytes in `bdData` using the algorithm named by `hashAlg` and verifies the ECDSA
+   * signature in `encodedSig` with the EC public key in `pubkey`. `encoding` identifies the textual
+   * encoding of the signature, such as `hex` or `base64`. Supported hash algorithms are `sha256`,
+   * `sha384`, and `sha512`.
+   *
+   * Chilkat automatically recognizes ASN.1 DER and raw `r || s` signature layouts.
+   *
+   * ReturnMeaning
+   *
+   * | `1` |  | Valid signature. |
+   *
+   * | `0` |  | Invalid signature. |
+   *
+   * | `-1` |  | Operational failure; examine `LastErrorText`. |
+   *
+   * **Exact-data requirement:** A valid signature becomes invalid if any signed byte changes or if
+   * a different hash algorithm is selected.
+   */
+  verifyBd(bdData: BinData, hashAlg: string, encodedSig: string, encoding: string, pubkey: PublicKey): number
+
+  /**
+   * Hashes the bytes in `bdData` and creates an ECDSA signature using the private key associated
+   * with the certificate in `cert`. `hashAlg` selects `sha256`, `sha384`, or `sha512`; `encoding`
+   * selects the textual encoding of the returned signature.
+   *
+   * The certificate must contain an EC public key and must provide access to its corresponding
+   * private key. The private key may be embedded with the certificate or supplied through the
+   * platform or key-storage mechanism from which the certificate was loaded. Signature layout is
+   * controlled by {@link Ecc.asnFormat}.
+   *
+   * **Certificate versus key:** The certificate identifies the public key and may describe the key
+   * owner, but signing requires actual access to the associated private key. A public-only
+   * certificate cannot sign.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  signBdUsingCert(bdData: BinData, hashAlg: string, encoding: string, cert: Cert): string
+
+  /**
+   * Creates an ECDSA signature over a digest that has already been computed. `encodedHash` contains
+   * the digest encoded using the binary encoding named by `encoding`. `cert` supplies a certificate
+   * whose public key is EC and whose associated private key is accessible for signing.
+   *
+   * The returned signature uses the same textual encoding named by `encoding`. Its binary layout is
+   * controlled by {@link Ecc.asnFormat}.
+   *
+   * **No hashing is performed:** `encodedHash` must contain the final digest bytes expected by the
+   * receiving protocol. Use {@link Ecc.signBdUsingCert} when Chilkat should hash the source data
+   * before signing.
+   *
+   * **Private-key requirement:** A certificate containing only a public key is not sufficient. The
+   * associated EC private key must be present and usable.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  signHashUsingCert(encodedHash: string, encoding: string, cert: Cert): string
+
+  /**
+   * Generates a new elliptic-curve private key and stores it in `privKey`. `curveName` selects the
+   * named curve, and `prng` supplies the cryptographically secure random data used to choose the
+   * private scalar. Returns `true` on success and `false` on failure.
+   *
+   * Supported curve names are:
+   *
+   * Curve nameNotes
+   *
+   * | `secp256r1` |  | Also known as P-256 and `prime256v1`. |
+   *
+   * | `secp384r1` |  | Also known as P-384. |
+   *
+   * | `secp521r1` |  | Also known as P-521. |
+   *
+   * | `secp256k1` |  | Widely associated with Bitcoin and related systems. |
+   *
+   * | `secp192r1`, `secp224r1` |  | Older, smaller SEC curves retained for compatibility. |
+   *
+   * | `brainpoolP160r1`, `brainpoolP192r1`, `brainpoolP224r1`, `brainpoolP256r1`,
+   * `brainpoolP320r1`, `brainpoolP384r1`, `brainpoolP512r1` | | Brainpool prime-field curves. |
+   *
+   * **Choose the curve required by the protocol:** The curve name determines the key size,
+   * signature size, and interoperability. P-256, P-384, and P-521 are broadly standardized;
+   * `secp256k1` is commonly required by Bitcoin-related systems. Older and smaller curves should
+   * generally be used only for compatibility with an existing format or peer.
+   *
+   * **Random generation matters:** The security of the private key depends on the randomness
+   * supplied by `prng`. Use a properly initialized cryptographic `Prng`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  genKey(curveName: string, prng: Prng, privKey: PrivateKey): void
+
+  /**
+   * Constructs an elliptic-curve private key in `privKey` from a caller-supplied private scalar.
+   * `curveName` selects the named curve, `encodedK` contains the scalar, and `encoding` names its
+   * representation, such as `hex`, `base64`, or `decimal`. Returns `true` on success and `false` on
+   * failure.
+   *
+   * Supported curve names are:
+   *
+   * Curve nameNotes
+   *
+   * | `secp256r1` |  | Also known as P-256 and `prime256v1`. |
+   *
+   * | `secp384r1` |  | Also known as P-384. |
+   *
+   * | `secp521r1` |  | Also known as P-521. |
+   *
+   * | `secp256k1` |  | Widely associated with Bitcoin and related systems. |
+   *
+   * | `secp192r1`, `secp224r1` |  | Older, smaller SEC curves retained for compatibility. |
+   *
+   * | `brainpoolP160r1`, `brainpoolP192r1`, `brainpoolP224r1`, `brainpoolP256r1`,
+   * `brainpoolP320r1`, `brainpoolP384r1`, `brainpoolP512r1` | | Brainpool prime-field curves. |
+   *
+   * **`encodedK` is the private key value:** Despite the historical argument name, `encodedK` is
+   * the long-lived private scalar used to construct the key. It is not the temporary ECDSA signing
+   * nonce also commonly denoted by \*k\*. The value must be valid for the selected curve,
+   * unpredictable when used as a real key, and kept secret.
+   *
+   * **Typical use:** Use this method to reproduce a known key for a test vector or to import a
+   * scalar supplied by another system. Use {@link Ecc.genKey} to create a new random private key.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Ecc.lastErrorText}.
+   */
+  genKey2(curveName: string, encodedK: string, encoding: string, privKey: PrivateKey): void
+}