Skip to content

compactVerify.md

Latest commit

 

History

History
83 lines (53 loc) · 5.63 KB

compactVerify.md

File metadata and controls

83 lines (53 loc) · 5.63 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.

Call Signature

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

Call Signature

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

Verifies the signature and format of and afterwards decodes the Compact JWS, resolving the key dynamically. The result additionally carries the resolved key.

Type Parameters

Type Parameter Default type
KeyType extends Uint8Array | CryptoKey Uint8Array | CryptoKey

Parameters

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

Returns

Promise<CompactVerifyResult & ResolvedKey<KeyType>>

Call Signature

▸ compactVerify(jws, key, options?): Promise<CompactVerifyResult & Partial<ResolvedKey<Uint8Array | CryptoKey>>>

Accepts either form of the key argument. Use this overload when forwarding a value that may be either a key or a key resolution function; key is present on the result only when a resolution function was used.

Parameters

Parameter Type Description
jws string | Uint8Array Compact JWS.
key KeyInput | CompactVerifyGetKey<Uint8Array | CryptoKey> Key, or function resolving a key, to verify the JWS with. See Algorithm Key Requirements.
options? VerifyOptions JWS Verify options.

Returns

Promise<CompactVerifyResult & Partial<ResolvedKey<Uint8Array | CryptoKey>>>