Class DkimVerifier

A DKIM-Signature verifier.

Hierarchy (View Summary)

DkimVerifierBase
- DkimVerifier

Constructors

constructor

new DkimVerifier(publicKeyLocator: DkimPublicKeyLocator): DkimVerifier
Initialize a new instance of the DKIM verifier.
Parameters
- publicKeyLocator: DkimPublicKeyLocator
  The public key locator.
Returns DkimVerifier

Throws
publicKeyLocator is null or undefined.
Overrides DkimVerifierBase.constructor
- Defined in src/dkim/dkim-verifier.ts:21

Properties

minimumRsaKeyLength

minimumRsaKeyLength: number

The minimum allowed RSA key length.

`Protected` `Readonly`publicKeyLocator

publicKeyLocator: DkimPublicKeyLocator

The public key locator.

Methods

enable

enable(algorithm: DkimSignatureAlgorithm): void
Enable a DKIM signature algorithm.
Parameters
- algorithm: DkimSignatureAlgorithm
  The DKIM signature algorithm.
Returns void
Inherited from DkimVerifierBase.enable
- Defined in src/dkim/dkim-verifier-base.ts:88

disable

disable(algorithm: DkimSignatureAlgorithm): void
Disable a DKIM signature algorithm.
Parameters
- algorithm: DkimSignatureAlgorithm
  The DKIM signature algorithm.
Returns void
Inherited from DkimVerifierBase.disable
- Defined in src/dkim/dkim-verifier-base.ts:97

isEnabled

isEnabled(algorithm: DkimSignatureAlgorithm): boolean
Check whether a DKIM signature algorithm is enabled.
Parameters
- algorithm: DkimSignatureAlgorithm
  The DKIM signature algorithm.
Returns boolean
true if the algorithm is enabled; otherwise, false.
Inherited from DkimVerifierBase.isEnabled
- Defined in src/dkim/dkim-verifier-base.ts:107

`Static`parseParameterTags

parseParameterTags(header: HeaderId, signature: string): Map<string, string>
Parse the parameter tags of a DKIM/ARC header value.
Parameters
- header: HeaderId
  The header identifier (for error messages).
- signature: string
  The header value.
Returns Map<string, string>
A map of parameter names to values.

Throws
The value is malformed.
Inherited from DkimVerifierBase.parseParameterTags
- Defined in src/dkim/dkim-verifier-base.ts:119

`Static`validateCommonParameters

validateCommonParameters(
header: string,
parameters: Map<string, string>,
): CommonParameters
Validate the common DKIM/ARC parameter tags.
Parameters
- header: string
  The header name (for error messages).
- parameters: Map<string, string>
  The parsed parameters.
Returns CommonParameters
The validated common parameters.

Throws
A required parameter is missing or malformed.
Inherited from DkimVerifierBase.validateCommonParameters
- Defined in src/dkim/dkim-verifier-base.ts:168

`Static`validateCommonSignatureParameters

validateCommonSignatureParameters(
header: string,
parameters: Map<string, string>,
): CommonSignatureParameters
Validate the common DKIM/ARC signature parameter tags.
Parameters
- header: string
  The header name (for error messages).
- parameters: Map<string, string>
  The parsed parameters.
Returns CommonSignatureParameters
The validated common signature parameters.

Throws
A required parameter is missing or malformed.
Inherited from DkimVerifierBase.validateCommonSignatureParameters
- Defined in src/dkim/dkim-verifier-base.ts:211

`Static`writeHeaderRelaxed

writeHeaderRelaxed(
    options: FormatOptions,
    stream: Stream,
    header: Header,
    isDkimSignature: boolean,
): void
Write a header using the DKIM relaxed header canonicalization.
Parameters
- options: FormatOptions
  The formatting options.
- stream: Stream
  The output stream.
- header: Header
  The header to write.
- isDkimSignature: boolean
  Whether this is the DKIM/ARC signature header.
Returns void
Inherited from DkimVerifierBase.writeHeaderRelaxed
- Defined in src/dkim/dkim-verifier-base.ts:271

`Static`writeHeaderSimple

writeHeaderSimple(
    _options: FormatOptions,
    stream: Stream,
    header: Header,
    isDkimSignature: boolean,
): void
Write a header using the DKIM simple header canonicalization.
Parameters
- _options: FormatOptions
  The formatting options (unused).
- stream: Stream
  The output stream.
- header: Header
  The header to write.
- isDkimSignature: boolean
  Whether this is the DKIM/ARC signature header.
Returns void
Inherited from DkimVerifierBase.writeHeaderSimple
- Defined in src/dkim/dkim-verifier-base.ts:314

createVerifyContext

createVerifyContext(
algorithm: DkimSignatureAlgorithm,
key: AsymmetricKey,
): DigestSigner
Create the digest verifying context.
Parameters
- algorithm: DkimSignatureAlgorithm
  The DKIM signature algorithm.
- key: AsymmetricKey
  The public (or private) key.
Returns DigestSigner
The digest signer.
Inherited from DkimVerifierBase.createVerifyContext
- Defined in src/dkim/dkim-verifier-base.ts:337

`Static`writeHeaders

writeHeaders(
    options: FormatOptions,
    message: MimeMessage,
    fields: readonly string[],
    headerCanonicalizationAlgorithm: DkimCanonicalizationAlgorithm,
    stream: Stream,
): void
Write the signed message headers to the stream (in DKIM signing order).
Parameters
- options: FormatOptions
  The formatting options.
