11 files changed, 325 insertions, 252 deletions
diff --git a/pskc/scripts/__init__.py b/pskc/scripts/__init__.py
new file mode 100644
index 0000000..0d4006e
--- /dev/null
+++ b/pskc/scripts/__init__.py
@@ -0,0 +1,21 @@
+# __init__.py - collection of command-line scripts
+# coding: utf-8
+#
+# Copyright (C) 2018 Arthur de Jong
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 USA
+
+"""Collection of command-line scripts."""
diff --git a/pskc/scripts/pskc2csv.py b/pskc/scripts/pskc2csv.py
new file mode 100644
index 0000000..f482d5b
--- /dev/null
+++ b/pskc/scripts/pskc2csv.py
@@ -0,0 +1,110 @@
+# pskc2csv.py - script to convert a PSKC file to CSV
+#
+# Copyright (C) 2014-2018 Arthur de Jong
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 USA
+
+"""Script to convert a PSKC file to CSV."""
+
+import argparse
+import base64
+import csv
+import getpass
+import operator
+import sys
+from binascii import b2a_hex
+
+import pskc
+from pskc.scripts.util import (
+    OutputFile, VersionAction, get_key, get_password)
+
+
+epilog = '''
+supported columns:
+  id, serial, secret, counter, time_offset, time_interval, interval,
+  time_drift, issuer, manufacturer, response_length, algorithm
+And any other properties of pskc.key.Key instances.
+
+Report bugs to <python-pskc-users@lists.arthurdejong.org>.
+'''.strip()
+
+# set up command line parser
+parser = argparse.ArgumentParser(
+    formatter_class=argparse.RawDescriptionHelpFormatter,
+    description='Convert a PSKC file to CSV.', epilog=epilog)
+parser.add_argument(
+    'input', metavar='FILE', help='the PSKC file to read')
+parser.add_argument(
+    '-V', '--version', action=VersionAction)
+parser.add_argument(
+    '-o', '--output', metavar='FILE',
+    help='write CSV to file instead of stdout')
+parser.add_argument(
+    '-c', '--columns', metavar='COL:LABEL,COL,..',
+    type=lambda x: [column.split(':', 1) for column in x.split(',')],
+    help='list of columns with optional labels to export',
+    default='serial,secret,algorithm,response_length,time_interval')
+parser.add_argument(
+    '-p', '--password', '--passwd', metavar='PASS/FILE',
+    help='password to use for decryption (or read from a file)')
+parser.add_argument(
+    '-s', '--secret', metavar='KEY/FILE',
+    help='hex encoded encryption key or file containing the binary key')
+encodings = {
+    'hex': b2a_hex,
+    'base32': base64.b32encode,
+    'base64': base64.b64encode,
+}
+parser.add_argument(
+    '-e', '--secret-encoding', choices=sorted(encodings.keys()),
+    help='encoding used for outputting key material',
+    default='hex')
+
+
+def get_column(key, column, encoding):
+    """Return a string value for the given column."""
+    value = operator.attrgetter(column)(key)
+    if column == 'secret':
+        # Python 3 compatible construct for outputting a string
+        return str(encodings[encoding](value).decode())
+    return value
+
+
+def main():
+    """Convert a PSKC file to CSV."""
+    # parse command-line arguments
+    args = parser.parse_args()
+    # open and parse input PSKC file
+    pskcfile = pskc.PSKC(args.input)
+    if args.secret:
+        pskcfile.encryption.key = get_key(args.secret)
+    elif args.password:
+        pskcfile.encryption.derive_key(get_password(args.password))
+    elif sys.stdin.isatty() and pskcfile.encryption.is_encrypted:
+        # prompt for a password
+        prompt = 'Password: '
+        if pskcfile.encryption.key_name:
+            prompt = '%s: ' % pskcfile.encryption.key_name
+        passwd = getpass.getpass(prompt)
+        pskcfile.encryption.derive_key(passwd)
+    # open output CSV file, write header and keys
+    with OutputFile(args.output) as output:
+        csvfile = csv.writer(output, quoting=csv.QUOTE_MINIMAL)
+        csvfile.writerow([column[-1] for column in args.columns])
+        for key in pskcfile.keys:
+            csvfile.writerow([
+                get_column(key, column[0], args.secret_encoding)
+                for column in args.columns])
diff --git a/pskc/scripts/pskc2pskc.py b/pskc/scripts/pskc2pskc.py
new file mode 100644
index 0000000..0a80a44
--- /dev/null
+++ b/pskc/scripts/pskc2pskc.py
@@ -0,0 +1,84 @@
+# pskc2pskc.py - script to convert a PSKC file to another PSKC file
+#
+# Copyright (C) 2018 Arthur de Jong
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 USA
+
+"""Script to convert a PSKC file to another PSKC file."""
+
+import argparse
+
+import pskc
+from pskc.scripts.util import (
+    OutputFile, VersionAction, get_key, get_password)
+
+
+epilog = '''
+supported columns:
+  id, serial, secret, counter, time_offset, time_interval, interval,
+  time_drift, issuer, manufacturer, response_length, algorithm
+And any other properties of pskc.key.Key instances.
+
+Report bugs to <python-pskc-users@lists.arthurdejong.org>.
+'''.strip()
+
+# set up command line parser
+parser = argparse.ArgumentParser(
+    formatter_class=argparse.RawDescriptionHelpFormatter,
+    description='Convert a PSKC file to another PSKC file.', epilog=epilog)
+parser.add_argument(
+    'input', metavar='FILE', help='the PSKC file to read')
+parser.add_argument(
+    '-V', '--version', action=VersionAction)
+parser.add_argument(
+    '-o', '--output', metavar='FILE',
+    help='write PSKC to file instead of stdout')
+parser.add_argument(
+    '-p', '--password', '--passwd', metavar='PASS/FILE',
+    help='password to use for decryption (or read from a file)')
+parser.add_argument(
+    '-s', '--secret', metavar='KEY/FILE',
+    help='hex encoded encryption key or a file containing the binary key')
+parser.add_argument(
+    '--new-password', '--new-passwd', metavar='PASS/FILE',
+    help='password to use for encryption (or read from a file)')
+parser.add_argument(
+    '--new-secret', metavar='KEY/FILE',
+    help='hex encoded encryption key or a file containing the binary key')
+
+
+def main():
+    """Convert a PSKC file to another PSKC file."""
+    # parse command-line arguments
+    args = parser.parse_args()
+    # open and parse input PSKC file
+    pskcfile = pskc.PSKC(args.input)
+    if args.secret:
+        pskcfile.encryption.key = get_key(args.secret)
+        pskcfile.encryption.remove_encryption()
+    elif args.password:
+        pskcfile.encryption.derive_key(get_password(args.password))
+        pskcfile.encryption.remove_encryption()
+    # encrypt the output file if needed
+    if args.new_secret:
+        assert not pskcfile.encryption.is_encrypted
+        pskcfile.encryption.setup_preshared_key(key=get_key(args.new_secret))
+    elif args.new_password:
+        assert not pskcfile.encryption.is_encrypted
+        pskcfile.encryption.setup_pbkdf2(get_password(args.new_password))
+    # write output PSKC file
+    with OutputFile(args.output) as output:
+        pskcfile.write(output)
diff --git a/pskc/scripts/util.py b/pskc/scripts/util.py
new file mode 100644
index 0000000..c3adf54
--- /dev/null
+++ b/pskc/scripts/util.py
@@ -0,0 +1,90 @@
+# util.py - utility functions for command-line scripts
+#
+# Copyright (C) 2014-2018 Arthur de Jong
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 USA
+
+"""Utility functions for command-line scripts."""
+
+import argparse
+import os.path
+import sys
+from binascii import a2b_hex
+
+import pskc
+
+
+version_string = '''
+%s (python-pskc) %s
+Written by Arthur de Jong.
+
+Copyright (C) 2014-2018 Arthur de Jong
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+'''.lstrip()
+
+
+class VersionAction(argparse.Action):
+    """Define --version argparse action."""
+
+    def __init__(self, option_strings, dest,
+                 help='output version information and exit'):
+        super(VersionAction, self).__init__(
+            option_strings=option_strings,
+            dest=argparse.SUPPRESS,
+            default=argparse.SUPPRESS,
+            nargs=0,
+            help=help)
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        """Output version information and exit."""
+        sys.stdout.write(version_string % (parser.prog, pskc.__version__))
+        parser.exit()
+
+
+def get_key(argument):
+    """Get the key from a file or a hex-encoded string."""
+    if os.path.isfile(argument):
+        with open(argument, 'rb') as keyfile:
+            return keyfile.read()
+    else:
+        return a2b_hex(argument)
+
+
+def get_password(argument):
+    """Get the password from a file or as a string."""
+    if os.path.isfile(argument):
+        with open(argument, 'r') as passfile:
+            return passfile.read().replace('\n', '')
+    else:
+        return argument
+
+
+class OutputFile(object):
+    """Wrapper around output file to also fall back to stdout."""
+
+    def __init__(self, output):
+        self.output = output
+
+    def __enter__(self):
+        self.file = open(self.output, 'w') if self.output else sys.stdout
+        return self.file
+
+    def __exit__(self, *args):
+        if self.output:
+            self.file.close()
+        else:  # we are using stdout
+            self.file.flush()
diff --git a/pskc2csv.py b/pskc2csv.py
index 57dee1c..33cae99 100755
--- a/pskc2csv.py
+++ b/pskc2csv.py
@@ -3,7 +3,7 @@
 
 # pskc2csv.py - script to convert a PSKC file to CSV
 #
