Skip to main content

SecretBag

Represents the SecretBag structure described in RFC7292

Extends​

Implements​

Constructors​

new SecretBag()​

new SecretBag(parameters): SecretBag

Initializes a new instance of the SecretBag class

Parameters​

• parameters: SecretBagParameters = {}

Initialization parameters

Returns​

SecretBag

Overrides​

PkiObject.constructor

Properties​

secretTypeId​

secretTypeId: string

Implementation of​

ISecretBag.secretTypeId

secretValue​

secretValue: SchemaCompatible

Implementation of​

ISecretBag.secretValue

CLASS_NAME​

static CLASS_NAME: string = "SecretBag"

Name of the class

Overrides​

PkiObject.CLASS_NAME

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​

• schema: any

ASN.1 schema

Returns​

void

Overrides​

PkiObject.fromSchema

toJSON()​

toJSON(): SecretBagJson

Converts the class to JSON object

Returns​

SecretBagJson

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: "base64" | "base64url" | "hex" = "hex"

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()​

defaultValues(memberName)​

static defaultValues(memberName): string

Returns default values for all class members

Parameters​

• memberName: "secretTypeId"

String name for a class member

Returns​

string

Default value

Overrides​

PkiObject.defaultValues

defaultValues(memberName)​

static defaultValues(memberName): SchemaCompatible

Returns default values for all class members

Parameters​

• memberName: "secretValue"

String name for a class member

Returns​

SchemaCompatible

Default value

Overrides​

PkiObject.defaultValues

fromBER()​

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

Creates PKI object from the raw data

Type Parameters​

• 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<object> = {}

Input parameters for the schema

Returns​

any

ASN.1 schema object

Overrides​

PkiObject.schema