7.0 KiB
Obsidian Encrypt Plugin
Create encrypted notes within your Obsidian.md vault.
Encrypted notes are never decrypted to disk (unless you use the decrypt in-place feature) giving you piece-of-mind that the decrypted contents haven't been sync'd or backed up to external systems.
⚠️ WARNING - Use at your own risk ⚠️
- Your passwords are never stored anywhere, if you forget your passwords you can't decrypt your notes.
- No known audits have been undertaken for the soundness of encryption methods being used. Unwanted decryption by a 3rd party may be possible if they have access to your files.
- Bugs could be introduced to the software at anytime, you are responsible for having backups of your notes.
⚜️ Installation
You can install the plugin via the Community Plugins tab within Obsidian by searching for "Meld Encrypt"
⚜️ Latest Changes
Please report any bugs or feature requests here.
2.1.3
- follow 'readable line length' and 'show inline title' settings in encrypted notes
- update layout and styling
- enable spell check when editing
2.1.2
- add inline encrypted text marker (clickable) in reading view
2.1.1
- Limited support for markdown in
.encryptednotes - New setting to select the default view when opening
.encryptednotes (Source or Reading)
v2.1.0
- Auto decrypt note if password remembered
- Clear remembered password when re-locking file
- When changing password, remember it if 'remember passwords' is active
- Change wording for 'Remember Password Timeout' in settings
- Add new setting to remember password by parent folder path
- Code refactors
v2.0.5
- fix creating encrypted note on mobile
⚜️ Usage
Standalone, always encrypted, notes (.encrypted files)
To create a new encrypted note
- Select 'Create encrypted note' from the command palette.
- Enter and confirm a password and optional hint to use.
- Edit your encrypted note (it's contents will be encrypted and saved to disk).
To edit/view an encrypted note
- Open the note as usual from the navigation tree.
- Enter the password for the note.
To changing an encrypted notes password and hint
- Open the note as usual from the navigation tree.
- Enter the password for the note.
- Click 'Change Password' from the tab title bar or tab context menu.
- Enter the new password and hint.
In-place Encryption
To encrypt selected text
- Select some text to encrypt
Note: A partial selection will be expanded to include the whole line if the 'Expand selection to whole line' setting is enabled.
-
Run the Encrypt/Decrypt command from the palette (or bind a keyboard shortcut to it).
-
Enter and confirm a password and optional hint.
-
Your selected text should now be encrypted.
How to reveal your encrypted text
-
Place your cursor anywhere on encrypted text.
-
Run the Encrypt/Decrypt command from the palette.
Note: If you choose 'Encrypt/Decrypt In-place' your text will be decrypted directly into the editor without showing the dialog in step 4 below (any syncing or backup software could then pick this up).
- Enter the correct password.
Note: Your previously used password is filled in by default (You can change this in the plugin settings).
- Your decrypted text is revealed in a dialog window.
Note: Click 'Decrypt In-place' to replace the encrypted text in the editor.
⚜️ Settings
| Common Settings | |
|---|---|
| ⚙️ Confirm password | Confirm password when encrypting |
| ⚙️ Remember password | Remember the last used password for this session. |
| ⚙️ Remember Password Timeout | The number of minutes to remember the last used password. |
| ⚙️ Remember Password Using | Remember passwords by using File or Parent path |
| Whole note encryption Settings | |
|---|---|
| ⚙️ Add ribbon icon to create note | Adds a ribbon icon to the left bar to create an encrypted note. |
| ⚙️ Default view for new tabs | The default view that a new encrypted note tab gets opened in |
| In-place encryption Settings | |
|---|---|
| ⚙️ Expand selection to whole line | Partial selections will get expanded to the whole line |
| ⚙️ By default, show encrypted marker when reading | When encrypting inline text, should the default be to have a visible marker in Reading view |
⚜️ Do you find this plugin useful?
Support further development of the plugin by...
Thank you for your support 😊
⚜️ Previous changes
v2.0.4
- fix password remembered even when 'remember password' setting is unchecked
v2.0.3
- add common password session cache
- also remember passwords for whole note encryption
- add password peek button
v2.0.2
Due to popular demand, the encrypt in-place functionality is no longer scheduled for removal 🙄🥳.
Changes
- Code refactors
- UI clean up
- Update usage docs
v2.0.1
Bug fixes
- fix large files can't be encrypted (#41)
- add 'Change Password' and 'Lock' actions to note tab context menu (#49)
v2.0.0
To make encrypted notes more resilient, starting from v2.0.0, the plugin introduces a new .encrypted note.
The advantages of this new approach are:
- Your note contents are always encrypted on disk.
- Encrypted bytes are hidden away from the user making it difficult to accidentally corrupt the encryption and thus making the note un-decryptable.
- Encrypted notes are easily identifiable by their '.encrypted' file extension.
- Better workflow for editing encrypted notes.
⚠️ It is recommended that you change all previously inline encrypted text into the new encrypted note format.