Skip to main content
Home
Browse packagesDocsSign in

@hugoalh/symmetric-crypto@4.2.1
Built and signed on GitHub Actions

latest
hugoalh/symmetric-crypto-es

A module to provide an easier symmetric crypto.

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
88%
Published
6 months ago (4.2.1)

Symmetric Crypto (ES)

⚖️ MIT

GitHub: hugoalh/symmetric-crypto-es JSR: @hugoalh/symmetric-crypto NPM: @hugoalh/symmetric-crypto

An ES (JavaScript & TypeScript) module to provide an easier symmetric crypto.

🔰 Begin

🎯 Targets

Remote JSR NPM
Bun >= v1.1.0 ❌ ❓ ✔️
Cloudflare Workers ❌ ❓ ✔️
Deno >= v1.42.0 ✔️ ✔️ ✔️
NodeJS >= v16.13.0 ❌ ❓ ✔️
Note

  • It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

  • Remote - GitHub Raw: 
    https://raw.githubusercontent.com/hugoalh/symmetric-crypto-es/{Tag}/mod.ts
  • JSR: 
    [jsr:]@hugoalh/symmetric-crypto[@{Tag}]
  • NPM: 
    [npm:]@hugoalh/symmetric-crypto[@{Tag}]
Note

  • For usage of remote resources, it is recommended to import the entire module with the main path mod.ts, however it is also able to import part of the module with sub path if available, but do not import if:

    • it's path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
    • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
    • it's symbol has an underscore prefix (e.g.: _bar, _foo).

    These elements are not considered part of the public API, thus no stability is guaranteed for them.

  • For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints.

  • It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

  • File System - Read [Deno: read; NodeJS (>= v20.9.0) 🧪: fs-read]
    • Resources (Optional)
  • File System - Write [Deno: write; NodeJS (>= v20.9.0) 🧪: fs-write]
    • Resources (Optional)

🧩 APIs

  • class SymmetricCryptor {
  decrypt(data: string): Promise<string>;
  decrypt(data: Uint8Array): Promise<Uint8Array>;
  decryptFile(...filesPath: (string | URL)[]): Promise<this>;
  encrypt(data: string): Promise<string>;
  encrypt(data: Uint8Array): Promise<Uint8Array>;
  encryptFile(...filesPath: (string | URL)[]): Promise<this>;
  readEncryptedFile(filePath: string | URL, options?: Deno.ReadFileOptions): Promise<Uint8Array>;
  readEncryptedTextFile(filePath: string | URL, options?: Deno.ReadFileOptions): Promise<string>;
  writeEncryptedFile(filePath: string | URL, data: Uint8Array, options?: Omit<Deno.WriteFileOptions, "append">): Promise<this>;
  writeEncryptedTextFile(filePath: string | URL, data: string, options?: Omit<Deno.WriteFileOptions, "append">): Promise<this>;
}

  • enum SymmetricCryptorAlgorithm {
  "AES-CBC" = "AES-CBC",
  "AES-CTR" = "AES-CTR",
  "AES-GCM" = "AES-GCM",
  AESCBC = "AES-CBC",
  AESCTR = "AES-CTR",
  AESGCM = "AES-GCM"
}

  • function createSymmetricCryptor(key: SymmetricCryptorKeyInput | SymmetricCryptorKeyType, options?: SymmetricCryptorOptions): Promise<SymmetricCryptor>;
function createSymmetricCryptor(keys: (SymmetricCryptorKeyInput | SymmetricCryptorKeyType)[], options?: Omit<SymmetricCryptorOptions, "times">): Promise<SymmetricCryptor>;

  • interface SymmetricCryptorOptions {
  decoder?: SymmetricCryptorCipherTextDecoder;
  encoder?: SymmetricCryptorCipherTextEncoder;
  times?: number;
}

  • interface SymmetricCryptorKeyInput {
  algorithm?: SymmetricCryptorAlgorithm | keyof typeof SymmetricCryptorAlgorithm;
  key: SymmetricCryptorKeyType;
}

  • type SymmetricCryptorCipherTextDecoder = (input: string) => Uint8Array | Promise<Uint8Array>;

  • type SymmetricCryptorCipherTextEncoder = (input: Uint8Array) => string | Promise<string>;

  • type SymmetricCryptorKeyType = string | ArrayBuffer | DataView | Uint8Array | Uint16Array | Uint32Array | BigUint64Array;
Note

✍️ Examples

  • const data = "qwertyuiop";
const cryptor = await createSymmetricCryptor("<PassWord123456>!!");
const encrypted = await cryptor.encrypt(data);
console.log(encrypted);
// "lST)L-9$J[MPqk)3Pe1qa(;,i)Wi]\"4oD9+OE(Hc"
const decrypted = await cryptor.decrypt(encrypted);
console.log(decrypted);
// "qwertyuiop"
Built and signed on
GitHub Actions
View transparency log

New Ticket: 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:@hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";
or

Import directly with a jsr specifier

import * as symmetric_crypto from "jsr:@hugoalh/symmetric-crypto";

Add Package

pnpm i jsr:@hugoalh/symmetric-crypto
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";

Add Package

yarn add jsr:@hugoalh/symmetric-crypto
or (using Yarn 4.8 or older)
yarn dlx jsr add @hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";

Add Package

vlt install jsr:@hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";

Add Package

npx jsr add @hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";

Add Package

bunx jsr add @hugoalh/symmetric-crypto

Import symbol

import * as symmetric_crypto from "@hugoalh/symmetric-crypto";