---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: Ecc
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsEccRef.html
---
# Chilkat Ecc — JavaScript — v11.7.0

> Chilkat 11.7.0 · language=js · class=Ecc
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Ecc.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/guide.md`.

## Purpose

**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**

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).

## Object creation, unlocking and error handling

**Object Creation**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkEcc();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in JavaScript.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AsnFormat` | property, read/write | `AsnFormat` |
| `GenKey` | method | `var success = GenKey(curveName, prng, privKey);` |
| `GenKey2` | method | `var success = GenKey2(curveName, encodedK, encoding, privKey);` |
| `SharedSecretENC` | method | `var strVal = SharedSecretENC(privKey, pubKey, encoding);` |
| `SignBd` | method | `var strVal = SignBd(bdData, hashAlg, encoding, privKey, prng);` |
| `SignBdUsingCert` | method | `var strVal = SignBdUsingCert(bdData, hashAlg, encoding, cert);` |
| `SignHashENC` | method | `var strVal = SignHashENC(encodedHash, encoding, privkey, prng);` |
| `SignHashUsingCert` | method | `var strVal = SignHashUsingCert(encodedHash, encoding, cert);` |
| `VerifyBd` | method | `var intVal = VerifyBd(bdData, hashAlg, encodedSig, encoding, pubkey);` |
| `VerifyHashENC` | method | `var intVal = VerifyHashENC(encodedHash, encodedSig, encoding, pubkey);` |

## Properties

### Ecc.AsnFormat

`Chilkat 11.7.0 · js · Ecc · AsnFormat · property · read/write · since 9.5.0.97`

```javascript
AsnFormat
```

· `boolean`

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`. |

**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.

## Methods

### Ecc.GenKey

`Chilkat 11.7.0 · js · Ecc · GenKey · method · since 11.0.0`

```javascript
var success = GenKey(curveName, prng, privKey);
```

· return: `boolean`; `true` for success, `false` for failure  
· curveName: `string`  
· prng: `CkPrng`  
· privKey: `CkPrivateKey`

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 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. |

**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`.

Returns true for success, false for failure.

### Ecc.GenKey2

`Chilkat 11.7.0 · js · Ecc · GenKey2 · method · since 11.0.0`

```javascript
var success = GenKey2(curveName, encodedK, encoding, privKey);
```

· return: `boolean`; `true` for success, `false` for failure  
· curveName: `string`  
· encodedK: `string`  
· encoding: `string`  
· privKey: `CkPrivateKey`

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 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, `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 `GenKey` to create a new random private key.

Returns true for success, false for failure.

### Ecc.SharedSecretENC

`Chilkat 11.7.0 · js · Ecc · SharedSecretENC · method · since 9.5.0.52`

```javascript
var strVal = SharedSecretENC(privKey, pubKey, encoding);
```

**Full documentation for this method (same in every language):** [List of Supported Encodings (Base64, Hex, etc.)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

· return: `string`  
· privKey: `CkPrivateKey`  
· pubKey: `CkPublicKey`  
· encoding: `string`

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.

Returns `null` on failure

### Ecc.SignBd

`Chilkat 11.7.0 · js · Ecc · SignBd · method · since 9.5.0.85`

```javascript
var strVal = SignBd(bdData, hashAlg, encoding, privKey, prng);
```

· return: `string`  
· bdData: `CkBinData`  
· hashAlg: `string`  
· encoding: `string`  
· privKey: `CkPrivateKey`  
· prng: `CkPrng`

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 `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.

Returns `null` on failure

### Ecc.SignBdUsingCert

`Chilkat 11.7.0 · js · Ecc · SignBdUsingCert · method · since 9.5.0.91`

```javascript
var strVal = SignBdUsingCert(bdData, hashAlg, encoding, cert);
```

· return: `string`  
· bdData: `CkBinData`  
· hashAlg: `string`  
· encoding: `string`  
· cert: `CkCert`

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 `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.

Returns `null` on failure

### Ecc.SignHashENC

`Chilkat 11.7.0 · js · Ecc · SignHashENC · method · since 9.5.0.52`

```javascript
var strVal = SignHashENC(encodedHash, encoding, privkey, prng);
```

**Full documentation for this method (same in every language):** [List of Supported Encodings (Base64, Hex, etc.)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

· return: `string`  
· encodedHash: `string`  
· encoding: `string`  
· privkey: `CkPrivateKey`  
· prng: `CkPrng`

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 `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`.

Returns `null` on failure

### Ecc.SignHashUsingCert

`Chilkat 11.7.0 · js · Ecc · SignHashUsingCert · method · since 10.1.0`

```javascript
var strVal = SignHashUsingCert(encodedHash, encoding, cert);
```

· return: `string`  
· encodedHash: `string`  
· encoding: `string`  
· cert: `CkCert`

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 `AsnFormat`.

**No hashing is performed:** `encodedHash` must contain the final digest bytes expected by the receiving protocol. Use `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.

Returns `null` on failure

### Ecc.VerifyBd

`Chilkat 11.7.0 · js · Ecc · VerifyBd · method · since 9.5.0.85`

```javascript
var intVal = VerifyBd(bdData, hashAlg, encodedSig, encoding, pubkey);
```

· return: `int`  
· bdData: `CkBinData`  
· hashAlg: `string`  
· encodedSig: `string`  
· encoding: `string`  
· pubkey: `CkPublicKey`

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.

| Return | Meaning |
| :--- | :--- |
| `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.

### Ecc.VerifyHashENC

`Chilkat 11.7.0 · js · Ecc · VerifyHashENC · method · since 9.5.0.52`

```javascript
var intVal = VerifyHashENC(encodedHash, encodedSig, encoding, pubkey);
```

**Full documentation for this method (same in every language):** [List of Supported Encodings (Base64, Hex, etc.)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

· return: `int`  
· encodedHash: `string`  
· encodedSig: `string`  
· encoding: `string`  
· pubkey: `CkPublicKey`

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 `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`. |

**Digest-level verification:** This method does not hash the original message. It verifies only the digest bytes supplied in `encodedHash`.

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/BinData.md), [`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/Cert.md), [`PrivateKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/PrivateKey.md), [`Prng`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/Prng.md), [`PublicKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/PublicKey.md)