Staticrypt 使用指南

项目介绍

Staticrypt 是一个用于加密HTML文件的工具，它允许您创建密码保护的静态网页。此项目特别适用于那些希望在不牺牲安全性的情况下分享敏感内容的场景。通过使用WebCrypto API（自版本3.x起），Staticrypt确保了在HTTPS环境或本地环境中提供加密服务，从而增强了数据传输的安全性。此外，它支持“记住我”功能，通过在浏览器的localStorage中安全地存储哈希加盐后的密码，以及分享功能，使得页面可以在不同环境下保持登录状态。

项目快速启动

要快速开始使用Staticrypt，首先确保您的开发环境已安装Node.js。然后，您可以按以下步骤操作：

安装Staticrypt

打开终端，运行以下命令以全局安装Staticrypt：

npm install -g staticrypt

加密文件

假设您有一个名为index.html的文件想要加密，可以使用以下命令：

staticrypt index.html -p your_password_here

这将创建一个加密后的HTML文件，访问时需要输入密码。

如果您希望自动化解密过程用于测试或部署，可以加上--decrypt标志来解密文件：

staticrypt index.html --decrypt

提示： 为了方便持续集成(CI)环境，您可以通过环境变量或配置文件设置默认密码。

应用案例和最佳实践

单一文件加密分享

对于个人或小团队分享私密资料，直接加密单个HTML文件并通过电子邮件或私人链接发送给指定接收者，每个接收者对应不同的密码。

多用户访问控制

为实现多用户的访问管理，可通过脚本自动化为每位用户创建不同的密码和对应的加密文件夹，如：

for user in user1 user2 user3; do
    staticrypt index.html -p ${user}_password -d ${user}
done

随后，向每位用户提供专属的URL和密码，例如https://yourwebsite.com/user1。

“记住我”功能利用

在需要用户长时间保持登录的场景下，利用Staticrypt的“记住我”选项，通过配置适当的过期天数来平衡便捷性和安全需求。

典型生态项目

虽然Staticrypt本身是独立使用的，但它鼓励开发者结合其他前端框架或静态站点生成器使用，比如Jekyll、Gatsby或Hugo，以创建完整的、动态可选的静态网站。尽管Staticrypt没有直接与其他特定生态项目整合的说明，但开发者可以根据需要，在构建流程中引入Staticrypt，作为发布前的最后一步，对特定页面进行加密处理，以此增强特定内容的隐私保护。

---

以上就是使用Staticrypt的基本指引，无论是简单的文件加密分享，还是复杂的用户访问控制逻辑，Staticrypt都提供了灵活且安全的解决方案。通过遵循这些步骤和实践建议，你可以轻松集成加密技术到你的下一个项目中。