qualys-cli 0.1.1__py3-none-any.whl

qualys_cli/commands/cs.py

@@ -0,0 +1,410 @@
+# Auto-generated from api-model.json — run scripts/generate_commands.py to regenerate.
+# Container Security APIs  (JWT Bearer auth, JSON responses)
+from __future__ import annotations
+
+import typer
+
+from .. import client as _c
+from ..formatters import DEFAULT_LIMIT, output, output_success
+
+app = typer.Typer(name="cs", help="Container Security APIs — images, containers, registries, sensors, reports")
+
+# ── image ─────────────────────────────────────────────────────────────────────
+_image = typer.Typer(help="Container image operations")
+app.add_typer(_image, name="image")
+
+
+@_image.command("list")
+def image_list(
+    ctx: typer.Context,
+    filter: str | None = typer.Option(None, "--filter", help="Qualys QQL filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    sort: str | None = typer.Option(None, "--server-sort", help="Server-side sort, e.g. created:desc. Use --sort/--sort-by for client-side post-processing."),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List images in the account (max 10,000).
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_a_list_of_images_in_your_account.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    if sort:
+        params["sort"] = sort
+    data = client.get_json("/csapi/v1.3/images", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_image.command("get")
+def image_get(
+    ctx: typer.Context,
+    image_sha: str = typer.Argument(..., help="Image SHA value"),
+    scan_details: str | None = typer.Option(None, "--scan-details", help="malware,secrets,compliance"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get details of a specific image.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_image_details.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {}
+    if scan_details:
+        params["scanDetails"] = scan_details
+    data = client.get_json(f"/csapi/v1.3/images/{image_sha}", params)
+    output(data, format=format)
+
+
+@_image.command("vulns")
+def image_vulns(
+    ctx: typer.Context,
+    image_sha: str = typer.Argument(..., help="Image SHA value"),
+    filter: str | None = typer.Option(None, "--filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get vulnerability details for an image.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_vulnerability_details_for_an_image.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    data = client.get_json(f"/csapi/v1.3/images/{image_sha}/vuln", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_image.command("software")
+def image_software(
+    ctx: typer.Context,
+    image_sha: str = typer.Argument(..., help="Image SHA value"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List software installed on an image.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_a_list_of_software_installed_on_an_image.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    data = client.get_json(f"/csapi/v1.3/images/{image_sha}/software", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_image.command("delete")
+def image_delete(
+    ctx: typer.Context,
+    filter: str = typer.Option(..., "--filter", help="QQL filter to select images to delete"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete images matching a filter.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/delete_images_in_your_account.htm
+    """
+    if not yes:
+        typer.confirm("Delete images matching filter?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    client.post_json("/csapi/v1.3/images/delete", {"filter": filter})
+    output_success(f"Deleted images matching filter '{filter}'.")
+
+
+# ── container ─────────────────────────────────────────────────────────────────
+_container = typer.Typer(help="Container operations")
+app.add_typer(_container, name="container")
+
+
+@_container.command("list")
+def container_list(
+    ctx: typer.Context,
+    filter: str | None = typer.Option(None, "--filter", help="Qualys QQL filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    sort: str | None = typer.Option(None, "--server-sort", help="Server-side sort (passed to API). Use --sort/--sort-by for client-side."),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List containers in the account.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_a_list_of_containers_in_your_account.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    if sort:
+        params["sort"] = sort
+    data = client.get_json("/csapi/v1.3/containers", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_container.command("get")
+def container_get(
+    ctx: typer.Context,
+    container_sha: str = typer.Argument(..., help="Container SHA"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get details of a specific container.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_container_details.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/csapi/v1.3/containers/{container_sha}")
+    output(data, format=format)
+
+
+@_container.command("vulns")
+def container_vulns(
+    ctx: typer.Context,
+    container_sha: str = typer.Argument(..., help="Container SHA"),
+    filter: str | None = typer.Option(None, "--filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get vulnerability details for a container.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_vulnerability_details_for_a_container.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    data = client.get_json(f"/csapi/v1.3/containers/{container_sha}/vuln", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_container.command("software")
+def container_software(
+    ctx: typer.Context,
+    container_sha: str = typer.Argument(..., help="Container SHA"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List software installed on a container.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_a_list_of_software_installed_on_a_container.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    data = client.get_json(f"/csapi/v1.3/containers/{container_sha}/software", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+# ── registry ──────────────────────────────────────────────────────────────────
+_registry = typer.Typer(help="Registry operations")
+app.add_typer(_registry, name="registry")
+
+
+@_registry.command("list")
+def registry_list(
+    ctx: typer.Context,
+    filter: str | None = typer.Option(None, "--filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List registries.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/fetch_a_list_of_registries_in_your_account.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    data = client.get_json("/csapi/v1.3/registry", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_registry.command("get")
+def registry_get(
+    ctx: typer.Context,
+    registry_uuid: str = typer.Argument(..., help="Registry UUID"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get registry details.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/fetch_registry_details.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/csapi/v1.3/registry/{registry_uuid}")
+    output(data, format=format)
+
+
+@_registry.command("delete")
+def registry_delete(
+    ctx: typer.Context,
+    registry_uuids: str = typer.Argument(..., help="Comma-separated registry UUIDs"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete one or more registries.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/delete_registries_in_your_account.htm
+    """
+    if not yes:
+        typer.confirm("Delete registry/registries?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    uuids = [u.strip() for u in registry_uuids.split(",")]
+    client.post_json("/csapi/v1.3/registry/delete", {"registryUuids": uuids})
+    output_success(f"Deleted {len(uuids)} registry/registries.")
+
+
+# ── sensor ────────────────────────────────────────────────────────────────────
+_sensor = typer.Typer(help="Sensor operations")
+app.add_typer(_sensor, name="sensor")
+
+
+@_sensor.command("list")
+def sensor_list(
+    ctx: typer.Context,
+    filter: str | None = typer.Option(None, "--filter"),
+    page_number: int = typer.Option(1, "--page-number"),
+    page_size: int = typer.Option(50, "--page-size"),
+    sort: str | None = typer.Option(None, "--server-sort", help="Server-side sort (passed to API). Use --sort/--sort-by for client-side."),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List sensors.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/sensors/fetch_a_list_of_sensors_in_your_account.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {"pageNumber": page_number, "pageSize": page_size}
+    if filter:
+        params["filter"] = filter
+    if sort:
+        params["sort"] = sort
+    data = client.get_json("/csapi/v1.3/sensors", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_sensor.command("get")
+def sensor_get(
+    ctx: typer.Context,
+    sensor_uuid: str = typer.Argument(..., help="Sensor UUID"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get sensor details.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/sensors/fetch_sensor_details.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/csapi/v1.3/sensors/{sensor_uuid}")
+    output(data, format=format)
+
+
+# ── report ────────────────────────────────────────────────────────────────────
+_report = typer.Typer(help="Vulnerability report operations")
+app.add_typer(_report, name="report")
+
+
+@_report.command("list")
+def report_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List vulnerability reports.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/fetch_a_list_of_reports.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json("/csapi/v1.3/reports")
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_report.command("create")
+def report_create(
+    ctx: typer.Context,
+    name: str = typer.Option(..., "--name", help="Report title (max 150 chars)"),
+    template_name: str = typer.Option(..., "--template",
+                                      help="CS_IMAGE_VULNERABILITY|CS_CONTAINER_VULNERABILITY|CS_IMAGE_SECRETS|CS_IMAGE_MALWARE"),
+    expire_after: str = typer.Option(..., "--expire-after", help="Days until expiry: 1|7|30|90"),
+    filter: str | None = typer.Option(None, "--filter", help="QQL filter"),
+    description: str | None = typer.Option(None, "--description"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Create a new vulnerability report request.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/create_a_report_request.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    body: dict = {"name": name, "templateName": template_name, "expireAfter": expire_after}
+    if filter:
+        body["filter"] = filter
+    if description:
+        body["description"] = description
+    data = client.post_json("/csapi/v1.3/reports", body)
+    output(data, format=format)
+
+
+@_report.command("download")
+def report_download(
+    ctx: typer.Context,
+    report_uuid: str = typer.Argument(..., help="Report UUID"),
+    output_file: str = typer.Option("cs-report.json", "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Download a report in JSON format.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/fetch_a_report_in_json_format.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    resp = client.request("GET", f"/csapi/v1.3/reports/{report_uuid}/download")
+    from pathlib import Path
+    Path(output_file).write_bytes(resp.content)
+    output_success(f"Report saved to {output_file} ({len(resp.content):,} bytes)")
+
+
+@_report.command("delete")
+def report_delete(
+    ctx: typer.Context,
+    report_uuids: str = typer.Argument(..., help="Comma-separated report UUIDs"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete one or more reports.
+
+    Source: https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/delete_reports.htm
+    """
+    if not yes:
+        typer.confirm("Delete report(s)?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    uuids = [u.strip() for u in report_uuids.split(",")]
+    client.post_json("/csapi/v1.3/reports/delete", {"uuids": uuids})
+    output_success(f"Deleted {len(uuids)} report(s).")