Class SubtleCrypto`Abstract`

This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto). Available only in secure contexts.

MDN Reference

Index

Constructors

constructor

Methods

decrypt deriveBits deriveKey digest encrypt exportKey generateKey importKey sign timingSafeEqual unwrapKey verify wrapKey

Constructors

constructor

new SubtleCrypto(): SubtleCrypto
Returns SubtleCrypto

Methods

decrypt

decrypt(
    algorithm: string | SubtleCryptoEncryptAlgorithm,
    key: CryptoKey,
    cipherText: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<ArrayBuffer>
Parameters
- algorithm: string | SubtleCryptoEncryptAlgorithm
- key: CryptoKey
- cipherText: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Promise<ArrayBuffer>

deriveBits

deriveBits(
    algorithm: string | SubtleCryptoDeriveKeyAlgorithm,
    baseKey: CryptoKey,
    length?: null | number,
): Promise<ArrayBuffer>
Parameters
- algorithm: string | SubtleCryptoDeriveKeyAlgorithm
- baseKey: CryptoKey
- Optionallength: null | number
Returns Promise<ArrayBuffer>

deriveKey

deriveKey(
    algorithm: string | SubtleCryptoDeriveKeyAlgorithm,
    baseKey: CryptoKey,
    derivedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm,
    extractable: boolean,
    keyUsages: string[],
): Promise<CryptoKey>
Parameters
- algorithm: string | SubtleCryptoDeriveKeyAlgorithm
- baseKey: CryptoKey
- derivedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm
- extractable: boolean
- keyUsages: string[]
Returns Promise<CryptoKey>

digest

digest(
algorithm: string | SubtleCryptoHashAlgorithm,
data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<ArrayBuffer>
Parameters
- algorithm: string | SubtleCryptoHashAlgorithm
- data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Promise<ArrayBuffer>

encrypt

encrypt(
    algorithm: string | SubtleCryptoEncryptAlgorithm,
    key: CryptoKey,
    plainText: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<ArrayBuffer>
Parameters
- algorithm: string | SubtleCryptoEncryptAlgorithm
- key: CryptoKey
- plainText: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Promise<ArrayBuffer>

exportKey

exportKey(format: string, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>
Parameters
- format: string
- key: CryptoKey
Returns Promise<ArrayBuffer | JsonWebKey>

generateKey

generateKey(
    algorithm: string | SubtleCryptoGenerateKeyAlgorithm,
    extractable: boolean,
    keyUsages: string[],
): Promise<CryptoKey | CryptoKeyPair>
Parameters
- algorithm: string | SubtleCryptoGenerateKeyAlgorithm
- extractable: boolean
- keyUsages: string[]
Returns Promise<CryptoKey | CryptoKeyPair>

importKey

importKey(
    format: string,
    keyData: ArrayBuffer | ArrayBufferView<ArrayBufferLike> | JsonWebKey,
    algorithm: string | SubtleCryptoImportKeyAlgorithm,
    extractable: boolean,
    keyUsages: string[],
): Promise<CryptoKey>
Parameters
- format: string
- keyData: ArrayBuffer | ArrayBufferView<ArrayBufferLike> | JsonWebKey
- algorithm: string | SubtleCryptoImportKeyAlgorithm
- extractable: boolean
- keyUsages: string[]
Returns Promise<CryptoKey>

sign

sign(
    algorithm: string | SubtleCryptoSignAlgorithm,
    key: CryptoKey,
    data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<ArrayBuffer>
Parameters
- algorithm: string | SubtleCryptoSignAlgorithm
- key: CryptoKey
- data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Promise<ArrayBuffer>

timingSafeEqual

timingSafeEqual(
a: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
b: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): boolean
Parameters
- a: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
- b: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns boolean

unwrapKey

unwrapKey(
    format: string,
    wrappedKey: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
    unwrappingKey: CryptoKey,
    unwrapAlgorithm: string | SubtleCryptoEncryptAlgorithm,
    unwrappedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm,
    extractable: boolean,
    keyUsages: string[],
): Promise<CryptoKey>
Parameters
- format: string
- wrappedKey: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
- unwrappingKey: CryptoKey
- unwrapAlgorithm: string | SubtleCryptoEncryptAlgorithm
- unwrappedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm
- extractable: boolean
- keyUsages: string[]
Returns Promise<CryptoKey>

verify

verify(
    algorithm: string | SubtleCryptoSignAlgorithm,
    key: CryptoKey,
    signature: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
    data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<boolean>
Parameters
- algorithm: string | SubtleCryptoSignAlgorithm
- key: CryptoKey
- signature: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
- data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Promise<boolean>

wrapKey

wrapKey(
    format: string,
    key: CryptoKey,
    wrappingKey: CryptoKey,
    wrapAlgorithm: string | SubtleCryptoEncryptAlgorithm,
): Promise<ArrayBuffer>
Parameters
- format: string
- key: CryptoKey
- wrappingKey: CryptoKey
- wrapAlgorithm: string | SubtleCryptoEncryptAlgorithm
Returns Promise<ArrayBuffer>

Class SubtleCryptoAbstract

Index

Constructors

Methods

Constructors

constructor

Returns SubtleCrypto

Methods

decrypt

Parameters

Returns Promise<ArrayBuffer>

deriveBits

Parameters

Returns Promise<ArrayBuffer>

deriveKey

Parameters

Returns Promise<CryptoKey>

digest

Parameters

Returns Promise<ArrayBuffer>

encrypt

Parameters

Returns Promise<ArrayBuffer>

exportKey

Parameters

Returns Promise<ArrayBuffer | JsonWebKey>

generateKey

Parameters

Returns Promise<CryptoKey | CryptoKeyPair>

importKey

Parameters

Returns Promise<CryptoKey>

sign

Parameters

Returns Promise<ArrayBuffer>

timingSafeEqual

Parameters

Returns boolean

unwrapKey

Parameters

Returns Promise<CryptoKey>

verify

Parameters

Returns Promise<boolean>

wrapKey

Parameters

Returns Promise<ArrayBuffer>

Settings

On This Page

Class SubtleCrypto`Abstract`