Class PKCS8ShroudedKeyBag

Represents the PKCS8ShroudedKeyBag structure described in RFC7292

Hierarchy

PkiObject
- PKCS8ShroudedKeyBag

Implements

IPKCS8ShroudedKeyBag

Index

Constructors

constructor

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

Properties

encryptedData

encryptedData: OctetString

encryptionAlgorithm

encryptionAlgorithm: AlgorithmIdentifier

`Optional` parsedValue

parsedValue?: PrivateKeyInfo

`Static` CLASS_NAME

CLASS_NAME: string = "PKCS8ShroudedKeyBag"

Name of the class

Accessors

className

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

Methods

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/PKCS8ShroudedKeyBag.ts:154

makeInternalValues

makeInternalValues(parameters: PKCS8ShroudedKeyBagMakeInternalValuesParams, crypto?: ICryptoEngine): Promise<void>
Parameters
- parameters: PKCS8ShroudedKeyBagMakeInternalValuesParams
- crypto: ICryptoEngine = ...
Returns Promise<void>
- Defined in src/PKCS8ShroudedKeyBag.ts:218

`Protected` parseInternalValues

parseInternalValues(parameters: { password: ArrayBuffer }, crypto?: ICryptoEngine): Promise<void>
Parameters
- parameters: { password: ArrayBuffer }
  - password: ArrayBuffer
- crypto: ICryptoEngine = ...
Returns Promise<void>
- Defined in src/PKCS8ShroudedKeyBag.ts:195

toJSON

toJSON(): PKCS8ShroudedKeyBagJson
Converts the class to JSON object

Returns
JSON object

Returns PKCS8ShroudedKeyBagJson
Overrides PkiObject.toJSON
- Defined in src/PKCS8ShroudedKeyBag.ts:188

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/PKCS8ShroudedKeyBag.ts:179

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/PKCS8ShroudedKeyBag.ts:91

`Static` defaultValues

defaultValues(memberName: "encryptionAlgorithm"): AlgorithmIdentifier
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "encryptionAlgorithm"
  
  String name for a class member
Returns AlgorithmIdentifier
Overrides PkiObject.defaultValues
- Defined in src/PKCS8ShroudedKeyBag.ts:70
defaultValues(memberName: "encryptedData"): OctetString
Parameters
- memberName: "encryptedData"
Returns OctetString
Overrides PkiObject.defaultValues
- Defined in src/PKCS8ShroudedKeyBag.ts:71
defaultValues(memberName: "parsedValue"): PrivateKeyInfo
Parameters
- memberName: "parsedValue"
Returns PrivateKeyInfo
Overrides PkiObject.defaultValues
- Defined in src/PKCS8ShroudedKeyBag.ts:72

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

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

Class PKCS8ShroudedKeyBag

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: PKCS8ShroudedKeyBagParameters = {}

Returns PKCS8ShroudedKeyBag

Properties

encryptedData

encryptionAlgorithm

Optional parsedValue

Static CLASS_NAME

Accessors

className

Returns string

Methods

fromSchema

Parameters

schema: any

Returns void

makeInternalValues

Parameters

parameters: PKCS8ShroudedKeyBagMakeInternalValuesParams

crypto: ICryptoEngine = ...

Returns Promise<void>

Protected parseInternalValues

Parameters

parameters: { password: ArrayBuffer }

password: ArrayBuffer

crypto: ICryptoEngine = ...

Returns Promise<void>

toJSON

Returns

Returns PKCS8ShroudedKeyBagJson

toSchema

Returns

Returns Sequence

toString

Parameters

encoding: "base64" | "base64url" | "hex" = "hex"

Returns string

Static blockName

Returns

Returns string

Static compareWithDefault

Parameters

memberName: string

memberValue: any

Returns boolean

Static defaultValues

Returns

Parameters

memberName: "encryptionAlgorithm"

Returns AlgorithmIdentifier

Parameters

memberName: "encryptedData"

Returns OctetString

Parameters

memberName: "parsedValue"

Returns PrivateKeyInfo

Static fromBER

Returns

Type Parameters

T extends PkiObject<T>

Parameters

this: PkiObjectConstructor<T>

raw: BufferSource

Returns T

Static schema

Returns

Parameters

parameters: SchemaParameters<{ encryptedData?: string; encryptionAlgorithm?: AlgorithmIdentifierSchema }> = {}

Returns any

Settings

`Optional` parsedValue

`Static` CLASS_NAME

`Protected` parseInternalValues

`Static` blockName

`Static` compareWithDefault

`Static` defaultValues

`Static` fromBER

`Static` schema