Class PrivateKeyInfo

Represents the PrivateKeyInfo structure described in RFC5280

Hierarchy

PkiObject
- PrivateKeyInfo
  - KeyBag

Implements

IPrivateKeyInfo

Index

Constructors

Properties

attributes? parsedKey? privateKey privateKeyAlgorithm version CLASS_NAME

Accessors

Methods

fromJSON fromSchema toJSON toSchema toString blockName defaultValues fromBER schema

Constructors

constructor

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

Properties

`Optional` attributes

attributes?: Attribute[]

`Optional` parsedKey

parsedKey?: ECPrivateKey | RSAPrivateKey

privateKey

privateKey: OctetString

privateKeyAlgorithm

privateKeyAlgorithm: AlgorithmIdentifier

version

version: number

`Static` CLASS_NAME

CLASS_NAME: string = "PrivateKeyInfo"

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/PrivateKeyInfo.ts:276

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/PrivateKeyInfo.ts:150

toJSON

toJSON(): JsonWebKey | PrivateKeyInfoJson
Converts the class to JSON object

Returns
JSON object

Returns JsonWebKey | PrivateKeyInfoJson
Overrides PkiObject.toJSON
- Defined in src/PrivateKeyInfo.ts:234

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/PrivateKeyInfo.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` defaultValues

defaultValues(memberName: string): any
Returns default values for all class members

Returns
Default value
Parameters
- memberName: string
  
  String name for a class member
Returns any
Overrides PkiObject.defaultValues
- Defined in src/PrivateKeyInfo.ts:85

`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<{ attributes?: string; privateKey?: string; privateKeyAlgorithm?: AlgorithmIdentifierSchema; version?: string }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ attributes?: string; privateKey?: string; privateKeyAlgorithm?: AlgorithmIdentifierSchema; version?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/PrivateKeyInfo.ts:119

Generated using TypeDoc