namespace

crypto.webcrypto

namespace webcrypto

An implementation of the Web Crypto API standard.

See the Web Crypto API documentation for details.

interface AeadParams
- additionalData?: BufferSource
- iv: BufferSource
- name: string
- tagLength: number
interface AesCbcParams
- iv: BufferSource
- name: string
interface AesCtrParams
- counter: BufferSource
- length: number
- name: string
interface AesDerivedKeyParams
- length: number
- name: string
interface AesKeyAlgorithm
- length: number
- name: string
interface AesKeyGenParams
- length: number
- name: string
interface Algorithm
- name: string
interface Argon2Params
- associatedData?: BufferSource
- memory: number
- name: string
- nonce: BufferSource
- parallelism: number
- passes: number
- secretValue?: BufferSource
- version?: number
interface ContextParams
- context?: BufferSource
- name: string
interface Crypto
- readonly subtle: SubtleCrypto
- getRandomValues<T extends Uint8Array<ArrayBuffer> | Uint8ClampedArray<ArrayBuffer> | Uint16Array<ArrayBuffer> | Uint32Array<ArrayBuffer> | Int8Array<ArrayBuffer> | Int16Array<ArrayBuffer> | Int32Array<ArrayBuffer> | BigUint64Array<ArrayBuffer> | BigInt64Array<ArrayBuffer>>(
  typedArray: T
  ): T;
- randomUUID(): `${string}-${string}-${string}-${string}-${string}`;
interface CryptoKey
- readonly algorithm: KeyAlgorithm
- readonly extractable: boolean
- readonly type: KeyType
- readonly usages: KeyUsage[]
interface CryptoKeyPair
- privateKey: CryptoKey
- publicKey: CryptoKey
interface CShakeParams
- customization?: BufferSource
- functionName?: BufferSource
- name: string
- outputLength: number
interface EcdhKeyDeriveParams
- name: string
- public: CryptoKey
interface EcdsaParams
- hash: AlgorithmIdentifier
- name: string
interface EcKeyAlgorithm
- name: string
- namedCurve: string
interface EcKeyGenParams
- name: string
- namedCurve: string
interface EcKeyImportParams
- name: string
- namedCurve: string
interface EncapsulatedBits
- ciphertext: ArrayBuffer
- sharedKey: ArrayBuffer
interface EncapsulatedKey
- ciphertext: ArrayBuffer
- sharedKey: CryptoKey
interface HkdfParams
- hash: AlgorithmIdentifier
- info: BufferSource
- name: string
- salt: BufferSource
interface HmacImportParams
- hash: AlgorithmIdentifier
- length?: number
- name: string
interface HmacKeyAlgorithm
- hash: KeyAlgorithm
- length: number
- name: string
interface HmacKeyGenParams
- hash: AlgorithmIdentifier
- length?: number
- name: string
interface JsonWebKey
- alg?: string
- crv?: string
- d?: string
- dp?: string
- dq?: string
- e?: string
- ext?: boolean
- k?: string
- key_ops?: string[]
- kty?: string
- n?: string
- oth?: RsaOtherPrimesInfo[]
- p?: string
- q?: string
- qi?: string
- use?: string
- x?: string
- y?: string
interface KangarooTwelveParams
- customization?: BufferSource
- outputLength: number
interface KeyAlgorithm
- name: string
interface KmacImportParams
- length?: number
- name: string
interface KmacKeyAlgorithm
- length: number
- name: string
interface KmacKeyGenParams
- length?: number
- name: string
interface KmacParams
- customization?: BufferSource
- name: string
- outputLength: number
interface Pbkdf2Params
- hash: AlgorithmIdentifier
- iterations: number
- name: string
- salt: BufferSource
interface RsaHashedImportParams
- hash: AlgorithmIdentifier
- name: string
interface RsaHashedKeyAlgorithm
- hash: KeyAlgorithm
- modulusLength: number
- name: string
- publicExponent: NonSharedUint8Array
interface RsaHashedKeyGenParams
- hash: AlgorithmIdentifier
- modulusLength: number
- name: string
- publicExponent: NonSharedUint8Array
interface RsaKeyAlgorithm
- modulusLength: number
- name: string
- publicExponent: NonSharedUint8Array
interface RsaKeyGenParams
- modulusLength: number
- name: string
- publicExponent: NonSharedUint8Array
interface RsaOaepParams
- label?: BufferSource
- name: string
interface RsaOtherPrimesInfo
- d?: string
- r?: string
- t?: string
interface RsaPssParams
- name: string
- saltLength: number
interface SubtleCrypto
- decapsulateBits(
  decapsulationAlgorithm: AlgorithmIdentifier,
  decapsulationKey: CryptoKey,
  ciphertext: BufferSource
  ): Promise<ArrayBuffer>;
- decapsulateKey(
  decapsulationAlgorithm: AlgorithmIdentifier,
  decapsulationKey: CryptoKey,
  ciphertext: BufferSource,
  sharedKeyAlgorithm: AlgorithmIdentifier | HmacImportParams | AesDerivedKeyParams | KmacImportParams,
  extractable: boolean,
  usages: KeyUsage[]
  ): Promise<CryptoKey>;
- decrypt(
  algorithm: AlgorithmIdentifier | AeadParams | AesCbcParams | AesCtrParams | RsaOaepParams,
  key: CryptoKey,
  data: BufferSource
  ): Promise<ArrayBuffer>;
- deriveBits(
  algorithm: AlgorithmIdentifier | Argon2Params | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params,
  baseKey: CryptoKey,
  length?: null | number
  ): Promise<ArrayBuffer>;
