Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.33 KB

flattenedVerify.md

File metadata and controls

65 lines (43 loc) · 3.33 KB
Raw

Function: flattenedVerify()

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

Call Signature

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

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

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/jws/flattened/verify'.

Parameters

Parameter Type Description
jws FlattenedJWSInput Flattened JWS.
key Uint8Array | KeyLike | JWK Key to verify the JWS with. See Algorithm Key Requirements.
options? VerifyOptions JWS Verify options.

Returns

Promise<FlattenedVerifyResult>

Example

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

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

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

Call Signature

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

Type Parameters

Type Parameter Default type
KeyLikeType extends KeyLike KeyLike

Parameters

Parameter Type Description
jws FlattenedJWSInput Flattened JWS.
getKey FlattenedVerifyGetKey Function resolving a key to verify the JWS with. See Algorithm Key Requirements.
options? VerifyOptions JWS Verify options.

Returns

Promise<FlattenedVerifyResult & ResolvedKey<KeyLikeType>>