Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalCryptographyClient

Package version

A client used to perform local cryptographic operations with JSON Web Keys.

Hierarchy

  • LocalCryptographyClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructs a new instance of the Local Cryptography client for the given key.

    Example usage:

    import { LocalCryptographyClient } from "@azure/keyvault-keys";
    
    const jsonWebKey: JsonWebKey = {
      // ...
    };
    const client = new LocalCryptographyClient(jsonWebKey);
    memberof

    CryptographyClient

    Parameters

    • key: JsonWebKey

      The JsonWebKey to use during cryptography operations.

    Returns LocalCryptographyClient

Properties

key

A JSON Web Key, used for the local cryptography operations.

Methods

encrypt

verifyData

  • Verify the signed block of data

    Example usage:

    let client = new LocalCryptographyClient(jsonWebKey, credentials);
    let result = await client.verifyData("RS256", signedMessage, signature);

    Parameters

    • algorithm: LocalSupportedAlgorithmName

      The algorithm to use to verify with.

    • data: Uint8Array

      The signed block of data to verify.

    • signature: Uint8Array

      The signature to verify the block against.

    Returns Promise<VerifyResult>

wrapKey

Generated using TypeDoc