Каталог, в котором находится `nse_main.lua`, — это тот, который использует данный nmap.

</details>

## Аргументы скрипта

| Аргумент | По умолчанию | Назначение |
|---|---|---|
| `vulners.mincvss` | `0` | Скрывать находки с оценкой ниже этого значения. Бюллетени без оценки и всё, что имеет известный эксплойт, показываются независимо от порога |
| `vulners.paths` | опубликованные 939 путей | Пути для веб-обхода: список Lua, одна строка с именем файла, содержащего по одному пути на строку, или `none` для отключения обхода. Файл, который вы указали и который невозможно прочитать, останавливает обход и сообщает об этом, а не откатывается к опубликованному списку |
| `vulners.width` | `80` | Ширина терминала, под которую свёрстана таблица |
| `vulners.max_items` | `32` | Потолок на оплачиваемые элементы для всего сканирования |
| `vulners.api_key` | - | Токен API. Утечка: nmap копирует собственную командную строку в `-oX` |
| `vulners.api_key_file` | - | Абсолютный путь к файлу, первая строка которого — токен |
| `vulners.api_host` | `vulners.com` | Имя хоста API |
| `vulners.api_port` | `443` | Порт на `api_host` |

Голое имя тоже работает, так что `--script-args mincvss=7` достаточно.

Префиксы аргументов версии 1.x — `vulners_enterprise.*` и
`http-vulners-regex.paths` — принимаются в течение одного релиза и выводят
уведомление об устаревании.

## Где хранить ключ API

В порядке предпочтения:

1. `~/.nmap/vulners.key`, одна строка, режим 600 — установщик предлагает записать его
2. `VULNERS_API_KEY` в окружении
3. `--script-args vulners.api_key_file=/absolute/path`
4. `--script-args vulners.api_key=<token>`

Последний вариант удобен, но утекает: nmap копирует собственную командную строку в каждый
отчёт, поэтому токен попадает в атрибут `args` вывода `-oX` и в вашу
историю shell. Сам скрипт никогда не записывает токен куда-либо, включая свой
отладочный вывод — об этом говорит регрессионный тест.

Файл ключа, который вы указали явно и который невозможно прочитать, останавливает запуск, а не
тихо откатывается — оператор, назвавший файл, имеет в виду именно этот файл — и
отчёт сообщает, какой это был файл. Ошибочно введённый путь не может выглядеть как чистое
сканирование.

## Откуда берутся отпечатки

Скрипт не носит их с собой. Он загружает три словаря один раз за сканирование,
до того как будет затронут первый хост:```
https://raw.githubusercontent.com/vulnersCom/nmap-vulners/catalog/
    index.json          what exists, at which serial
    fingerprints.json   721 product and version rules
    paths.json          939 paths the sweep requests
    probes.json         targeted version probes

Ответы кэшируются для всего сканирования, привязываясь к каждой идентичности, поэтому сотня
одинаковых серверов стоит одного запроса. Обогащение кэшируется по идентификатору находки, поэтому два
веб-порта с перекрывающимся программным обеспечением загружают каждый документ один раз.

## Машиночитаемый вывод

Всё, что выводится, также структурировано, поэтому `-oX` можно разбирать, не касаясь
человекочитаемого текста. Идентификатор скрипта, два уровня таблиц и пять исходных
ключей элементов не изменились с версии 1.x — именно это читают DefectDojo, Faraday,
nmap2csv и raven:```xml
<script id="vulners">
  <elem key="schema">2.0</elem>
  <elem key="mode">keyed</elem>
  <table key="cpe:/a:apache:http_server:2.4.7">
    <table>
      <elem key="id">CVE-2021-40438</elem>
      <elem key="type">cve</elem>
      <elem key="severity">CRITICAL</elem>
      <elem key="cvss">9.0</elem>
      <elem key="cvss_type">cvss3.1</elem>
      <elem key="is_exploit">false</elem>
      <elem key="exploit_known">true</elem>
      <elem key="kev">true</elem>
      <elem key="epss">0.99612</elem>
      <elem key="exploitation">active</elem>
      <elem key="title">Apache HTTP Server SSRF in mod_proxy</elem>
      <elem key="href">https://vulners.com/cve/CVE-2021-40438</elem>
      <elem key="source_href">https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2021-40438</elem>
    </table>
  </table>
</script>

