Interface: Signature

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Configures an individual signature in a General JWS.

Methods

addSignature()

▸ addSignature(key, options?): Signature

Adds another signature to the enclosing GeneralSign and returns its configuration.

Parameters

Parameter	Type	Description
key	KeyInput	Private key or shared secret. See Algorithm Key Requirements.
options?	SignOptions	JWS Sign options.

Returns

Signature

---

done()

▸ done(): GeneralSign

Returns the enclosing GeneralSign instance.

Returns

GeneralSign

---

setProtectedHeader()

▸ setProtectedHeader(protectedHeader): Signature

Sets the JWS Protected Header. May only be called once.

Parameters

Parameter	Type	Description
protectedHeader	JWSHeaderParameters	JWS Protected Header.

Returns

Signature

---

setUnprotectedHeader()

▸ setUnprotectedHeader(unprotectedHeader): Signature

Sets the JWS Unprotected Header. May only be called once.

Parameters

Parameter	Type	Description
unprotectedHeader	JWSHeaderParameters	JWS Unprotected Header.

Returns

Signature

---

sign()

▸ sign(): Promise<GeneralJWS>

Creates all signatures on the enclosing GeneralSign, using their configured keys.

Returns

Promise<GeneralJWS>