- deriveKey(
  algorithm: AlgorithmIdentifier | Argon2Params | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params,
  baseKey: CryptoKey,
  derivedKeyType: AlgorithmIdentifier | HmacImportParams | AesDerivedKeyParams | KmacImportParams,
  extractable: boolean,
  keyUsages: readonly KeyUsage[]
  ): Promise<CryptoKey>;
- digest(
  algorithm: AlgorithmIdentifier | CShakeParams | KangarooTwelveParams | TurboShakeParams,
  data: BufferSource
  ): Promise<ArrayBuffer>;
- encapsulateBits(
  encapsulationAlgorithm: AlgorithmIdentifier,
  encapsulationKey: CryptoKey
  ): Promise<EncapsulatedBits>;
- encapsulateKey(
  encapsulationAlgorithm: AlgorithmIdentifier,
  encapsulationKey: CryptoKey,
  sharedKeyAlgorithm: AlgorithmIdentifier | HmacImportParams | AesDerivedKeyParams | KmacImportParams,
  extractable: boolean,
  usages: KeyUsage[]
  ): Promise<EncapsulatedKey>;
- encrypt(
  algorithm: AlgorithmIdentifier | AeadParams | AesCbcParams | AesCtrParams | RsaOaepParams,
  key: CryptoKey,
  data: BufferSource
  ): Promise<ArrayBuffer>;
- exportKey(
  format: 'jwk',
  key: CryptoKey
  ): Promise<JsonWebKey>;
  exportKey(
  format: 'spki' | 'pkcs8' | 'raw-public' | 'raw-seed' | 'raw' | 'raw-secret',
  key: CryptoKey
  ): Promise<ArrayBuffer>;
  exportKey(
  format: KeyFormat,
  key: CryptoKey
  ): Promise<ArrayBuffer | JsonWebKey>;
- generateKey(
  algorithm: EcKeyGenParams | RsaHashedKeyGenParams,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKeyPair>;
  generateKey(
  algorithm: AesKeyGenParams | HmacKeyGenParams | KmacKeyGenParams | Pbkdf2Params,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey>;
  generateKey(
  algorithm: AlgorithmIdentifier,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey | CryptoKeyPair>;
- getPublicKey(
  key: CryptoKey,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey>;
- importKey(
  format: 'jwk',
  keyData: JsonWebKey,
  algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm | KmacImportParams,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey>;
  importKey(
  format: 'spki' | 'pkcs8' | 'raw-public' | 'raw-seed' | 'raw' | 'raw-secret',
  keyData: BufferSource,
  algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm | KmacImportParams,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey>;
- sign(
  algorithm: AlgorithmIdentifier | ContextParams | EcdsaParams | KmacParams | RsaPssParams,
  key: CryptoKey,
  data: BufferSource
  ): Promise<ArrayBuffer>;
- unwrapKey(
  format: KeyFormat,
  wrappedKey: BufferSource,
  unwrappingKey: CryptoKey,
  unwrapAlgorithm: AlgorithmIdentifier | AeadParams | AesCbcParams | AesCtrParams | RsaOaepParams,
  unwrappedKeyAlgorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm | KmacImportParams,
  extractable: boolean,
  keyUsages: KeyUsage[]
  ): Promise<CryptoKey>;
- verify(
  algorithm: AlgorithmIdentifier | ContextParams | EcdsaParams | KmacParams | RsaPssParams,
  key: CryptoKey,
  signature: BufferSource,
  data: BufferSource
  ): Promise<boolean>;
- wrapKey(
  format: KeyFormat,
  key: CryptoKey,
  wrappingKey: CryptoKey,
  wrapAlgorithm: AlgorithmIdentifier | AeadParams | AesCbcParams | AesCtrParams | RsaOaepParams
  ): Promise<ArrayBuffer>;
interface TurboShakeParams
- domainSeparation?: number
- outputLength: number
type AlgorithmIdentifier = Algorithm | string
type BigInteger = NodeJS.NonSharedUint8Array
type HashAlgorithmIdentifier = AlgorithmIdentifier
type KeyFormat =
| 'jwk'
| 'pkcs8'
| 'raw'
| 'raw-public'
| 'raw-secret'
| 'raw-seed'
| 'spki'
type KeyType = 'private' | 'public' | 'secret'
type KeyUsage =
| 'decapsulateBits'
| 'decapsulateKey'
| 'decrypt'
| 'deriveBits'
| 'deriveKey'
| 'encapsulateBits'
| 'encapsulateKey'
| 'encrypt'
| 'sign'
| 'unwrapKey'
| 'verify'
| 'wrapKey'
type NamedCurve = string

crypto.webcrypto

namespace webcrypto

interface AeadParams

interface AesCbcParams

interface AesCtrParams

interface AesDerivedKeyParams

interface AesKeyAlgorithm

interface AesKeyGenParams

interface Algorithm

interface Argon2Params

interface ContextParams

interface Crypto

interface CryptoKey

interface CryptoKeyPair

interface CShakeParams

interface EcdhKeyDeriveParams

interface EcdsaParams

interface EcKeyAlgorithm

interface EcKeyGenParams

interface EcKeyImportParams

interface EncapsulatedBits

interface EncapsulatedKey

interface HkdfParams

interface HmacImportParams

interface HmacKeyAlgorithm

interface HmacKeyGenParams

interface JsonWebKey

interface KangarooTwelveParams

interface KeyAlgorithm

interface KmacImportParams

interface KmacKeyAlgorithm

interface KmacKeyGenParams

interface KmacParams

interface Pbkdf2Params

interface RsaHashedImportParams

interface RsaHashedKeyAlgorithm

interface RsaHashedKeyGenParams

interface RsaKeyAlgorithm

interface RsaKeyGenParams

interface RsaOaepParams

interface RsaOtherPrimesInfo

interface RsaPssParams

interface SubtleCrypto

interface TurboShakeParams