jws_general_verify.generalVerify.md

Function: generalVerify

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

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

example Usage

const decoder = new TextDecoder()
const jws = {
  payload: 'SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4',
  signatures: [
    {
      signature: 'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
      protected: 'eyJhbGciOiJFUzI1NiJ9'
    }
  ]
}

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

console.log(protectedHeader)
console.log(decoder.decode(payload))

example ESM import

import { generalVerify } from 'jose'

example CJS import

const { generalVerify } = require('jose')

example Deno import

import { generalVerify } from 'https://deno.land/x/jose@v4.1.0/index.ts'

Parameters

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

Returns

Promise<GeneralVerifyResult>

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

Parameters

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

Returns

Promise<GeneralVerifyResult & ResolvedKey>