Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PGPSigner

exports

Hierarchy

  • PGPSigner

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializing the Signer.

    Parameters

    Returns PGPSigner

Properties

algo

algo: string = 'sha256'

Encryption algorithm used

dgst

dgst: string

Message digest

engine

engine: string = 'pgp'

Encryption engine used.

keyStore

keyStore: MutableKeyStore

A keystore holding pgp keys.

loggingService

loggingService: LoggingService

A service that provides logging capabilities.

onsign

onsign: (signature: Signature) => void

Event triggered on successful signing of message.

Type declaration

onverify

onverify: (flag: boolean) => void

Event triggered on successful verification of a signature.

Type declaration

    • (flag: boolean): void

    • Parameters

      • flag: boolean

      Returns void

signature

signature: Signature

Generated signature

Methods

fingerprint

  • fingerprint(): string

  • Get the private key fingerprint.

    Returns string

    A private key fingerprint.

prepare

  • Load the message digest.

    Parameters

    Returns boolean

    true - If digest has been loaded successfully.

sign

  • sign(digest: string): Promise<void>

  • Signs a message using a private key.

    async

    Parameters

    • digest: string

      The message to be signed.

    Returns Promise<void>

verify

  • verify(digest: string, signature: Signature): void

  • Verify that signature is valid.

    Parameters

    • digest: string

      The message that was signed.

    • signature: Signature

      The generated signature.

    Returns void

Generated using TypeDoc