jws_flattened_verify.flattenedVerify.md

Function: flattenedVerify

▸ flattenedVerify(jws, key, options?): Promise<FlattenedVerifyResult>

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

example Usage

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

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

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

example ESM import

import { flattenedVerify } from 'jose'

example CJS import

const { flattenedVerify } = require('jose')

example Deno import

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

Parameters

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

Returns

Promise<FlattenedVerifyResult>

▸ flattenedVerify(jws, getKey, options?): Promise<FlattenedVerifyResult & ResolvedKey>

Parameters

Name	Type	Description
jws	FlattenedJWSInput	Flattened JWS.
getKey	FlattenedVerifyGetKey	Function resolving a key to verify the JWS with.
options?	VerifyOptions	JWS Verify options.

Returns

Promise<FlattenedVerifyResult & ResolvedKey>