cosette/build/sign.d.ts

isomorphic Typescript COSE implementation

/// <reference types="node" />
import * as cbor from 'cbor-web';
import webcrypto from 'isomorphic-webcrypto';
import * as common from './common';
export { webcrypto, cbor };
export declare const SignTag = 98;
export declare const Sign1Tag = 18;
export interface CreateOptions {
    encodep?: string;
    excludetag?: boolean;
}
export interface Signer {
    externalAAD?: Buffer | ArrayBuffer;
    key: CryptoKey;
    u?: {
        kid: number | string;
    };
    p?: {
        alg: string;
    };
}
export declare type Signers = Signer | Signer[];
export declare function create(headers: common.HeaderPU, payload: any, signers: Signers, options?: CreateOptions): Promise<any>;
export declare type AlgorithmParams = Algorithm | RsaPssParams | EcdsaParams;
export declare type VerifierFunction = (kid: Uint8Array, algorithm: AlgorithmParams) => Promise<Verifier>;
export interface Verifier {
    externalAAD?: ArrayBuffer | Buffer;
    key: CryptoKey;
    kid?: string;
}
export interface VerifyOptions {
    defaultType?: number;
}
/**
 * Error thrown where a message signature could not be verified.
 * This may mean that the message was forged.
 *
 * @member plaintext The decoded message, for which the signature is incorrect.
 */
export declare class SignatureMismatchError extends Error {
    /** The decoded CBOR message with an invalid signature.  */
    plaintext: any;
    constructor(plaintext: any);
}
/**
 * Verify the COSE signature of a CBOR message.
 *
 * @throws {SignatureMismatchError} Will throw an exception if the signature is invalid.
 * @param payload A CBOR-encoded signed message
 * @param verifier The key used to check the signature
 * @returns The decoded message, if the signature was correct.
 */
export declare function verify(payload: Uint8Array, verifierParam: Verifier | VerifierFunction, options?: VerifyOptions): Promise<any>;