= simplepass

* Project homepage: http://danielchoi.com/software/simplepass.html

== DESCRIPTION:

simplepass is a lightweight, secure password database with a simple command-line
interface.

== FEATURES/PROBLEMS:

* Uses the Blowfish encryption algorithm to securely store your passwords.
* Can export all your passwords into an unencrypted YAML format whenever you
need to.

== SYNOPSIS:

Usage: simplepass [options] [domain name]

Where domain name is typically a website domain, e.g. yahoo.com. The domain can
also be any other string, e.g. "Gmail account".

For example, you enter

simplepass gmail.com

If your domain name has spaces, remember to quote it like so:

simplepass 'Gmail account'

for the first time, simplepass will launch your text editor (whatever your
EDITOR environment variable has been set to) and present you with a simple form
that you can fill out to save a login, password, and arbitrary notes for that
domain:

gmail.com
login:
password:
notes:

You can leave any of the fields blank. So if you want, you can just fill out
the 'notes' portion for items that are not web logins, such as credit card
numbers and such.

Once you fill out the fields save the file and exit your editor, simplepass will
parse the information, encrypt it, store it in the database, and delete the
temporary file.

The next time you give the command,

simplepass gmail.com

simplepass will display something like this, via the 'less' command:

gmail.com
login: funnyface
password: audreyhepburn
notes: I love gmail! blah... blah...

(We pipe the output to 'less' so as to leave no trace of your password in your
console, where someone can find it by scrolling up.)

The first time you launch simplepass, it will ask you to set a master password.
This password will unlock the simplepass database. This database is stored in
a single file: a partly encrypted text file called simplepass.db. This file will be
saved in the directory in which you invoked the simplepass command. Always
invoke simplepass from the same directory as the simplepass.db datafile.

The top part of this file is a message in plain text and just serves to remind
you of the file's purpose. The bottom part is your password database, which is
nothing more than a YAML string encrypted with the Blowfish encryption
algorithm. Your master password is the the key that decrypts this portion of the
simplepass.db file. Do not edit this file directly; any edits may render the
data un-decryptable.


== REQUIREMENTS:

* crypt

== INSTALL:

* sudo gem install simplepass

== LICENSE:

(The MIT License)

Copyright (c) 2008 FIX

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.