SubtleCrypto - Crypto - Web

interface SubtleCrypto

Private

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 globalThis.crypto).

Methods



generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKeyPair>



generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>



generateKey(algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKeyPair | CryptoKey>



importKey(format: "jwk",
keyData: JsonWebKey,
algorithm: AlgorithmIdentifier
 | HmacImportParams
 | RsaHashedImportParams
 | EcKeyImportParams,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>



importKey(format: Exclude<KeyFormat, "jwk">,
keyData: BufferSource,
algorithm: AlgorithmIdentifier
 | HmacImportParams
 | RsaHashedImportParams
 | EcKeyImportParams,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>



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



exportKey(format: Exclude<KeyFormat, "jwk">,
key: CryptoKey,
): Promise<ArrayBuffer>



sign(algorithm: AlgorithmIdentifier
 | RsaPssParams
 | EcdsaParams,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>



verify(algorithm: AlgorithmIdentifier
 | RsaPssParams
 | EcdsaParams,
key: CryptoKey,
signature: BufferSource,
data: BufferSource,
): Promise<boolean>



digest(algorithm: AlgorithmIdentifier,
data: BufferSource,
): Promise<ArrayBuffer>



encrypt(algorithm: AlgorithmIdentifier
 | RsaOaepParams
 | AesCbcParams
 | AesGcmParams
 | AesCtrParams,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>



decrypt(algorithm: AlgorithmIdentifier
 | RsaOaepParams
 | AesCbcParams
 | AesGcmParams
 | AesCtrParams,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>



deriveBits(algorithm: AlgorithmIdentifier
 | HkdfParams
 | Pbkdf2Params
 | EcdhKeyDeriveParams,
baseKey: CryptoKey,
length: number,
): Promise<ArrayBuffer>



deriveKey(algorithm: AlgorithmIdentifier
 | HkdfParams
 | Pbkdf2Params
 | EcdhKeyDeriveParams,
baseKey: CryptoKey,
derivedKeyType: AlgorithmIdentifier
 | AesDerivedKeyParams
 | HmacImportParams
 | HkdfParams
 | Pbkdf2Params,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>



wrapKey(format: KeyFormat,
key: CryptoKey,
wrappingKey: CryptoKey,
wrapAlgorithm: AlgorithmIdentifier
 | RsaOaepParams
 | AesCbcParams
 | AesCtrParams,
): Promise<ArrayBuffer>



unwrapKey(format: KeyFormat,
wrappedKey: BufferSource,
unwrappingKey: CryptoKey,
unwrapAlgorithm: AlgorithmIdentifier
 | RsaOaepParams
 | AesCbcParams
 | AesCtrParams,
unwrappedKeyAlgorithm: AlgorithmIdentifier
 | HmacImportParams
 | RsaHashedImportParams
 | EcKeyImportParams,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>

variable SubtleCrypto

Properties

readonly



prototype: SubtleCrypto