jose/docs/functions/jws_general_verify.generalVerify.md

Function: generalVerify

💗 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.

---

▸ generalVerify(jws, key, options?): Promise<GeneralVerifyResult>

Verifies the signature and format of and afterwards decodes the General JWS.

Parameters

Name	Type	Description
jws	GeneralJWSInput	General JWS.
key	Uint8Array | KeyLike	Key to verify the JWS with. See Algorithm Key Requirements.
options?	VerifyOptions	JWS Verify options.

Returns

Promise<GeneralVerifyResult>

Example

const jws = {
  payload: 'SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4',
  signatures: [
    {
      signature:
        'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
      protected: 'eyJhbGciOiJFUzI1NiJ9',
    },
  ],
}

const { payload, protectedHeader } = await jose.generalVerify(jws, publicKey)

console.log(protectedHeader)
console.log(new TextDecoder().decode(payload))

▸ generalVerify<T>(jws, getKey, options?): Promise<GeneralVerifyResult & ResolvedKey<T>>

Type parameters

Name	Type
T	extends KeyLike = KeyLike

Parameters

Name	Type	Description
jws	GeneralJWSInput	General JWS.
getKey	GeneralVerifyGetKey	Function resolving a key to verify the JWS with. See Algorithm Key Requirements.
options?	VerifyOptions	JWS Verify options.

Returns

Promise<GeneralVerifyResult & ResolvedKey<T>>