Interface IDigitalSignature

An interface for a digital signature.

interface IDigitalSignature {
    signerCertificate: IDigitalCertificate | null;
    publicKeyAlgorithm: PublicKeyAlgorithm;
    digestAlgorithm: DigestAlgorithm;
    creationDate: Date;
    verify(verifySignatureOnly?: boolean): Promise<boolean>;
}

Implemented by

Index

Properties

signerCertificate publicKeyAlgorithm digestAlgorithm creationDate

Methods

Properties

`Readonly`signerCertificate

signerCertificate: IDigitalCertificate | null

The certificate used by the signer.

`Readonly`publicKeyAlgorithm

publicKeyAlgorithm: PublicKeyAlgorithm

The public key algorithm used for the signature.

`Readonly`digestAlgorithm

digestAlgorithm: DigestAlgorithm

The digest algorithm used for the signature.

`Readonly`creationDate

creationDate: Date

The creation date of the digital signature.

Methods

verify

verify(verifySignatureOnly?: boolean): Promise<boolean>
Verify the digital signature.
Parameters
- OptionalverifySignatureOnly: boolean
  When true, only the signature itself is verified; otherwise both the signature and the certificate chain are validated.
Returns Promise<boolean>
true if the signature is valid.

Throws
An error verifying the signature occurred.
- Defined in src/smime/digital-signature.ts:50