xref: /plugin/dokucrypt3/README.md (revision 97c734d516051c5b55fc0c340717b771d97a295d)
1*97c734d5Sternite# DokuWiki Plugin: DokuCrypt2
2*97c734d5Sternite
3*97c734d5SterniteThis is a plugin for DokuWiki to support client side cryptography.
4*97c734d5Sternite
5*97c734d5Sternite* https://www.dokuwiki.org/plugin:dokucrypt3
6*97c734d5Sternite* Licence: GPL-3.0 (https://www.gnu.org/licenses/gpl-3.0)
7*97c734d5Sternite* Author: Originally by By Scott Moser. Maintained by Thomas Schäfer (thomas@hilbershome.de). Previously maintained by Sherri Wheeler (dokucrypt2)
8*97c734d5Sternite
9*97c734d5Sternite> **!! Warning:** This plugin should not replace a password manager or peer reviewed cryptography tools for high-priority use. Do not store mission critical type data with this plugin - I cannot be sure that the info is not cached by DokuWiki or the web browser.
10*97c734d5Sternite
11*97c734d5Sternite> **!! This plugin is provided without warranty or guarantee of any kind. Use at your own discretion.**
12*97c734d5Sternite
13*97c734d5Sternite## Usage
14*97c734d5Sternite
15*97c734d5Sternite```
16*97c734d5SterniteHi world.  I have a secret.  Can you read it?
17*97c734d5Sternite<SECRET>I like ice cream</SECRET>
18*97c734d5Sternite```
19*97c734d5Sternite
20*97c734d5SterniteWhen the user hits 'Save' (or a draft is attempted to be saved) a prompt will open, asking the user to enter a pass phrase key for the encryption. Once supplied, the encryption will be done in the browser and the encrypted text submitted to the server.
21*97c734d5Sternite
22*97c734d5Sternite## Settings
23*97c734d5Sternite
24*97c734d5SterniteThis plugin includes configuration settings.
25*97c734d5Sternite
26*97c734d5Sternite* `copytoclipboard` - If set to true, the plugin tries to copy the decrypted value to the clipboard.
27*97c734d5Sternite* `hidepasswordoncopytoclipboard` - If set to true, the decrypted value will not be shown after being copied to the clipboard (see option 'copytoclipboard').
28*97c734d5Sternite
29*97c734d5Sternite## ChangeLog
30*97c734d5Sternite
31*97c734d5Sternite* 2025-10-15: Release of dokucrypt3, which has originally been an internal fork of dokucrypt2 with massive changes to the way encryption is handled. The resulting pull request would not be merged into the base repository (due to maintenance effort). So a new github repository `dokucrypt3` was created based on dokucrypt2 and the new encryption engine.
32