Class: KeyAgreeRecipientInfo

Represents the KeyAgreeRecipientInfo structure described in RFC5652

Hierarchy

• PkiObject

  ↳ KeyAgreeRecipientInfo

Implements

• IKeyAgreeRecipientInfo

Constructors

constructor

• new KeyAgreeRecipientInfo(parameters?): KeyAgreeRecipientInfo

Initializes a new instance of the KeyAgreeRecipientInfo class

Parameters

Name	Type	Description
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 className(): string

Returns

string

Inherited from

PkiObject.className

Methods

fromSchema

▸ fromSchema(schema): void

Converts parsed ASN.1 object into current class

Parameters

Name	Type	Description
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

Name	Type	Default value
encoding	"base64" | "base64url" | "hex"	"hex"

Returns

string

Inherited from

PkiObject.toString

---

blockName

▸ blockName(): string

Returns block name

Returns

string

Returns string block name

Inherited from

PkiObject.blockName

---

compareWithDefault

▸ compareWithDefault(memberName, memberValue): boolean

Compare values with default values for all class members

Parameters

Name	Type	Description
memberName	string	String name for a class member
memberValue	any	Value to compare with default value

Returns

boolean

---

defaultValues

▸ defaultValues(memberName): number

Returns default values for all class members

Parameters

Name	Type	Description
memberName	"version"	String name for a class member

Returns

number

Default value

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): OriginatorIdentifierOrKey

Parameters

Name	Type
memberName	"originator"

Returns

OriginatorIdentifierOrKey

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): OctetString

Parameters

Name	Type
memberName	"ukm"

Returns

OctetString

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): AlgorithmIdentifier

Parameters

Name	Type
memberName	"keyEncryptionAlgorithm"

Returns

AlgorithmIdentifier

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): RecipientEncryptedKeys

Parameters

Name	Type
memberName	"recipientEncryptedKeys"

Returns

RecipientEncryptedKeys

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): Certificate

Parameters

Name	Type
memberName	"recipientCertificate"

Returns

Certificate

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): null

Parameters

Name	Type
memberName	"recipientPublicKey"

Returns

null

Overrides

PkiObject.defaultValues

---

fromBER

▸ fromBER<T>(this, raw): T

Creates PKI object from the raw data

Type parameters

Name	Type
T	extends PkiObject

Parameters

Name	Type	Description
this	PkiObjectConstructor<T>	-
raw	BufferSource	ASN.1 encoded raw data

Returns

T

Initialized and filled current class object

Inherited from

PkiObject.fromBER

---

schema

▸ schema(parameters?): any

Returns value of pre-defined ASN.1 schema for current class

Parameters

Name	Type	Description
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