diff --git a/README.md b/README.md index 1b4bb33..8439416 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,18 @@

Cisco Advisory Impact Analyzer

-

Fleet-wide firewall impact analysis, straight from Cisco

+

Check a Cisco advisory bundle against your firewall inventory

--- -Run one command in the folder holding your firewall inventory and get back an HTML report -telling you **which of your firewalls Cisco lists as vulnerable, and to what**. +Cisco publishes firewall vulnerabilities in **bundles** — an Event Response page listing every +advisory released that day. Give this tool the link to one and it tells you **which of your +firewalls and software releases that publication impacts**, and the release that fixes each. It asks Cisco's **PSIRT advisory API** — the same published data behind Cisco's public -Software Checker — which advisories apply to each firewall's software release on its exact -hardware model, and reports the answer. Every verdict comes from Cisco; nothing is inferred. +Software Checker — which of the bundle's advisories apply to each firewall's software release +on its exact hardware model. Every verdict comes from Cisco; nothing is inferred, and a +firewall it could not check is never reported as safe. Installed as a **[uv](https://docs.astral.sh/uv/) tool**: one install command, then a single `caia` command you can run from any folder. Works on **macOS, @@ -29,7 +31,7 @@ Windows, and Linux**. | 2 | **Git** | The uv install command below pulls the tool straight from GitHub, so Git must be installed first. Not sure if you have it? See [Get Git](#get-git) below. | | 3 | **Cisco PSIRT API credentials** | A client ID and client secret from — each person needs their own (steps below). | | 4 | **Your firewall inventory** as an Excel `.xlsx` file in the folder you run from | You build this yourself (format below). | -| 5 | **Internet access** to `apix.cisco.com` and `id.cisco.com` | Usually already available; corporate proxies can block these. | +| 5 | **Internet access** to `apix.cisco.com`, `id.cisco.com` and `sec.cloudapps.cisco.com` | The first two are Cisco's advisory API and its token endpoint; the third serves the bundle page. Usually already available; corporate proxies can block these. | > Your credentials are stored once, per user, via `caia --config`. The tool refuses to run > without them and points you at `--config`. @@ -202,47 +204,49 @@ on it behaves exactly like the uv install — use it as described in [Run it](#r caia ``` -The tool finds your inventory in that folder (if there's more than one candidate, it lists them -and lets you pick), asks whether you want to scope the report to one Cisco advisory bundle -(press **Enter** to skip), asks Cisco which published advisories apply to each firewall's -software release on its exact hardware model, and writes -**`impact_report__