Class ArcSigner`Abstract`

An ARC signer.

Hierarchy (View Summary)

DkimSignerBase
- ArcSigner

Index

Constructors

Properties

domain selector signatureAlgorithm bodyCanonicalizationAlgorithm headerCanonicalizationAlgorithm signaturesExpireAfter privateKey

Methods

generateArcAuthenticationResults getTimestamp sign createSigningContext

Constructors

`Protected`constructor

new ArcSigner(
    key: DkimPrivateKeySource,
    domain: string,
    selector: string,
    algorithm?: DkimSignatureAlgorithm,
): ArcSigner
Initialize a new instance of the signer base.
Parameters
- key: DkimPrivateKeySource
  The private key (an AsymmetricKey, PEM string, PEM bytes, or a stream containing a PEM private key).
- domain: string
  The domain that the signer represents.
- selector: string
  The selector subdividing the domain.
- algorithm: DkimSignatureAlgorithm = DkimSignatureAlgorithm.RsaSha256
  The signature algorithm.
Returns ArcSigner

Throws
key, domain, or selector is null; key is empty or not a private key.
Inherited from DkimSignerBase.constructor
- Defined in src/dkim/dkim-signer-base.ts:85

Properties

`Readonly`domain

domain: string

The domain that the signer represents.

`Readonly`selector

selector: string

The selector subdividing the domain.

signatureAlgorithm

signatureAlgorithm: DkimSignatureAlgorithm

The algorithm to use for signing.

bodyCanonicalizationAlgorithm

bodyCanonicalizationAlgorithm: DkimCanonicalizationAlgorithm = DkimCanonicalizationAlgorithm.Simple

The canonicalization algorithm to use for the message body.

headerCanonicalizationAlgorithm

headerCanonicalizationAlgorithm: DkimCanonicalizationAlgorithm = DkimCanonicalizationAlgorithm.Simple

The canonicalization algorithm to use for the message headers.

signaturesExpireAfter

signaturesExpireAfter: number | null = null

The number of seconds after which signatures are no longer valid, or null for no expiration (C#: SignaturesExpireAfter, a TimeSpan).

`Protected` `Readonly`privateKey

privateKey: AsymmetricKey

The private key used for signing.

Methods

`Protected` `Abstract`generateArcAuthenticationResults

generateArcAuthenticationResults(
options: FormatOptions,
message: MimeMessage,
): Promise<AuthenticationResults | null>
Generate an ARC-Authentication-Results header.

If the returned AuthenticationResults contains a result with method arc, its result is used as the cv= tag value in the generated ARC-Seal.
Parameters
- options: FormatOptions
  The format options.
- message: MimeMessage
  The message.
Returns Promise<AuthenticationResults | null>
The ARC-Authentication-Results, or null to not sign the message.
- Defined in src/dkim/arc-signer.ts:42

`Protected`getTimestamp

getTimestamp(): number
Get the timestamp to use as the t= value in the ARC headers.

Returns number
The Unix timestamp in seconds.
- Defined in src/dkim/arc-signer.ts:49

sign

sign(
    options: FormatOptions,
    message: MimeMessage,
    headers: readonly string[] | readonly HeaderId[],
): Promise<void>
Digitally sign and seal a message using ARC.
Parameters
- options: FormatOptions
- message: MimeMessage
- headers: readonly string[] | readonly HeaderId[]
Returns Promise<void>

Throws
A required argument is null, or the header list is invalid.
- Defined in src/dkim/arc-signer.ts:175
sign(
message: MimeMessage,
headers: readonly string[] | readonly HeaderId[],
): Promise<void>
Digitally sign and seal a message using ARC.
Parameters
- message: MimeMessage
- headers: readonly string[] | readonly HeaderId[]
Returns Promise<void>

Throws
A required argument is null, or the header list is invalid.
- Defined in src/dkim/arc-signer.ts:176

createSigningContext

createSigningContext(): DigestSigner
Create the digest signing context.

Returns DigestSigner
The digest signer.
Inherited from DkimSignerBase.createSigningContext
- Defined in src/dkim/dkim-signer-base.ts:107

Class ArcSigner`Abstract`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

`Protected`constructor

Parameters

Returns ArcSigner

Throws

Properties

`Readonly`domain

`Readonly`selector

signatureAlgorithm

bodyCanonicalizationAlgorithm

headerCanonicalizationAlgorithm

signaturesExpireAfter

`Protected` `Readonly`privateKey

Methods

`Protected` `Abstract`generateArcAuthenticationResults

Parameters

Returns Promise<AuthenticationResults | null>

`Protected`getTimestamp

Returns number

sign

Parameters

Returns Promise<void>

Throws

Parameters

Returns Promise<void>

Throws

createSigningContext

Returns DigestSigner

Settings

On This Page

Class ArcSignerAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns ArcSigner

Throws

Properties

Readonlydomain

Readonlyselector

signatureAlgorithm

bodyCanonicalizationAlgorithm

headerCanonicalizationAlgorithm

signaturesExpireAfter

Protected ReadonlyprivateKey

Methods

Protected AbstractgenerateArcAuthenticationResults

Parameters

Returns Promise<AuthenticationResults | null>

ProtectedgetTimestamp

Returns number

sign

Parameters

Returns Promise<void>

Throws

Parameters

Returns Promise<void>

Throws

createSigningContext

Returns DigestSigner

Settings

On This Page

Class ArcSigner`Abstract`

`Protected`constructor

`Readonly`domain

`Readonly`selector

`Protected` `Readonly`privateKey

`Protected` `Abstract`generateArcAuthenticationResults

`Protected`getTimestamp