@eryx/crypto/hazmat/ecc Module

JSON

Elliptic-curve cryptography using interoperable named curves.

Provides named-curve key generation, PEM/DER conversion, ECDSA signing/verification, and ECDH shared-secret derivation.

The initial curve set focuses on standard interoperable curves: secp224r1, secp256r1, secp384r1, secp521r1, and secp256k1.

local ecc = require("@eryx/crypto/hazmat/ecc")

local alicePriv = ecc.generateKey("secp256r1")
local alicePub = ecc.getPublicPem(alicePriv)

local bobPriv = ecc.generateKey("secp256r1")
local bobPub = ecc.getPublicPem(bobPriv)

local sig = ecc.sign(alicePriv, buffer.fromstring("hello"))
assert(ecc.verify(alicePub, buffer.fromstring("hello"), sig))

local aliceSecret = ecc.derive(alicePriv, bobPub)
local bobSecret = ecc.derive(bobPriv, alicePub)
assert(buffer.tostring(aliceSecret) == buffer.tostring(bobSecret))

Summary

Functions

ecc.generateKey(curve: string?) → string
ecc.getPublicPem(private_pem: string) → string
ecc.sign(private_pem: string, data: buffer, hash: string?) → buffer
ecc.verify(public_pem: string, data: buffer, signature: buffer, hash: string?) → boolean
ecc.derive(private_pem: string, peer_public_pem: string) → buffer
ecc.privateToDer(private_pem: string) → buffer
ecc.publicToDer(public_pem: string) → buffer
ecc.privateFromDer(der: buffer) → string
ecc.publicFromDer(der: buffer) → string
ecc.getKeyBits(pem: string) → number
ecc.getCurve(pem: string) → string

API Reference

Functions

ecc.generateKey

Generates a new ECC private key on a named curve and returns it as PEM.

Supported curve names: "secp224r1", "secp256r1" (default), "prime256v1", "secp384r1", "secp521r1", and "secp256k1".

ecc.generateKey(curve: string?) → string

Parameters

curve: string?

Curve name. Defaults to "secp256r1".

Returns

string

PEM-encoded ECC private key.

ecc.getPublicPem

Derives the public key from a PEM-encoded ECC private key.

ecc.getPublicPem(private_pem: string) → string

Parameters

private_pem: string

PEM-encoded ECC private key.

Returns

string

PEM-encoded ECC public key.

ecc.sign

Signs data using ECDSA on the private key's curve.

Supported hash values: "sha256" (default), "sha1", "sha384", and "sha512".

ecc.sign(private_pem: string, data: buffer, hash: string?) → buffer

Parameters

private_pem: string

PEM-encoded ECC private key.

data: buffer

Message to sign.

hash: string?

Hash algorithm.

Returns

buffer

ASN.1 DER-encoded ECDSA signature.

ecc.verify

Verifies an ECDSA signature.

ecc.verify(public_pem: string, data: buffer, signature: buffer, hash: string?) → boolean

Parameters

public_pem: string

PEM-encoded ECC public key.

data: buffer

Original message.

signature: buffer

ASN.1 DER-encoded signature.

hash: string?

Hash algorithm.

Returns

boolean

true if the signature is valid.

ecc.derive

Derives a shared secret using ECDH.

Both keys must be on the same curve.

ecc.derive(private_pem: string, peer_public_pem: string) → buffer

Parameters

private_pem: string

Your PEM-encoded ECC private key.

peer_public_pem: string

Peer's PEM-encoded ECC public key.

Returns

buffer

Raw shared secret bytes.

ecc.privateToDer

Encodes a PEM private key as raw DER bytes.

ecc.privateToDer(private_pem: string) → buffer

Parameters

private_pem: string

PEM-encoded ECC private key.

Returns

buffer

Raw DER-encoded private key.

ecc.publicToDer

Encodes a PEM public key as raw DER bytes.

ecc.publicToDer(public_pem: string) → buffer

Parameters

public_pem: string

PEM-encoded ECC public key.

Returns

buffer

Raw DER-encoded public key.

ecc.privateFromDer

Parses a DER-encoded ECC private key and returns it as PEM.

ecc.privateFromDer(der: buffer) → string

Parameters

der: buffer

Raw DER-encoded ECC private key.

Returns

string

PEM-encoded ECC private key.

ecc.publicFromDer

Parses a DER-encoded ECC public key and returns it as PEM.

ecc.publicFromDer(der: buffer) → string

Parameters

der: buffer

Raw DER-encoded ECC public key.

Returns

string

PEM-encoded ECC public key.

ecc.getKeyBits

Returns the key size in bits for a PEM-encoded ECC key.

ecc.getKeyBits(pem: string) → number

Parameters

pem: string

PEM-encoded ECC private or public key.

Returns

number

Curve size in bits.

ecc.getCurve

Returns the canonical curve name for a PEM-encoded ECC key.

Known return values currently include "secp224r1", "secp256r1", "secp384r1", "secp521r1", "secp256k1", and "unknown" if the curve is not one of the canonical names recognised by this wrapper.

ecc.getCurve(pem: string) → string

Parameters

pem: string

PEM-encoded ECC private or public key.

Returns

string

Canonical curve name.