30 lines
1.8 KiB
Plaintext
30 lines
1.8 KiB
Plaintext
import type { JWTPayload, KeyLike, VerifyOptions, JWTClaimVerificationOptions, JWTHeaderParameters, GetKeyFunction, FlattenedJWSInput, JWTVerifyResult, ResolvedKey } from '../types';
|
|
/** Combination of JWS Verification options and JWT Claims Set verification options. */
|
|
export interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOptions {
|
|
}
|
|
/**
|
|
* Interface for JWT Verification dynamic key resolution. No token components have been verified at
|
|
* the time of this function call.
|
|
*
|
|
* @see [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset) to verify using a remote JSON Web Key Set.
|
|
*/
|
|
export interface JWTVerifyGetKey extends GetKeyFunction<JWTHeaderParameters, FlattenedJWSInput> {
|
|
}
|
|
/**
|
|
* Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the
|
|
* JWT Claims Set.
|
|
*
|
|
* @param jwt JSON Web Token value (encoded as JWS).
|
|
* @param key Key to verify the JWT with. See
|
|
* {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
|
|
* @param options JWT Decryption and JWT Claims Set validation options.
|
|
*/
|
|
export declare function jwtVerify<PayloadType = JWTPayload>(jwt: string | Uint8Array, key: KeyLike | Uint8Array, options?: JWTVerifyOptions): Promise<JWTVerifyResult<PayloadType>>;
|
|
/**
|
|
* @param jwt JSON Web Token value (encoded as JWS).
|
|
* @param getKey Function resolving a key to verify the JWT with. See
|
|
* {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
|
|
* @param options JWT Decryption and JWT Claims Set validation options.
|
|
*/
|
|
export declare function jwtVerify<PayloadType = JWTPayload, KeyLikeType extends KeyLike = KeyLike>(jwt: string | Uint8Array, getKey: JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<JWTVerifyResult<PayloadType> & ResolvedKey<KeyLikeType>>;
|