Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alicewriteswrongs/secrets
A small python app to keep encrypted notes!
https://github.com/alicewriteswrongs/secrets
Last synced: about 1 month ago
JSON representation
A small python app to keep encrypted notes!
- Host: GitHub
- URL: https://github.com/alicewriteswrongs/secrets
- Owner: alicewriteswrongs
- Created: 2015-07-27T15:37:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-02T22:21:27.000Z (over 5 years ago)
- Last Synced: 2024-11-07T19:57:14.759Z (3 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Secrets
```
_________ __
/ _____/ ____ ___________ _____/ |_ ______
\_____ \_/ __ \_/ ___\_ __ \_/ __ \ __\/ ___/
/ \ ___/\ \___| | \/\ ___/| | \___ \
/_______ /\___ >\___ >__| \___ >__| /____ >
\/ \/ \/ \/ \/
```
Secrets is a little Python wrapper around gpg to automate encrypted
notekeeping. You need to already have a gpg key (I wrote a [guide to
gpg](https://github.com/aliceriot/gpg_workshop/blob/master/gpg.markdown)
if you haven't got one) and you need to have your gpg configured to use
gpg-agent (allows the key to be unlocked and stay open for a bit).
## Installing
Just do this:
```
pip install secret-notes
```
and that should be it! If you're a Debian or Ubuntu user and you'd rather
use your system's package manager you can, after cloning the repo, do:
```
sudo apt-get install dh-virtualenv
sudo dpkg-buildpackage -us -uc
```
in the directory into which you cloned this repo, and you'll get a nice
tasty Debian package you can install! Great! As a reminder you can then
do:
```
sudo dpkg --install ../secrets_0.1_amd64.deb
```
and that's it!
## Verification
If you use [keybase](https://keybase.io) you can verify the signature on
the repo with:
```
keybase dir verify
```
## Keeping super secret notes!
To start off you should do
```
secrets init
```
to configure the program. Then to list your notes:
```
secrets list
```
to see your secrets (titles only).
To start a new note called foo:
```
secrets new foo
```
Secrets will open the notes in your `$EDITOR`. If you haven't set that
before it's probably Vim or nano?
To get rid of useless secrets (like foo) do:
```
secrets delete foo
```
To put the contents of foo on `stdout` try:
```
secrets echo foo
```
and finally, do:
```
secrets foo
```
to edit an existing note foo. Nice!
## Warnings and disclaimers and blah
I'm not a cryptographer or security expert. This program certainly has
some security flaws. Don't use it if you adversary is more technically
sophisticated than 'your roommate snooping through your recent documents'.
In particular I made several decisions which are not secure - the contents
of the notes live in files in `/tmp` in plaintext while you're editing
them. The whole notes database is also in memory when the program is
running. Oops!
Happy secreting!
### TODO