Class: ECPrivateKey

Represents the PrivateKeyInfo structure described in RFC5915

Hierarchy

• PkiObject

  ↳ ECPrivateKey

Implements

• IECPrivateKey

Constructors

constructor

• new ECPrivateKey(parameters?): ECPrivateKey

Initializes a new instance of the ECPrivateKey class

Parameters

Name	Type	Description
parameters	ECPrivateKeyParameters	Initialization parameters

Returns

ECPrivateKey

Overrides

PkiObject.constructor

Properties

namedCurve

• Optional namedCurve: string

Implementation of

IECPrivateKey.namedCurve

---

privateKey

• privateKey: OctetString

Implementation of

IECPrivateKey.privateKey

---

publicKey

• Optional publicKey: ECPublicKey

Implementation of

IECPrivateKey.publicKey

---

version

• version: number

Implementation of

IECPrivateKey.version

---

CLASS_NAME

▪ Static CLASS_NAME: string = "ECPrivateKey"

Name of the class

Overrides

PkiObject.CLASS_NAME

Accessors

className

• get className(): string

Returns

string

Inherited from

PkiObject.className

Methods

fromJSON

▸ fromJSON(json): void

Converts JSON value into current object

Parameters

Name	Type	Description
json	any	JSON object

Returns

void

---

fromSchema

▸ fromSchema(schema): void

Converts parsed ASN.1 object into current class

Parameters

Name	Type	Description
schema	any	ASN.1 schema

Returns

void

Overrides

PkiObject.fromSchema

---

toJSON

▸ toJSON(): ECPrivateKeyJson

Converts the class to JSON object

Returns

ECPrivateKeyJson

JSON object

Overrides

PkiObject.toJSON

---

toSchema

▸ toSchema(): Sequence

Converts current object to ASN.1 object and sets correct values

Returns

Sequence

ASN.1 object

Overrides

PkiObject.toSchema

---

toString

▸ toString(encoding?): string

Parameters

Name	Type	Default value
encoding	"base64" | "base64url" | "hex"	"hex"

Returns

string

Inherited from

PkiObject.toString

---

blockName

▸ blockName(): string

Returns block name

Returns

string

Returns string block name

Inherited from

PkiObject.blockName

---

compareWithDefault

▸ compareWithDefault(memberName, memberValue): boolean

Compare values with default values for all class members

Parameters

Name	Type	Description
memberName	string	String name for a class member
memberValue	any	Value to compare with default value

Returns

boolean

---

defaultValues

▸ defaultValues(memberName): 1

Returns default values for all class members

Parameters

Name	Type	Description
memberName	"version"	String name for a class member

Returns

1

Default value

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): OctetString

Parameters

Name	Type
memberName	"privateKey"

Returns

OctetString

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): string

Parameters

Name	Type
memberName	"namedCurve"

Returns

string

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): ECPublicKey

Parameters

Name	Type
memberName	"publicKey"

Returns

ECPublicKey

Overrides

PkiObject.defaultValues

---

fromBER

▸ fromBER<T>(this, raw): T

Creates PKI object from the raw data

Type parameters

Name	Type
T	extends PkiObject

Parameters

Name	Type	Description
this	PkiObjectConstructor<T>	-
raw	BufferSource	ASN.1 encoded raw data

Returns

T

Initialized and filled current class object

Inherited from

PkiObject.fromBER

---

schema

▸ schema(parameters?): any

Returns value of pre-defined ASN.1 schema for current class

Parameters

Name	Type	Description
parameters	SchemaParameters<{ namedCurve?: string ; privateKey?: string ; publicKey?: string ; version?: string }>	Input parameters for the schema

Returns

any

ASN.1 schema object

Overrides

PkiObject.schema