-# Copyright (C) 2014-2017 Arthur de Jong
+# Copyright (C) 2014-2018 Arthur de Jong
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -20,134 +20,8 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301 USA
 
-from __future__ import print_function
-import argparse
-import base64
-import csv
-import getpass
-import operator
-import os.path
-import sys
-from binascii import a2b_hex, b2a_hex
-
-import pskc
-
-
-version_string = '''
-pskc2csv (python-pskc) %s
-Written by Arthur de Jong.
-
-Copyright (C) 2014-2017 Arthur de Jong
-This is free software; see the source for copying conditions.  There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-'''.strip() % pskc.__version__
-
-
-class VersionAction(argparse.Action):
-
-    def __init__(self, option_strings, dest,
-                 help='output version information and exit'):
-        super(VersionAction, self).__init__(
-            option_strings=option_strings,
-            dest=argparse.SUPPRESS,
-            default=argparse.SUPPRESS,
-            nargs=0,
-            help=help)
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        print(version_string)
-        parser.exit()
-
-
-epilog = '''
-supported columns:
-  id, serial, secret, counter, time_offset, time_interval, interval,
-  time_drift, issuer, manufacturer, response_length, algorithm
-And any other properties of pskc.key.Key instances.
-
-Report bugs to <python-pskc-users@lists.arthurdejong.org>.
-'''.strip()
-
-# set up command line parser
-parser = argparse.ArgumentParser(
-    formatter_class=argparse.RawDescriptionHelpFormatter,
-    description='Convert a PSKC file to CSV.', epilog=epilog)
-parser.add_argument(
-    'input', metavar='FILE', help='the PSKC file to read')
-parser.add_argument(
-    '-V', '--version', action=VersionAction)
-parser.add_argument(
-    '-o', '--output', metavar='FILE',
-    help='write CSV to file instead of stdout')
-parser.add_argument(
-    '-c', '--columns', metavar='COL:LABEL,COL,..',
-    type=lambda x: [column.split(':', 1) for column in x.split(',')],
-    help='list of columns with optional labels to export',
-    default='serial,secret,algorithm,response_length,time_interval')
-parser.add_argument(
-    '-p', '--password', '--passwd', metavar='PASS/FILE',
-    help='password to use for decryption (or read from a file)')
-parser.add_argument(
-    '-s', '--secret', metavar='KEY/FILE',
-    help='hex encoded encryption key or file containing the binary key')
-encodings = {
-    'hex': b2a_hex,
-    'base32': base64.b32encode,
-    'base64': base64.b64encode,
-}
-parser.add_argument(
-    '-e', '--secret-encoding', choices=sorted(encodings.keys()),
-    help='encoding used for outputting key material',
-    default='hex')
-
-
-def get_column(key, column, encoding):
-    """Return a string value for the given column."""
-    value = operator.attrgetter(column)(key)
-    if column == 'secret':
-        # Python 3 compatible construct for outputting a string
-        return str(encodings[encoding](value).decode())
-    return value
-
-
-def main():
-    # parse command-line arguments
-    args = parser.parse_args()
-    # open and parse input PSKC file
-    pskcfile = pskc.PSKC(args.input)
-    if args.secret:
-        if os.path.isfile(args.secret):
-            with open(args.secret, 'rb') as keyfile:
-                pskcfile.encryption.key = keyfile.read()
-        else:
-            pskcfile.encryption.key = a2b_hex(args.secret)
-    elif args.password:
-        if os.path.isfile(args.password):
-            with open(args.password, 'r') as passfile:
-                passwd = passfile.read().replace('\n', '')
-            pskcfile.encryption.derive_key(passwd)
-        else:
-            pskcfile.encryption.derive_key(args.password)
-    elif sys.stdin.isatty() and pskcfile.encryption.is_encrypted:
-        # prompt for a password
-        prompt = 'Password: '
-        if pskcfile.encryption.key_name:
-            prompt = '%s: ' % pskcfile.encryption.key_name
-        passwd = getpass.getpass(prompt)
-        pskcfile.encryption.derive_key(passwd)
-    # open output CSV file, write header and keys
-    output = open(args.output, 'w') if args.output else sys.stdout
-    csvfile = csv.writer(output, quoting=csv.QUOTE_MINIMAL)
-    csvfile.writerow([column[-1] for column in args.columns])
-    for key in pskcfile.keys:
-        csvfile.writerow([
-            get_column(key, column[0], args.secret_encoding)
-            for column in args.columns])
-    if args.output:
-        output.close()
-    else:
-        output.flush()
+from pskc.scripts import pskc2csv
 
 
 if __name__ == '__main__':  # pragma: no cover
