From 469db9393f18dee986cd0635fc969c050288df36 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@osmocom.org>
Date: Wed, 1 Nov 2023 23:17:06 +0100
Subject: [PATCH] pySim-shell: Use argparser for verify_adm to support --help

Let's add a proper argparser instance for the 'verify_adm' command,
avoiding situations where the user types 'verif_adm --help' and then
--help is interpreted as the PIN value, removing one more attempt from
the failed ADM1 counter.

Let's use that opportunity to improve the documentation of the command.

Change-Id: I3321fae66a11efd00c53b66c7890fce84796e658
---
 docs/shell.rst |  7 ++++---
 pySim-shell.py | 16 ++++++++++++----
 2 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/docs/shell.rst b/docs/shell.rst
index f4374952..d8c09679 100644
--- a/docs/shell.rst
+++ b/docs/shell.rst
@@ -137,10 +137,11 @@ Example:
 
 verify_adm
 ~~~~~~~~~~
-Verify the ADM (Administrator) PIN specified as argument.  This is typically needed in order
-to get write/update permissions to most of the files on SIM cards.
 
-Currently only ADM1 is supported.
+.. argparse::
+   :module: pySim-shell
+   :func: PySimCommands.verify_adm_parser
+
 
 Example (successful):
 ::
diff --git a/pySim-shell.py b/pySim-shell.py
index c02555f8..7aaa2343 100755
--- a/pySim-shell.py
+++ b/pySim-shell.py
@@ -776,11 +776,19 @@ class PySimCommands(CommandSet):
         else:
             self._cmd.poutput("no description available")
 
-    def do_verify_adm(self, arg):
-        """VERIFY the ADM1 PIN"""
-        if arg:
+    verify_adm_parser = argparse.ArgumentParser()
+    verify_adm_parser.add_argument('ADM1', nargs='?', type=str,
+                                   help='ADM1 pin value. If none given, CSV file will be queried')
+
+    @cmd2.with_argparser(verify_adm_parser)
+    def do_verify_adm(self, opts):
+        """Verify the ADM (Administrator) PIN specified as argument.  This is typically needed in order
+to get write/update permissions to most of the files on SIM cards.
+
+Currently only ADM1 is supported."""
+        if opts.ADM1:
             # use specified ADM-PIN
-            pin_adm = sanitize_pin_adm(arg)
+            pin_adm = sanitize_pin_adm(opts.ADM1)
         else:
             # try to find an ADM-PIN if none is specified
             result = card_key_provider_get_field(