@unvision/jose
Version:
Implementation of the RFCs of the JOSE Working Group.
57 lines (56 loc) • 2.52 kB
TypeScript
/// <reference types="node" />
import { SupportedJsonWebKeyAlgorithm } from '../../jwk/algorithms/types/supported-jsonwebkey-algorithm';
import { JsonWebKey } from '../../jwk/jsonwebkey';
import { SupportedJsonWebSignatureAlgorithm } from './types/supported-jsonwebsignature-algorithm';
/**
* Abstract Base Class for the JSON Web Signature Algorithm.
*
* All JSON Web Signature Algorithms **MUST** extend this base class and implement its abstract methods.
*
* @see https://www.rfc-editor.org/rfc/rfc7518.html#section-3
*/
export declare abstract class JsonWebSignatureAlgorithm {
/**
* Name of the JSON Web Signature Algorithm.
*/
protected readonly algorithm: SupportedJsonWebSignatureAlgorithm;
/**
* Hash Algorithm used to Sign and Verify Messages.
*/
protected readonly hash?: string;
/**
* Type of JSON Web Key supported by this JSON Web Signature Algorithm.
*/
protected readonly keyType?: SupportedJsonWebKeyAlgorithm;
/**
* Instantiates a new JSON Web Signature Algorithm to Sign and Verify Messages.
*
* @param algorithm Name of the JSON Web Signature Algorithm.
* @param hash Hash Algorithm used to Sign and Verify Messages.
* @param keyType Type of JSON Web Key supported by this JSON Web Signature Algorithm.
*/
constructor(algorithm: SupportedJsonWebSignatureAlgorithm, hash?: string, keyType?: SupportedJsonWebKeyAlgorithm);
/**
* Signs a Message with the provided JSON Web Key.
*
* @param message Message to be Signed.
* @param key JSON Web Key used to Sign the provided Message.
* @returns Resulting Signature of the provided Message.
*/
abstract sign(message: Buffer, key?: JsonWebKey): Promise<Buffer>;
/**
* Checks if the provided Signature matches the provided Message based on the provided JSON Web Key.
*
* @param signature Signature to be matched against the provided Message.
* @param message Message to be matched against the provided Signature.
* @param key JSON Web Key used to verify the Signature and Message.
*/
abstract verify(signature: Buffer, message: Buffer, key?: JsonWebKey): Promise<void>;
/**
* Checks if the provided JSON Web Key can be used by the requesting JSON Web Signature Algorithm.
*
* @param key JSON Web Key to be checked.
* @throws {InvalidJsonWebKeyException} The provided JSON Web Key is invalid.
*/
protected validateJsonWebKey(key: JsonWebKey): void;
}