qualys-cli 0.1.1__py3-none-any.whl

qualys_cli/commands/etm.py

@@ -0,0 +1,170 @@
+# Hand-edited — do NOT regenerate from api-model.json (codegen will skip this file).
+# Enterprise TruRisk Management API  (JWT auth, JSON responses)
+# Originally generated from api-model.json; corrected:
+#   - report list  → POST /reports/list  (was incorrect GET /reports)
+#   - bulk-delete  → DELETE /reports with raw JSON-array body
+#                    (was incorrect POST /reports/delete with {reportIds:[...]})
+from __future__ import annotations
+
+import typer
+
+from .. import client as _c
+from ..formatters import DEFAULT_LIMIT, output, output_success
+
+app = typer.Typer(name="etm", help="Enterprise TruRisk Management APIs (JWT Bearer auth)")
+
+_report = typer.Typer(help="ETM report operations")
+app.add_typer(_report, name="report")
+
+
+@_report.command("list")
+def report_list(
+    ctx: typer.Context,
+    offset: int = typer.Option(0, "--offset", help="Pagination offset (0-based)"),
+    page_size: int = typer.Option(50, "--page-size", help="Items per page on the API"),
+    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 active ETM reports.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/list_of_active_reports.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.post_json(
+        "/etm/api/rest/v1/reports/list",
+        {"offset": offset, "limit": page_size},
+    )
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_report.command("create")
+def report_create(
+    ctx: typer.Context,
+    report_format: str = typer.Option(..., "--report-format", help="JSON|PARQUET"),
+    name: str | None = typer.Option(None, "--name"),
+    description: str | None = typer.Option(None, "--description"),
+    asset_qql: str | None = typer.Option(None, "--asset-qql", help="Asset QQL filter"),
+    findings_qql: str | None = typer.Option(None, "--findings-qql", help="Findings QQL filter"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Submit a finding report request.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/submit_finding_report.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    body: dict = {"reportFormat": report_format}
+    if name:
+        body["name"] = name
+    if description:
+        body["description"] = description
+    if asset_qql:
+        body["assetQql"] = asset_qql
+    if findings_qql:
+        body["findingsQql"] = findings_qql
+    data = client.post_json("/etm/api/rest/v1/reports/findings", body)
+    output(data, format=format)
+
+
+@_report.command("get")
+def report_get(
+    ctx: typer.Context,
+    report_id: str = typer.Argument(..., help="Report ID"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get details of a specific ETM report.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/get_report_details.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/etm/api/rest/v1/reports/{report_id}")
+    output(data, format=format)
+
+
+@_report.command("download")
+def report_download(
+    ctx: typer.Context,
+    report_id: str = typer.Argument(..., help="Report ID"),
+    output_file: str = typer.Option("etm-report.zip", "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Download all resources for an ETM report as a ZIP.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/download_all_resources_zip.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    resp = client.request("GET", f"/etm/api/rest/v1/reports/{report_id}/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("download-resource")
+def report_download_resource(
+    ctx: typer.Context,
+    report_id: str = typer.Argument(..., help="Report ID"),
+    resource_name: str = typer.Argument(..., help="Resource name (e.g. part_15097524224131306.json)"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Download a specific resource file from an ETM report.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/download_report_using_resource_name.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    resp = client.request("GET", f"/etm/api/rest/v1/reports/{report_id}/resources/{resource_name}")
+    from pathlib import Path
+    out = output_file or resource_name
+    Path(out).write_bytes(resp.content)
+    output_success(f"Resource saved to {out} ({len(resp.content):,} bytes)")
+
+
+@_report.command("delete")
+def report_delete(
+    ctx: typer.Context,
+    report_id: str = typer.Argument(..., help="Report ID"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete an ETM report.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/delete_report_id.htm
+    """
+    if not yes:
+        typer.confirm(f"Delete ETM report {report_id}?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    client.delete_json(f"/etm/api/rest/v1/reports/{report_id}")
+    output_success(f"Report {report_id} deleted.")
+
+
+@_report.command("bulk-delete")
+def report_bulk_delete(
+    ctx: typer.Context,
+    report_ids: str = typer.Argument(..., help="Comma-separated report IDs"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Bulk delete ETM reports.
+
+    Source: https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/bulk_delete_reports.htm
+    """
+    ids = [r.strip() for r in report_ids.split(",") if r.strip()]
+    if not yes:
+        typer.confirm(f"Delete {len(ids)} ETM report(s)?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    # Doc requires DELETE /reports with the body as a raw JSON array, not a wrapper object.
+    resp = client.request(
+        "DELETE", "/etm/api/rest/v1/reports",
+        json=ids,
+        headers={"Accept": "application/json", "Content-Type": "application/json"},
+    )
+    if resp.status_code == 204 or not resp.content:
+        output_success(f"Deleted {len(ids)} ETM report(s).")
+    else:
+        try:
+            output(resp.json())
+        except ValueError:
+            output_success(f"Deleted {len(ids)} ETM report(s).")

qualys_cli/commands/pc.py

@@ -0,0 +1,255 @@
+# Hand-edited — do NOT regenerate from api-model.json (codegen will skip this file).
+# Policy Compliance API  (Basic auth, XML responses)
+# Originally generated from api-model.json; corrections:
+#   - policy export: --id (was wrongly --policy-id), supports --title alternative;
+#     added --show-user-controls, --show-appendix
+#   - policy list: --ids (was sending wrong key policy_ids)
+#   - scan launch: --option-id OR --option-title required (was silently optional);
+#     added --scanner, --asset-groups, --priority
+from __future__ import annotations
+
+import typer
+
+from .. import client as _c
+from ..formatters import DEFAULT_LIMIT, output, output_success
+
+app = typer.Typer(name="pc", help="Policy Compliance APIs (Basic auth)")
+
+# ── scan ─────────────────────────────────────────────────────────────────────
+_scan = typer.Typer(help="PC scan operations")
+app.add_typer(_scan, name="scan")
+
+
+@_scan.command("list")
+def scan_list(
+    ctx: typer.Context,
+    state: str | None = typer.Option(None, "--state"),
+    launched_after: str | None = typer.Option(None, "--launched-after"),
+    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 compliance scans.
+
+    Source: https://docs.qualys.com/en/vm/api/scans/pc_scans/list_pc_scans.htm
+    """
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    params: dict = {"action": "list"}
+    if state:
+        params["state"] = state
+    if launched_after:
+        params["launched_after_datetime"] = launched_after
+    data = client.get_xml("/api/2.0/fo/scan/compliance/", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_scan.command("launch")
+def scan_launch(
+    ctx: typer.Context,
+    title: str = typer.Option(..., "--title"),
+    ip: str = typer.Option(..., "--ip"),
+    option_id: str | None = typer.Option(
+        None, "--option-id", help="Option profile ID (required if --option-title not given)"
+    ),
+    option_title: str | None = typer.Option(
+        None, "--option-title", help="Option profile title (required if --option-id not given)"
+    ),
+    scanner_name: str | None = typer.Option(
+        None, "--scanner", help="Scanner appliance name(s)"
+    ),
+    asset_groups: str | None = typer.Option(
+        None, "--asset-groups", help="Asset group IDs, comma-separated (alternative to --ip)"
+    ),
+    priority: int | None = typer.Option(
+        None, "--priority", help="0–9", min=0, max=9
+    ),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Launch a compliance scan.
+
+    The Qualys API requires an option profile to be selected — either by ID
+    (--option-id) or by exact title (--option-title). Pass at least one.
+
+    Source: https://docs.qualys.com/en/vm/api/scans/pc_scans/launch_pc_scan.htm
+    """
+    if not option_id and not option_title:
+        raise typer.BadParameter(
+            "Provide --option-id or --option-title (one is required by the API)."
+        )
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    params: dict = {"action": "launch", "scan_title": title, "ip": ip}
+    if option_id:
+        params["option_id"] = option_id
+    if option_title:
+        params["option_title"] = option_title
+    if scanner_name:
+        params["scanner_appliances"] = scanner_name
+    if asset_groups:
+        params["asset_groups"] = asset_groups
+    if priority is not None:
+        params["priority"] = str(priority)
+    data = client.post_xml("/api/2.0/fo/scan/compliance/", data=params)
+    output(data)
+
+
+# ── scan-schedule ─────────────────────────────────────────────────────────────
+_sched = typer.Typer(help="Compliance scan schedule operations")
+app.add_typer(_sched, name="scan-schedule")
+
+
+@_sched.command("list")
+def sched_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List compliance scan schedules.
+
+    Source: https://docs.qualys.com/en/vm/api/scans/pc_schedules/list_compliance_scan_schedules.htm
+    """
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    data = client.get_xml("/api/2.0/fo/schedule/scan/compliance/", {"action": "list"})
+    output(data, format=format, limit=limit)
+
+
+@_sched.command("delete")
+def sched_delete(
+    ctx: typer.Context,
+    id_: str = typer.Argument(..., help="Schedule ID"),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete a compliance scan schedule.
+
+    Source: https://docs.qualys.com/en/vm/api/scans/pc_schedules/Delete_a_compliance_scan_schedule.htm
+    """
+    if not yes:
+        typer.confirm(f"Delete schedule {id_}?", abort=True)
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    data = client.post_xml("/api/2.0/fo/schedule/scan/compliance/",
+                           data={"action": "delete", "id": id_})
+    output(data)
+
+
+# ── policy ────────────────────────────────────────────────────────────────────
+_policy = typer.Typer(help="Policy operations")
+app.add_typer(_policy, name="policy")
+
+
+@_policy.command("list")
+def policy_list(
+    ctx: typer.Context,
+    ids: str | None = typer.Option(None, "--ids", help="Comma-separated policy ID(s)"),
+    title: str | None = typer.Option(None, "--title"),
+    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 compliance policies.
+
+    Source: https://docs.qualys.com/en/vm/api/pc/policies/list_policies.htm
+    """
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    params: dict = {"action": "list"}
+    if ids:
+        params["ids"] = ids
+    if title:
+        params["title"] = title
+    data = client.get_xml("/api/2.0/fo/compliance/policy/", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_policy.command("export")
+def policy_export(
+    ctx: typer.Context,
+    id_: str | None = typer.Argument(None, help="Policy ID (omit if using --title)"),
+    title: str | None = typer.Option(None, "--title", help="Look up policy by title instead of ID"),
+    show_user_controls: bool = typer.Option(False, "--show-user-controls", help="Include user-defined controls"),
+    show_appendix: bool = typer.Option(False, "--show-appendix", help="Include the policy appendix"),
+    output_file: str = typer.Option("policy.xml", "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Export a policy to XML.
+
+    Source: https://docs.qualys.com/en/vm/api/pc/policies/policy_export.htm
+    """
+    if not id_ and not title:
+        raise typer.BadParameter("Provide a policy ID as an argument, or --title.")
+    params: dict = {"action": "export"}
+    if id_:
+        params["id"] = id_
+    if title:
+        params["title"] = title
+    if show_user_controls:
+        params["show_user_controls"] = "1"
+    if show_appendix:
+        params["show_appendix"] = "1"
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    resp = client.request("GET", "/api/2.0/fo/compliance/policy/", params=params)
+    from pathlib import Path
+    Path(output_file).write_bytes(resp.content)
+    output_success(f"Policy exported to {output_file}")
+
+
+# ── posture ───────────────────────────────────────────────────────────────────
+_posture = typer.Typer(help="Compliance posture operations")
+app.add_typer(_posture, name="posture")
+
+
+@_posture.command("list")
+def posture_list(
+    ctx: typer.Context,
+    policy_id: str = typer.Option(
+        ..., "--policy-id",
+        help="Policy ID to evaluate posture against (required by the API).",
+    ),
+    host_id: str | None = typer.Option(None, "--host-id"),
+    control_id: str | None = typer.Option(None, "--control-id"),
+    status: str | None = typer.Option(None, "--status", help="Pass|Fail|Error"),
+    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 compliance posture info.
+
+    Source: https://docs.qualys.com/en/vm/api/pc/posture/list_posture_info.htm
+    """
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    params: dict = {"action": "list", "policy_id": policy_id}
+    if host_id:
+        params["host_id"] = host_id
+    if control_id:
+        params["control_id"] = control_id
+    if status:
+        params["status"] = status
+    data = client.get_xml("/api/2.0/fo/compliance/posture/info/", params)
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+# ── option-profile ────────────────────────────────────────────────────────────
+_op = typer.Typer(help="PC option profile operations")
+app.add_typer(_op, name="option-profile")
+
+
+@_op.command("list")
+def op_list(
+    ctx: typer.Context,
+    ids: str | None = typer.Option(None, "--ids"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List PC option profiles.
+
+    Source: https://docs.qualys.com/en/vm/api/scans/ops/ops_pc/PC_Option_Profile.htm
+    """
+    client = _c.make(ctx.obj, auth_type="basic", verbose=verbose)
+    params: dict = {"action": "list"}
+    if ids:
+        params["ids"] = ids
+    data = client.get_xml("/api/2.0/fo/subscription/option_profile/pc/", params)
+    output(data, format=format, limit=limit)