Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 3.34 KB

compactVerify.md

File metadata and controls

60 lines (38 loc) · 3.34 KB
Raw

Function: compactVerify()

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

compactVerify(jws, key, options)

▸ compactVerify(jws, key, options?): Promise<CompactVerifyResult>

Verifies the signature and format of and afterwards decodes the Compact 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/compact/verify'.

Parameters

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

Returns

Promise<CompactVerifyResult>

Example

const jws =
  'eyJhbGciOiJFUzI1NiJ9.SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4.kkAs_gPPxWMI3rHuVlxHaTPfDWDoqdI8jSvuSmqV-8IHIWXg9mcAeC9ggV-45ZHRbiRJ3obUIFo1rHphPA5URg'

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

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

compactVerify(jws, getKey, options)

▸ compactVerify<KeyLikeType>(jws, getKey, options?): Promise<CompactVerifyResult & ResolvedKey<KeyLikeType>>

Type Parameters

Type Parameter Default type
KeyLikeType extends KeyLike KeyLike

Parameters

Parameter Type Description
jws string | Uint8Array Compact JWS.
getKey CompactVerifyGetKey Function resolving a key to verify the JWS with. See Algorithm Key Requirements.
options? VerifyOptions JWS Verify options.

Returns

Promise<CompactVerifyResult & ResolvedKey<KeyLikeType>>