
Сервис, который собирает подключённые open-source репозитории в изолированных офлайн-виртуальных машинах и сканирует их на наличие уязвимостей безопасности, отправляя по электронной почте результаты с воспроизводителями и предлагаемыми патчами.
OSS Scanner — это сервис от Anthropic для сканирования критически важных open-source репозиториев на предмет уязвимостей безопасности. Подробнее о сервисе можно узнать на red.anthropic.com/oss-scanner.
Обратите внимание: использование этого инструмента регулируется условиями, изложенными в OSS Scanner terms.
Зарегистрируйте open-source проект, открыв pull request, который добавляет один каталог:
projects/<name>
Наш сканер безопасности собирает ваш проект в изолированной виртуальной машине, затем анализирует его без доступа к Интернету и отправляет найденные проблемы по электронной почте на адрес primary_contact (и любым получателям в копии), каждая с воспроизведением и предложенным патчем, где это возможно. Отчёты генерируются моделью и не проверяются человеком. По этой причине мы не устанавливаем 90-дневный период раскрытия для этих находок и не будем делать их публичными. Владельцам проектов следует предоставить project.yaml (для настройки сканера), Dockerfile (указывающий, как собрать проект) и, опционально, threat_model.md (содержащий моделирование угроз для конкретного проекта), report_guidelines.md и patch_guidelines.md (описывающие, как вы хотели бы, чтобы выглядели отчёты и патчи).
Начните с templates/project.yaml:
repo: https://github.com/example/project # required: the git repository to scan; add #branch to pin one
primary_contact: [email protected] # required: reports and build problems go here (one address)
auto_ccs: # optional: more addresses on every mail
- [email protected]
homepage: https://example.org # optional
disabled: false # optional: true pauses reports without removing the enrolment
dockerfile: .oss-scanner/Dockerfile # required unless a Dockerfile sits in this repo next to your project.yaml
threat_model: .oss-scanner/threat_model.md # optional; also supports placing the file in this repository
# report_guidelines: .oss-scanner/report_guidelines.md # optional; the same
# patch_guidelines: .oss-scanner/patch_guidelines.md # optional; the same
repo и primary_contact обязательны всегда. dockerfile обязателен, если только вы не храните свой Dockerfile рядом с project.yaml (см. ниже). Остальные параметры необязательны.
Адреса электронной почты в project.yaml являются публичными. Используйте адреса, которые вы готовы видеть опубликованными, например, псевдоним для вопросов безопасности.
Чтобы получать зашифрованные отчёты по электронной почте, добавьте свой публичный ключ OpenPGP в armored-формате. Тогда они будут отправляться только на primary_contact; pgp нельзя комбинировать с auto_ccs:
pgp: |
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF...
-----END PGP PUBLIC KEY BLOCK-----
Чтобы выбрать, куда направляются отчёты, задайте минимальный уровень серьёзности, который получает каждый канал: low, medium, high, critical или none, чтобы отключить канал. Канал, который вы не указали, использует показанное здесь значение по умолчанию, а отчёт с уровнем не ниже обоих минимумов направляется в оба канала. pgp применяется только к электронной почте, поэтому отчёты GitHub не шифруются вашим ключом:
output_format:
email:
min_severity: low
github_security_advisory: # GitHub private vulnerability reporting
min_severity: none
Чтобы включить отчёты GitHub, сначала включите приватное сообщение об уязвимостях в вашем репозитории и добавьте oss-scanner в качестве доверенного репортёра. Anthropic управляет аккаунтом oss-scanner, от имени которого приходят наши отчёты; без этого GitHub ограничивает, сколько отчётов может вам отправить. Мы просим вас подтвердить это в вашем pull request до того, как мы выполним слияние.
Вы должны предоставить Dockerfile ровно в одном из двух мест:
dockerfile: с путём к нему (мы предлагаем разместить его где-то вроде .oss-scanner/Dockerfile). Это предпочтительный вариант, поскольку он позволяет вам обновлять сборку без pull request здесь; илиproject.yaml, как projects/<name>/Dockerfile, без заданного ключа Dockerfile: в project.yaml. Если вы предпочитаете не добавлять файлы в свой репозиторий, разместите его здесь, и сканер соберёт его точно так же, как копию внутри репозитория.(Модель угроз работает так же. Задайте поле threat_model с указанием её расположения в вашем репозитории или разместите её здесь как projects/<name>/threat_model.md. То же касается рекомендаций по отчётам и рекомендаций по патчам — с полями report_guidelines и patch_guidelines.)
Назначение Dockerfile — настроить ваше окружение, установить все зависимости и собрать проект. Первоначальная настройка проекта выполняется с включённым доступом к сети, но следующий за ней аудит безопасности выполняется без доступа к Интернету. Всё, что нужно для сборки или тестов, должно быть загружено во время первоначальной настройки Dockerfile. Мы рекомендуем проверить, что ваши тесты проходят внутри собранного образа.
Файл threat_model.md (необязательный, но настоятельно рекомендуемый) позволяет предоставить сканеру документацию о ваших предполагаемых целях безопасности. Мы обнаружили, что наиболее полезно давать указания о том, как вы оцениваете серьёзность отчётов (например, считаете ли вы SQLi после аутентификации высокой или критической? ограничены ли переполнения буфера без продемонстрированных эксплойтов уровнем high? когда хранимый XSS является medium, high и critical?). Этот файл также может описывать, что делает проект, откуда поступает недоверенный ввод, какие компоненты важны, а какие вне области охвата, или что-либо ещё, что вы считаете важным или полезным.
Ещё два файла (необязательных, но настоятельно рекомендуемых) позволяют вам указать, как вы хотели бы, чтобы выглядели наши отчёты и патчи:
report_guidelines.md — для формата каждого отчёта: его структуры и разделов, длины, тона и того, какие факты следует указывать.patch_guidelines.md — для стиля каждого патча: например, сколько комментариев писать, должен ли исправление быть очень узким или более общим, какие тесты добавлять и какой форматтер использовать.Начните с templates/report_guidelines.md и templates/patch_guidelines.md. Оба представляют собой простой текст размером не более 16 KiB.
Эти файлы меняют только то, как пишутся отчёты и патчи; что входит в область охвата и как вы оцениваете серьёзность, относится к threat_model.md. Каждый файл автоматически проверяется перед использованием. Файл, который пытается изменить больше, например, опустить находки или запустить несвязанные команды, игнорируется целиком.
Мы рекомендуем выполнить две команды перед открытием pull request:
tools/validate.py проверяет projects/<name>/ на соответствие правилам выше.tools/check <name> собирает ваш проект так, как это сделает наш сканер, и открывает оболочку в готовом образе без сети. Если ваши тесты проходят в этом контейнере, наш сканер, скорее всего, будет работать с вашим проектом. tools/check --qemu <name> делает то же самое внутри виртуальных машин, устроенных как у сканера.Эти инструменты требуют, чтобы на вашем хосте были установлены git, Docker и Python 3 с PyYAML (pip install pyyaml); для --qemu требуется Linux на x86-64 с QEMU вместо Docker.