Class PFX

Represents the PFX structure described in RFC7292

Hierarchy

PkiObject
- PFX

Implements

IPFX

Index

Constructors

Properties

authSafe macData? parsedValue? version CLASS_NAME

Accessors

Methods

fromSchema makeInternalValues parseInternalValues toJSON toSchema toString blockName compareWithDefault defaultValues fromBER schema

Constructors

constructor

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

Properties

authSafe

authSafe: ContentInfo

`Optional` macData

macData?: MacData

`Optional` parsedValue

parsedValue?: PFXParsedValue

version

version: number

`Static` CLASS_NAME

CLASS_NAME: string = "PFX"

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/PFX.ts:187

makeInternalValues

makeInternalValues(parameters?: MakeInternalValuesParams, crypto?: ICryptoEngine): Promise<void>
Making ContentInfo from PARSED_VALUE object
Parameters
- parameters: MakeInternalValuesParams = {}
  
  Parameters, specific to each "integrity mode"
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<void>
- Defined in src/PFX.ts:254

parseInternalValues

parseInternalValues(parameters: { checkIntegrity?: boolean; password?: ArrayBuffer }, crypto?: ICryptoEngine): Promise<void>
Parameters
- parameters: { checkIntegrity?: boolean; password?: ArrayBuffer }
  - Optional checkIntegrity?: boolean
  - Optional password?: ArrayBuffer
- crypto: ICryptoEngine = ...
Returns Promise<void>
- Defined in src/PFX.ts:419

toJSON

toJSON(): PFXJson
Converts the class to JSON object

Returns
JSON object

Returns PFXJson
Overrides PkiObject.toJSON
- Defined in src/PFX.ts:236

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/PFX.ts:219

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/PFX.ts:132

`Static` defaultValues

defaultValues(memberName: "version"): number
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "version"
  
  String name for a class member
Returns number
Overrides PkiObject.defaultValues
- Defined in src/PFX.ts:108
defaultValues(memberName: "authSafe"): ContentInfo
Parameters
- memberName: "authSafe"
Returns ContentInfo
Overrides PkiObject.defaultValues
- Defined in src/PFX.ts:109
defaultValues(memberName: "macData"): MacData
Parameters
- memberName: "macData"
Returns MacData
Overrides PkiObject.defaultValues
- Defined in src/PFX.ts:110
defaultValues(memberName: "parsedValue"): PFXParsedValue
Parameters
- memberName: "parsedValue"
Returns PFXParsedValue
Overrides PkiObject.defaultValues
- Defined in src/PFX.ts:111

`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<{ authSafe?: ContentInfoSchema; macData?: MacDataSchema; version?: string }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ authSafe?: ContentInfoSchema; macData?: MacDataSchema; version?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/PFX.ts:161

Generated using TypeDoc