Add click handling of cli options

Signed-off-by: Fabio Utzig <utzig@apache.org>

scripts/imgtool.py

@@ -14,15 +14,43 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import argparse
+import click
 import getpass
 from imgtool import keys
 from imgtool import image
-from imgtool import version
+from imgtool.version import decode_version
-import sys
 
-def get_password(args):
+
-    if args.password:
+def gen_rsa2048(keyfile, passwd):
+    keys.RSA2048.generate().export_private(path=keyfile, passwd=passwd)
+
+
+def gen_ecdsa_p256(keyfile, passwd):
+    keys.ECDSA256P1.generate().export_private(keyfile, passwd=passwd)
+
+
+def gen_ecdsa_p224(keyfile, passwd):
+    print("TODO: p-224 not yet implemented")
+
+
+valid_langs = ['c', 'rust']
+keygens = {
+    'rsa-2048':   gen_rsa2048,
+    'ecdsa-p256': gen_ecdsa_p256,
+    'ecdsa-p224': gen_ecdsa_p224,
+}
+
+
+def load_key(keyfile):
+    # TODO: better handling of invalid pass-phrase
+    key = keys.load(keyfile)
+    if key is not None:
+        return key
+    passwd = getpass.getpass("Enter key passphrase: ").encode('utf-8')
+    return keys.load(keyfile, passwd)
+
+
+def get_password():
     while True:
         passwd = getpass.getpass("Enter key passphrase: ")
         passwd2 = getpass.getpass("Reenter passphrase: ")
@@ -33,118 +61,113 @@ def get_password(args):
     # Password must be bytes, always use UTF-8 for consistent
     # encoding.
     return passwd.encode('utf-8')
-    else:
-        return None
 
-def gen_rsa2048(args):
-    passwd = get_password(args)
-    keys.RSA2048.generate().export_private(path=args.key, passwd=passwd)
 
-def gen_ecdsa_p256(args):
+@click.option('-p', '--password', is_flag=True,
-    passwd = get_password(args)
+              help='Prompt for password to protect key')
-    keys.ECDSA256P1.generate().export_private(args.key, passwd=passwd)
+@click.option('-t', '--type', metavar='type', required=True,
+              type=click.Choice(keygens.keys()))
+@click.option('-k', '--key', metavar='filename', required=True)
+@click.command(help='Generate pub/private keypair')
+def keygen(type, key, password):
+    password = get_password() if password else None
+    keygens[type](key, password)
 
-def gen_ecdsa_p224(args):
-    print("TODO: p-224 not yet implemented")
 
-keygens = {
+@click.option('-l', '--lang', metavar='lang', default=valid_langs[0],
-        'rsa-2048': gen_rsa2048,
+              type=click.Choice(valid_langs))
-        'ecdsa-p256': gen_ecdsa_p256,
+@click.option('-k', '--key', metavar='filename', required=True)
-        'ecdsa-p224': gen_ecdsa_p224, }
+@click.command(help='Get public key from keypair')
-
+def getpub(key, lang):
-def do_keygen(args):
+    key = load_key(key)
-    if args.type not in keygens:
+    if key is None:
-        msg = "Unexpected key type: {}".format(args.type)
+        print("Invalid passphrase")
-        raise argparse.ArgumentTypeError(msg)
+    elif lang == 'c':
-    keygens[args.type](args)
-
-def load_key(args):
-    key = keys.load(args.key)
-    if key is not None:
-        return key
-    passwd = getpass.getpass("Enter key passphrase: ")
-    passwd = passwd.encode('utf-8')
-    return keys.load(args.key, passwd)
-
-def do_getpub(args):
-    key = load_key(args)
-    if args.lang == 'c':
         key.emit_c()
-    elif args.lang == 'rust':
+    elif lang == 'rust':
         key.emit_rust()
     else:
-        msg = "Unsupported language, valid are: c, or rust"
+        raise ValueError("BUG: should never get here!")
-        raise argparse.ArgumentTypeError(msg)
 
-def do_sign(args):
+
-    img = image.Image.load(args.infile, version=args.version,
+def validate_version(ctx, param, value):
-            header_size=args.header_size,
+    try:
-            included_header=args.included_header,
+        decode_version(value)
-            pad=args.pad)
+        return value
-    key = load_key(args) if args.key else None
+    except ValueError as e:
+        raise click.BadParameter("{}".format(e))
+
+
+class BasedIntParamType(click.ParamType):
+    name = 'integer'
+
+    def convert(self, value, param, ctx):
+        try:
+            if value[:2].lower() == '0x':
+                return int(value[2:], 16)
+            elif value[:1] == '0':
+                return int(value, 8)
+            return int(value, 10)
+        except ValueError:
+            self.fail('%s is not a valid integer' % value, param, ctx)
+
+
+@click.argument('outfile')
+@click.argument('infile')
+@click.option('--pad', type=int,
+              help='Pad image to this many bytes, adding trailer magic')
+@click.option('--included-header', default=False, is_flag=True,
+              help='Image has gap for header')
+@click.option('-H', '--header-size', type=BasedIntParamType(), required=True)
+@click.option('-v', '--version', callback=validate_version,  required=True)
+@click.option('--align', type=click.Choice(['1', '2', '4', '8']),
+              required=True)
+@click.option('-k', '--key', metavar='filename')
+@click.command(help='Create a signed or unsigned image')
+def sign(key, align, version, header_size, included_header, pad, infile,
+         outfile):
+    img = image.Image.load(infile, version=decode_version(version),
+                           header_size=header_size,
+                           included_header=included_header, pad=pad)
+    key = load_key(key) if key else None
     img.sign(key)
 
