open.source/pass-append
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README.

Browse Source
This commit is contained in:
NunoSempere 2022-12-06 23:33:58 +00:00
parent fbff12a8f2
commit 0553ef84f2
1 changed files with 26 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@ -1,47 +1,27 @@
# pass-reveal # pass-append
An extension for [pass](https://www.passwordstore.org/) (the standard Unix password manager) to easily find elements of the password store.
An extension for [pass](https://www.passwordstore.org/) (the standard Unix password manager) to append a pass-style password and copy it to the clipboard before a `pass insert -m` call.
## Motivation ## Motivation
`pass show` requires that one type in the full path of the service, but I am too lazy to do that. `pass generate` is cool. `pass insert -m # <- multiline` is cool. ¿Por qué no los dos? (Why not both?) Well, the answer is that it would be annoying to do in the pass code, I think.
## Usage ## Usage
``` ```
Usage: Usage:
pass append [filename]
pass reveal [reveallocation] Generates a strong password, copies it to the clipboard, and runs pass insert -m [filename]
On the first run it creates a directory ".reveals" in \$PASSWORD_STORE_DIR. Based on the pass apppend extension, itself based on the pass backup extension.
By default this is ~/.password-store/.reveals". pass append help
It creates a reveal of the complete password store by creating a
compressed tar-file with extension .tar.bz2.
reveals themselves are excluded from the reveal.
Without argument the reveal file will receive the default name "passwordstore.DATE.TIME.tar.bz2"
where DATE and TIME are the current date and time.
If an argument is given and it is a directory, the reveal file will be placed
into the specified directory instead of the default ".reveals" directory.
If an argument is given and it is not a directory, it is used as a file
name and the reveal is stored with this filename with .at.gz2 appended.
pass reveal help
Prints this help message. Prints this help message.
pass reveal version pass append version
Prints the version number. Prints the version number.
Usage: Example: pass append services/amazon
pass reveal [search-terms] Generates a strong password, copies it to the clipboard,
Searches and displays passwords from \$PASSWORD_STORE_LOCATION. and starts pass insert -m services/amazon
A simple wrapper over pass show, find, and grep.
Based on the pass reveal extension.
$PROGRAM reveal help
Prints this help message.
$PROGRAM reveal version
Prints the version number.
Example: $PROGRAM reveal web
Searches for any files in $PASSWORD_STORE_LOCATION whose filenames contain
the keyword "web"
``` ```
@ -49,45 +29,38 @@ Example: $PROGRAM reveal web
Let's generate a password for this example Let's generate a password for this example
``` ```
pass generate test/test pass append web/digitalocean
Copied new password to clipboard:
Gm,G^98w8e3YZ)Op&pi4v+Q>I
Enter contents of test/test and press Ctrl+D when finished:
Gm,G^98w8e3YZ)Op&pi4v+Q>I
my.email@email-provider.com
[master 1dd0d0b] Add generated password for test/test. [master 1dd0d0b] Add generated password for test/test.
1 file changed, 0 insertions(+), 0 deletions(-)
rewrite test/test.gpg (100%)
The generated password for test/test is:
]$OJ&<J18JSk!(Y4u:~n\`E3B
```
Then we can search with:
```
> pass reveal test
Best match: test/test
]$OJ&<J18JSk!(Y4u:~n\`E3B
Copied test/test to clipboard. Will clear in 45 seconds.
``` ```
## Installation ## Installation
For installation download and place this bash script file ```reveal.bash``` into For installation download and place this bash script file ```apppend.bash``` into
the passwordstore extension directory specified with ```$PASSWORD_STORE_EXTENSIONS_DIR```. the passwordstore extension directory specified with ```$PASSWORD_STORE_EXTENSIONS_DIR```.
By default this is ```~/.password-store/.extensions```. By default this is ```~/.password-store/.extensions```.
``` ```
$ cp reveal.bash ~/.password-store/.extensions $ cp apppend.bash ~/.password-store/.extensions
``` ```
Give the file execution permissions: Give the file execution permissions:
``` ```
$ chmod 700 ~/.password-store/.extensions/reveal.bash $ chmod 700 ~/.password-store/.extensions/apppend.bash
``` ```
Set the variable ```PASSWORD_STORE_ENABLE_EXTENSIONS```, to true to enable extensions, e.g., in your `.bashrc` Set the variable ```PASSWORD_STORE_ENABLE_EXTENSIONS```, to true to enable extensions, e.g., in your `.bashrc`
``` ```
$ export PASSWORD_STORE_ENABLE_EXTENSIONS=true $ export PASSWORD_STORE_ENABLE_EXTENSIONS=true
``` ```
Download and source the bash completion file ```pass-reveal.bash.completion``` for bash completion. Download and source the bash completion file ```pass-apppend.bash.completion``` for bash completion.
``` ```
$ source ~/.password-store/.bash-completions/pass-reveal.bash.completion $ source ~/.password-store/.bash-completions/pass-apppend.bash.completion
``` ```
Type ```pass reveal keyword``` to make your first search. Type ```pass apppend filename/identifier``` to save your first password using this method, e.g.:
``` ```
$ pass reveal keyword $ pass apppend web/digitalocean
``` ```
## Requirements ## Requirements
@ -100,6 +73,6 @@ This work is released under the [GNU GENERAL PUBLIC LICENSE](https://www.gnu.org
## Notes ## Notes
Both files are tiny: 92 lines (script) and 17 lines (autocompletion) respectively. You can check them yourself quickly. No need to trust anyone. Both files are fairly small: 95 lines (script) and 17 lines (autocompletion) respectively. You can check them yourself quickly. No need to trust anyone.
This extension is heavily based on the [pass-backup](https://github.com/8go/pass-backup) extension (archived [here](https://git.loki.red/open.source/pass-backup)). Because `pass-backup` is open source, it was easy to take its architecture and use it for a different purpose. This extension is heavily based on the [pass-backup](https://github.com/8go/pass-backup) extension. Because `pass-backup` is open source, it was easy to take its architecture and use it for a different purpose.