Class EnvelopedData

Represents a CMS EnvelopedData structure as defined in RFC 5652.

Asn

EnvelopedData ::= SEQUENCE {
    version CMSVersion,
    originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
    recipientInfos RecipientInfos,
    encryptedContentInfo EncryptedContentInfo,
    unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
}

Hierarchy (View Summary)

PkiBase<EnvelopedData>
- EnvelopedData

Index

Constructors

constructor

new EnvelopedData(
    options: {
        encryptedContentInfo: EncryptedContentInfo;
        originatorInfo?: OriginatorInfo;
        recipientInfos: RecipientInfo[];
        unprotectedAttrs?: Attribute[];
        version: number;
    },
): EnvelopedData
Creates a new EnvelopedData instance.
Parameters
- options: {
      encryptedContentInfo: EncryptedContentInfo;
      originatorInfo?: OriginatorInfo;
      recipientInfos: RecipientInfo[];
      unprotectedAttrs?: Attribute[];
      version: number;
  }
Returns EnvelopedData
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:116

Properties

encryptedContentInfo

encryptedContentInfo: EncryptedContentInfo

The encrypted content and associated parameters.

`Optional`originatorInfo

originatorInfo?: OriginatorInfo

Optional information about the originator.

recipientInfos

recipientInfos: RecipientInfos

A collection of per-recipient information.

`Optional`unprotectedAttrs

unprotectedAttrs?: Attributes

Optional unprotected attributes.

version

version: number

The version of the EnvelopedData structure.

`Static`RecipientInfos

RecipientInfos: typeof RecipientInfos = RecipientInfos

Represents a set of RecipientInfo structures.

Asn

RecipientInfos ::= SET SIZE (1..MAX) OF RecipientInfo

`Static`UnprotectedAttributes

UnprotectedAttributes: typeof Attributes = UnprotectedAttributes

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Inherited from PkiBase.pemHeader
- Defined in packages/pki-lite/src/core/PkiBase.ts:60

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

addCrl

addCrl(crl: CertificateList): void
Parameters
- crl: CertificateList
Returns void
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:342

addOcsp

addOcsp(OCSP: OCSPResponse): void
Parameters
- OCSP: OCSPResponse
Returns void
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:330

decrypt

decrypt(privateKey: PrivateKeyInfo): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- privateKey: PrivateKeyInfo
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:296

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Asn1BaseBlock
Converts the EnvelopedData to an ASN.1 structure.

Returns Asn1BaseBlock
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:146

toCms

toCms(): ContentInfo
Returns ContentInfo
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:289

toDer

toDer(): Uint8Array
Converts this PKI object to DER (Distinguished Encoding Rules) format.

Returns Uint8Array
The DER-encoded bytes of this object
Inherited from PkiBase.toDer
- Defined in packages/pki-lite/src/core/PkiBase.ts:100

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts this PKI object to PEM (Privacy-Enhanced Mail) format.

Returns string
A PEM-encoded string with appropriate headers
Inherited from PkiBase.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from PkiBase.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

`Static`builder

builder(): EnvelopedDataBuilder
Returns EnvelopedDataBuilder
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:285

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): EnvelopedData
Creates an EnvelopedData from an ASN.1 structure.
Parameters
- asn1: Asn1BaseBlock
Returns EnvelopedData
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:182

`Static`fromCms

fromCms(cms: Uint8Array<ArrayBufferLike> | ContentInfo): EnvelopedData
Parameters
- cms: Uint8Array<ArrayBufferLike> | ContentInfo
Returns EnvelopedData
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:267

`Static`fromDer

fromDer(der: Uint8Array): EnvelopedData
Parameters
- der: Uint8Array
Returns EnvelopedData
- Defined in packages/pki-lite/src/pkcs7/EnvelopedData.ts:263

Class EnvelopedData

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EnvelopedData

Properties

encryptedContentInfo

OptionaloriginatorInfo

recipientInfos

OptionalunprotectedAttrs

version

StaticRecipientInfos

Asn

StaticUnprotectedAttributes

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

addCrl

Parameters

Returns void

addOcsp

Parameters

Returns void

decrypt

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toCms

Returns ContentInfo

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

Staticbuilder

Returns EnvelopedDataBuilder

StaticfromAsn1

Parameters

Returns EnvelopedData

StaticfromCms

Parameters

Returns EnvelopedData

StaticfromDer

Parameters

Returns EnvelopedData

Settings

On This Page

`Optional`originatorInfo

`Optional`unprotectedAttrs

`Static`RecipientInfos

`Static`UnprotectedAttributes

`Static`builder

`Static`fromAsn1

`Static`fromCms

`Static`fromDer