Class EncryptedData

Represents a PKCS#7 EncryptedData structure.

Asn

EncryptedData ::= SEQUENCE {
     version INTEGER,
     encryptedContentInfo EncryptedContentInfo
     unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
}

Hierarchy (View Summary)

PkiBase<EncryptedData>
- EncryptedData

Index

Constructors

constructor

new EncryptedData(
options: { encryptedContentInfo: EncryptedContentInfo; version: number },
): EncryptedData
Parameters
- options: { encryptedContentInfo: EncryptedContentInfo; version: number }
Returns EncryptedData
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs7/EncryptedData.ts:24

Properties

encryptedContentInfo

encryptedContentInfo: EncryptedContentInfo

version

version: number

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

asCms

asCms(): ContentInfo
Returns ContentInfo
- Defined in packages/pki-lite/src/pkcs7/EncryptedData.ts:113

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 EncryptedData to an ASN.1 structure.

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

toDer

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

Returns Uint8Array<ArrayBuffer>
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(): EncryptedDataBuilder
Returns a builder for creating encrypted data.

Returns EncryptedDataBuilder
A new EncryptedDataBuilder instance
- Defined in packages/pki-lite/src/pkcs7/EncryptedData.ts:83

`Static`create

create(
    options: {
        contentType:
            | "DATA"
            | "SIGNED_DATA"
            | "ENVELOPED_DATA"
            | "SIGNED_AND_ENVELOPED_DATA"
            | "DIGESTED_DATA"
            | "ENCRYPTED_DATA"
            | "AUTHENTICATED_DATA"
            | "AUTH_ENVELOPED_DATA"
            | "TST_INFO";
        data: Uint8Array<ArrayBuffer>;
        iterations?: number;
        iv?: Uint8Array<ArrayBuffer>;
        password: string | Uint8Array<ArrayBuffer>;
        salt?: Uint8Array<ArrayBuffer>;
    },
): Promise<EncryptedData>
Creates an encrypted data structure using PBES2 (PBKDF2 + AES-256-CBC).
Parameters
- options: {
      contentType:
          | "DATA"
          | "SIGNED_DATA"
          | "ENVELOPED_DATA"
          | "SIGNED_AND_ENVELOPED_DATA"
          | "DIGESTED_DATA"
          | "ENCRYPTED_DATA"
          | "AUTHENTICATED_DATA"
          | "AUTH_ENVELOPED_DATA"
          | "TST_INFO";
      data: Uint8Array<ArrayBuffer>;
      iterations?: number;
      iv?: Uint8Array<ArrayBuffer>;
      password: string | Uint8Array<ArrayBuffer>;
      salt?: Uint8Array<ArrayBuffer>;
  }
  Configuration for creating encrypted data
Returns Promise<EncryptedData>
Promise resolving to the encrypted data
- Defined in packages/pki-lite/src/pkcs7/EncryptedData.ts:93

`Static`fromAsn1

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

Class EncryptedData

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EncryptedData

Properties

encryptedContentInfo

version

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

asCms

Returns ContentInfo

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array<ArrayBuffer>

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

Staticbuilder

Returns EncryptedDataBuilder

Staticcreate

Parameters

Returns Promise<EncryptedData>

StaticfromAsn1

Parameters

Returns EncryptedData

Settings

On This Page

`Static`builder

`Static`create

`Static`fromAsn1