Options
All
  • Public
  • Public/Protected
  • All
Menu

Module functions/keys

Index

Interfaces

Type aliases

Functions

Type aliases

PairResponse

PairResponse: { message: string; success: false } | { message: string; pair: PairObject; success: true }

Functions

parseKeyPair

  • Parse a Private and Public Key Pair into a Pair Object

    Parameters

    • keyPair: any

      Private and Public Key Pair

    Returns Promise<PairResponse>

    Success Message and KeyPair Object, or Error Message Object

signText

  • signText(text: string, pairObject: PairObject): Promise<string | boolean>

  • CompactSign a text string with a KeyPair Object

    Parameters

    • text: string

      String to Sign

    • pairObject: PairObject

      Key Pair Object

    Returns Promise<string | boolean>

    JWS Token or False

validateKeyPair

  • validateKeyPair(pairObject: PairObject): Promise<boolean>

  • Validate a Key Pair Object and a test message with JOSE CompactSign

    Parameters

    Returns Promise<boolean>

    True if valid, False if an error occurred