- message: MimeMessage
  The message.
- fields: readonly string[]
  The header field names to sign.
- headerCanonicalizationAlgorithm: DkimCanonicalizationAlgorithm
  The header canonicalization algorithm.
- stream: Stream
  The output stream.
Returns void
Inherited from DkimVerifierBase.writeHeaders
- Defined in src/dkim/dkim-verifier-base.ts:350

`Static`getSignedSignatureHeader

getSignedSignatureHeader(header: Header): Header
Get the signed DKIM/ARC signature header (with the b= value stripped).
Parameters
- header: Header
  The DKIM-Signature/ARC-* header.
Returns Header
A new header whose value has the signature value removed.

Throws
The signature parameter is missing.
Inherited from DkimVerifierBase.getSignedSignatureHeader
- Defined in src/dkim/dkim-verifier-base.ts:396

`Protected` `Static`verifyBodyHash

verifyBodyHash(
    options: FormatOptions,
    message: MimeMessage,
    signatureAlgorithm: DkimSignatureAlgorithm,
    canonicalizationAlgorithm: DkimCanonicalizationAlgorithm,
    maxLength: number,
    bodyHash: string,
): boolean
Verify the hash of the message body.
Parameters
- options: FormatOptions
  The formatting options.
- message: MimeMessage
  The signed MIME message.
- signatureAlgorithm: DkimSignatureAlgorithm
  The signature algorithm.
- canonicalizationAlgorithm: DkimCanonicalizationAlgorithm
  The body canonicalization algorithm.
- maxLength: number
  The max body length to hash, or -1.
- bodyHash: string
  The expected base64 body hash.
Returns boolean
true if the computed body hash matches.
Inherited from DkimVerifierBase.verifyBodyHash
- Defined in src/dkim/dkim-verifier-base.ts:450

`Protected`verifySignature

verifySignature(
    options: FormatOptions,
    message: MimeMessage,
    dkimSignature: Header,
    signatureAlgorithm: DkimSignatureAlgorithm,
    key: AsymmetricKey,
    headers: readonly string[],
    canonicalizationAlgorithm: DkimCanonicalizationAlgorithm,
    signature: string,
): Promise<boolean>
Verify the signature of the message headers.
Parameters
- options: FormatOptions
  The formatting options.
- message: MimeMessage
  The signed MIME message.
- dkimSignature: Header
  The DKIM-Signature or ARC-Message-Signature header.
- signatureAlgorithm: DkimSignatureAlgorithm
  The signature algorithm.
- key: AsymmetricKey
  The public key.
- headers: readonly string[]
  The signed header field names.
- canonicalizationAlgorithm: DkimCanonicalizationAlgorithm
  The header canonicalization algorithm.
- signature: string
  The expected base64 signature.
Returns Promise<boolean>
true if the signature verifies.
Inherited from DkimVerifierBase.verifySignature
- Defined in src/dkim/dkim-verifier-base.ts:468

verify

verify(
    options: FormatOptions,
    message: MimeMessage,
    dkimSignature: Header,
): Promise<boolean>
Verify the specified DKIM-Signature header.
Parameters
- options: FormatOptions
- message: MimeMessage
- dkimSignature: Header
Returns Promise<boolean>
true if the DKIM-Signature is valid; otherwise, false.

Throws
A required argument is null, or the header is not a DKIM-Signature.

Throws
The DKIM-Signature header value is malformed.
- Defined in src/dkim/dkim-verifier.ts:67
verify(message: MimeMessage, dkimSignature: Header): Promise<boolean>
Verify the specified DKIM-Signature header.
Parameters
- message: MimeMessage
- dkimSignature: Header
Returns Promise<boolean>
true if the DKIM-Signature is valid; otherwise, false.

Throws
A required argument is null, or the header is not a DKIM-Signature.

Throws
The DKIM-Signature header value is malformed.
- Defined in src/dkim/dkim-verifier.ts:68

Class DkimVerifier

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DkimVerifier

Throws

Properties

minimumRsaKeyLength

Protected ReadonlypublicKeyLocator

Methods

enable

Parameters

Returns void

disable

Parameters

Returns void

isEnabled

Parameters

Returns boolean

StaticparseParameterTags

Parameters

Returns Map<string, string>

Throws

StaticvalidateCommonParameters

Parameters

Returns CommonParameters

Throws

StaticvalidateCommonSignatureParameters

Parameters

Returns CommonSignatureParameters

Throws

StaticwriteHeaderRelaxed

Parameters

Returns void

StaticwriteHeaderSimple

Parameters

Returns void

createVerifyContext

Parameters

Returns DigestSigner

StaticwriteHeaders

Parameters

Returns void

StaticgetSignedSignatureHeader

Parameters

Returns Header

Throws

Protected StaticverifyBodyHash

Parameters

Returns boolean

ProtectedverifySignature

Parameters

Returns Promise<boolean>

verify

Parameters

Returns Promise<boolean>

Throws

Throws

Parameters

Returns Promise<boolean>

Throws

Throws

Settings

On This Page

`Protected` `Readonly`publicKeyLocator

`Static`parseParameterTags

`Static`validateCommonParameters

`Static`validateCommonSignatureParameters

`Static`writeHeaderRelaxed

`Static`writeHeaderSimple

`Static`writeHeaders

`Static`getSignedSignatureHeader

`Protected` `Static`verifyBodyHash

`Protected`verifySignature