Module webcrypto

source · [−]
Expand description

Wrapper for node/browser webcrypto

Variables

source

_crypto

source

const _crypto: Promise<Crypto> = ...

Crypto loader which loads native webcrypto depending on environment

Functions

source

<T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

Parameters

  • algorithm: U
  • key: T
  • data: BufferSource

Returns Promise<ArrayBuffer>

source

<T, U>(algorithm: U, baseKey: T, length: number): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params

Parameters

  • algorithm: U
  • baseKey: T
  • length: number

Returns Promise<ArrayBuffer>

source

<T, U>(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, key: CryptoKey, derivedKeyType: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams

Parameters

  • algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params
  • key: CryptoKey
  • derivedKeyType: U
  • extractable: boolean
  • keyUsages: KeyUsage[]

Returns Promise<T>

source

<T>(algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512", data: BufferSource): Promise<T>

Type Parameters

  • T extends ArrayBuffer

Parameters

  • algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512"
  • data: BufferSource

Returns Promise<T>

source

<T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

Parameters

  • algorithm: U
  • key: T
  • data: BufferSource

Returns Promise<ArrayBuffer>

source

<T>(format: "jwk", key: T): Promise<JsonWebKey>

Type Parameters

  • T extends CryptoKey

Parameters

  • format: "jwk"
  • key: T

Returns Promise<JsonWebKey>

source

<T>(format: "pkcs8" | "raw" | "spki", key: T): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

Parameters

  • format: "pkcs8" | "raw" | "spki"
  • key: T

Returns Promise<ArrayBuffer>

source

<T, U>(algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

Type Parameters

  • T extends CryptoKey | CryptoKeyPair

  • U extends AlgorithmIdentifier | Pbkdf2Params | RsaHashedKeyGenParams | EcKeyGenParams | AesKeyGenParams | HmacKeyGenParams

Parameters

  • algorithm: U
  • extractable: boolean
  • keyUsages: KeyUsage[]

Returns Promise<T>

source

<T, U>(format: "jwk", key: JsonWebKey, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

Parameters

  • format: "jwk"
  • key: JsonWebKey
  • algorithm: U
  • extractable: boolean
  • keyUsages: KeyUsage[]

Returns Promise<T>

source

<T, U>(format: "pkcs8" | "raw" | "spki", key: BufferSource, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

Parameters

  • format: "pkcs8" | "raw" | "spki"
  • key: BufferSource
  • algorithm: U
  • extractable: boolean
  • keyUsages: KeyUsage[]

Returns Promise<T>

source

<T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

Parameters

  • algorithm: U
  • key: T
  • data: BufferSource

Returns Promise<ArrayBuffer>

source

<T, U, V>(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: T, unwrapAlgorithm: U, unwrappedKeyAlgorithm: V, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

  • V extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

Parameters

  • format: KeyFormat
  • wrappedKey: BufferSource
  • unwrappingKey: T
  • unwrapAlgorithm: U
  • unwrappedKeyAlgorithm: V
  • extractable: boolean
  • keyUsages: KeyUsage[]

Returns Promise<CryptoKey>

source

<T, U>(algorithm: U, key: T, signature: BufferSource, data: BufferSource): Promise<boolean>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

Parameters

  • algorithm: U
  • key: T
  • signature: BufferSource
  • data: BufferSource

Returns Promise<boolean>

source

<T, U>(format: KeyFormat, key: CryptoKey, wrappingKey: T, wrapAlgorithm: U): Promise<ArrayBuffer>

Type Parameters

  • T extends CryptoKey

  • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

Parameters

  • format: KeyFormat
  • key: CryptoKey
  • wrappingKey: T
  • wrapAlgorithm: U

Returns Promise<ArrayBuffer>