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 a Compact JWS signature and decodes its payload.

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`	Public key or shared secret. 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 a Compact JWS signature and decodes its payload with a dynamically resolved key, included in the result.

Type Parameters

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

Parameters

Parameter	Type	Description
`jws`	`string` \| `Uint8Array`	Compact JWS.
`getKey`	`CompactVerifyGetKey`<`KeyType`>	Resolves a public key or shared secret from unverified token data.
`options?`	`VerifyOptions`	JWS Verify options.

Returns

Promise<CompactVerifyResult & ResolvedKey<KeyType>>

Call Signature

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

Verifies a Compact JWS and decodes its payload using a key or key resolver. The result includes key only when a resolver is used.

Parameters

Parameter	Type	Description
`jws`	`string` \| `Uint8Array`	Compact JWS.
`key`	`KeyInput` \| `CompactVerifyGetKey`<`Uint8Array` \| `CryptoKey`>	Public key or shared secret, or a function resolving one.
`options?`	`VerifyOptions`	JWS Verify options.

Returns

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