Class MbedTlsCrypto

Class that exposes mbedTls cryptographic function.

Index

Constructors

Methods

ecdhEs concatKdf ecCreateKey ecdsaSign ecdsaVerify

Constructors

constructor

new MbedTlsCrypto(): MbedTlsCrypto
Returns MbedTlsCrypto

Methods

`Static`ecdhEs

ecdhEs(
    private_key: JsonWebKey,
    public_key: JsonWebKey,
    encryption: "A128GCM" | "A192GCM" | "A256GCM",
    apu?: string,
    apv?: string,
): Promise<Uint8Array>
Creates Encryption Key by using ECDH-ES (Elliptic Curve Diffie-Hellman Ephemeral Static key agreement). This method supports all curves supported by mbedTls
Parameters
- private_key: JsonWebKey
- public_key: JsonWebKey
- encryption: "A128GCM" | "A192GCM" | "A256GCM"
  Allowed encryption algorithm from JWA "enc" param.
- Optionalapu: string
  Agreement PartyUInfo, value contains information about the producer. In base64Url
- Optionalapv: string
  Agreement PartyVInfo, value contains information about the recipient. In base64Url
Returns Promise<Uint8Array>

`Static`concatKdf

concatKdf(
    sharedSecret: Uint8Array,
    keyDataLen: number,
    AlgorithmID: string,
    apu?: string,
    apv?: string,
): Promise<Uint8Array>
The Concat Key DerivationFunction. Based on NIST.800-56A Section 5.8.1 in use case for ECDH-ES.
Parameters
- sharedSecret: Uint8Array
  ECDH shared secret.
- keyDataLen: number
  Resulting key length in bits
- AlgorithmID: string
- Optionalapu: string
  Agreement PartyUInfo, value contains information about the producer. In base64Url
- Optionalapv: string
  Agreement PartyVInfo, value contains information about the recipient. In base64Url
Returns Promise<Uint8Array>
See
- https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.2
- https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar2.pdf

`Static`ecCreateKey

ecCreateKey(curve: EcCurveNames): Promise<JsonWebKey>
Creates a new EC Key
Parameters
- curve: EcCurveNames
  Name of the curve, as named in the
Returns Promise<JsonWebKey>

`Static`ecdsaSign

ecdsaSign(
    privateKey: JsonWebKey,
    hash: Uint8Array,
    hashType: HashTypeNames,
): Promise<Uint8Array>
Signs a hash with the given key
Parameters
- privateKey: JsonWebKey
- hash: Uint8Array
- hashType: HashTypeNames
  Name of the hash type
Returns Promise<Uint8Array>

`Static`ecdsaVerify

ecdsaVerify(
    publicKey: JsonWebKey,
    hash: Uint8Array,
    signature: Uint8Array,
): Promise<boolean>
Tests the hash against the public key & signature.
Parameters
- publicKey: JsonWebKey
- hash: Uint8Array
- signature: Uint8Array
Returns Promise<boolean>
Is signature valid.