Class ECPrivateKey

Represents the PrivateKeyInfo structure described in RFC5915

Hierarchy

PkiObject
- ECPrivateKey

Implements

IECPrivateKey

Index

Constructors

Properties

namedCurve? privateKey publicKey? version CLASS_NAME

Accessors

Methods

fromJSON fromSchema toJSON toSchema toString blockName compareWithDefault defaultValues fromBER schema

Constructors

constructor

new ECPrivateKey(parameters?: ECPrivateKeyParameters): ECPrivateKey
Initializes a new instance of the ECPrivateKey class
Parameters
- parameters: ECPrivateKeyParameters = {}
  
  Initialization parameters
Returns ECPrivateKey
Overrides PkiObject.constructor
- Defined in src/ECPrivateKey.ts:54

Properties

`Optional` namedCurve

namedCurve?: string

privateKey

privateKey: OctetString

`Optional` publicKey

publicKey?: ECPublicKey

version

version: number

`Static` CLASS_NAME

CLASS_NAME: string = "ECPrivateKey"

Name of the class

Accessors

className

get className(): string
Returns string
Inherited from PkiObject.className
- Defined in src/PkiObject.ts:65

Methods

fromJSON

fromJSON(json: any): void
Converts JSON value into current object
Parameters
- json: any
  
  JSON object
Returns void
- Defined in src/ECPrivateKey.ts:268

fromSchema

fromSchema(schema: any): void
Converts parsed ASN.1 object into current class
Parameters
- schema: any
  
  ASN.1 schema
Returns void
Overrides PkiObject.fromSchema
- Defined in src/ECPrivateKey.ts:170

toJSON

toJSON(): ECPrivateKeyJson
Converts the class to JSON object

Returns
JSON object

Returns ECPrivateKeyJson
Overrides PkiObject.toJSON
- Defined in src/ECPrivateKey.ts:242

toSchema

toSchema(): Sequence
Converts current object to ASN.1 object and sets correct values

Returns
ASN.1 object

Returns Sequence
Overrides PkiObject.toSchema
- Defined in src/ECPrivateKey.ts:207

toString

toString(encoding?: "base64" | "base64url" | "hex"): string
Parameters
- encoding: "base64" | "base64url" | "hex" = "hex"
Returns string
Inherited from PkiObject.toString
- Defined in src/PkiObject.ts:88

`Static` blockName

blockName(): string
Returns block name

Returns
Returns string block name

Returns string
Inherited from PkiObject.blockName
- Defined in src/PkiObject.ts:27

`Static` compareWithDefault

compareWithDefault(memberName: string, memberValue: any): boolean
Compare values with default values for all class members
Parameters
- memberName: string
  
  String name for a class member
- memberValue: any
  
  Value to compare with default value
Returns boolean
- Defined in src/ECPrivateKey.ts:104

`Static` defaultValues

defaultValues(memberName: "version"): 1
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "version"
  
  String name for a class member
Returns 1
Overrides PkiObject.defaultValues
- Defined in src/ECPrivateKey.ts:80
defaultValues(memberName: "privateKey"): OctetString
Parameters
- memberName: "privateKey"
Returns OctetString
Overrides PkiObject.defaultValues
- Defined in src/ECPrivateKey.ts:81
defaultValues(memberName: "namedCurve"): string
Parameters
- memberName: "namedCurve"
Returns string
Overrides PkiObject.defaultValues
- Defined in src/ECPrivateKey.ts:82
defaultValues(memberName: "publicKey"): ECPublicKey
Parameters
- memberName: "publicKey"
Returns ECPublicKey
Overrides PkiObject.defaultValues
- Defined in src/ECPrivateKey.ts:83

`Static` fromBER

fromBER<T>(this: PkiObjectConstructor<T>, raw: BufferSource): T
Creates PKI object from the raw data

Returns
Initialized and filled current class object
Type Parameters
- T extends PkiObject<T>
Parameters
- this: PkiObjectConstructor<T>
- raw: BufferSource
  
  ASN.1 encoded raw data
Returns T
Inherited from PkiObject.fromBER
- Defined in src/PkiObject.ts:36

`Static` schema

schema(parameters?: SchemaParameters<{ namedCurve?: string; privateKey?: string; publicKey?: string; version?: string }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ namedCurve?: string; privateKey?: string; publicKey?: string; version?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/ECPrivateKey.ts:133

Generated using TypeDoc