Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.35 KB

generalVerify.md

File metadata and controls

68 lines (46 loc) · 3.35 KB
Raw

Function: generalVerify()

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

generalVerify(jws, key, options)

▸ generalVerify(jws, key, options?): Promise<GeneralVerifyResult>

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

Parameters

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

Returns

Promise<GeneralVerifyResult>

Example

const jws = {
  payload: 'SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4',
  signatures: [
    {
      signature:
        'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
      protected: 'eyJhbGciOiJFUzI1NiJ9',
    },
  ],
}

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

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

generalVerify(jws, getKey, options)

▸ generalVerify<KeyLikeType>(jws, getKey, options?): Promise<GeneralVerifyResult & ResolvedKey<KeyLikeType>>

Type Parameters

Type Parameter Default type
KeyLikeType extends KeyLike KeyLike

Parameters

Parameter Type Description
jws GeneralJWSInput General JWS.
getKey GeneralVerifyGetKey Function resolving a key to verify the JWS with. See Algorithm Key Requirements.
options? VerifyOptions JWS Verify options.

Returns

Promise<GeneralVerifyResult & ResolvedKey<KeyLikeType>>