-    main()
+    pskc2csv.main()
diff --git a/pskc2pskc.py b/pskc2pskc.py
index 282f4f9..d882a0c 100755
--- a/pskc2pskc.py
+++ b/pskc2pskc.py
@@ -20,121 +20,8 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301 USA
 
-from __future__ import print_function
-import argparse
-import getpass
-import operator
-import os.path
-import sys
-from binascii import a2b_hex, b2a_hex
-
-import pskc
-
-
-version_string = '''
-pskc2pskc (python-pskc) %s
-Written by Arthur de Jong.
-
-Copyright (C) 2018 Arthur de Jong
-This is free software; see the source for copying conditions.  There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-'''.strip() % pskc.__version__
-
-
-class VersionAction(argparse.Action):
-
-    def __init__(self, option_strings, dest,
-                 help='output version information and exit'):
-        super(VersionAction, self).__init__(
-            option_strings=option_strings,
-            dest=argparse.SUPPRESS,
-            default=argparse.SUPPRESS,
-            nargs=0,
-            help=help)
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        print(version_string)
-        parser.exit()
-
-
-epilog = '''
-supported columns:
-  id, serial, secret, counter, time_offset, time_interval, interval,
-  time_drift, issuer, manufacturer, response_length, algorithm
-And any other properties of pskc.key.Key instances.
-
-Report bugs to <python-pskc-users@lists.arthurdejong.org>.
-'''.strip()
-
-# set up command line parser
-parser = argparse.ArgumentParser(
-    formatter_class=argparse.RawDescriptionHelpFormatter,
-    description='Convert a PSKC file to another PSKC file.', epilog=epilog)
-parser.add_argument(
-    'input', metavar='FILE', help='the PSKC file to read')
-parser.add_argument(
-    '-V', '--version', action=VersionAction)
-parser.add_argument(
-    '-o', '--output', metavar='FILE',
-    help='write PSKC to file instead of stdout')
-parser.add_argument(
-    '-p', '--password', '--passwd', metavar='PASS/FILE',
-    help='password to use for decryption (or read from a file)')
-parser.add_argument(
-    '-s', '--secret', metavar='KEY/FILE',
-    help='hex encoded encryption key or a file containing the binary key')
-parser.add_argument(
-    '--new-password', '--new-passwd', metavar='PASS/FILE',
-    help='password to use for encryption (or read from a file)')
-parser.add_argument(
-    '--new-secret', metavar='KEY/FILE',
-    help='hex encoded encryption key or a file containing the binary key')
-
-
-def get_key(argument):
-    """Get the key from a file or a hex-encoded string."""
-    if os.path.isfile(argument):
-        with open(argument, 'rb') as keyfile:
-            return keyfile.read()
-    else:
-        return a2b_hex(argument)
-
-
-def get_password(argument):
-    """Get the password from a file or as a string."""
-    if os.path.isfile(argument):
-        with open(argument, 'r') as passfile:
-            return passfile.read().replace('\n', '')
-    else:
-        return argument
-
-
-def main():
-    # parse command-line arguments
-    args = parser.parse_args()
-    # open and parse input PSKC file
-    pskcfile = pskc.PSKC(args.input)
-    if args.secret:
-        pskcfile.encryption.key = get_key(args.secret)
-        pskcfile.encryption.remove_encryption()
-    elif args.password:
-        pskcfile.encryption.derive_key(get_password(args.password))
-        pskcfile.encryption.remove_encryption()
-    # encrypt the file if needed
-    if args.new_secret:
-        assert not pskcfile.encryption.is_encrypted
-        pskcfile.encryption.setup_preshared_key(key=get_key(args.new_secret))
-    elif args.new_password:
-        assert not pskcfile.encryption.is_encrypted
-        pskcfile.encryption.setup_pbkdf2(get_password(args.new_password))
-    # write output PSKC file
-    output = open(args.output, 'w') if args.output else sys.stdout
-    pskcfile.write(output)
-    if args.output:
-        output.close()
-    else:
-        output.flush()
+from pskc.scripts import pskc2pskc
 
 
 if __name__ == '__main__':  # pragma: no cover
