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

feat: First commmit for the pass reveal extension, which reuses pass-backup code

Browse Source
This commit is contained in:
NunoSempere 2021-11-28 11:02:54 +00:00
parent c857634fd0
commit 17550da1fa
4 changed files with 151 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
README.md
View File

@ -1,10 +1,10 @@
# pass-backup
An extension for [pass](https://www.passwordstore.org/) (the standard Unix password manager) to easily create backups of the password store.
# pass-reveal
An extension for [pass](https://www.passwordstore.org/) (the standard Unix password manager) to easily find elements of the password store.
## Motivation
One should always do backups. So backups must be simple. Nothing more simple than typing ```pass backup```.
`pass show` requires that one type in the full path of the service, but I am too lazy to do that.
## Usage
@ -12,69 +12,82 @@ One should always do backups. So backups must be simple. Nothing more simple tha
```
Usage:
pass backup [backuplocation]
On the first run it creates a directory ".backups" in \$PASSWORD_STORE_DIR.
By default this is ~/.password-store/.backups".
It creates a backup of the complete password store by creating a
pass reveal [reveallocation]
On the first run it creates a directory ".reveals" in \$PASSWORD_STORE_DIR.
By default this is ~/.password-store/.reveals".
It creates a reveal of the complete password store by creating a
compressed tar-file with extension .tar.bz2.
Backups themselves are excluded from the backup.
Without argument the backup file will receive the default name "passwordstore.DATE.TIME.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 backup file will be placed
into the specified directory instead of the default ".backups" directory.
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 backup is stored with this filename with .at.gz2 appended.
pass backup help
name and the reveal is stored with this filename with .at.gz2 appended.
pass reveal help
Prints this help message.
pass backup version
pass reveal version
Prints the version number.
Usage:
pass reveal [search-terms]
Searches and displays passwords from \$PASSWORD_STORE_LOCATION.
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"
```
## Examples
## Example
Let's generate a password for this example
### Example 1: Using defaults, standard use
```
$ pass backup
pass generate 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
```
This is the typical usage. This creates a backup and places it into ```$PASSWORD_STORE_DIR/.backups```
e.g. ```~/.password-store/.backups/passwordstore.190407.122034.tar.gz2```.
### Example 2: Specifying a destination directory
Then we can search with:
```
$ pass backup Documents/Backups/
> pass reveal test
Best match: test/test
]$OJ&<J18JSk!(Y4u:~n\`E3B
Copied test/test to clipboard. Will clear in 45 seconds.
```
This creates a backup and places it into ```Documents/Backups/```
i.e. ```Documents/Backups/passwordstore.190407.122034.tar.gz2```.
### Example 3: Specifying a destination file
```
$ pass backup Documents/Backups/mypassbackup
```
This creates a backup and places it into ```Documents/Backups/mypassbackup.tar.gz2```.
## Installaiton
## Installation
For installation download and place this bash script file ```backup.bash``` into
For installation download and place this bash script file ```reveal.bash``` into
the passwordstore extension directory specified with ```$PASSWORD_STORE_EXTENSIONS_DIR```.
By default this is ```~/.password-store/.extensions```.
```
$ cp backup.bash ~/.password-store/.extensions
$ cp reveal.bash ~/.password-store/.extensions
```
Give the file execution permissions:
```
$ chmod 700 ~/.password-store/.extensions/backup.bash
$ chmod 700 ~/.password-store/.extensions/reveal.bash
```
Set the variable ```PASSWORD_STORE_ENABLE_EXTENSIONS``` to true to enable extensions.
Set the variable ```PASSWORD_STORE_ENABLE_EXTENSIONS```, to true to enable extensions, e.g., in your `.bashrc`
```
$ export PASSWORD_STORE_ENABLE_EXTENSIONS=true
```
Download and source the bash completion file ```pass-backup.bash.completion``` for bash completion.
Download and source the bash completion file ```pass-reveal.bash.completion``` for bash completion.
```
$ source ~/.password-store/.bash-completions/pass-backup.bash.completion
$ source ~/.password-store/.bash-completions/pass-reveal.bash.completion
```
Type ```pass backup``` to create your first backup.
Type ```pass reveal keyword``` to make your first search.
```
$ pass backup
$ pass reveal keyword
```
## Requirements
@ -82,7 +95,11 @@ $ pass backup
- `pass` from [https://www.passwordstore.org/](https://www.passwordstore.org/)
- `tar` to be installed for zipping and compression.
## License
This work is released under the [GNU GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/gpl-3.0.en.html).
## Notes
Both files are tiny: 142 lines (script) and 17 lines (autocompletion) respectively. You can check them yourself quickly. No need to trust anyone.
Both files are tiny: 92 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.

142
backup.bash
View File

@ -1,142 +0,0 @@
#!/usr/bin/env bash
# pass backup - Password Store Extension (https://www.passwordstore.org/)
# Copyright (C) 2019
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# []
VERSION="1.1.1"
PASSWORD_STORE_BACKUP_DEBUG=false # true or false, prints debugging messages
PASSWORD_STORE_BACKUP_DIR=".backups" # default backup directory is $PASSWORD_STORE_BACKUP_DIR; if it is a relative path it becomes $PASSWORD_STORE_DIR/$PASSWORD_STORE_BACKUP_DIR
PASSWORD_STORE_BACKUP_BASENAME="passwordstore" # to create backup filenames like passwordstore.190407.123423.tar.gz2
TAR=$(which tar)
cmd_backup_usage() {
cat <<-_EOF
Usage:
$PROGRAM backup [backuplocation]
On the first run it creates a directory ".backups" in \$PASSWORD_STORE_DIR.
By default this is ~/.password-store/.backups".
It creates a backup of the complete password store by creating a
compressed tar-file with extension .tar.bz2.
Backups themselves are excluded from the backup.
Without argument the backup 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 backup file will be placed
into the specified directory instead of the default ".backups" directory.
If an argument is given and it is not a directory, it is used as a file
name and the backup is stored with this filename with .at.gz2 appended.
$PROGRAM backup help
Prints this help message.
$PROGRAM backup version
Prints the version number.
Example: $PROGRAM backup
this is the typical usage
creates a backup and places it into \$PASSWORD_STORE_DIR/.backups
e.g. ~/.password-store/.backups/passwordstore.190407.122034.tar.gz2
Example: $PROGRAM backup Documents/Backups/
creates a backup and places it into Documents/Backups/
i.e. Documents/Backups/passwordstore.190407.122034.tar.gz2
Example: $PROGRAM backup Documents/Backups/mypassbackup
creates a backup and places it into
Documents/Backups/mypassbackup.tar.gz2
For installation place this bash script file "backup.bash" into
the passwordstore extension directory specified with \$PASSWORD_STORE_EXTENSIONS_DIR.
By default this is ~/.password-store/.extensions.
E.g. cp backup.bash ~/.password-store/.extensions
Give the file execution permissions:
E.g. chmod 700 ~/.password-store/.extensions/backup.bash
Set the variable PASSWORD_STORE_ENABLE_EXTENSIONS to true to enable extensions.
E.g. export PASSWORD_STORE_ENABLE_EXTENSIONS=true
Source the bash completion file "pass-backup.bash.completion" for bash completion.
E.g. source ~/.password-store/.bash-completions/pass-backup.bash.completion
Type "pass backup" to create your first backup.
E.g. pass backup
_EOF
exit 0
}
cmd_backup_version() {
echo $VERSION
exit 0
}
cmd_backup_createbackup() {
[[ $# -gt 1 ]] && die "Too many arguments. At most 1 argument allowed."
[[ -z "$TAR" ]] && die "Failed to generate backup: tar is not installed."
TODAYTIME=$(date "+%Y%m%d.%H%M%S") # e.g. 20190409.212327
# expect 0 or 1 argument
# ignore 2nd argument and higher
if [ $# -eq 0 ]; then
PASSWORD_STORE_BACKUP_PATH="$PASSWORD_STORE_BACKUP_DIR/${PASSWORD_STORE_BACKUP_BASENAME}.${TODAYTIME}.tar.bz2" # path includes filename
$PASSWORD_STORE_BACKUP_DEBUG && echo "No arguments supplied. That is okay."
$PASSWORD_STORE_BACKUP_DEBUG && echo "Setting backup directory to $PASSWORD_STORE_BACKUP_DIR"
$PASSWORD_STORE_BACKUP_DEBUG && echo "Setting backup file to $PASSWORD_STORE_BACKUP_PATH"
else
ARG1="$1"
case "$ARG1" in
/*)
$PASSWORD_STORE_BACKUP_DEBUG && echo "$ARG1 is an absolute path"
;;
*)
$PASSWORD_STORE_BACKUP_DEBUG && echo "$ARG1 is a relative path"
ARG1="$(pwd)/$ARG1"
$PASSWORD_STORE_BACKUP_DEBUG && echo "Now $ARG1 is an absolute path"
;;
esac
if [[ -d "$ARG1" ]]; then
$PASSWORD_STORE_BACKUP_DEBUG && echo "Argument $ARG1 is a directory"
PASSWORD_STORE_BACKUP_PATH="$ARG1/${PASSWORD_STORE_BACKUP_BASENAME}.${TODAYTIME}.tar.bz2" # path includes filename
else
$PASSWORD_STORE_BACKUP_DEBUG && echo "Argument $ARG1 treated as a filename"
PASSWORD_STORE_BACKUP_PATH="${ARG1}.tar.bz2"
fi
$PASSWORD_STORE_BACKUP_DEBUG && echo "Setting exclusion directory to $PASSWORD_STORE_BACKUP_DIR"
$PASSWORD_STORE_BACKUP_DEBUG && echo "Setting backup file to $PASSWORD_STORE_BACKUP_PATH"
fi
[[ -f "$PASSWORD_STORE_BACKUP_PATH" ]] && yesno "File $PASSWORD_STORE_BACKUP_PATH already exists. Overwrite it?"
if [ -z "$PASSWORD_STORE_DIR" ]; then # var is empty
PASSWORD_STORE_DIR="${HOME}/.password-store"
fi
$PASSWORD_STORE_BACKUP_DEBUG && echo "Password storage directory is $PASSWORD_STORE_DIR"
pushd "${PASSWORD_STORE_DIR}" >/dev/null || die "Could not cd into directory $PASSWORD_STORE_DIR. Aborting."
mkdir -p "${PASSWORD_STORE_BACKUP_DIR}" >/dev/null || die "Could not create directory $PASSWORD_STORE_BACKUP_DIR. Aborting."
tar --exclude="${PASSWORD_STORE_BACKUP_DIR}" -cjf "${PASSWORD_STORE_BACKUP_PATH}" . # add v for debugging if need be
chmod 400 "${PASSWORD_STORE_BACKUP_PATH}" >/dev/null || die "Could not change permissions to read-only on file $PASSWORD_STORE_BACKUP_PATH. Aborting."
BZ2SIZE=$(wc -c <"${PASSWORD_STORE_BACKUP_PATH}") # returns size in bytes
BZ2ENTRIES=$(tar -tf "${PASSWORD_STORE_BACKUP_PATH}" | wc -l)
echo "Created backup file \"${PASSWORD_STORE_BACKUP_PATH}\" of size ${BZ2SIZE} bytes with ${BZ2ENTRIES} entries."
popd >/dev/null || die "Could not change directory. Aborting."
}
case "$1" in
help | --help | -h)
shift
cmd_backup_usage "$@"
;;
version | --version | -v)
shift
cmd_backup_version "$@"
;;
*) cmd_backup_createbackup "$@" ;;
esac
exit 0

6
pass-backup.bash.completion → pass-reveal.bash.completion
View File

@ -1,6 +1,6 @@
PASSWORD_STORE_EXTENSION_COMMANDS+=(backup)
PASSWORD_STORE_EXTENSION_COMMANDS+=(reveal)
__password_store_extension_complete_backup() {
__password_store_extension_complete_reveal() {
if [[ $COMP_CWORD -gt 2 ]]; then
case "${COMP_WORDS[2]}" in
help|--help|-h)
@ -14,4 +14,4 @@ __password_store_extension_complete_backup() {
COMPREPLY+=($(compgen -W "help version -h --help -v --version" -- ${cur}))
_pass_complete_entries 1
fi
}
}

92
reveal.bash Normal file
View File

@ -0,0 +1,92 @@
#!/usr/bin/env bash
# pass reveal - Password Store Extension (https://www.passwordstore.org/)
# Copyright (C) 2021
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# []
VERSION="0.0.1"
PASSWORD_STORE_LOCATION="~/password-store"
cmd_reveal_usage() {
cat <<-_EOF
Usage:
$PROGRAM reveal [search-terms]
Searches and displays passwords from \$PASSWORD_STORE_LOCATION.
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"
For installation place this bash script file "reveal.bash" into
the passwordstore extension directory specified with \$PASSWORD_STORE_EXTENSIONS_DIR.
By default this is ~/.password-store/.extensions.
E.g. cp reveal.bash ~/.password-store/.extensions
Give the file execution permissions:
E.g. chmod 700 ~/.password-store/.extensions/reveal.bash
Set the variable PASSWORD_STORE_ENABLE_EXTENSIONS to true to enable extensions.
E.g. export PASSWORD_STORE_ENABLE_EXTENSIONS=true
Source the bash completion file "pass-reveal.bash.completion" for bash completion.
E.g. source ~/.password-store/.bash-completions/pass-reveal.bash.completion
Type "pass reveal query" to make your first query
E.g. pass reveal query
_EOF
exit 0
}
cmd_reveal_version() {
echo $VERSION
exit 0
}
cmd_reveal_reveal() {
## [[ $# -gt 1 ]] && die "Too many arguments. At most 1 argument allowed."
# expect 0 or 1 argument
# ignore 2nd argument and higher
if [ $# -eq 0 ]; then
echo "Error: Query is empty"
else
ARGS="$@"
BEST_FIT="$(find ~/.password-store -type f -printf "%P\n" | grep -v '^\.' | grep -i "$ARGS" | sed 's/.gpg//' | head -1)"
if [ -z "$BEST_FIT" ]; then
# $STRING is empty
echo "No match found for $ARGS"
else
echo "Best match: $BEST_FIT"
pass show "$BEST_FIT"
pass show -c "$BEST_FIT"
fi
fi
}
case "$1" in
help | --help | -h)
shift
cmd_reveal_usage "$@"
;;
version | --version | -v)
shift
cmd_reveal_version "$@"
;;
*) cmd_reveal_reveal "$@" ;;
esac
exit 0