Skip to content
Experimental WebAPI

SubtleCrypto

Values

decrypt

Read more on MDN

let decrypt: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~data: WebAPI.ArrayBufferTypedArrayOrDataView.t,
) => promise<ArrayBuffer.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.cryptoKeyWebAPI.ArrayBufferTypedArrayOrDataView.t

Return type

promise<Stdlib.ArrayBuffer.t>

deriveBits

Read more on MDN

let deriveBits: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithm,
  ~baseKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~length: int=?,
) => promise<ArrayBuffer.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmWebAPI.WebCryptoTypes.cryptoKeyoption<int>

Return type

promise<Stdlib.ArrayBuffer.t>

deriveBits2

Read more on MDN

let deriveBits2: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: string,
  ~baseKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~length: int=?,
) => promise<ArrayBuffer.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptostringWebAPI.WebCryptoTypes.cryptoKeyoption<int>

Return type

promise<Stdlib.ArrayBuffer.t>

deriveKey

Read more on MDN

let deriveKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~baseKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~derivedKeyType: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~extractable: bool,
  ~keyUsages: array<WebAPI.WebCryptoTypes.keyUsage>,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.cryptoKeyWebAPI.WebCryptoTypes.algorithmIdentifierboolarray<WebAPI.WebCryptoTypes.keyUsage>

Return type

promise<Stdlib.JSON.t>

digest

Read more on MDN

let digest: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~data: WebAPI.ArrayBufferTypedArrayOrDataView.t,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.ArrayBufferTypedArrayOrDataView.t

Return type

promise<Stdlib.JSON.t>

encrypt

Read more on MDN

let encrypt: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~data: WebAPI.ArrayBufferTypedArrayOrDataView.t,
) => promise<ArrayBuffer.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.cryptoKeyWebAPI.ArrayBufferTypedArrayOrDataView.t

Return type

promise<Stdlib.ArrayBuffer.t>

exportKey

Read more on MDN

let exportKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~format: WebAPI.WebCryptoTypes.keyFormat,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.keyFormatWebAPI.WebCryptoTypes.cryptoKey

Return type

promise<Stdlib.JSON.t>

generateKey

Read more on MDN

let generateKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithm,
  ~extractable: bool,
  ~keyUsages: array<WebAPI.WebCryptoTypes.keyUsage>,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmboolarray<WebAPI.WebCryptoTypes.keyUsage>

Return type

promise<Stdlib.JSON.t>

generateKey2

Read more on MDN

let generateKey2: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: string,
  ~extractable: bool,
  ~keyUsages: array<WebAPI.WebCryptoTypes.keyUsage>,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptostringboolarray<WebAPI.WebCryptoTypes.keyUsage>

Return type

promise<Stdlib.JSON.t>

importKey

Read more on MDN

let importKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~format: unknown,
  ~keyData: WebAPI.ArrayBufferTypedArrayOrDataView.t,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~extractable: bool,
  ~keyUsages: array<WebAPI.WebCryptoTypes.keyUsage>,
) => promise<WebAPI.WebCryptoTypes.cryptoKey>

Parameters

WebAPI.WebCryptoTypes.subtleCryptounknownWebAPI.ArrayBufferTypedArrayOrDataView.tWebAPI.WebCryptoTypes.algorithmIdentifierboolarray<WebAPI.WebCryptoTypes.keyUsage>

Return type

promise<WebAPI.WebCryptoTypes.cryptoKey>

sign

Read more on MDN

let sign: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~data: WebAPI.ArrayBufferTypedArrayOrDataView.t,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.cryptoKeyWebAPI.ArrayBufferTypedArrayOrDataView.t

Return type

promise<Stdlib.JSON.t>

unwrapKey

Read more on MDN

let unwrapKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~format: WebAPI.WebCryptoTypes.keyFormat,
  ~wrappedKey: WebAPI.ArrayBufferTypedArrayOrDataView.t,
  ~unwrappingKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~unwrapAlgorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~unwrappedKeyAlgorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~extractable: bool,
  ~keyUsages: array<WebAPI.WebCryptoTypes.keyUsage>,
) => promise<WebAPI.WebCryptoTypes.cryptoKey>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.keyFormatWebAPI.ArrayBufferTypedArrayOrDataView.tWebAPI.WebCryptoTypes.cryptoKeyWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.algorithmIdentifierboolarray<WebAPI.WebCryptoTypes.keyUsage>

Return type

promise<WebAPI.WebCryptoTypes.cryptoKey>

verify

Read more on MDN

let verify: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~algorithm: WebAPI.WebCryptoTypes.algorithmIdentifier,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~signature: WebAPI.ArrayBufferTypedArrayOrDataView.t,
  ~data: WebAPI.ArrayBufferTypedArrayOrDataView.t,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.algorithmIdentifierWebAPI.WebCryptoTypes.cryptoKeyWebAPI.ArrayBufferTypedArrayOrDataView.tWebAPI.ArrayBufferTypedArrayOrDataView.t

Return type

promise<Stdlib.JSON.t>

wrapKey

Read more on MDN

let wrapKey: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~format: WebAPI.WebCryptoTypes.keyFormat,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~wrappingKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~wrapAlgorithm: WebAPI.WebCryptoTypes.algorithm,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.keyFormatWebAPI.WebCryptoTypes.cryptoKeyWebAPI.WebCryptoTypes.cryptoKeyWebAPI.WebCryptoTypes.algorithm

Return type

promise<Stdlib.JSON.t>

wrapKey2

Read more on MDN

let wrapKey2: (
  WebAPI.WebCryptoTypes.subtleCrypto,
  ~format: WebAPI.WebCryptoTypes.keyFormat,
  ~key: WebAPI.WebCryptoTypes.cryptoKey,
  ~wrappingKey: WebAPI.WebCryptoTypes.cryptoKey,
  ~wrapAlgorithm: string,
) => promise<JSON.t>

Parameters

WebAPI.WebCryptoTypes.subtleCryptoWebAPI.WebCryptoTypes.keyFormatWebAPI.WebCryptoTypes.cryptoKeyWebAPI.WebCryptoTypes.cryptoKeystring

Return type

promise<Stdlib.JSON.t>