-    main()
+    pskc2pskc.main()
diff --git a/setup.cfg b/setup.cfg
index d1d7b30..77d3c1f 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -14,7 +14,7 @@ doctest-extension=doctest
 doctest-options=+IGNORE_EXCEPTION_DETAIL
 with-coverage=true
 cover-branches=true
-cover-package=pskc,pskc2csv,pskc2pskc
+cover-package=pskc
 cover-inclusive=true
 cover-erase=true
 cover-html=true
@@ -29,5 +29,6 @@ builder = html man
 ignore =
   D105  # Missing docstring in magic method
   D107  # Missing docstring in __init__
+  Q001  # Use of ''' multiline strings
 max-complexity = 14
 max-line-length = 78
diff --git a/setup.py b/setup.py
index dfb71c7..261db78 100755
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@
 
 # setup.py - python-pskc installation script
 #
-# Copyright (C) 2014-2017 Arthur de Jong
+# Copyright (C) 2014-2018 Arthur de Jong
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -70,8 +70,14 @@ setup(
     packages=find_packages(),
     install_requires=['cryptography', 'python-dateutil'],
     extras_require={
-        'lxml':  ['lxml'],
-        'defuse':  ['defusedxml'],
-        'signature': ['signxml']
+        'lxml': ['lxml'],
+        'defuse': ['defusedxml'],
+        'signature': ['signxml'],
+    },
+    entry_points={
+        'console_scripts': [
+            'pskc2csv = pskc.scripts.pskc2csv:main',
+            'pskc2pskc = pskc.scripts.pskc2pskc:main',
+        ],
     },
 )
