diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 81 |
1 files changed, 49 insertions, 32 deletions
@@ -1,10 +1,11 @@ # rofi-pass -#### bash script to handle pass storages in a convenient way +A bash script to handle [Simple Password Store](http://www.passwordstore.org/) +in a convenient way using [rofi](https://github.com/DaveDavenport/rofi).  -## Features: +## Features * Open URLs of entries with hotkey * Add new Entries to Password Storage @@ -12,34 +13,41 @@ * Generate new passwords for entries * Inline view, which can copy/type individual entries * Move/Delete existing entries -* Support for multiple roots for password-store (e.g. separate work from private passwords) +* Support for different password stores (roots), e.g. to separate passwords for + work from private passwords * Type any field from entry -* Auto Type User and Password. Format of password files are expected to be like: -* Bookmarks mode (default: Alt+x) -* Share common used passwords between several entries (with different URLS,usernames etc) -``` -foobarmysecurepassword -user: MyUser -url: http://my.url.foo -``` -* Auto Typing of more than one field. This expects a autotype field in password file. -``` -foobarmysecurepassword ---- -user: MyUser -SomeField: foobar -AnotherField: barfoo -url: http://my.url.foo -autotype: SomeField :tab UserName :tab AnotherField :tab pass -``` -The `:tab` field has a special meaning. this will hit the tab key, obviously.<br> -Same for `:space`, which will hit the space key, can be used to activate checkboxes. -In addition to those `:enter` and `:delay` are available. - -* All Hotkeys are configurable in config file -* user, url and autotype field names are also configurable +* Auto-typing of user and/or password fields. + The format for password files should look like: + + ``` + foobarmysecurepassword + user: MyUser + url: http://my.url.foo + ``` + +* Auto-typing of more than one field, using the `autotype` entry: + + ``` + foobarmysecurepassword + --- + user: MyUser + SomeField: foobar + AnotherField: barfoo + url: http://my.url.foo + autotype: SomeField :tab UserName :tab AnotherField :tab pass + ``` + + You can use `:tab`, `:enter`, or `:space` here to type <kbd>Tab</kbd>, + <kbd>Enter</kbd>, or <kbd>Space</kbd> (useful for toggling checkboxes) + respectively. + `:delay` will trigger a delay (2 seconds by default). +* All hotkeys are configurable in the config file +* The field names for `user`, `url` and `autotype` are configurable +* Bookmarks mode (open stored URLs in browser, default: Alt+x) +* Share common used passwords between several entries (with different URLs, usernames etc) ## Requirements + * pass (http://www.passwordstore.org/) * sed * rofi (https://github.com/DaveDavenport/rofi) @@ -49,14 +57,17 @@ In addition to those `:enter` and `:delay` are available. * pwgen ### BSD + * gnugrep * gawk ## Configuration + rofi-pass may read its configuration values from `/etc/rofi-pass` and/or `$HOME/.config/rofi-pass/config`. For an example configuration please take a look at the included `config.example` file. ## Extras + rofi-pass comes with a tiny helper script, which makes it easier to create new pass entries. Just run it with @@ -73,7 +84,7 @@ Also included is an import script for keepass2 databases. It's the same script t ## Sharing passwords -Rofi-pass allows you to easily share common used passwords across multiple entries. +Rofi-pass allows you to easily share common used passwords across multiple entries. For example, if you have an academic account which includes several services (such as a library, Salary, Student portal etc), all with different URL's, login forms etc. you can share one password across all of them. This is very handy when the passwords change annually. To use this function you need to add the following line instead of the password, referencing a pass file which holds the password. @@ -86,10 +97,16 @@ where PATH is relative to your password-store. ## FAQ -* rofi pass prints garbage instead of my actual passes <br>Make sure to run `setxkbmap <language> <variant>` at the start of your Xorg session. +### rofi pass prints garbage instead of my actual passes + +Make sure to run `setxkbmap <language> <variant>` at the start of your Xorg +session. ## Alternative -jreinert has written the roughly compatible tool [autopass](https://github.com/jreinert/autopass). It has less features, but definately saner code. -Also he provided a nice little script called `passed` to change your fieldnames. [link](https://github.com/jreinert/passed) -And finally it ships with a script "pass2csv.py", which can export your pass store to csv format. +jreinert has written the roughly compatible tool +[autopass](https://github.com/jreinert/autopass). It has less features, but +definately saner code. +Also he provided a nice little script called `passed` to change your +fieldnames. [link](https://github.com/jreinert/passed) +It includes a script "pass2csv.py" to export your password store as CSV. |