DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:dokucrypt2

dokucrypt2 Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" probably
  • 2023-04-04 "Jack Jackrum" probably
  • 2022-07-31 "Igor" probably
  • 2020-07-29 "Hogfather" yes

plugin A plugin to support client side cryptography

Last updated on
2022-08-08
Provides
Admin
Repository
Source
Conflicts with
aceeditor, fastwiki

Similar to dokucrypt

Tagged with encryption, password

By Scott Moser (smoser@brickies.net), maintained by Sherri Wheeler. (Twitter @SyntaxSeed / SyntaxSeed.com)

This replaces the: Original DokuCrypt Plugin.

:!: I am looking for a new maintainer for this plugin. If interested, please contact me via my business contact form (https://www.avinus.com/contact). — sherri 2023-09-05 17:09

Installation

This is a newly maintained version of the DokuCrypt plugin. It is fully patched for the latest version of Dokuwiki.

  • Fully tested on: 2018-04-22b+ “Greebo”
  • Fully tested on:: 2020-07-29 “Hogfather”. (Use version 2020-10-19 or later of DokuCrypt2.)

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Note: Plugin is now maintained by Sherri Wheeler. — Sherri 2017-06-26 04:45

About

dokucrypt is a client side (javascript) cryptography plugin. This plugins allows a user to store and access sensitive data in a dokuwiki. All sensitive data is encrypted before it is submitted and decrypted on the clients machine. A users' sensitive data will only be accessible when viewed with a javascript enabled browser and the proper pass phrase. It will never be transmitted or stored in plain text, and you will avoid having passwords and sensitive data stored in plain text on the server.

The Javascrypt (http://www.fourmilab.ch/javascrypt/) library is used for encryption and decryption to provide 256 Bit AES encryption.

:!: 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. — sherri 2020-10-14 19:55

:!: This plugin is provided without warranty or guarantee of any kind. Use at your own discretion.sherri 2020-10-14 19:55

Releases

  • 2022-08-08: Added ability and setting for copying the contents to the clipboard on decrypt.
  • 2022-02-02: Preparatory fixes/testing for PHP 8. Improvements for code style PSRs.
  • 2021-05-18: Fix for internal link edit toolbar button. Issue #12.
  • 2021-03-03: Add wrapping for the pre tag. Contributed by dustin-something.
  • 2020-10-19: Cosmetic changes, add CSS classes, collapse blocks by default.
  • 2020-10-14: Temp fix for Dokuwiki 2020-07-29 “Hogfather”. DecryptSecret button was not appearing on page edit.
  • 2020-02-07: Updated for PHP v 7+.
  • 2017-11-08: Fixed an issue with the heading buttons 'PATCH 1' required (above). Added plugin info text file.
  • 2017-06-25: Fork the original plugin. Patch it up. Release for most recent DokuWiki version. Cheers!

Usage

Entering Encrypted Data

In order to encrypt some sensitive data, the user needs to add text like the following

Hi world.  I have a secret.  Can you read it?
<SECRET>I like ice cream.</SECRET>

When 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.

Special Characters

The less-than (<) and greater-than(>) symbols, if included in the enclosed text to encrypt, will break the decryption and cause some content to not be shown. To enter these characters in your content to be encrypted, use their HTML entity equivalents:

  • < = Use: &lt;
  • > = Use: &gt;

Viewing Encrypted Data

When the page is viewed, the user will see the encrypted text and a link 'Decrypt Encrypted Text' will appear which will prompt the user for a password and decrypt the text (see the example below).

The encrypted text is compatible with javascrypt decryption (http://www.fourmilab.ch/javascrypt/jscrypt.html).

Editing Encrypted Data

To edit the encrypted data, the user needs to Edit the wiki page. When first loaded, encrypted text will appear encrypted, surrounded by <ENCRYPTED> and </ENCRYPTED> tags. To edit this text, the user needs to press the 'DecryptSecret' button between 'Save' and 'Preview', and supply the correct pass phrase. The encrypted text will be decrypted to the 'SECRET' form showed above, and the use can edit in plaintext. Submits or drafts will be encrypted before submission with the same pass phrase supplied.

Settings

This plugin includes configuration settings.

  • copytoclipboard - If set to true, the plugin tries to copy the decrypted value to the clipboard.
  • hidepasswordoncopytoclipboard - If set to true, the decrypted value will not be shown after being copied to the clipboard (see option 'copytoclipboard').

Known Issues

  • May not work if the website including plugin control text is being translated into another language.
  • Conflicts with Encrypted Passwords plugin (both plugins attempt to parse the <encrypt></encrypt> tag). — Fumigator2 2024-03-12 02:41

Feature Requests

Please use the GitHub Issues page.

Bugs - Please Submit Bugs On GitHub

Please use the Issues page on GitHub.

Patches For Older Versions of DokuWiki

plugin/dokucrypt2.txt · Last modified: 2024-03-12 02:43 by Fumigator2

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki