Interface SubtleCrypto

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.

Hierarchy

SubtleCrypto

Index

Methods

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

Methods

decrypt

decrypt(algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:107

deriveBits

deriveBits(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params
- baseKey: CryptoKey
- length: number
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:108

deriveKey

deriveKey(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, derivedKeyType: AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params
- baseKey: CryptoKey
- derivedKeyType: AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
- Defined in typescript-types/src/dom.ts:109

digest

digest(algorithm: AlgorithmIdentifier, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier
- data: BufferSource
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:110

encrypt

encrypt(algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:111

exportKey

exportKey(format: "jwk", key: CryptoKey): Promise<JsonWebKey>
Parameters
- format: "jwk"
- key: CryptoKey
Returns Promise<JsonWebKey>
- Defined in typescript-types/src/dom.ts:112
exportKey(format: "raw" | "pkcs8" | "spki", key: CryptoKey): Promise<ArrayBuffer>
Parameters
- format: "raw" | "pkcs8" | "spki"
- key: CryptoKey
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:113

generateKey

generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: readonly KeyUsage[]): Promise<CryptoKeyPair>
Parameters
- algorithm: RsaHashedKeyGenParams | EcKeyGenParams
- extractable: boolean
- keyUsages: readonly KeyUsage[]
Returns Promise<CryptoKeyPair>
- Defined in typescript-types/src/dom.ts:114
generateKey(algorithm: Pbkdf2Params | AesKeyGenParams | HmacKeyGenParams, extractable: boolean, keyUsages: readonly KeyUsage[]): Promise<CryptoKey>
Parameters
- algorithm: Pbkdf2Params | AesKeyGenParams | HmacKeyGenParams
- extractable: boolean
- keyUsages: readonly KeyUsage[]
Returns Promise<CryptoKey>
- Defined in typescript-types/src/dom.ts:115
generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey | CryptoKeyPair>
Parameters
- algorithm: AlgorithmIdentifier
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey | CryptoKeyPair>
- Defined in typescript-types/src/dom.ts:116

importKey

importKey(format: "jwk", keyData: JsonWebKey, algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: readonly KeyUsage[]): Promise<CryptoKey>
Parameters
- format: "jwk"
- keyData: JsonWebKey
- algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm
- extractable: boolean
- keyUsages: readonly KeyUsage[]
Returns Promise<CryptoKey>
- Defined in typescript-types/src/dom.ts:117
importKey(format: "raw" | "pkcs8" | "spki", keyData: BufferSource, algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- format: "raw" | "pkcs8" | "spki"
- keyData: BufferSource
- algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
- Defined in typescript-types/src/dom.ts:118

sign

sign(algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:119

unwrapKey

unwrapKey(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: CryptoKey, unwrapAlgorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams, unwrappedKeyAlgorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- format: KeyFormat
- wrappedKey: BufferSource
- unwrappingKey: CryptoKey
- unwrapAlgorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams
- unwrappedKeyAlgorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
- Defined in typescript-types/src/dom.ts:120

verify

verify(algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams, key: CryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
- algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams
- key: CryptoKey
- signature: BufferSource
- data: BufferSource
Returns Promise<boolean>
- Defined in typescript-types/src/dom.ts:121

wrapKey

wrapKey(format: KeyFormat, key: CryptoKey, wrappingKey: CryptoKey, wrapAlgorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams): Promise<ArrayBuffer>
Parameters
- format: KeyFormat
- key: CryptoKey
- wrappingKey: CryptoKey
- wrapAlgorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams
Returns Promise<ArrayBuffer>
- Defined in typescript-types/src/dom.ts:122

Interface SubtleCrypto

Hierarchy

Index

Methods

Methods

decrypt

Parameters

algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

key: CryptoKey

data: BufferSource

Returns Promise<ArrayBuffer>

deriveBits

Parameters

algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params

baseKey: CryptoKey

length: number

Returns Promise<ArrayBuffer>

deriveKey

Parameters

algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params

baseKey: CryptoKey

derivedKeyType: AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams

extractable: boolean

keyUsages: KeyUsage[]

Returns Promise<CryptoKey>

digest

Parameters

algorithm: AlgorithmIdentifier

data: BufferSource

Returns Promise<ArrayBuffer>

encrypt

Parameters

algorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

key: CryptoKey

data: BufferSource

Returns Promise<ArrayBuffer>

exportKey

Parameters

format: "jwk"

key: CryptoKey

Returns Promise<JsonWebKey>

Parameters

format: "raw" | "pkcs8" | "spki"

key: CryptoKey

Returns Promise<ArrayBuffer>

generateKey

Parameters

algorithm: RsaHashedKeyGenParams | EcKeyGenParams

extractable: boolean

keyUsages: readonly KeyUsage[]

Returns Promise<CryptoKeyPair>

Parameters

algorithm: Pbkdf2Params | AesKeyGenParams | HmacKeyGenParams

extractable: boolean

keyUsages: readonly KeyUsage[]

Returns Promise<CryptoKey>

Parameters

algorithm: AlgorithmIdentifier

extractable: boolean

keyUsages: KeyUsage[]

Returns Promise<CryptoKey | CryptoKeyPair>

importKey

Parameters

format: "jwk"

keyData: JsonWebKey

algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

extractable: boolean

keyUsages: readonly KeyUsage[]

Returns Promise<CryptoKey>

Parameters

format: "raw" | "pkcs8" | "spki"

keyData: BufferSource

algorithm: AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

extractable: boolean

keyUsages: KeyUsage[]

Returns Promise<CryptoKey>

sign

Parameters

algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams

key: CryptoKey