https://github.com/cipherswami/joplin-plugin-secure-notes
Joplin plugin to password protect and encrypt the notes.
https://github.com/cipherswami/joplin-plugin-secure-notes
encryption joplin-plugin password privacy secure-notes
Last synced: 24 days ago
JSON representation
Joplin plugin to password protect and encrypt the notes.
- Host: GitHub
- URL: https://github.com/cipherswami/joplin-plugin-secure-notes
- Owner: cipherswami
- License: mit
- Created: 2025-09-27T17:54:44.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-11-01T17:25:49.000Z (3 months ago)
- Last Synced: 2025-11-01T19:15:18.712Z (3 months ago)
- Topics: encryption, joplin-plugin, password, privacy, secure-notes
- Language: TypeScript
- Homepage: https://joplinapp.org/plugins/plugin/com.cipherswami.secure.notes
- Size: 2.12 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secure Notes
Secure Notes is a Joplin plugin that lets you password-protect and encrypt your notes locally. It ensures your sensitive information stays private — only you can unlock and read your data.
## Features
- 🔒 **Password-Protected** - Encrypt sensitive notes with a password of your choice
- 👁️ **Secure View** - Preview encrypted notes without decrypting them permanently
- 📁 **Local Storage** - Encrypted notes are stored locally in Joplin's database
- 🛡️ **Strong Encryption** - Uses industry-standard AES encryption with Webcrypto API.
- 🔄 **Multiple Modes** - Supports AES-CBC, AES-CTR, and AES-GCM modes with 128-bit or 256-bit key sizes.
## **Disclaimer**
**NO RECOVERY** – If you forget your password, your encrypted notes are permanently lost. There’s no way to recover or reset it. Please keep backups of anything important.
**NO WARRANTIES** – This plugin is provided "as is" without any guarantees. While it uses industry-standard AES encryption, no system is 100% secure. The author is not liable for data loss or security issues.
**_Use at your own risk. By using this plugin, you accept these terms._**
## Installation
### Plugin Market-Place (Recommended)
1. Open Joplin and navigate to `Tools > Options > Plugins`
2. Search for "Secure Notes"
3. Click Install and restart Joplin
### Manual Installation
1. Follow the instructions in [GENERATOR_DOC](GENERATOR_DOC.md) to generate the `.jpl` file.
2. Open Joplin → Tools → Options → Plugins → `Install from file`.
3. Select the generated `.jpl` file and install.
## Usage
### Encrypt Note
1. Select the note you want to encrypt.
2. Click the lock icon in the toolbar, or go to `Tools > Secure Notes > Encrypt Note`.
3. Enter a password when prompted.
4. The note will be encrypted and encryption tag is added.
### Decrypt Note
1. Select an encrypted note.
2. Click the unlock icon in the toolbar, or go to `Tools > Secure Notes > Decrypt Note`.
3. Enter the correct password.
4. The note will be permanently decrypted and the encryption tag removed.
### View Note
1. Select an encrypted note.
2. The plugin will automatically prompt for a password.
3. Enter your password to view the note in read-only mode.
4. The content is displayed temporarily without permanently decrypting the note.
## Settings
Access plugin settings via `Tools > Options > Secure Notes`
#### AES Key Size
- **128-bit** - Faster, suitable for most use cases
- **256-bit** - Maximum security (Recommended)
#### AES Cipher Mode
- **CBC** - Cipher Block Chaining mode
- **CTR** - Counter mode
- **GCM** - Galois/Counter Mode (Recommended)
> **Note:** Changing encryption settings only affects newly encrypted notes. Previously encrypted notes will use the settings that were active when they were encrypted.
## FAQ
**Q: Can I encrypt all my notes or notebook at once?**
A: Currently, the plugin encrypts notes individually. Batch encryption may be added in future versions.
**Q: Are resources in my notes encrypted?**
A: This plugin only encrypts your note contents. Resources like images, attachments are **not** encrypted because they’re just hyperlinks not the actual files themselves.
**Q: Are encrypted notes searchable?**
A: No, encrypted content cannot be searched until the note is decrypted.
**Q: What happens if I uninstall the plugin?**
A: Encrypted notes will remain encrypted. Reinstall the plugin to decrypt them.
## Contributing
Contributions are welcome! Feel free to open issues or pull requests on [GitHub](https://github.com/cipherswami/joplin-plugin-secure-notes).
## License
[MIT License © Aravind Potluri](./LICENSE)