Skip to content

Latest commit

 

History

History
127 lines (74 loc) · 4.82 KB

README_zh.md

File metadata and controls

127 lines (74 loc) · 4.82 KB

English|中文

这是原项目的一个分支

Joplin 加密插件

这是joplin笔记本的一个插件

支持Joplin2.9.17

使用

  • 点击右上角工具栏锁形按钮，输入密码加密。

  • 离开该笔记后再次进入时解密。解密对话框自动弹出。可以通过设置取消自动弹出。

  • 该插件禁止修改加密的文件，但是在没有安装该插件时可以修改，包括移动端app；修改加密后的文件无法正常解密。可以通过高级设置启用编辑加密文件。

  • 使用一个固定的特殊前缀字符串判断是否是加密文档，所以不要在你的正常文档的开头写相同的字符串，同理如果你修改加密文件的这个字符串，那么禁止修改加密文件的功能会失效

特殊字符串列表

版本 前缀 版本信息 密文数据分隔符 偏移向量分隔符
1.0.0 [[crypted]] <br/>
1.0.1 ;;ENCRYPTNOTE? UTF8?AES?CBC128?PKCS7?V101; ;DATA;
1.0.5 ;;ENCRYPTNOTE? UTF8?AES?CBC128?PKCS7?V105; ;DATA; ;IV;

注意

  • 支持Linux和Windows 7/10平台的Joplin，理论上所有桌面版本可用插件。其他平台未测试。移动端App目前仍不支持插件；

  • 该插件使用 CryptoJS 加密文本，不加密附件，数据安全性取决于 CryptoJS；

  • 没有找回密码功能，不在任何地方保存密码，密码丢失后没有任何手段找回；

  • 历史笔记功能可能导致你想加密的内容泄露，禁用该功能可以避免泄露；但是如果密码忘记，将有可能通过历史笔记来恢复重要内容； 使用建议：私人笔记使用不同的笔记账户（Profile），由于不同Profile可以采用不同设置————因为它们链接不同的数据库,大部分的设置是互相独立的————重要的笔记采用开放的Profile仍然保留历史，私人笔记禁用历史。 笔记账户（Profile）的设置在 文件->Switch Profile->。

    或者在解密前关闭笔记历史功能，在加密后再打开。

    更多关于笔记历史的内容（英文）

    Note history now in Joplin

    Note-history user document

    Note-history specification

    关闭历史笔记功能（设置里面启用不挑勾）不影响数据库中已存在的笔记历史，但是保留的历史会在设定的天数到期后自动被删除。但是如果把保留天数设置到1，则理论上一天前的历史立刻会被全部删除（未测试）。

  • 插件为一次性加密-解密，每次解密后，需要手动重新加密；

  • 加密插件与富文本编辑器不兼容，请不要再富文本编辑模式下加密或解密（尤其是加密）。（富文本编辑器：所见即所得编辑器，操作类似Word，Joplin中首次进入此模式下会有一行黄字提示，切换编辑器模式的按钮在右上角第二行。）

加密算法

  • 算法 algorithm：AES
  • 密文编码 encryption encode：BASE64
  • 加密模式 encryption mode：CBC
  • 密钥 key： 长度 key length：128位 字符 character：16个UTF8 8位字符（数字、拉丁字母以及其他ASCII符号） 长度不够则补充0：如用户设定密钥为12345abc+ 则补充为12345abc+0000000
  • 偏移向量 iv：随机值（1.0.5更新） 编码 iv encode：BASE64
  • 填充模式 padding：Pkcs7

安装

复制 publish/File_encryption.jpl 文件到你的电脑，然后用 Joplin 导入该插件

从源码构建

Generator Doc

需要环境

手动安装NodeJS， javascript 运行环境

指令安装以下 yeoman 模板化应用构建工具

crypto-js 加密程序

安装

打开命令行运行安装指令

npm install -g yo
npm install -g crypto-js
npm install -g generator-joplin

创建并移动到工作路径 比如 ：cd C:/user/username/documents/joplin-plugin-encrypt-notes/

yo joplin

输入信息

执行完成后在工作路径会产生构建所需的框架文件

构建

将src文件夹下的代码复制到工作路径的src中。

在命令行工作路径下运行 npm run dist

可以运行的插件会在publish中生成，扩展名称为.jpl

问题

1.1.1 修复 富文本编辑器中无法正确修改标题 的问题。

反馈

问题报告和功能要求

可以使用github上的issue反馈问题。 也可以发送邮件至[email protected]。