-    if args.pad:
+    if pad is not None:
-        img.pad_to(args.pad, args.align)
+        img.pad_to(pad, align)
 
-    img.save(args.outfile)
+    img.save(outfile)
 
-subcmds = {
-    'keygen': do_keygen,
-    'getpub': do_getpub,
-    'sign': do_sign,
-    'create': do_sign,
-}
 
-def alignment_value(text):
+class AliasesGroup(click.Group):
-    value = int(text)
-    if value not in [1, 2, 4, 8]:
-        msg = "{} must be one of 1, 2, 4 or 8".format(value)
-        raise argparse.ArgumentTypeError(msg)
-    return value
 
-def intparse(text):
+    _aliases = {
-    """Parse a command line argument as an integer.
+        "create": "sign",
+    }
 
-    Accepts 0x and other prefixes to allow other bases to be used."""
+    def list_commands(self, ctx):
-    return int(text, 0)
+        cmds = [k for k in self.commands]
+        aliases = [k for k in self._aliases]
+        return sorted(cmds + aliases)
 
-def args():
+    def get_command(self, ctx, cmd_name):
-    parser = argparse.ArgumentParser()
+        rv = click.Group.get_command(self, ctx, cmd_name)
-    subs = parser.add_subparsers(help='subcommand help', dest='subcmd')
+        if rv is not None:
+            return rv
+        if cmd_name in self._aliases:
+            return click.Group.get_command(self, ctx, self._aliases[cmd_name])
+        return None
 
-    keygenp = subs.add_parser('keygen', help='Generate pub/private keypair')
-    keygenp.add_argument('-k', '--key', metavar='filename', required=True)
-    keygenp.add_argument('-t', '--type', metavar='type',
-            choices=keygens.keys(), required=True)
-    keygenp.add_argument('-p', '--password', default=False, action='store_true',
-            help='Prompt for password to protect key')
 
-    getpub = subs.add_parser('getpub', help='Get public key from keypair')
+@click.command(cls=AliasesGroup,
-    getpub.add_argument('-k', '--key', metavar='filename', required=True)
+               context_settings=dict(help_option_names=['-h', '--help']))
-    getpub.add_argument('-l', '--lang', metavar='lang', default='c')
+def imgtool():
+    pass
 
-    sign = subs.add_parser('sign',
-            help='Sign an image with a private key (or create an unsigned image)',
-            aliases=['create'])
-    sign.add_argument('-k', '--key', metavar='filename',
-            help='private key to sign, or no key for an unsigned image')
-    sign.add_argument("--align", type=alignment_value, required=True)
-    sign.add_argument("-v", "--version", type=version.decode_version, required=True)
-    sign.add_argument("-H", "--header-size", type=intparse, required=True)
-    sign.add_argument("--included-header", default=False, action='store_true',
-            help='Image has gap for header')
-    sign.add_argument("--pad", type=intparse,
-            help='Pad image to this many bytes, adding trailer magic')
-    sign.add_argument("infile")
-    sign.add_argument("outfile")
 
-    args = parser.parse_args()
+imgtool.add_command(keygen)
-    if args.subcmd is None:
+imgtool.add_command(getpub)
-        print('Must specify a subcommand', file=sys.stderr)
+imgtool.add_command(sign)
-        sys.exit(1)
 
-    subcmds[args.subcmd](args)
 
 if __name__ == '__main__':
-    args()
+    imgtool()

scripts/imgtool/version.py

@@ -15,20 +15,24 @@
 """
 Semi Semantic Versioning
 
-Implements a subset of semantic versioning that is supportable by the image header.
+Implements a subset of semantic versioning that is supportable by the image
+header.
 """
 
-import argparse
 from collections import namedtuple
 import re
 
-SemiSemVersion = namedtuple('SemiSemVersion', ['major', 'minor', 'revision', 'build'])
+SemiSemVersion = namedtuple('SemiSemVersion', ['major', 'minor', 'revision',
+                                               'build'])
+
+version_re = re.compile(
+    r"""^([1-9]\d*|0)(\.([1-9]\d*|0)(\.([1-9]\d*|0)(\+([1-9]\d*|0))?)?)?$""")
+
 
-version_re = re.compile(r"""^([1-9]\d*|0)(\.([1-9]\d*|0)(\.([1-9]\d*|0)(\+([1-9]\d*|0))?)?)?$""")
 def decode_version(text):
-    """Decode the version string, which should be of the form maj.min.rev+build"""
+    """Decode the version string, which should be of the form maj.min.rev+build
+    """
     m = version_re.match(text)
-    # print("decode:", text, m.groups())
     if m:
         result = SemiSemVersion(
                 int(m.group(1)) if m.group(1) else 0,
@@ -37,8 +41,10 @@ def decode_version(text):
                 int(m.group(7)) if m.group(7) else 0)
         return result
     else:
-        msg = "Invalid version number, should be maj.min.rev+build with later parts optional"
+        msg = "Invalid version number, should be maj.min.rev+build with later "
-        raise argparse.ArgumentTypeError(msg)
+        msg += "parts optional"
+        raise ValueError(msg)
+
 
 if __name__ == '__main__':
     print(decode_version("1.2"))

scripts/requirements.txt

@@ -1,2 +1,3 @@
 cryptography
 intelhex
+click