Skip to main content

KeyAgreeRecipientInfo

Represents the KeyAgreeRecipientInfo structure described in RFC5652

Extends​

Implements​

Constructors​

new KeyAgreeRecipientInfo()​

new KeyAgreeRecipientInfo(parameters): KeyAgreeRecipientInfo

Initializes a new instance of the KeyAgreeRecipientInfo class

Parameters​

parameters​

KeyAgreeRecipientInfoParameters = {}

Initialization parameters

Returns​

KeyAgreeRecipientInfo

Overrides​

PkiObject.constructor

Properties​

keyEncryptionAlgorithm​

keyEncryptionAlgorithm: AlgorithmIdentifier

Implementation of​

IKeyAgreeRecipientInfo.keyEncryptionAlgorithm

originator​

originator: OriginatorIdentifierOrKey

Implementation of​

IKeyAgreeRecipientInfo.originator

recipientCertificate​

recipientCertificate: Certificate

Implementation of​

IKeyAgreeRecipientInfo.recipientCertificate

recipientEncryptedKeys​

recipientEncryptedKeys: RecipientEncryptedKeys

Implementation of​

IKeyAgreeRecipientInfo.recipientEncryptedKeys

recipientPublicKey​

recipientPublicKey: null | CryptoKey

Implementation of​

IKeyAgreeRecipientInfo.recipientPublicKey

ukm?​

optional ukm: OctetString

Implementation of​

IKeyAgreeRecipientInfo.ukm

version​

version: number

Implementation of​

IKeyAgreeRecipientInfo.version

CLASS_NAME​

static CLASS_NAME: string = "KeyAgreeRecipientInfo"

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(): KeyAgreeRecipientInfoJson

Conversion for the class to JSON object

Returns​

KeyAgreeRecipientInfoJson

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"

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

Returns default values for all class members

Parameters​
memberName​

"version"

String name for a class member

Returns​

number

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): OriginatorIdentifierOrKey

Returns default values for all class members

Parameters​
memberName​

"originator"

String name for a class member

Returns​

OriginatorIdentifierOrKey

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): OctetString

Returns default values for all class members

Parameters​
memberName​

"ukm"

String name for a class member

Returns​

OctetString

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): AlgorithmIdentifier

Returns default values for all class members

Parameters​
memberName​

"keyEncryptionAlgorithm"

String name for a class member

Returns​

AlgorithmIdentifier

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): RecipientEncryptedKeys

Returns default values for all class members

Parameters​
memberName​

"recipientEncryptedKeys"

String name for a class member

Returns​

RecipientEncryptedKeys

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): Certificate

Returns default values for all class members

Parameters​
memberName​

"recipientCertificate"

String name for a class member

Returns​

Certificate

Default value

Overrides​

PkiObject.defaultValues

Call Signature​

static defaultValues(memberName): null

Returns default values for all class members

Parameters​
memberName​

"recipientPublicKey"

String name for a class member

Returns​

null

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<{ keyEncryptionAlgorithm: AlgorithmIdentifierSchema; originator: OriginatorIdentifierOrKeySchema; recipientEncryptedKeys: RecipientEncryptedKeysSchema; ukm: string; version: string; }> = {}

Input parameters for the schema

Returns​

any

ASN.1 schema object

Overrides​

PkiObject.schema