Class: PKCS8ShroudedKeyBag
Represents the PKCS8ShroudedKeyBag structure described in RFC7292
Hierarchy
-
↳
PKCS8ShroudedKeyBag
Implements
Constructors
constructor
• new PKCS8ShroudedKeyBag(parameters?
): PKCS8ShroudedKeyBag
Initializes a new instance of the PKCS8ShroudedKeyBag class
Parameters
Name | Type | Description |
---|---|---|
parameters | PKCS8ShroudedKeyBagParameters | Initialization parameters |
Returns
Overrides
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
Accessors
className
• get
className(): string
Returns
string
Inherited from
PkiObject.className
Methods
fromSchema
▸ fromSchema(schema
): void
Converts parsed ASN.1 object into current class
Parameters
Name | Type | Description |
---|---|---|
schema | any | ASN.1 schema |
Returns
void
Overrides
makeInternalValues
▸ makeInternalValues(parameters
, crypto?
): Promise
<void
>
Parameters
Name | Type |
---|---|
parameters | PKCS8ShroudedKeyBagMakeInternalValuesParams |
crypto | ICryptoEngine |
Returns
Promise
<void
>
parseInternalValues
▸ parseInternalValues(parameters
, crypto?
): Promise
<void
>
Parameters
Name | Type |
---|---|
parameters | Object |
parameters.password | ArrayBuffer |
crypto | ICryptoEngine |
Returns
Promise
<void
>
toJSON
▸ toJSON(): PKCS8ShroudedKeyBagJson
Converts the class to JSON object
Returns
JSON object
Overrides
toSchema
▸ toSchema(): Sequence
Converts current object to ASN.1 object and sets correct values
Returns
Sequence
ASN.1 object
Overrides
toString
▸ toString(encoding?
): string
Parameters
Name | Type | Default value |
---|---|---|
encoding | "base64" | "base64url" | "hex" | "hex" |
Returns
string
Inherited from
blockName
▸ blockName(): string
Returns block name
Returns
string
Returns string block name
Inherited from
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
): AlgorithmIdentifier
Returns default values for all class members
Parameters
Name | Type | Description |
---|---|---|
memberName | "encryptionAlgorithm" | String name for a class member |
Returns
Default value
Overrides
▸ defaultValues(memberName
): OctetString
Parameters
Name | Type |
---|---|
memberName | "encryptedData" |
Returns
OctetString
Overrides
PkiObject.defaultValues
▸ defaultValues(memberName
): PrivateKeyInfo
Parameters
Name | Type |
---|---|
memberName | "parsedValue" |
Returns
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
schema
▸ schema(parameters?
): any
Returns value of pre-defined ASN.1 schema for current class
Parameters
Name | Type | Description |
---|---|---|
parameters | SchemaParameters <{ encryptedData? : string ; encryptionAlgorithm? : AlgorithmIdentifierSchema }> | Input parameters for the schema |
Returns
any
ASN.1 schema object