Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.45 KB

jws_general_sign.GeneralSign.md

File metadata and controls

82 lines (49 loc) · 2.45 KB

Class: GeneralSign

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.


The GeneralSign class is used to build and sign General JWS objects.

Example

const jws = await new jose.GeneralSign(
  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
)
  .addSignature(ecPrivateKey)
  .setProtectedHeader({ alg: 'ES256' })
  .addSignature(rsaPrivateKey)
  .setProtectedHeader({ alg: 'PS256' })
  .sign()

console.log(jws)

Table of contents

Constructors

Methods

Constructors

constructor

new GeneralSign(payload): GeneralSign

Parameters

Name Type Description
payload Uint8Array Binary representation of the payload to sign.

Returns

GeneralSign

Methods

addSignature

addSignature(key, options?): Signature

Adds an additional signature for the General JWS object.

Parameters

Name Type Description
key Uint8Array | KeyLike Private Key or Secret to sign the individual JWS signature with. See Algorithm Key Requirements.
options? SignOptions JWS Sign options.

Returns

Signature


sign

sign(): Promise<GeneralJWS>

Signs and resolves the value of the General JWS object.

Returns

Promise<GeneralJWS>