Skip to main content

PKCS8ShroudedKeyBag

Represents the PKCS8ShroudedKeyBag structure described in RFC7292

Extends​

Implements​

Constructors​

Constructor​

new PKCS8ShroudedKeyBag(parameters): PKCS8ShroudedKeyBag

Initializes a new instance of the PKCS8ShroudedKeyBag class

Parameters​

parameters​

PKCS8ShroudedKeyBagParameters = {}

Initialization parameters

Returns​

PKCS8ShroudedKeyBag

Overrides​

PkiObject.constructor

Properties​

encryptedData​

encryptedData: OctetString

Implementation of​

IPKCS8ShroudedKeyBag.encryptedData

encryptionAlgorithm​

encryptionAlgorithm: AlgorithmIdentifier

Implementation of​

IPKCS8ShroudedKeyBag.encryptionAlgorithm

parsedValue?​

optional parsedValue: PrivateKeyInfo

Implementation of​

IPKCS8ShroudedKeyBag.parsedValue

CLASS_NAME​

static CLASS_NAME: string = "PKCS8ShroudedKeyBag"

Name of the class

Overrides​

PkiObject.CLASS_NAME

Accessors​

className​

Get Signature​

get className(): string

Returns​

string

Inherited from​

PkiObject.className

Methods​

fromSchema()​

fromSchema(schema): void

Converts parsed ASN.1 object into current class

Parameters​

schema​

any

ASN.1 schema

Returns​

void

Overrides​

PkiObject.fromSchema

makeInternalValues()​

makeInternalValues(parameters, crypto): Promise<void>

Parameters​

parameters​

PKCS8ShroudedKeyBagMakeInternalValuesParams

crypto​

ICryptoEngine = ...

Returns​

Promise<void>

parseInternalValues()​

protected parseInternalValues(parameters, crypto): Promise<void>

Parameters​

parameters​
password​

ArrayBuffer

crypto​

ICryptoEngine = ...

Returns​

Promise<void>

toJSON()​

toJSON(): PKCS8ShroudedKeyBagJson

Converts the class to JSON object

Returns​

PKCS8ShroudedKeyBagJson

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​

encoding​

"hex" | "base64" | "base64url"

Returns​

string

Inherited from​

PkiObject.toString

blockName()​

static blockName(): string

Returns block name

Returns​

string

Returns string block name

Inherited from​

PkiObject.blockName

compareWithDefault()​

static compareWithDefault(memberName, memberValue): 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

defaultValues()​

Call Signature​

static defaultValues(memberName): AlgorithmIdentifier

Returns default values for all class members

Parameters​
memberName​

"encryptionAlgorithm"

String name for a class member

Returns​

AlgorithmIdentifier

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): OctetString

Returns default values for all class members

Parameters​
memberName​

"encryptedData"

String name for a class member

Returns​

OctetString

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): PrivateKeyInfo

Returns default values for all class members

Parameters​
memberName​

"parsedValue"

String name for a class member

Returns​

PrivateKeyInfo

Default value

Overrides​

PkiObject.defaultValues

fromBER()​

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

Creates PKI object from the raw data

Type Parameters​

T​

T extends PkiObject

Parameters​

this​

PkiObjectConstructor<T>

raw​

BufferSource

ASN.1 encoded raw data

Returns​

T

Initialized and filled current class object

Inherited from​

PkiObject.fromBER

schema()​

static schema(parameters): any

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

Parameters​

parameters​

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

Input parameters for the schema

Returns​

any

ASN.1 schema object

Overrides​

PkiObject.schema