Class SignedData

Represents a CMS/PKCS#7 SignedData structure.

SignedData is used to digitally sign content. It can contain the signed content (attached signature) or just the signature information (detached signature). Multiple signers can sign the same content, and certificates and CRLs can be included for signature verification.

Asn

SignedData ::= SEQUENCE {
     version CMSVersion,
     digestAlgorithms DigestAlgorithmIdentifiers,
     encapContentInfo EncapsulatedContentInfo,
     certificates [0] IMPLICIT CertificateSet OPTIONAL,
     crls [1] IMPLICIT RevocationInfoChoices OPTIONAL,
     signerInfos SignerInfos
}
CMSVersion ::= INTEGER
DigestAlgorithmIdentifiers ::= SET OF DigestAlgorithmIdentifier
DigestAlgorithmIdentifier ::= AlgorithmIdentifier
SignerInfos ::= SET OF SignerInfo
CertificateSet ::= SET OF Certificate
RevocationInfoChoices ::= SET OF RevocationInfoChoice

Example

// Create signed data with builder
const signedData = await SignedData.builder()
   .setContent(new Uint8Array([0x01, 0x02, 0x03, 0x04]))
   .addSigner({
       certificate: signerCert,
       privateKey: signerPrivateKey
   })
   .addCertificate(signerCert)
   .build()

// Verify signatures
const isValid = await signedData.verify({
    data: originalData,
})

Hierarchy (View Summary)

PkiBase<SignedData>
- SignedData

Index

Constructors

constructor

new SignedData(
    options: {
        certificates?: CertificateChoices[];
        crls?: RevocationInfoChoice[];
        digestAlgorithms: AlgorithmIdentifier[];
        encapContentInfo: EncapsulatedContentInfo;
        signerInfos: SignerInfo[];
        version: number;
    },
): SignedData
Parameters
- options: {
      certificates?: CertificateChoices[];
      crls?: RevocationInfoChoice[];
      digestAlgorithms: AlgorithmIdentifier[];
      encapContentInfo: EncapsulatedContentInfo;
      signerInfos: SignerInfo[];
      version: number;
  }
Returns SignedData
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:164

Properties

`Optional`certificates

certificates?: CertificateSet

Optional set of certificates for signature verification.

`Optional`crls

crls?: RevocationInfoChoices

Optional set of certificate revocation information.

digestAlgorithms

digestAlgorithms: DigestAlgorithmIdentifiers

Set of digest algorithms used by signers.

encapContentInfo

encapContentInfo: EncapsulatedContentInfo

Information about the encapsulated content being signed.

signerInfos

signerInfos: SignerInfos

version

version: number

Version of the CMS structure.

`Static`CertificateSet

CertificateSet: typeof CertificateSet = CertificateSet

Reference to CertificateSet class.

`Static`DigestAlgorithmIdentifier

DigestAlgorithmIdentifier: typeof DigestAlgorithmIdentifier = DigestAlgorithmIdentifier

Reference to DigestAlgorithmIdentifier class.

`Static`DigestAlgorithmIdentifiers

DigestAlgorithmIdentifiers: typeof DigestAlgorithmIdentifiers = DigestAlgorithmIdentifiers

Reference to DigestAlgorithmIdentifiers class.

`Static`RevocationInfoChoices

RevocationInfoChoices: typeof RevocationInfoChoices = RevocationInfoChoices

Reference to RevocationInfoChoices class.

`Static`SignerInfos

SignerInfos: typeof SignerInfos = SignerInfos

Reference to SignerInfos 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

addCrl

addCrl(crl: CertificateList): void
Adds a CRL to the SignedData's CRLs.
Parameters
- crl: CertificateList
  The CertificateList (CRL) to add
Returns void
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:534

addOcsp

addOcsp(OCSP: OCSPResponse): void
Adds an OCSPResponse to the SignedData's CRLs.
Parameters
- OCSP: OCSPResponse
  The OCSPResponse to add
Returns void
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:519

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

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

toCms

toCms(): ContentInfo
Returns a ContentInfo object with this SignedData as content

Returns ContentInfo
ContentInfo object
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:399

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

verify

verify(
    options: {
        certificateValidation?: true | CertificateValidationOptions;
        data?: Uint8Array<ArrayBufferLike>;
    },
): Promise<
    | { signerInfo: SignerInfo; valid: true }
    | { reasons: string[]; valid: false },
>
Verifies the signatures in the SignedData object.
Parameters
- options: {
  certificateValidation?: true | CertificateValidationOptions;
  data?: Uint8Array<ArrayBufferLike>;
  }
  Verification options
  - OptionalcertificateValidation?: true | CertificateValidationOptions
    Certificate validation options or true for default validation
  - Optionaldata?: Uint8Array<ArrayBufferLike>
    Optional original data for detached signatures
Returns Promise<
| { signerInfo: SignerInfo; valid: true }
| { reasons: string[]; valid: false },
>
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:414

`Static`builder

builder(): SignedDataBuilder
Creates a builder for constructing a SignedData object.

Returns SignedDataBuilder
A new SignedDataBuilder instance
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:391

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): SignedData
Creates a SignedData from an ASN.1 structure.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 structure
Returns SignedData
The SignedData object
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:236

`Static`fromCms

fromCms(cms: Uint8Array<ArrayBufferLike> | ContentInfo): SignedData
Creates a SignedData from a ContentInfo structure or DER bytes.
Parameters
- cms: Uint8Array<ArrayBufferLike> | ContentInfo
  The ContentInfo or DER bytes
Returns SignedData
The SignedData object
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:369

`Static`fromDer

fromDer(der: Uint8Array): SignedData
Creates a SignedData from a DER-encoded byte array.
Parameters
- der: Uint8Array
  The DER-encoded SignedData
Returns SignedData
The SignedData object
- Defined in packages/pki-lite/src/pkcs7/SignedData.ts:360

Class SignedData

Asn

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignedData

Properties

Optionalcertificates

Optionalcrls

digestAlgorithms

encapContentInfo

signerInfos

version

StaticCertificateSet

StaticDigestAlgorithmIdentifier

StaticDigestAlgorithmIdentifiers

StaticRevocationInfoChoices

StaticSignerInfos

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

addCrl

Parameters

Returns void

addOcsp

Parameters

Returns void

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

verify

Parameters

OptionalcertificateValidation?: true | CertificateValidationOptions

Optionaldata?: Uint8Array<ArrayBufferLike>

Returns Promise< | { signerInfo: SignerInfo; valid: true } | { reasons: string[]; valid: false },>

Staticbuilder

Returns SignedDataBuilder

StaticfromAsn1

Parameters

Returns SignedData

StaticfromCms

Parameters

Returns SignedData

StaticfromDer

Parameters

Returns SignedData

Settings

On This Page

`Optional`certificates

`Optional`crls

`Static`CertificateSet

`Static`DigestAlgorithmIdentifier

`Static`DigestAlgorithmIdentifiers

`Static`RevocationInfoChoices

`Static`SignerInfos

`Optional`certificateValidation?: true | CertificateValidationOptions

`Optional`data?: Uint8Array<ArrayBufferLike>

Returns Promise<
| { signerInfo: SignerInfo; valid: true }
| { reasons: string[]; valid: false },
>

`Static`builder

`Static`fromAsn1

`Static`fromCms

`Static`fromDer