270 модульных тестовых случаев выполняются внутри nmap против реальных библиотек NSE; 64 сквозных
случая запускают реальный бинарник nmap против локального веб-сервера и подставного
API Vulners, который принудительно применяет то же, что и реальный; гигиенический шлюз не допускает
секреты, вывод сканирования и мусор редактора в дерево и отказывает в глобальном чтении,
которое NSE превратило бы в потерянный результат; а последние четыре содержат данные и
инструменты, которые их публикуют — форму каталога, XML-контракт, который читает каждый
импортёр, транслятор шаблонов и шлюз, который решает, что пересборку безопасно публиковать. Последний удерживает весь репозиторий в соответствии с
[собственными стандартами кода Nmap](https://secwiki.org/w/Nmap/Code_Standards), которые
`HACKING` называет авторитетом для скрипта, желающего жить в дереве nmap:
никаких табуляций, никаких завершающих пробелов, строки короче 80 столбцов, никаких точек с запятой,
приватный NSEdoc, открывающийся с `--;`, PEP 8 для Python.
`python3 tests/e2e/run_e2e.py --live` добавляет проверки против реального сервиса.
См. [CONTRIBUTING.md](https://github.com/vulnerscom/nmap-vulners/blob/master/CONTRIBUTING.md).

## FAQ

**Эксплуатирует ли он что-либо?** Нет. Он читает баннеры и страницы и обращается к
базе данных — он не отправляет полезную нагрузку и не пробует учётные данные. Он классифицирован
как `discovery, intrusive, vuln, external`, а не `safe`, по одной причине:
развёртка путей запрашивает 939 путей веб-порта, а определение `safe` в nmap
исключает скрипты, использующие большие объёмы пропускной способности. Собственный `http-enum`
nmap запрашивает 2 204 и несёт ту же метку. Ваш `-T` задаёт, насколько быстро они уходят,
и никогда — сколько, а `--script-args vulners.paths=none` полностью отключает развёртку.

**Работает ли он без ключа API?** Да, полностью. Без него используется бесплатная
конечная точка, которая возвращает те же уязвимости для CPE, что и платная. Ключ
добавляет детали по каждой находке и может называть программное обеспечение, которое бесплатный путь не может.

**Почему `-sC` перестал находить веб-программное обеспечение?** Потому что `vulners` больше не в
категории `default` в nmap, и развёртка отпечатков, которая раньше жила в
`http-vulners-regex.nse`, тоже. Отправка идентичности программного обеспечения цели
третьей стороне должна быть тем, о чём вы попросили: запустите `--script vulners`.

**Почему одна уязвимость показывает `cvss2.0`, а другая — `cvss3.1`?** Метка
называет шкалу, на которой находится оценка. Vulners возвращает ту, которую опубликовал источник;
оценка v2 в 9.3 — это не оценка v3 в 9.3.

**Почему показывается запись с низкой оценкой, когда я задал `mincvss`?** Потому что у неё есть
известный эксплойт или потому что источник никогда её не оценивал. Оба случая намеренны.

**В отчёте сказано, что каталог не удалось загрузить.** Тогда веб-распознавание
отпечатков не выполнялось, а всё остальное выполнялось: программное обеспечение, которое сам nmap
назвал, всё равно было проверено. Это сказано вслух именно по этой причине — возможность,
которая не выполнялась, читается как возможность, которая ничего не нашла. Две причины имеют
отдельные формулировки: «не удалось загрузить» — это сеть, а «ответил, но
один из его словарей не удалось прочитать» — это зеркало, на которое вы его направили.

**Он ничего не нашёл на хосте, который, как я знаю, уязвим.** Запустите с `-d2`: он регистрирует
каждую идентичность, о которой спрашивал. Обычно nmap называл сервис, но не его
версию, и версию нечего искать.

## Лицензия

Скрипты лицензированы так же, как и сам Nmap — см. [LICENSE](https://github.com/vulnerscom/nmap-vulners/blob/master/LICENSE) для
Публичной исходной лицензии Nmap и
[nmap.org/npsl](https://nmap.org/npsl/) для того, что она означает.

Данные об уязвимостях поступают от [Vulners](https://vulners.com) и подчиняются
их условиям.

## Связанное

* [vulners.com](https://vulners.com) — база данных, стоящая за этими скриптами
* [vulnersCom/api](https://github.com/vulnersCom/api) — Python-клиент
* [vulnersCom/burp-vulners-scanner](https://github.com/vulnersCom/burp-vulners-scanner) — те же данные внутри Burp Suite
* [nmap.org/book/nse.html](https://nmap.org/book/nse.html) — как работают скрипты NSE

---

<div align="center">

Поддерживается командой Vulners &lt;[email protected]&gt;

`#nmap` `#nse` `#vulnerability-scanner` `#cve` `#cvss` `#cpe` `#vulners`
`#security-tools` `#pentest` `#infosec` `#network-scanner` `#exploit-database`
`#lua` `#vulnerability-detection` `#security-automation`

</div>