Documents for @litert/signatures
    Preparing search index...

    Interface ISigner

    The signer interface.

    interface ISigner {
        hashAlgorithm: string;
        signAlgorithm: string;
        sign(message: string | Buffer<ArrayBufferLike>): Buffer;
        signStream(message: Readable): Promise<Buffer<ArrayBufferLike>>;
        verify(
            message: string | Buffer<ArrayBufferLike>,
            signature: Buffer,
        ): boolean;
        verifyStream(message: Readable, signature: Buffer): Promise<boolean>;
    }
    Index

    Properties

    hashAlgorithm signAlgorithm

    Methods

    sign signStream verify verifyStream

    Properties

    hashAlgorithm: string

    The digest hash algorithm of this signer.

    signAlgorithm: string

    The signing algorithm of this signer.

    Methods

    • Sign simple short data.

      Parameters

      • message: string | Buffer<ArrayBufferLike>

        The payload to be signed.

      Returns Buffer

    • Sign data insides stream.

      Parameters

      • message: Readable

        The payload to be signed.

      Returns Promise<Buffer<ArrayBufferLike>>

    • Verify the signature of simple short data.

      Parameters

      • message: string | Buffer<ArrayBufferLike>

        The payload to be verified.

      • signature: Buffer

        The signature of payload to be verified.

      Returns boolean

    • Verify data insides stream.

      Parameters

      • message: Readable

        The payload to be verified.

      • signature: Buffer

        The signature of payload to be verified.

      Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods