@47ng/cloak

中文文档
1.2.0发布于 2024/09/24MITTypeScriptCommonJS近 30 天下载 44万

AES-GCM 256 浏览器和节点的加密、解密和密钥管理

中文使用文档
文档目录4 节
  1. 安装
  2. 国 际
  3. 程序用途
  4. 许可证

@47ng/cloak

NPM MIT License Continuous Integration Coverage Status

串行AES-GCM 256加密,解密以及浏览器和节点.js中的密钥管理.

安装

$ yarn add @47ng/cloak
# or
$ npm i @47ng/cloak

国 际

软件包带有一个用于生成和管理密钥的 CLI 工具, 如 以及加密和解密终端中的数据:

$ cloak --help
Usage: cloak [options] [command]

Options:
  -h, --help                 output usage information

Commands:
  generate                   Generate an AES-GCM key
  encrypt [options] [key]    Encrypt stdin
  decrypt                    Decrypt stdin
  revoke <keyFingerprint>    Remove a key from the environment keychain
  keychain [options] [full]  List the contents of the environment keychain

# Start by generating an empty keychain and master key:
$ cloak generate
Key:          k1.aesgcm256.DL2G9PQeZ9r65J59pph6dy9Sk4fBLEZ3CTQZsandgYE=
Fingerprint:  6f28c026

Generated new empty keychain:
export CLOAK_MASTER_KEY=k1.aesgcm256.DL2G9PQeZ9r65J59pph6dy9Sk4fBLEZ3CTQZsandgYE=
export CLOAK_KEYCHAIN=v1.aesgcm256.6f28c026.yhCUkzv5gOyHJ2M_.jrGSf2_MPVofk-kSDgnYzvEy

# Copy/paste the exports into your terminal
# (the CLI does not mutate your environment directly)
$ export CLOAK_MASTER_KEY=k1.aesgcm256.DL2G9PQeZ9r65J59pph6dy9Sk4fBLEZ3CTQZsandgYE=
$ export CLOAK_KEYCHAIN=v1.aesgcm256.6f28c026.yhCUkzv5gOyHJ2M_.jrGSf2_MPVofk-kSDgnYzvEy

# Generate a key to use for encryption
$ cloak generate
Key:          k1.aesgcm256.pHLFYdaqXut62LoFbt8KV80x_YNyZPmY0kQaPhJ0Ehc=
Fingerprint:  cd38bcc4

Updated keychain:
export CLOAK_MASTER_KEY=k1.aesgcm256.DL2G9PQeZ9r65J59pph6dy9Sk4fBLEZ3CTQZsandgYE=
export CLOAK_KEYCHAIN=v1.aesgcm256.6f28c026.jr9fqMA_RfNhIjHz.lo4IfIYfZ0zxrdSns_ibWq6YX1D5AnzN-fhUF0CKVx5dRVIo0x-Atumr9WZqpHOeEIWT5bEGFKHhxGkFdwk2vg5TZQNk5Rj_jo3hnfSLaFAYncG59dB  jUkz1JE0Plq2d-GR1AbDs6P18VzOG_JrU

To use this new key as default for encryption:
export CLOAK_CURRENT_KEY=cd38bcc4

# Encrypt sdtin
$ echo 'Hello, World !' | cloak encrypt
v1.aesgcm256.cd38bcc4.yxAp2iONy7zYOhbs.X2zmGpmGw9a7tiSnyukEW8Ac-2IIcIENW5uHxtHYyA==

# Decrypt stdin
$ echo 'v1.aesgcm256.cd38bcc4.yxAp2iONy7zYOhbs.X2zmGpmGw9a7tiSnyukEW8Ac-2IIcIENW5uHxtHYyA==' | cloak decrypt
Hello, World !

程序用途

// Works in the browser or in Node.js

import { generateKey, encryptString, decryptString } from '@47ng/cloak'

const demo = async () => {
  const key = generateKey()
  const cipher = await encryptString('Hello, World', key)
  const decipher = await decryptString(cipher, key)
}

许可证

麻省理工学院 - 由 \ \ \ 由 \ \ \ 由 \ 弗朗索瓦·贝斯

工作时用这个包? 赞助我 帮助支持和维护.

版本与发布记录

@47ng/cloak 共发布 25 个版本,首次发布于 2019/12/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.2.0latest2024/09/242 年前
1.2.0-beta.1beta2024/09/242 年前
1.1.02021/12/144 年前
1.1.0-beta.22021/11/254 年前
1.1.0-beta.12021/11/254 年前
1.0.12020/12/235 年前

关于 @47ng/cloak 的常见问题

@47ng/cloak 是什么?

AES-GCM 256 浏览器和节点的加密、解密和密钥管理

如何安装 @47ng/cloak?

在项目目录运行 npm install @47ng/cloak,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cloak,可以用 npx cloak 直接运行。

@47ng/cloak 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@47ng/cloak 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@47ng/cloak 可以商用吗?

@47ng/cloak 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@47ng/cloak 的下载量有多少?

根据 npm 官方下载统计,@47ng/cloak 在 2026/10/05 – 2026/11/03 这 30 天内被下载 440,438 次,日均约 14,681 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@47ng/cloak 还在维护吗?

最新版本 1.2.0 发布于 2024/09/24(2 年前);至今共发布 25 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/12/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。