Class SafeBag<T>

Represents the SafeBag structure described in RFC7292

Type Parameters

T extends BagType = BagType

Hierarchy

PkiObject
- SafeBag

Implements

ISafeBag<T>

Index

Constructors

Properties

bagAttributes? bagId bagValue CLASS_NAME

Accessors

Methods

fromSchema toJSON toSchema toString blockName compareWithDefault defaultValues fromBER schema

Constructors

constructor

new SafeBag<T>(parameters?: SafeBagParameters<T>): SafeBag<T>
Initializes a new instance of the SafeBag class
Type Parameters
- T extends BagType = BagType
Parameters
- parameters: SafeBagParameters<T> = {}
  
  Initialization parameters
Returns SafeBag<T>
Overrides PkiObject.constructor
- Defined in src/SafeBag.ts:46

Properties

`Optional` bagAttributes

bagAttributes?: Attribute[]

bagId

bagId: string

bagValue

bagValue: T

`Static` CLASS_NAME

CLASS_NAME: string = "SafeBag"

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/SafeBag.ts:141

toJSON

toJSON(): SafeBagJson
Converts the class to JSON object

Returns
JSON object

Returns SafeBagJson
Overrides PkiObject.toJSON
- Defined in src/SafeBag.ts:198

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/SafeBag.ts:173

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/SafeBag.ts:86

`Static` defaultValues

defaultValues(memberName: "bagId"): string
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "bagId"
  
  String name for a class member
Returns string
Overrides PkiObject.defaultValues
- Defined in src/SafeBag.ts:65
defaultValues(memberName: "bagValue"): BagType
Parameters
- memberName: "bagValue"
Returns BagType
Overrides PkiObject.defaultValues
- Defined in src/SafeBag.ts:66
defaultValues(memberName: "bagAttributes"): Attribute[]
Parameters
- memberName: "bagAttributes"
Returns Attribute[]
Overrides PkiObject.defaultValues
- Defined in src/SafeBag.ts:67

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

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ bagAttributes?: string; bagId?: string; bagValue?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/SafeBag.ts:110

Generated using TypeDoc