Class AlgorithmIdentifier

Represents the AlgorithmIdentifier structure described in RFC5280

Hierarchy

PkiObject
- AlgorithmIdentifier

Implements

IAlgorithmIdentifier

Index

Constructors

Properties

algorithmId algorithmParams? CLASS_NAME

Accessors

Methods

fromSchema isEqual toJSON toSchema toString blockName compareWithDefault defaultValues fromBER schema

Constructors

constructor

new AlgorithmIdentifier(parameters?: AlgorithmIdentifierParameters): AlgorithmIdentifier
Initializes a new instance of the AlgorithmIdentifier class
Parameters
- parameters: AlgorithmIdentifierParameters = {}
  
  Initialization parameters
Returns AlgorithmIdentifier
Overrides PkiObject.constructor
- Defined in src/AlgorithmIdentifier.ts:57

Properties

algorithmId

algorithmId: string

ObjectIdentifier for algorithm (string representation)

`Optional` algorithmParams

algorithmParams?: any

Any algorithm parameters

`Static` CLASS_NAME

CLASS_NAME: string = "AlgorithmIdentifier"

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/AlgorithmIdentifier.ts:126

isEqual

isEqual(algorithmIdentifier: unknown): boolean
Checks that two "AlgorithmIdentifiers" are equal
Parameters
- algorithmIdentifier: unknown
Returns boolean
- Defined in src/AlgorithmIdentifier.ts:179

toJSON

toJSON(): AlgorithmIdentifierJson
Converts the class to JSON object

Returns
JSON object

Returns AlgorithmIdentifierJson
Overrides PkiObject.toJSON
- Defined in src/AlgorithmIdentifier.ts:163

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/AlgorithmIdentifier.ts:149

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
Compares 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/AlgorithmIdentifier.ts:93

`Static` defaultValues

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

Returns
Default value
Parameters
- memberName: "algorithmId"
  
  String name for a class member
Returns string
Overrides PkiObject.defaultValues
- Defined in src/AlgorithmIdentifier.ts:75
defaultValues(memberName: "algorithmParams"): any
Parameters
- memberName: "algorithmParams"
Returns any
Overrides PkiObject.defaultValues
- Defined in src/AlgorithmIdentifier.ts:76

`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?: AlgorithmIdentifierSchema): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: AlgorithmIdentifierSchema = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/AlgorithmIdentifier.ts:113

Generated using TypeDoc