Class ECPrivateKey

Represents an EC private key according to RFC 5915.

ASN.1 Structure:

ECPrivateKey ::= SEQUENCE {
  version        INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
  privateKey     OCTET STRING,
  parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
  publicKey  [1] BIT STRING OPTIONAL
}

Hierarchy (View Summary)

PkiBase<ECPrivateKey>
- ECPrivateKey

Index

Constructors

constructor

new ECPrivateKey(
    options: {
        namedCurve?: string;
        privateKey: Uint8Array;
        publicKey?: Uint8Array<ArrayBufferLike>;
    },
): ECPrivateKey
Creates a new ECPrivateKey
Parameters
- options: {
      namedCurve?: string;
      privateKey: Uint8Array;
      publicKey?: Uint8Array<ArrayBufferLike>;
  }
Returns ECPrivateKey
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:54

Properties

`Optional`namedCurve

namedCurve?: string

The named curve OID (if parameters are present) Most commonly this is a string like '1.2.840.10045.3.1.7' for P-256

privateKey

privateKey: Uint8Array

The private key value as an octet string

`Optional`publicKey

publicKey?: Uint8Array<ArrayBufferLike>

The key component (if included)

version

version: number = 1

The version of the EC private key structure (always 1)

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Inherited from PkiBase.pemHeader
- Defined in packages/pki-lite/src/core/PkiBase.ts:60

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Asn1BaseBlock
Converts the ECPrivateKey to an ASN.1 structure

Returns Asn1BaseBlock
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:69

toDer

toDer(): Uint8Array
Converts the ECPrivateKey to a DER-encoded byte array

Returns Uint8Array
Overrides PkiBase.toDer
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:110

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts the ECPrivateKey to a PEM-encoded string

Returns string
Overrides PkiBase.toPem
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:118

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from PkiBase.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

`Static`forCurve

forCurve(
    curve: string,
    privateKey: Uint8Array,
    publicKey?: Uint8Array<ArrayBufferLike>,
): ECPrivateKey
Creates an ECPrivateKey for a specific named curve
Parameters
- curve: string
  The named curve OID (e.g., EC_CURVES.SECP256R1)
- privateKey: Uint8Array
  The private key value
- OptionalpublicKey: Uint8Array<ArrayBufferLike>
  Optional key value
Returns ECPrivateKey
An ECPrivateKey object
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:251

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): ECPrivateKey
Creates an ECPrivateKey from an ASN.1 structure
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 structure
Returns ECPrivateKey
An ECPrivateKey object
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:128

`Static`fromDer

fromDer(der: Uint8Array): ECPrivateKey
Creates an ECPrivateKey from a DER-encoded byte array
Parameters
- der: Uint8Array
  The DER-encoded ECPrivateKey
Returns ECPrivateKey
An ECPrivateKey object
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:228

`Static`fromPem

fromPem(pem: string): ECPrivateKey
Creates an ECPrivateKey from a PEM-encoded string
Parameters
- pem: string
  The PEM-encoded ECPrivateKey
Returns ECPrivateKey
An ECPrivateKey object
- Defined in packages/pki-lite/src/keys/ECPrivateKey.ts:239

Class ECPrivateKey

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ECPrivateKey

Properties

OptionalnamedCurve

privateKey

OptionalpublicKey

version

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

StaticforCurve

Parameters

Returns ECPrivateKey

StaticfromAsn1

Parameters

Returns ECPrivateKey

StaticfromDer

Parameters

Returns ECPrivateKey

StaticfromPem

Parameters

Returns ECPrivateKey

Settings

On This Page

`Optional`namedCurve

`Optional`publicKey

`Static`forCurve

`Static`fromAsn1

`Static`fromDer

`Static`fromPem