diff --git a/tests/test_pskc2csv.doctest b/tests/test_pskc2csv.doctest
index a97e297..8c049ad 100644
--- a/tests/test_pskc2csv.doctest
+++ b/tests/test_pskc2csv.doctest
@@ -25,7 +25,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 >>> import tempfile
 
 >>> from pskc import PSKC
->>> from pskc2csv import main
+>>> from pskc.scripts.pskc2csv import main
 
 
 Sadly we cannot test --help and --version properly because argparse calls
diff --git a/tests/test_pskc2pskc.doctest b/tests/test_pskc2pskc.doctest
index f404469..c1a91bb 100644
--- a/tests/test_pskc2pskc.doctest
+++ b/tests/test_pskc2pskc.doctest
@@ -24,7 +24,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 >>> import tempfile
 
 >>> from pskc import PSKC
->>> from pskc2pskc import main
+>>> from pskc.scripts.pskc2pskc import main
 
 
 Sadly we cannot test --help and --version properly because argparse calls
diff --git a/tox.ini b/tox.ini
index 7a3e049..a3e48eb 100644
--- a/tox.ini
+++ b/tox.ini
@@ -32,7 +32,7 @@ deps = flake8
        flake8-tidy-imports
        flake8-tuple
        pep8-naming
-commands = flake8 pskc *.py
+commands = flake8 pskc
 
 [testenv:docs]
 basepython = python