Add support for new API parameters

setup.py

@@ -10,7 +10,7 @@ setup(
     #long_description_content_type="text/markdown",
     install_requires=["requests>=2.20.0,<3.0", "PyYAML", "tabulate"],
     keywords=["step-ca-inspector"],
-    version="0.0.1",
+    version="0.0.3",
     classifiers=[
         "Intended Audience :: Developers",
         "Development Status :: 3 - Alpha",

step_ca_inspector_client/cli.py

@@ -9,6 +9,21 @@ from step_ca_inspector_client.config import config
 
 config()
 
+CERT_STATUS = ["Valid", "Expired", "Revoked"]
+PROVISIONER_TYPES = [
+    "ACME",
+    "AWS",
+    "GCP",
+    "JWK",
+    "Nebula",
+    "OIDC",
+    "SCEP",
+    "SSHPOP",
+    "X5C",
+    "K8sSA",
+]
+SSH_CERT_TYPES = ["Host", "User"]
+
 
 def delta_text(delta):
     s = "s"[: abs(delta.days) ^ 1]
@@ -36,11 +51,19 @@ def fetch_api(endpoint, params={}):
     return results.json()
 
 
-def list_ssh_certs(sort_key, revoked=False, expired=False):
+def list_ssh_certs(
+    sort_key,
+    cert_status=["Valid"],
+    cert_type=SSH_CERT_TYPES,
+    key=None,
+    principal=None,
+):
     params = {
         "sort_key": sort_key,
-        "revoked": revoked,
+        "cert_status": cert_status,
-        "expired": expired,
+        "cert_type": cert_type,
+        "key": key,
+        "principal": principal,
     }
     cert_list = fetch_api("ssh/certs", params=params)
 
@@ -140,11 +163,21 @@ def dump_ssh_cert(serial):
     print(cert["public_identity"])
 
 
-def list_x509_certs(sort_key, revoked=False, expired=False):
+def list_x509_certs(
+    sort_key,
+    cert_status=["Valid"],
+    provisioner_type=None,
+    provisioner_name=None,
+    subject=None,
+    san=None,
+):
     params = {
         "sort_key": sort_key,
-        "revoked": revoked,
+        "cert_status": cert_status,
-        "expired": expired,
+        "provisioner_type": provisioner_type,
+        "provisioner": provisioner_name,
+        "subject": subject,
+        "san": san,
     }
     cert_list = fetch_api(f"x509/certs", params=params)
     cert_tbl = []
@@ -276,18 +309,12 @@ def main():
     )
     x509_list_parser = x509_subparsers.add_parser("list", help="List x509 certificates")
     x509_list_parser.add_argument(
-        "--show-expired",
+        "--status",
-        "-e",
+        type=str,
-        action="store_true",
+        choices=CERT_STATUS,
-        default=False,
+        default=["Valid"],
-        help="Show expired certificates",
+        nargs="+",
-    )
+        help="Filter by x509 certificate status (default: Valid)",
-    x509_list_parser.add_argument(
-        "--show-revoked",
-        "-r",
-        action="store_true",
-        default=False,
-        help="Show revoked certificates",
     )
     x509_list_parser.add_argument(
         "--sort-by",
@@ -297,6 +324,34 @@ def main():
         default="not_after",
         help="Sort certificates",
     )
+    x509_list_parser.add_argument(
+        "--provisioner-type",
+        "-t",
+        type=str,
+        choices=PROVISIONER_TYPES,
+        default=None,
+        nargs="+",
+        help="Filter by provisioner type",
+    )
+    x509_list_parser.add_argument(
+        "--provisioner-name",
+        "-p",
+        type=str,
+        default=None,
+        help="Filter by provisioner name",
+    )
+    x509_list_parser.add_argument(
+        "--subject",
+        type=str,
+        default=None,
+        help="Search for subject",
+    )
+    x509_list_parser.add_argument(
+        "--san",
+        type=str,
+        default=None,
+        help="Search for Subject Alt Name",
+    )
     x509_details_parser = x509_subparsers.add_parser(
         "details", help="Show an x509 certificate details"
     )
@@ -337,18 +392,12 @@ def main():
     )
     ssh_list_parser = ssh_subparsers.add_parser("list", help="List ssh certificates")
     ssh_list_parser.add_argument(
-        "--show-expired",
+        "--status",
-        "-e",
+        type=str,
-        action="store_true",
+        choices=CERT_STATUS,
-        default=False,
+        default=["Valid"],
-        help="Show expired certificates",
+        nargs="+",
-    )
+        help="Filter by SSH certificate status (default: Valid)",
-    ssh_list_parser.add_argument(
-        "--show-revoked",
-        "-r",
-        action="store_true",
-        default=False,
-        help="Show revoked certificates",
     )
     ssh_list_parser.add_argument(
         "--sort-by",
@@ -358,6 +407,29 @@ def main():
         default="not_after",
         help="Sort certificates (default: not_after)",
     )
+    ssh_list_parser.add_argument(
+        "--type",
+        "-t",
+        type=str,
+        choices=SSH_CERT_TYPES,
+        default=SSH_CERT_TYPES,
+        nargs="+",
+        help="Filter by SSH certificate type",
+    )
+    ssh_list_parser.add_argument(
+        "--key-id",
+        "-k",
+        type=str,
+        default=None,
+        help="Search for key ID",
+    )
+    ssh_list_parser.add_argument(
+        "--principal",
+        "-p",
+        type=str,
+        default=None,
+        help="Search for principal",
+    )
     ssh_details_parser = ssh_subparsers.add_parser(
         "details", help="Show an ssh certificate details"
     )
@@ -373,9 +445,12 @@ def main():
     if args.object == "x509":
         if args.action == "list":
             list_x509_certs(
-                revoked=args.show_revoked,
+                cert_status=args.status,
-                expired=args.show_expired,
                 sort_key=args.sort_by,
+                provisioner_type=args.provisioner_type,
+                provisioner_name=args.provisioner_name,
+                subject=args.subject,
+                san=args.san,
             )
         elif args.action == "details":
             get_x509_cert(
@@ -388,9 +463,11 @@ def main():
     elif args.object == "ssh":
         if args.action == "list":
             list_ssh_certs(
-                revoked=args.show_revoked,
+                cert_status=args.status,
-                expired=args.show_expired,
                 sort_key=args.sort_by,
+                cert_type=args.type,
+                key=args.key_id,
+                principal=args.principal,
             )
         elif args.action == "details":
             get_ssh_cert(serial=args.serial)