Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@std/crypto@0.215.0

latest
Works with
It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
It is unknown whether this package works with Browsers
It is unknown whether this package works with Deno
It is unknown whether this package works with Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score70%•
Published2 years ago (0.215.0)

Extensions to the Web Crypto API supporting additional encryption APIs, but also delegating to the built-in APIs when possible.

Provides additional digest algorithms that are not part of the WebCrypto standard as well as a subtle.digest and subtle.digestSync methods.

The KeyStack export implements the KeyRing interface for managing rotatable keys for signing data to prevent tampering, like with HTTP cookies.

Supported algorithms

Here is a list of supported algorithms. If the algorithm name in WebCrypto and Wasm/Rust is the same, this library prefers to use algorithms that are supported by WebCrypto.

WebCrypto:

  • SHA-384
  • SHA-256
  • SHA-512 (length-extendable and collidable)

Wasm/Rust:

  • BLAKE2B-128
  • BLAKE2B-160
  • BLAKE2B-224
  • BLAKE2B-256
  • BLAKE2B-384
  • BLAKE2B
  • BLAKE2S
  • BLAKE3
  • FNV32 (length-extendable)
  • FNV32A (length-extendable)
  • FNV64 (length-extendable)
  • FNV64A (length-extendable)
  • KECCAK-224
  • KECCAK-256
  • KECCAK-384
  • KECCAK-512
  • SHA-384
  • SHA3-224
  • SHA3-256
  • SHA3-384
  • SHA3-512
  • SHAKE128
  • SHAKE256
  • TIGER
  • RIPEMD-160 (length-extendable)
  • SHA-224 (length-extendable)
  • SHA-256 (length-extendable)
  • SHA-512 (length-extendable)
  • MD4 (collidable and length-extendable)
  • MD5 (collidable and length-extendable)
  • SHA-1 (collidable and length-extendable)

Examples

Example 1

import { crypto } from "@std/crypto";

// This will delegate to the runtime's WebCrypto implementation.
console.log(
  new Uint8Array(
    await crypto.subtle.digest(
      "SHA-384",
      new TextEncoder().encode("hello world"),
    ),
  ),
);

// This will use a bundled Wasm/Rust implementation.
console.log(
  new Uint8Array(
    await crypto.subtle.digest(
      "BLAKE3",
      new TextEncoder().encode("hello world"),
    ),
  ),
);

Convert hash to a string

import {
  crypto,
} from "@std/crypto";
import { encodeHex } from "@std/encoding/hex"
import { encodeBase64 } from "@std/encoding/base64"

const hash = await crypto.subtle.digest(
  "SHA-384",
  new TextEncoder().encode("You hear that Mr. Anderson?"),
);

// Hex encoding
console.log(encodeHex(hash));

// Or with base64 encoding
console.log(encodeBase64(hash));

Interfaces

I
StdCrypto

Extensions to the Web Crypto interface.

  • subtle: StdSubtleCrypto

    Extension to the crypto.SubtleCrypto interface.

I
StdSubtleCrypto

Extensions to the web standard SubtleCrypto interface.

  • digest(
    algorithm: DigestAlgorithm,
    data:
    BufferSource
    | AsyncIterable<BufferSource>
    | Iterable<BufferSource>
    ): Promise<ArrayBuffer>

    Returns a new Promise object that will digest data using the specified AlgorithmIdentifier.

  • digestSync(
    algorithm: DigestAlgorithm,
    data: BufferSource | Iterable<BufferSource>
    ): ArrayBuffer

    Returns a ArrayBuffer with the result of digesting data using the specified AlgorithmIdentifier.

Type Aliases

T
DigestAlgorithm = DigestAlgorithmName | DigestAlgorithmObject

Extended digest algorithms accepted by stdCrypto.subtle.digest.

T
DigestAlgorithmName = WasmDigestAlgorithm | FNVAlgorithms

Extended digest algorithm names.

T
DigestAlgorithmObject = { name: DigestAlgorithmName; length?: number; }

Extended digest algorithm objects.

  • length: number
    No documentation available
  • name: DigestAlgorithmName
    No documentation available
T
FNVAlgorithms = "FNV32" | "FNV32A" | "FNV64" | "FNV64A"

FNV (Fowler/Noll/Vo) algorithms names.

T
WasmDigestAlgorithm = digestAlgorithms[number]

An algorithm name supported by std/crypto/_wasm.

Variables

v
crypto: StdCrypto

An wrapper for WebCrypto adding support for additional non-standard algorithms, but delegating to the runtime WebCrypto implementation whenever possible.

v
wasmDigestAlgorithms:
"BLAKE2B-128"
| "BLAKE2B-160"
| "BLAKE2B-224"
| "BLAKE2B-256"
| "BLAKE2B-384"
| "BLAKE2B"
| "BLAKE2S"
| "BLAKE3"
| "KECCAK-224"
| "KECCAK-256"
| "KECCAK-384"
| "KECCAK-512"
| "SHA-384"
| "SHA3-224"
| "SHA3-256"
| "SHA3-384"
| "SHA3-512"
| "SHAKE128"
| "SHAKE256"
| "TIGER"
| "RIPEMD-160"
| "SHA-224"
| "SHA-256"
| "SHA-512"
| "MD4"
| "MD5"
| "SHA-1"
[]

All cryptographic hash/digest algorithms supported by std/crypto/_wasm.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/crypto

Import symbol

import * as mod from "@std/crypto/crypto";
or

Import directly with a jsr specifier

import * as mod from "jsr:@std/crypto/crypto";