Ecc Rust Reference Documentation
Ecc
Current Version: 11.6.1
Chilkat.Ecc
Create elliptic-curve private keys for supported curves and use the
resulting key with Chilkat signing, verification, or key-agreement APIs.
Sign hashes or input data using an EC private key, producing ECDSA
signatures in the configured output format.
Verify ECDSA signatures using the matching EC public key and the original
hash or data.
Sign with an ECDSA certificate when the certificate has access to its
associated private key.
Compute an encoded shared secret from compatible EC private and public
keys for key-agreement workflows.
Use
For an extended overview, see
Ecc Class Overview.
Generate EC keys, create ECDSA signatures, verify signatures, and compute shared secrets.
Chilkat.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
ECDSA signing
ECDSA verification
Certificate-based signing
Shared-secret calculation
Signature format control
AsnFormat to control whether ECDSA signatures are
encoded as ASN.1/DER or as raw r || s values.
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.
Object Creation
// Cargo.toml:
// [dependencies]
// chilkat = "11.6"
use chilkat::Ecc;
// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?; // shorthand for Global::new().unlock_bundle(..)
let ecc = Ecc::new();
// ... the native object is freed when `ecc` goes out of scope.Creates the underlying native Chilkat object (Ecc also implements Default). Every method takes &self, so the object never needs to be declared mut. A Ecc is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.
The native object is freed when the Ecc is dropped — when it goes out of scope, or explicitly with drop(ecc). There is no Dispose method to call.
Errors
Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Ecc>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.
match ecc.some_method(...) {
Ok(value) => println!("{value:?}"),
Err(e) => eprintln!("{}", e.last_error_text()),
}Properties
AsnFormat
pub fn asn_format(&self) -> bool
pub fn set_asn_format(&self, value: bool)
Controls the binary layout of ECDSA signatures created by this object. The default is true.
| Value | Signature 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. |
r || s signatures.DebugLogFilePath
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)
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.
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
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
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
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)
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.
VerboseLogging
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)
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
Methods
GenKey
Generates a new elliptic-curve private key and stores it in priv_key. curve_name 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 name | Notes |
|---|---|
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. |
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.prng. Use a properly initialized cryptographic Prng.Returns Ok(()) for success, Err(chilkat::Error) for failure.
GenKey2
Constructs an elliptic-curve private key in priv_key from a caller-supplied private scalar. curve_name selects the named curve, encoded_k 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 name | Notes |
|---|---|
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, encoded_k 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.GenKey to create a new random private key.Returns Ok(()) for success, Err(chilkat::Error) for failure.
SharedSecretENC
Computes an elliptic-curve Diffie-Hellman shared secret from the private key in priv_key and the peer's public key in pub_key. 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.
Returns Err(chilkat::Error) on failure.
SignBd
Hashes the bytes currently contained in bd_data and creates an ECDSA signature with the EC private key in priv_key. hash_alg 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 AsnFormat. The contents of the BinData object are read but not modified.
priv_key.Prng. Reusing or predicting an ECDSA nonce can expose the private key.Returns Err(chilkat::Error) on failure.
SignBdUsingCert
Hashes the bytes in bd_data and creates an ECDSA signature using the private key associated with the certificate in cert. hash_alg 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 AsnFormat.
Returns Err(chilkat::Error) on failure.
SignHashENC
Creates an ECDSA signature over a digest that has already been computed by the application. encoded_hash 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 AsnFormat: ASN.1 DER when true, or raw r || s when false.
encoded_hash must be the exact digest required by the protocol. The verifier must use the same digest bytes and the matching public key.Prng.Returns Err(chilkat::Error) on failure.
SignHashUsingCert
Creates an ECDSA signature over a digest that has already been computed. encoded_hash 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 AsnFormat.
encoded_hash must contain the final digest bytes expected by the receiving protocol. Use SignBdUsingCert when Chilkat should hash the source data before signing.Returns Err(chilkat::Error) on failure.
VerifyBd
Hashes the bytes in bd_data using the algorithm named by hash_alg and verifies the ECDSA signature in encoded_sig 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.
| Return | Meaning |
|---|---|
1 | Valid signature. |
0 | Invalid signature. |
-1 | Operational failure; examine LastErrorText. |
VerifyHashENC
Verifies an ECDSA signature over a digest that was computed by the application. encoded_hash is the encoded digest, encoded_sig 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 AsnFormat property therefore does not need to match the signature being verified.
| Return | Meaning |
|---|---|
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. |
encoded_hash.