Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.77 KB

jws_compact_verify.compactVerify.md

File metadata and controls

45 lines (29 loc) · 1.77 KB
Raw

Function: compactVerify

💗 Help the project

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

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

example Usage

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))

Parameters

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

Returns

Promise<CompactVerifyResult>

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

Parameters

Name Type Description
jws string | Uint8Array Compact JWS.
getKey CompactVerifyGetKey Function resolving a key to verify the JWS with.
options? VerifyOptions JWS Verify options.

Returns

Promise<CompactVerifyResult & ResolvedKey>