Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

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.

interface SubtleCrypto {
decrypt(
algorithm:
,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>;
deriveBits(
algorithm:
,
baseKey: CryptoKey,
length: number,
): Promise<ArrayBuffer>;
deriveKey(
algorithm:
,
baseKey: CryptoKey,
derivedKeyType:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>;
deriveKey(
algorithm:
,
baseKey: CryptoKey,
derivedKeyType:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>;
digest(algorithm: AlgorithmIdentifier, data: BufferSource): Promise<ArrayBuffer>;
encrypt(
algorithm:
,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>;
exportKey(format: "jwk", key: CryptoKey): Promise<JsonWebKey>;
exportKey(format: Exclude<KeyFormat, "jwk">, key: CryptoKey): Promise<ArrayBuffer>;
generateKey(
algorithm: RsaHashedKeyGenParams | EcKeyGenParams,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKeyPair>;
generateKey(
algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>;
generateKey(
algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKeyPair | CryptoKey>;
generateKey(
algorithm: RsaHashedKeyGenParams | EcKeyGenParams,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKeyPair>;
generateKey(
algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>;
generateKey(
algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKeyPair | CryptoKey>;
importKey(
format: "jwk",
keyData: JsonWebKey,
algorithm:
,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>;
importKey(
format: Exclude<KeyFormat, "jwk">,
keyData: BufferSource,
algorithm:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>;
importKey(
format: "jwk",
keyData: JsonWebKey,
algorithm:
,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>;
importKey(
format: Exclude<KeyFormat, "jwk">,
keyData: BufferSource,
algorithm:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>;
sign(
algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>;
unwrapKey(
format: KeyFormat,
wrappedKey: BufferSource,
unwrappingKey: CryptoKey,
unwrapAlgorithm:
,
unwrappedKeyAlgorithm:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>;
unwrapKey(
format: KeyFormat,
wrappedKey: BufferSource,
unwrappingKey: CryptoKey,
unwrapAlgorithm:
,
unwrappedKeyAlgorithm:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>;
verify(
algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams,
key: CryptoKey,
signature: BufferSource,
data: BufferSource,
): Promise<boolean>;
wrapKey(
format: KeyFormat,
key: CryptoKey,
wrappingKey: CryptoKey,
wrapAlgorithm:
,
): Promise<ArrayBuffer>;
}
var SubtleCrypto: {
prototype: SubtleCrypto;
new (): SubtleCrypto;
};

§Methods

§
decrypt(
algorithm:
,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>
[src]
§
deriveBits(
algorithm:
,
baseKey: CryptoKey,
length: number,
): Promise<ArrayBuffer>
[src]
§
deriveKey(
algorithm:
,
baseKey: CryptoKey,
derivedKeyType:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>
[src]
§
deriveKey(
algorithm:
,
baseKey: CryptoKey,
derivedKeyType:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>
[src]
§
digest(algorithm: AlgorithmIdentifier, data: BufferSource): Promise<ArrayBuffer>
[src]
§
encrypt(
algorithm:
,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>
[src]
§
exportKey(format: "jwk", key: CryptoKey): Promise<JsonWebKey>
[src]
§
exportKey(format: Exclude<KeyFormat, "jwk">, key: CryptoKey): Promise<ArrayBuffer>
[src]
§
generateKey(
algorithm: RsaHashedKeyGenParams | EcKeyGenParams,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKeyPair>
[src]
§
generateKey(
algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>
[src]
§
generateKey(
algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKeyPair | CryptoKey>
[src]
§
generateKey(
algorithm: RsaHashedKeyGenParams | EcKeyGenParams,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKeyPair>
[src]
§
generateKey(
algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>
[src]
§
generateKey(
algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKeyPair | CryptoKey>
[src]
§
importKey(
format: "jwk",
keyData: JsonWebKey,
algorithm:
,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>
[src]
§
importKey(
format: Exclude<KeyFormat, "jwk">,
keyData: BufferSource,
algorithm:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>
[src]
§
importKey(
format: "jwk",
keyData: JsonWebKey,
algorithm:
,
extractable: boolean,
keyUsages: ReadonlyArray<KeyUsage>,
): Promise<CryptoKey>
[src]
§
importKey(
format: Exclude<KeyFormat, "jwk">,
keyData: BufferSource,
algorithm:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>
[src]
§
sign(
algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams,
key: CryptoKey,
data: BufferSource,
): Promise<ArrayBuffer>
[src]
§
unwrapKey(
format: KeyFormat,
wrappedKey: BufferSource,
unwrappingKey: CryptoKey,
unwrapAlgorithm:
,
unwrappedKeyAlgorithm:
,
extractable: boolean,
keyUsages: KeyUsage[],
): Promise<CryptoKey>
[src]
§
unwrapKey(
format: KeyFormat,
wrappedKey: BufferSource,
unwrappingKey: CryptoKey,
unwrapAlgorithm:
,
unwrappedKeyAlgorithm:
,
extractable: boolean,
keyUsages: Iterable<KeyUsage>,
): Promise<CryptoKey>
[src]
§
verify(
algorithm: AlgorithmIdentifier | RsaPssParams | EcdsaParams,
key: CryptoKey,
signature: BufferSource,
data: BufferSource,
): Promise<boolean>
[src]
§
wrapKey(
format: KeyFormat,
key: CryptoKey,
wrappingKey: CryptoKey,
wrapAlgorithm:
,
): Promise<ArrayBuffer>
[src]