CipherStash Protect.js 入门指南:数据加密与搜索实战
2025-06-05 06:06:18作者:裴锟轩Denise
前言
在现代应用开发中,数据安全至关重要。CipherStash Protect.js 是一个强大的 JavaScript 库,它允许开发者在 Node.js 应用中轻松实现数据加密、解密和搜索功能,同时保持数据在数据库中的可查询性。本文将带你从零开始,逐步掌握 Protect.js 的核心功能。
环境准备
在开始之前,请确保你的开发环境满足以下要求:
- Node.js 环境(建议使用 LTS 版本)
- TypeScript 编译器
- PostgreSQL 数据库(版本 12 或更高)
项目结构规划
一个典型的 Protect.js 项目结构如下:
项目根目录/
├── src/
│ ├── protect/
│ │ ├── index.ts # Protect 客户端配置
│ │ └── schema.ts # 数据表定义
│ └── index.ts # 应用入口
├── .env # 环境变量
├── cipherstash.toml # 配置文件
├── cipherstash.secret.toml # 密钥文件
├── package.json
└── tsconfig.json
安装与配置
1. 安装 Protect.js
使用 npm 或 yarn 安装核心包:
npm install @cipherstash/protect
同时需要安装 CipherStash CLI 工具:
- macOS 用户:
brew install cipherstash/tap/stash - Linux 用户需下载对应平台的二进制文件并添加到 PATH
2. 初始化配置
运行以下命令生成必要的配置文件:
stash setup
此命令会创建两个关键文件:
cipherstash.toml:公共配置cipherstash.secret.toml:包含敏感凭证(切勿提交到版本控制)
数据模型定义
3. 创建数据模式
在 src/protect/schema.ts 中定义你的数据表结构:
import { csTable, csColumn } from "@cipherstash/protect";
export const users = csTable("users", {
email: csColumn("email").freeTextSearch().equality().orderAndRange(),
});
export const orders = csTable("orders", {
address: csColumn("address"),
});
这里我们为 email 字段添加了三种搜索能力:
- 全文搜索 (
freeTextSearch) - 精确匹配 (
equality) - 排序和范围查询 (
orderAndRange)
客户端初始化
4. 创建 Protect 客户端
在 src/protect/index.ts 中初始化客户端:
import { protect } from "@cipherstash/protect";
import { users, orders } from "./schema";
export const protectClient = await protect({
schemas: [users, orders],
});
核心功能实现
5. 数据加密
使用 encrypt 方法加密敏感数据:
const encryptResult = await protectClient.encrypt("user@example.com", {
column: users.email,
table: users,
});
if (encryptResult.failure) {
console.error("加密失败:", encryptResult.failure.message);
return;
}
const ciphertext = encryptResult.data;
加密结果是一个包含密文的对象,可以安全地存储到数据库中。
6. 数据解密
使用 decrypt 方法解密数据:
const decryptResult = await protectClient.decrypt(ciphertext);
if (decryptResult.failure) {
console.error("解密失败:", decryptResult.failure.message);
return;
}
const plaintext = decryptResult.data; // "user@example.com"
7. 数据库集成
在 PostgreSQL 中创建表时,加密字段应使用 jsonb 类型:
CREATE TABLE users (
id SERIAL PRIMARY KEY,
email jsonb NOT NULL
);
这样设计允许存储 Protect.js 生成的加密数据结构,同时保持搜索能力。
高级功能
批量加密操作
对于大量数据,Protect.js 提供了批量加密接口:
const batchEncryptResult = await protectClient.batchEncrypt([
{ plaintext: "data1", column: users.email, table: users },
{ plaintext: "data2", column: users.email, table: users }
]);
搜索加密数据
由于我们在模式定义中添加了搜索能力,可以直接查询加密数据:
const searchResult = await protectClient.search(users.email, "example");
最佳实践
- 密钥管理:确保
cipherstash.secret.toml不被泄露,建议使用密钥管理服务 - 错误处理:始终检查加密/解密操作的返回结果
- 性能优化:对于高频操作,考虑缓存 Protect 客户端实例
- 类型安全:充分利用 TypeScript 的类型检查功能
结语
通过本指南,你已经掌握了 CipherStash Protect.js 的核心功能。这个强大的工具让数据加密变得简单而高效,同时不牺牲搜索能力。在实际项目中,你可以根据需求扩展数据模型,实现更复杂的安全数据管理方案。
对于更高级的用法,建议探索 Protect.js 的文档,了解如何实现字段级加密、细粒度访问控制等高级安全特性。
登录后查看全文
热门项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
248
2.46 K
deepin linux kernel
C
24
6
仓颉编译器源码及 cjdb 调试工具。
C++
116
89
React Native鸿蒙化仓库
JavaScript
217
297
暂无简介
Dart
547
119
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
596
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
410
Ascend Extension for PyTorch
Python
87
118
仓颉编程语言运行时与标准库。
Cangjie
124
102
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
123