SubtleCrypto
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1049
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.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SubtleCrypto():
SubtleCrypto
Returns
Section titled “Returns”SubtleCrypto
Methods
Section titled “Methods”decrypt()
Section titled “decrypt()”decrypt(
algorithm,key,cipherText):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1057
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoEncryptAlgorithm
cipherText
Section titled “cipherText”ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”Promise<ArrayBuffer>
deriveBits()
Section titled “deriveBits()”deriveBits(
algorithm,baseKey,length?):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1095
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoDeriveKeyAlgorithm
baseKey
Section titled “baseKey”length?
Section titled “length?”null | number
Returns
Section titled “Returns”Promise<ArrayBuffer>
deriveKey()
Section titled “deriveKey()”deriveKey(
algorithm,baseKey,derivedKeyAlgorithm,extractable,keyUsages):Promise<CryptoKey>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1087
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoDeriveKeyAlgorithm
baseKey
Section titled “baseKey”derivedKeyAlgorithm
Section titled “derivedKeyAlgorithm”string | SubtleCryptoImportKeyAlgorithm
extractable
Section titled “extractable”boolean
keyUsages
Section titled “keyUsages”string[]
Returns
Section titled “Returns”Promise<CryptoKey>
digest()
Section titled “digest()”digest(
algorithm,data):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1076
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoHashAlgorithm
ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”Promise<ArrayBuffer>
encrypt()
Section titled “encrypt()”encrypt(
algorithm,key,plainText):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1051
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoEncryptAlgorithm
plainText
Section titled “plainText”ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”Promise<ArrayBuffer>
exportKey()
Section titled “exportKey()”exportKey(
format,key):Promise<ArrayBuffer|JsonWebKey>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1109
Parameters
Section titled “Parameters”format
Section titled “format”string
Returns
Section titled “Returns”Promise<ArrayBuffer | JsonWebKey>
generateKey()
Section titled “generateKey()”generateKey(
algorithm,extractable,keyUsages):Promise<CryptoKey|CryptoKeyPair>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1081
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoGenerateKeyAlgorithm
extractable
Section titled “extractable”boolean
keyUsages
Section titled “keyUsages”string[]
Returns
Section titled “Returns”Promise<CryptoKey | CryptoKeyPair>
importKey()
Section titled “importKey()”importKey(
format,keyData,algorithm,extractable,keyUsages):Promise<CryptoKey>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1101
Parameters
Section titled “Parameters”format
Section titled “format”string
keyData
Section titled “keyData”ArrayBuffer | ArrayBufferView<ArrayBufferLike> | JsonWebKey
algorithm
Section titled “algorithm”string | SubtleCryptoImportKeyAlgorithm
extractable
Section titled “extractable”boolean
keyUsages
Section titled “keyUsages”string[]
Returns
Section titled “Returns”Promise<CryptoKey>
sign()
Section titled “sign()”sign(
algorithm,key,data):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1063
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoSignAlgorithm
ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”Promise<ArrayBuffer>
timingSafeEqual()
Section titled “timingSafeEqual()”timingSafeEqual(
a,b):boolean
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1127
Parameters
Section titled “Parameters”ArrayBuffer | ArrayBufferView<ArrayBufferLike>
ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”boolean
unwrapKey()
Section titled “unwrapKey()”unwrapKey(
format,wrappedKey,unwrappingKey,unwrapAlgorithm,unwrappedKeyAlgorithm,extractable,keyUsages):Promise<CryptoKey>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1118
Parameters
Section titled “Parameters”format
Section titled “format”string
wrappedKey
Section titled “wrappedKey”ArrayBuffer | ArrayBufferView<ArrayBufferLike>
unwrappingKey
Section titled “unwrappingKey”unwrapAlgorithm
Section titled “unwrapAlgorithm”string | SubtleCryptoEncryptAlgorithm
unwrappedKeyAlgorithm
Section titled “unwrappedKeyAlgorithm”string | SubtleCryptoImportKeyAlgorithm
extractable
Section titled “extractable”boolean
keyUsages
Section titled “keyUsages”string[]
Returns
Section titled “Returns”Promise<CryptoKey>
verify()
Section titled “verify()”verify(
algorithm,key,signature,data):Promise<boolean>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1069
Parameters
Section titled “Parameters”algorithm
Section titled “algorithm”string | SubtleCryptoSignAlgorithm
signature
Section titled “signature”ArrayBuffer | ArrayBufferView<ArrayBufferLike>
ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”Promise<boolean>
wrapKey()
Section titled “wrapKey()”wrapKey(
format,key,wrappingKey,wrapAlgorithm):Promise<ArrayBuffer>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:1111
Parameters
Section titled “Parameters”format
Section titled “format”string
wrappingKey
Section titled “wrappingKey”wrapAlgorithm
Section titled “wrapAlgorithm”string | SubtleCryptoEncryptAlgorithm
Returns
Section titled “Returns”Promise<ArrayBuffer>