pwsafe, catacomb/pwsafe.py: Documentation and cleanup.
[catacomb-python] / pwsafe
diff --git a/pwsafe b/pwsafe
old mode 100755 (executable)
new mode 100644 (file)
index 52f9abb..a5d15ea
--- a/pwsafe
+++ b/pwsafe
@@ -1,8 +1,32 @@
 #! /usr/bin/python
-# -*-python-*-
+### -*-python-*-
+###
+### Tool for maintaining a secure-ish password database
+###
+### (c) 2005 Straylight/Edgeware
+###
+
+###----- Licensing notice ---------------------------------------------------
+###
+### This file is part of the Python interface to Catacomb.
+###
+### Catacomb/Python 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 2 of the License, or
+### (at your option) any later version.
+###
+### Catacomb/Python 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 Catacomb/Python; if not, write to the Free Software Foundation,
+### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+###---------------------------------------------------------------------------
+### Imported modules.
 
-import catacomb as C
-from catacomb.pwsafe import *
 import gdbm as G
 from os import environ
 from sys import argv, exit, stdin, stdout, stderr
@@ -10,22 +34,57 @@ from getopt import getopt, GetoptError
 from fnmatch import fnmatch
 import re
 
+import catacomb as C
+from catacomb.pwsafe import *
+
+###--------------------------------------------------------------------------
+### Utilities.
+
+## The program name.
 prog = re.sub(r'^.*[/\\]', '', argv[0])
+
 def moan(msg):
+  """Issue a warning message MSG."""
   print >>stderr, '%s: %s' % (prog, msg)
+
 def die(msg):
+  """Report MSG as a fatal error, and exit."""
   moan(msg)
   exit(1)
 
-if 'PWSAFE' in environ:
-  file = environ['PWSAFE']
-else:
-  file = '%s/.pwsafe' % environ['HOME']
+def chomp(pp):
+  """Return the string PP, without its trailing newline if it has one."""
+  if len(pp) > 0 and pp[-1] == '\n':
+    pp = pp[:-1]
+  return pp
+
+def asciip(s):
+  """Answer whether all of the characters of S are plain ASCII."""
+  for ch in s:
+    if ch < ' ' or ch > '~': return False
+  return True
+
+def present(s):
+  """
+  Return a presentation form of the string S.
+
+  If S is plain ASCII, then return S unchanged; otherwise return it as one of
+  Catacomb's ByteString objects.
+  """
+  if asciip(s): return s
+  return C.ByteString(s)
+
+###--------------------------------------------------------------------------
+### Subcommand implementations.
 
 def cmd_create(av):
+
+  ## Default crypto-primitive selections.
   cipher = 'blowfish-cbc'
   hash = 'rmd160'
   mac = None
+
+  ## Parse the options.
   try:
     opts, args = getopt(av, 'c:h:m:', ['cipher=', 'mac=', 'hash='])
   except GetoptError:
@@ -45,7 +104,8 @@ def cmd_create(av):
     tag = args[0]
   else:
     tag = 'pwsafe'
-  db = G.open(file, 'n', 0600)
+
+  ## Choose a passphrase, and generate master keys.
   pp = C.ppread(tag, C.PMODE_VERIFY)
   if not mac: mac = hash + '-hmac'
   c = C.gcciphers[cipher]
@@ -55,6 +115,9 @@ def cmd_create(av):
   ck = C.rand.block(c.keysz.default)
   mk = C.rand.block(m.keysz.default)
   k = Crypto(c, h, m, ck, mk)
+
+  ## Set up the database, storing the basic information we need.
+  db = G.open(file, 'n', 0600)
   db['tag'] = tag
   db['salt'] = ppk.salt
   db['cipher'] = cipher
@@ -63,11 +126,6 @@ def cmd_create(av):
   db['key'] = ppk.encrypt(wrapstr(ck) + wrapstr(mk))
   db['magic'] = k.encrypt(C.rand.block(h.hashsz))
 
-def chomp(pp):
-  if len(pp) > 0 and pp[-1] == '\n':
-    pp = pp[:-1]
-  return pp
-
 def cmd_changepp(av):
   if len(av) != 0:
     return 1
@@ -150,13 +208,6 @@ def cmd_del(av):
   except KeyError, exc:
     die('Password `%s\' not found.' % exc.args[0])
 
-def asciip(s):
-  for ch in s:
-    if ch < ' ' or ch > '~': return False
-  return True
-def present(s):
-  if asciip(s): return s
-  return C.ByteString(s)
 def cmd_dump(av):
   db = gdbm.open(file, 'r')
   k = db.firstkey()
@@ -166,20 +217,25 @@ def cmd_dump(av):
     k = db.nextkey(k)
 
 commands = { 'create': [cmd_create,
-                       '[-c CIPHER] [-h HASH] [-m MAC] [PP-TAG]'],
-            'find' : [cmd_find, 'LABEL'],
-            'store' : [cmd_store, 'LABEL [VALUE]'],
-            'list' : [cmd_list, '[GLOB-PATTERN]'],
-            'changepp' : [cmd_changepp, ''],
-            'copy' : [cmd_copy, 'DEST-FILE [GLOB-PATTERN]'],
-            'to-pixie' : [cmd_topixie, '[TAG [PIXIE-TAG]]'],
-            'delete' : [cmd_del, 'TAG'],
-            'dump' : [cmd_dump, '']}
+                        '[-c CIPHER] [-h HASH] [-m MAC] [PP-TAG]'],
+             'find' : [cmd_find, 'LABEL'],
+             'store' : [cmd_store, 'LABEL [VALUE]'],
+             'list' : [cmd_list, '[GLOB-PATTERN]'],
+             'changepp' : [cmd_changepp, ''],
+             'copy' : [cmd_copy, 'DEST-FILE [GLOB-PATTERN]'],
+             'to-pixie' : [cmd_topixie, '[TAG [PIXIE-TAG]]'],
+             'delete' : [cmd_del, 'TAG'],
+             'dump' : [cmd_dump, '']}
+
+###--------------------------------------------------------------------------
+### Command-line handling and dispatch.
 
 def version():
   print '%s 1.0.0' % prog
+
 def usage(fp):
   print >>fp, 'Usage: %s COMMAND [ARGS...]' % prog
+
 def help():
   version()
   print
@@ -200,10 +256,16 @@ Commands provided:
   for c in commands:
     print '%s %s' % (c, commands[c][1])
 
+## Choose a default database file.
+if 'PWSAFE' in environ:
+  file = environ['PWSAFE']
+else:
+  file = '%s/.pwsafe' % environ['HOME']
+
+## Parse the command-line options.
 try:
-  opts, argv = getopt(argv[1:],
-                     'hvuf:',
-                     ['help', 'version', 'usage', 'file='])
+  opts, argv = getopt(argv[1:], 'hvuf:',
+                      ['help', 'version', 'usage', 'file='])
 except GetoptError:
   usage(stderr)
   exit(1)
@@ -225,6 +287,7 @@ if len(argv) < 1:
   usage(stderr)
   exit(1)
 
+## Dispatch to a command handler.
 if argv[0] in commands:
   c = argv[0]
   argv = argv[1:]
@@ -233,3 +296,5 @@ else:
 if commands[c][0](argv):
   print >>stderr, 'Usage: %s %s %s' % (prog, c, commands[c][1])
   exit(1)
+
+###----- That's all, folks --------------------------------------------------