Class SessionEnvelopedData

CMS EnvelopedData representation using the Channel Session Protocol.

Consequently, it uses the key agreement (KeyAgreeRecipientInfo) from CMS.

Hierarchy (view full)

EnvelopedData
- SessionEnvelopedData

Index

Methods

decrypt getOriginatorKey getRecipientKeyId serialize deserialize encrypt

Methods

decrypt

decrypt(privateKey): Promise<ArrayBuffer>
Return the plaintext for the ciphertext contained in the current EnvelopedData value.
Parameters
- privateKey: CryptoKey
  The private key to decrypt the ciphertext.
Returns Promise<ArrayBuffer>
Inherited from EnvelopedData.decrypt
- Defined in src/lib/crypto/cms/envelopedData.ts:107

getOriginatorKey

getOriginatorKey(): Promise<SessionKey>
Return the key of the ECDH key of the originator/producer of the EnvelopedData value.

Returns Promise<SessionKey>
- Defined in src/lib/crypto/cms/envelopedData.ts:236

getRecipientKeyId

getRecipientKeyId(): Buffer
Return the id of the recipient's key used to encrypt the content.

This id will often be the recipient's certificate's serial number, in which case the issuer will be ignored: This method is meant to be used by the recipient so it can look up the corresponding private key to decrypt the content. We could certainly extract the issuer to verify it matches the expected one, but if the id doesn't match any key decryption won't even be attempted, so there's really no risk from ignoring the issuer.

Returns Buffer
Overrides EnvelopedData.getRecipientKeyId
- Defined in src/lib/crypto/cms/envelopedData.ts:257

serialize

serialize(): ArrayBuffer
Return the DER serialization of the current EnvelopedData value.

It'll be wrapped around a ContentInfo value.

Returns ArrayBuffer
Inherited from EnvelopedData.serialize
- Defined in src/lib/crypto/cms/envelopedData.ts:94

`Static` deserialize

deserialize(envelopedDataSerialized): EnvelopedData
Deserialize an EnvelopedData value into a SessionlessEnvelopedData or SessionEnvelopedData instance.

Depending on the type of RecipientInfo.
Parameters
- envelopedDataSerialized: ArrayBuffer
Returns EnvelopedData
Inherited from EnvelopedData.deserialize
- Defined in src/lib/crypto/cms/envelopedData.ts:48

`Static` encrypt

encrypt(plaintext, recipientSessionKey, options?): Promise<SessionEncryptionResult>
Return an EnvelopedData value using the Channel Session Protocol.
Parameters
- plaintext: ArrayBuffer
  The plaintext whose ciphertext has to be embedded in the EnvelopedData value.
- recipientSessionKey: SessionKey
  The ECDH public key of the recipient.
- options: Partial<EncryptionOptions> = {}
  Any encryption options.
Returns Promise<SessionEncryptionResult>
- Defined in src/lib/crypto/cms/envelopedData.ts:197

Generated using TypeDoc