Skip to main content

SafeBag<T>

Represents the SafeBag structure described in RFC7292

Extends​

Type Parameters​

T​

T extends BagType = BagType

Implements​

Constructors​

Constructor​

new SafeBag<T>(parameters?): SafeBag<T>

Initializes a new instance of the SafeBag class

Parameters​

parameters?​

SafeBagParameters<T> = {}

Initialization parameters

Returns​

SafeBag<T>

Overrides​

PkiObject.constructor

Properties​

bagAttributes?​

optional bagAttributes?: Attribute[]

Implementation of​

ISafeBag.bagAttributes

bagId​

bagId: string

Implementation of​

ISafeBag.bagId

bagValue​

bagValue: T

Implementation of​

ISafeBag.bagValue

CLASS_NAME​

static CLASS_NAME: string = "SafeBag"

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

toJSON()​

toJSON(): SafeBagJson

Converts the class to JSON object

Returns​

SafeBagJson

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): string

Returns default values for all class members

Parameters​
memberName​

"bagId"

String name for a class member

Returns​

string

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): BagType

Returns default values for all class members

Parameters​
memberName​

"bagValue"

String name for a class member

Returns​

BagType

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): Attribute[]

Returns default values for all class members

Parameters​
memberName​

"bagAttributes"

String name for a class member

Returns​

Attribute[]

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<{ bagAttributes?: string; bagId?: string; bagValue?: string; }> = {}

Input parameters for the schema

Returns​

any

ASN.1 schema object

Overrides​

PkiObject.schema