Crypto
Cryptographic functionality for secure communication, data protection, and key management. Generate secure random numbers, encrypt and decrypt data, and manage cryptographic keys.
Eg crypto
Interfaces
This Web Crypto API interface provides basic cryptographic functionality.
It is accessed via the global crypto property, which gives access
to cryptographically strong random number generation and to the low-level
primitives exposed by SubtleCrypto through Crypto.subtle.
The CryptoKey dictionary of the Web Crypto API represents a cryptographic key.
The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for an asymmetric cryptography algorithm, also known as a public-key algorithm.
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).
Type Aliases
Variables
The global instance of Crypto that provides access to the Web
Crypto API, including cryptographically secure random number generation via
Crypto.getRandomValues, random UUID generation via
Crypto.randomUUID, and the low-level primitives exposed by
SubtleCrypto through Crypto.subtle.
interface Crypto
This Web Crypto API interface provides basic cryptographic functionality.
It is accessed via the global crypto property, which gives access
to cryptographically strong random number generation and to the low-level
primitives exposed by SubtleCrypto through Crypto.subtle.
Properties #
#subtle: SubtleCrypto Methods #
#getRandomValues<T extends ArrayBufferView>(array: T): T Mutates the provided typed array with cryptographically secure random values.
#randomUUID(): `${string}-${string}-${string}-${string}-${string}` Generates a random RFC 4122 version 4 UUID using a cryptographically secure random number generator.
interface CryptoKey
variable CryptoKey
The constructor object for CryptoKey.
CryptoKey instances cannot be created directly; they are produced by
SubtleCrypto methods such as generateKey, importKey, and
deriveKey, so calling the constructor throws.
Type #
globalThis extends { document: any; CryptoKey: infer T; } ? T : { readonly prototype: CryptoKey; } interface CryptoKeyPair
variable CryptoKeyPair
The constructor object for CryptoKeyPair.
CryptoKeyPair objects are returned by SubtleCrypto.generateKey
for asymmetric algorithms and cannot be constructed directly, so calling the
constructor throws.
Properties #
#prototype: CryptoKeyPair interface HmacImportParams
interface HmacKeyGenParams
interface JsonWebKey
Properties #
#oth: RsaOtherPrimesInfo[] interface KeyAlgorithm
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 globalThis.crypto).
Methods #
#generateKey(): Promise<CryptoKeyPair> Generates an asymmetric cryptographic key pair for encryption, signing, or key exchange.
This overload is used for generating key pairs with RSA or elliptic curve algorithms.
#generateKey(): Promise<CryptoKey> Generates a symmetric cryptographic key for encryption, authentication, or hashing.
This overload is used for algorithms such as AES and HMAC.
#generateKey(): Promise<CryptoKeyPair | CryptoKey> Generates a cryptographic key or key pair for a given algorithm.
This generic overload handles any key generation request, returning either a symmetric key or an asymmetric key pair based on the provided algorithm.
#importKey(): Promise<CryptoKey> Imports a cryptographic key in JSON Web Key (JWK) format.
This method is used to import an asymmetric key (e.g., RSA or ECDSA) from a JWK object. JWK allows structured representation of keys, making them portable across different systems.
#importKey(format: Exclude<KeyFormat, "jwk">,keyData: BufferSource,algorithm: ,extractable: boolean,keyUsages: KeyUsage[],): Promise<CryptoKey> Imports a cryptographic key in raw, PKCS8, or SPKI format.
This method is used to import symmetric keys (e.g., AES), private keys (PKCS8), or public keys (SPKI).
#exportKey(format: "jwk",key: CryptoKey,): Promise<JsonWebKey> Exports a cryptographic key in JSON Web Key (JWK) format.
This method allows exporting an asymmetric key (e.g., RSA, ECDSA) into a JSON-based representation, making it easy to store and transfer across systems.
Exports a cryptographic key in raw, PKCS8, or SPKI format.
This method is used to export symmetric keys (AES), private keys (PKCS8), or public keys (SPKI) in binary form.
Generates a digital signature using a private cryptographic key.
This method is used to sign data with an asymmetric key (e.g., RSA-PSS, ECDSA).
#verify(): Promise<boolean> Verifies a digital signature using a public cryptographic key.
This method checks whether a signature is valid for the given data.
#digest(algorithm: AlgorithmIdentifier,data: BufferSource,): Promise<ArrayBuffer> Computes a cryptographic hash (digest) of the given data.
This method is commonly used for verifying data integrity.
#encrypt(): Promise<ArrayBuffer> Encrypts data using a cryptographic key.
This method is used with both symmetric (AES) and asymmetric (RSA) encryption.
#decrypt(): Promise<ArrayBuffer> Decrypts previously encrypted data using a cryptographic key.
#deriveBits(): Promise<ArrayBuffer> This method is used to derive a key from a base key using a cryptographic algorithm.
#deriveKey(): Promise<CryptoKey> This method is used to derive a secret key from a base or master key using a cryptographic algorithm. It returns a Promise which fulfils with an object of the new key.
#wrapKey(): Promise<ArrayBuffer> Wraps (encrypts) a cryptographic key for secure storage or transmission
variable SubtleCrypto
The constructor object for SubtleCrypto.
The SubtleCrypto instance is accessed via Crypto.subtle
(crypto.subtle) rather than constructed directly, so calling the
constructor throws.
Type #
globalThis extends { document: any; SubtleCrypto: infer T; } ? T : { readonly prototype: SubtleCrypto; supports(operation: "encrypt"
| "decrypt"
| "sign"
| "verify"
| "digest"
| "generateKey"
| "deriveKey"
| "deriveBits"
| "importKey"
| "exportKey"
| "wrapKey"
| "unwrapKey"
| "encapsulateKey"
| "encapsulateBits"
| "decapsulateKey"
| "decapsulateBits"
| "getPublicKey",algorithm: string | object,lengthOrHash?: number
| string
| object
| null,): boolean; } type alias AlgorithmIdentifier
type alias BigInteger
Definition #
Uint8Array<ArrayBuffer> type alias HashAlgorithmIdentifier
Definition #
type alias NamedCurve
Definition #
string variable crypto
The global instance of Crypto that provides access to the Web
Crypto API, including cryptographically secure random number generation via
Crypto.getRandomValues, random UUID generation via
Crypto.randomUUID, and the low-level primitives exposed by
SubtleCrypto through Crypto.subtle.