Class AuthenticatedData

Authenticated Data

Asn

AuthenticatedData ::= SEQUENCE {
    version CMSVersion,
    originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
    recipientInfos RecipientInfos,
    macAlgorithm MessageAuthenticationCodeAlgorithm,
    digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL,
    encapContentInfo EncapsulatedContentInfo,
    authAttrs [2] IMPLICIT AuthAttributes OPTIONAL,
    mac MessageAuthenticationCode,
    unauthAttrs [3] IMPLICIT UnauthAttributes OPTIONAL
}

DigestAlgorithmIdentifier ::= AlgorithmIdentifier

Hierarchy (View Summary)

PkiBase<AuthenticatedData>
- AuthenticatedData

Index

Constructors

constructor

new AuthenticatedData(
    options: {
        authAttrs?: Attribute[];
        digestAlgorithm?: DigestAlgorithmIdentifier;
        encapContentInfo: EncapsulatedContentInfo;
        mac: Uint8Array;
        macAlgorithm: AlgorithmIdentifier;
        originatorInfo?: OriginatorInfo;
        recipientInfos: RecipientInfo[];
        unauthAttrs?: Attribute[];
        version: number;
    },
): AuthenticatedData
Creates a new AuthenticatedData instance.
Parameters
- options: {
      authAttrs?: Attribute[];
      digestAlgorithm?: DigestAlgorithmIdentifier;
      encapContentInfo: EncapsulatedContentInfo;
      mac: Uint8Array;
      macAlgorithm: AlgorithmIdentifier;
      originatorInfo?: OriginatorInfo;
      recipientInfos: RecipientInfo[];
      unauthAttrs?: Attribute[];
      version: number;
  }
Returns AuthenticatedData
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs7/AuthenticatedData.ts:202

Properties

`Optional`authAttrs

authAttrs?: AuthAttributes

Optional authenticated attributes.

`Optional`digestAlgorithm

digestAlgorithm?: DigestAlgorithmIdentifier

Optional digest algorithm.

encapContentInfo

encapContentInfo: EncapsulatedContentInfo

The encapsulated content information.

mac

mac: MessageAuthenticationCode

The message authentication code.

macAlgorithm

macAlgorithm: AlgorithmIdentifier

The MAC algorithm used for authentication.

`Optional`originatorInfo

originatorInfo?: OriginatorInfo

Optional information about the originator.

recipientInfos

recipientInfos: RecipientInfos

A collection of per-recipient information.

`Optional`unauthAttrs

unauthAttrs?: UnauthAttributes

Optional unauthenticated attributes.

version

version: number

The version of the AuthenticatedData structure.

`Static`AuthAttributes

AuthAttributes: typeof AuthAttributes = AuthAttributes

Internal AuthAttributes class

`Static`MessageAuthenticationCode

MessageAuthenticationCode: typeof MessageAuthenticationCode = MessageAuthenticationCode

Internal MessageAuthenticationCode class

`Static`RecipientInfos

RecipientInfos: typeof RecipientInfos = RecipientInfos

Internal RecipientInfos class

`Static`UnauthAttributes

UnauthAttributes: typeof UnauthAttributes = UnauthAttributes

Internal UnauthAttributes class

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

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

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

toCms

toCms(): ContentInfo
Wraps this AuthenticatedData in a ContentInfo structure.

Returns ContentInfo
- Defined in packages/pki-lite/src/pkcs7/AuthenticatedData.ts:434

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`fromAsn1

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

Class AuthenticatedData

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AuthenticatedData

Properties

OptionalauthAttrs

OptionaldigestAlgorithm

encapContentInfo

mac

macAlgorithm

OptionaloriginatorInfo

recipientInfos

OptionalunauthAttrs

version

StaticAuthAttributes

StaticMessageAuthenticationCode

StaticRecipientInfos

StaticUnauthAttributes

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

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

StaticfromAsn1

Parameters

Returns AuthenticatedData

Settings

On This Page

`Optional`authAttrs

`Optional`digestAlgorithm

`Optional`originatorInfo

`Optional`unauthAttrs

`Static`AuthAttributes

`Static`MessageAuthenticationCode

`Static`RecipientInfos

`Static`UnauthAttributes

`Static`fromAsn1