.github

Проекты, которые следуют приведенным ниже лучшим практикам, могут добровольно и самостоятельно оценить себя и продемонстрировать, что они получили значок Open Source Security Foundation (OpenSSF).

Не существует набора практик, гарантирующего, что у программного обеспечения никогда не будет недостатков или уязвимостей; даже формальные методы могут не помочь, если спецификации или допущения ошибочны. Также не существует какой-либо практики, которая могла бы гарантировать, что проект будет поддерживать здоровое и хорошо функционирующее сообщество разработчиков. Однако следующие хорошие правила могут помочь улучшить результаты проектов. Например, некоторые правила описывают ревью несколькими участниками перед выпуском, что может помочь найти технические уязвимости, которые было бы сложно найти другим способом, и помочь построить доверие и желание дальнейшего взаимодействия между разработчиками из разных компаний. Чтобы получить значок, нужно выполнить все критерии с ключевыми словами "НЕОБХОДИМО"/"ОБЯЗАН"/"НЕДОПУСТИМО", все критерии со словом "СЛЕДУЕТ" либо должны удовлетворяться, либо должно быть приведено обоснование их невыполнения, и все критерии со словом "ЖЕЛАТЕЛЬНО" могут быть удовлетворены ИЛИ неудовлетворены (желательно, чтобы они были хотя бы рассмотрены). Если вы хотите ввести общий комментарий вместо объяснения, почему текущая ситуация приемлема, начните текст с '//' и пробела. Приветствуется обратная связь через сайт на GitHub в виде issues или pull requests. Существует также список рассылки для общих вопросов.

Мы с удовольствием предоставляем информацию на нескольких языках, однако, если есть какой-либо конфликт или несоответствие между переводами, английская версия является авторитетной.
Если это ваш проект, пожалуйста, покажите свой значок на странице проекта! Статус значка выглядит следующим образом: Уровень значка для проекта 14058 - passing Вот как вставить его:
Вы можете показать свой статус значка, вставив его в файл с разметкой Markdown:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14058/badge)](https://www.bestpractices.dev/projects/14058)
- или HTML:
<a href="https://www.bestpractices.dev/projects/14058"><img src="https://www.bestpractices.dev/projects/14058/badge"></a>


Это критерии уровня Gold. Вы также можете просмотреть критерии уровня Passing или Silver.

Baseline Series: Базовый уровень 1 Базовый Уровень 2 Базовый Уровень 3

        

 Основы 2/5

  • Общая

    Обратите внимание, что другие проекты могут использовать то же имя.

    Shared workflows, community health files and org profile for Monumental Archive

    Используйте формат выражения лицензии SPDX; примеры включают «Apache-2.0», «BSD-2-Clause», «BSD-3-Clause», «GPL-2.0+», «LGPL-3.0+», «MIT» и «(BSD-2-Clause OR Ruby)».
    Если используется более одного языка, перечислите их через запятую (пробелы необязательны), и отсортируйте их от наиболее до наименее используемого. Если список длинный, пожалуйста, перечислите по крайней мере три наиболее распространенных. Если языка нет (например, это проект только для документации или только для тестирования), используйте один символ «-» (минус). Для каждого языка используйте общепринятую капитализацию названия, например «JavaScript».
    Common Platform Enumeration (CPE) - это структурированная схема именования для информационных систем, программного обеспечения и пакетов. Она используется в ряде систем и баз данных для отчетов об уязвимостях.
  • Предварительные требования


    Проект ОБЯЗАН получить серебряный значок. [achieve_silver]

  • Надзор за проектом


    Проект ОБЯЗАН иметь «коэффициент автобуса» 2 или более. (Требуется URL) [bus_factor]
    «Коэффициент автобуса» (или «коэффициент грузовика») - это минимальное количество участников проекта, которые должны внезапно исчезнуть из проекта («попасть под автобус»), чтобы проект заглох из-за отсутствия квалифицированного или компетентного персонала. Инструмент truck-factor может оценить это для проектов на GitHub. Для получения дополнительной информации см. статью Cosentino et al. Assessing the Bus Factor of Git Repositories.

    The bus factor is 1 — a single maintainer. Recorded plainly in docs/slsa-reference.md as headcount-blocked, with docs/continuity.md carrying the succession and break-glass paths that exist precisely because of it. https://github.com/monumental-archive/.github/blob/main/docs/continuity.md



    Проект ОБЯЗАН иметь как минимум двух несвязанных значительных соавторов. (Требуется URL) [contributors_unassociated]
    Соавторы связаны, если они оплачиваются работой одной и той же организации (как работник или подрядчик), и организация может выиграть от результатов проекта. Финансовые гранты не считаются находящимися в одной организации, если они проходят через другие организации (например, гранты на науку, выплачиваемые различным организациям из общего правительства или источника НПО, не приводят к тому, что вкладчики могут быть связаны). Соавтор считается значительным, если за последний год он(а) внес(ла) заметный вклад в проект. Примерами хороших показателей значительного соавтора являются: написано не менее 1000 строк кода, внесено 50 коммитов или предоставлено не менее 20 страниц документации.

    There is one significant contributor, so there cannot be two unassociated ones. Headcount, not policy: contributions are welcomed under CONTRIBUTING.md. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md


  • Другое


    Проект ОБЯЗАН указывать лицензию в каждом исходном файле. Это МОЖЕТ быть сделано путем включения в комментарий рядом с началом каждого файла следующей строки: SPDX-License-Identifier: [SPDX-выражение лицензии для проекта]. [license_per_file]
    Это МОЖЕТ также быть сделано путем указания лицензии на естественном языке. Проект МОЖЕТ также включать стабильный URL-адрес, указывающий на текст лицензии, или полный текст лицензии. Обратите внимание, что критерий license_location требует помещать лицензию проекта в стандартном расположении. См. этот учебник SPDX для получения дополнительных сведений об SPDX-выражениях лицензии. Обратите внимание на связь с критерием copyright_per_file, содержимое для которого обычно предшествует информации о лицензии.

    Every file carries an SPDX licence statement (0BSD) through REUSE.toml, with the full text in LICENSES/0BSD.txt. reuse lint reports 141 of 141 files with licence information and api.reuse.software independently reports the project compliant. https://github.com/monumental-archive/.github/blob/main/REUSE.toml


 Управление изменениями 4/4

  • Публичное хранилище исходного кода с поддержкой версий


    Хранилище проектного исходного кода ОБЯЗАНО использовать типовое ПО для распределенного управления версиями (например, git или mercurial). [repo_distributed]
    Не требуется именно git, и проекты могут использовать централизованное программное обеспечение для управления версиями (например, Subversion) с обоснованием.

    Git - a distributed version control system - hosted on GitHub. Every clone carries the complete history, and every commit and tree is content-addressed, so the record can be verified and republished from any clone independently of the hosting account. The repository is public and its history is the project's authoritative record; releases are cut from tags in that same history. https://github.com/monumental-archive/.github



    Проект ОБЯЗАН четко обозначать небольшие задачи, которые могут быть выполнены новыми или случайными участниками. (Требуется URL) [small_tasks]
    Это обозначение обычно делается путем маркировки выбранных проблем в трекере одним или несколькими тегами, которые использует проект для этой цели, например up-for-grabs, «только для новичков», «Небольшое исправление», «микрозадача» или IdealFirstBug. Эти новые задачи не обязательно требуют добавления функциональности; это может быть улучшение документации, добавление тестовых кейсов или что-то еще, что помогает проекту и помогает участнику лучше понять проект.

    Open issues are labelled 'good first issue' and 'help wanted': #4 (absorb the renovate-config repository and retire it) and #27 (stand up GitHub Sponsors and a FUNDING.yml). Both are self-contained and can be completed without prior context in the release machinery. https://github.com/monumental-archive/.github/labels/good%20first%20issue



    Проект ОБЯЗАН требовать двухфакторной аутентификации (ДФА) от разработчиков для изменения центрального хранилища или доступа к конфиденциальным данным (например, приватным отчетам об уязвимостях). Этот механизм ДФА МОЖЕТ использовать механизмы без криптографической защиты, такие как SMS, хотя это не рекомендуется. [require_2FA]

    Two-factor authentication is required organisation-wide — GitHub reports two_factor_requirement_enabled for the monumental-archive organisation — so it covers pushing to the repository and access to private vulnerability reports alike.



    При двухфакторной аутентификации (ДФА) проекту СЛЕДУЕТ использовать криптографические механизмы для предотвращения имперсонации. ДФА на основе службы коротких сообщений (SMS) сама по себе НЕ соответствует этому критерию, поскольку короткие сообщения не шифруются. [secure_2FA]
    Механизм ДФА, который соответствует этому критерию, может быть приложением для генерации временных одноразовых паролей (Time-based One-Time Password, TOTP), которое автоматически генерирует код аутентификации, меняющийся через определенный промежуток времени. Обратите внимание, что GitHub поддерживает TOTP.

    The 2FA in use is cryptographic rather than SMS-based: GitHub's supported second factors here are TOTP and WebAuthn, and the organisation's requirement is satisfied without SMS.


 Качество 4/7

  • Стандарты кодирования


    Проект ОБЯЗАН документировать свои требования по ревью кода, в том числе, как проводится ревью кода, что необходимо проверять и что необходимо для приемлемости кода. (Требуется URL) [code_review_standards]
    См. также критерии two_person_review и contrib_requirements.

    GOVERNANCE.md section 'Code review' documents how review is conducted and what must be checked: that the change does what it says, that the claim it makes is one its checks actually enforce, that it does not weaken a documented control, and that documentation changed alongside behaviour - with the mechanical floor (formatting, linting, licence headers, commit shape, tests) left to the CI gate rather than the reviewer. What is required to be acceptable is stated too: a green gate, resolved review threads enforced by ruleset, a DCO sign-off on every commit, and a PR title and body fit to become the permanent squash commit. It also records that with one maintainer there is no second human reviewer, and names the gate as the compensating control. https://github.com/monumental-archive/.github/blob/main/GOVERNANCE.md#code-review



    Проект ОБЯЗАН проводить проверку не менее 50% всех предлагаемых модификаций до их попадания в выпуск человеком, отличным от автора, для определения того, являются ли эти модификации целесообразными и не содержат ли известных проблем, препятствующих включению. [two_person_review]

    With a single maintainer, no proposed modification is reviewed by a person other than its author. This is the Source L4 and Gold boundary for this project and is recorded as headcount-blocked in docs/slsa-reference.md; it is watched as an issue rather than papered over. https://github.com/monumental-archive/.github/blob/main/docs/slsa-reference.md


  • Рабочая система сборки


    Проект ОБЯЗАН обеспечивать воспроизводимую сборку. Если сборка не требуется (например, в случае языков сценариев, где исходный код используется непосредственно вместо компиляции), выберите «N/A». (Требуется URL) [build_reproducible]
    Воспроизводимая сборка означает, что несколько сторон могут независимо повторить процесс генерации информации из исходных файлов и получить аналогичный результат с точностью до бита. В некоторых случаях воспроизводимости можно достичь путем принудительного выставления окружения. Разработчики JavaScript могут рассмотреть возможность использования npm shrinkwrap и webpack OccurenceOrderPlugin. Пользователи GCC и clang могут найти полезной опцию -frandom-seed. Среда сборки (включая набор инструментов) часто может быть определена для внешних сторон путём указания криптографической суммы (hash) для конкретного контейнера или виртуальной машины, которые они могут использовать для пересборки. В проекте Reproducible Builds есть документация о том, как это сделать.

    The release is reproducible and it is proven on every release, not asserted. This repository publishes the source-archive class, so publish.yml builds the archive twice independently (build-source and repro-build-source) and the repro gate compares the two outputs bit for bit before anything is signed, attached or published — a mismatch fails the release rather than warning. A scheduled repro-check additionally re-verifies published history from cold. Verified on the live release: v1.22.2 ships github-1.22.2.tar.gz with checksums.txt and an attestations.intoto.jsonl evidence bundle. https://github.com/monumental-archive/.github/releases/tag/v1.22.2


  • Набор автотестов


    Набор тестов ОБЯЗАН запускаться стандартным способом для этого языка. (Требуется URL) [test_invocation]
    Например, «make check», «mvn test» или «rake test» (Ruby).

    mise run ci — one command, identical locally and in CI, documented in README.md. https://github.com/monumental-archive/.github/blob/main/README.md



    Проект ОБЯЗАН реализовать непрерывную интеграцию, при которой новый или измененный код интегрируется в центральное хранилище кода, и на получившейся базе кода запускаются автоматические тесты. (Требуется URL) [test_continuous_integration]
    В большинстве случаев это означает, что каждый разработчик, занимающийся проектом полный рабочий день, интегрируется, по крайней мере, ежедневно.

    gate.yml runs the full gate on every push and pull request to main, self-applying the reusable workflow this project publishes. https://github.com/monumental-archive/.github/blob/main/.github/workflows/gate.yml



    Проект ОБЯЗАН иметь автоматические тестовые пакеты на СПО, которые обеспечивают покрытие не менее 90% инструкций кода, если есть хотя бы один инструмент на СПО, который может измерять этот критерий на выбранном языке. [test_statement_coverage90]

    Statement coverage is not measured. The product is bash and YAML, and no coverage tool meets this project's tooling priors for bash (kcov is source-only and Linux-only); the verdict and its revisit trigger are recorded in docs/tooling-verdicts.md. https://github.com/monumental-archive/.github/blob/main/docs/tooling-verdicts.md



    Проект ОБЯЗАН иметь автоматические тестовые пакеты на СПО, которые обеспечивают покрытие не менее 80% веток кода, если есть хотя бы один инструмент на СПО, который может измерять этот критерий на выбранном языке. [test_branch_coverage80]

    Branch coverage is not measured, for the same reason as statement coverage: no bash coverage tool meets this project's priors. Recorded in docs/tooling-verdicts.md. https://github.com/monumental-archive/.github/blob/main/docs/tooling-verdicts.md


 Безопасность 5/5

  • Основы правильного использования криптографии

    Обратите внимание, что некоторое ПО не нуждается в использовании криптографических механизмов.

    В ПО, создаваемом проектом, НЕОБХОДИМО поддерживать безопасные протоколы для всех сетевых коммуникаций, такие как SSHv2 или новее, TLS1.2 или новее (HTTPS), IPsec, SFTP и SNMPv3. По умолчанию НЕОБХОДИМО отключать небезопасные протоколы, такие как FTP, HTTP, telnet, SSLv3 или более ранние версии, и SSHv1, и разрешать их только в том случае, если пользователь явным образом это задаёт. Если программное обеспечение, созданное проектом, не поддерживает сетевые коммуникации, выберите «неприменимо» (N/A). [crypto_used_network]

    All network communication is HTTPS — GitHub APIs, tool downloads, registry publishing, transparency-log submission. No insecure protocol appears anywhere in the tree, and certificate verification is never disabled.



    Если ПО, создаваемое проектом, поддерживает или использует TLS, НЕОБХОДИМО поддерживать как минимум версию TLS 1.2. Примечание: предшественник TLS называется SSL. Если программное обеспечение не использует TLS, выберите «неприменимо» (N/A). [crypto_tls12]

    The software does not implement or configure TLS; it invokes tools (git, gh, curl) whose TLS versions are theirs.


  • Доставка, защищенная от атак посредника (MITM)


    Веб-сайт проекта, репозиторий (если он доступен через Интернет) и сайт загрузки (если он существует отдельно) ОБЯЗАНЫ использовать упрочняющие безопасность (hardening) заголовки с неразрешающими значениями. (Требуется URL) [hardened_site]
    Обратите внимание, что GitHub отвечает этому критерию. Такие сайты как https://securityheaders.io/ могут быстро проверить использование. Ключевыми заголовками для упрочнения являются: Content Security Policy (CSP), HTTP Strict Transport Security (HSTS), X-Content-Type-Options (выставленный в «nosniff»), X-Frame-Options и X-XSS-Protection. Статические веб-сайты без возможности входа в систему через веб-страницы могут опускать упрочняющие HTTP-заголовки CSP и X-XSS-Protection, поскольку в этом случае эти заголовки менее эффективны.

    The project site is the GitHub repository itself, and it is served with key hardening headers - verified against the live URL: strict-transport-security: max-age=31536000; includeSubdomains; preload, content-security-policy: default-src 'none'; base-uri 'self', x-frame-options: deny, x-content-type-options: nosniff, referrer-policy: no-referrer-when-downgrade. There is no separate project website or download site to harden; releases are served from the same origin. https://github.com/monumental-archive/.github


  • Другие вопросы безопасности


    Проект ОБЯЗАН иметь проверку безопасности за последние 5 лет. При проверке НЕОБХОДИМО учитывать требования и границы безопасности. [security_review]
    Эта оценка МОЖЕТ быть выполнена членами проекта и/или независимо. Эта оценка МОЖЕТ подкрепляться инструментами статического и динамического анализа, но кроме этого должна быть проверка человеком для выявления проблем (особенно в дизайне), которые инструменты не могут обнаружить.

    docs/build-assessment.md and docs/source-assessment.md are security reviews written against this project's own security requirements and boundary, control by control, and docs/slsa-reference.md records what is claimed and what is deliberately not. They are current, not historical: the scheduled audit re-checks the claims they rest on. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md



    В ПО, создаваемом проектом, НЕОБХОДИМО использовать механизмы упрочнения безопасности (hardening), чтобы дефекты программного обеспечения с меньшей вероятностью приводили к уязвимостям в безопасности. (Требуется URL) [hardening]
    Механизмы упрочнения могут включать HTTP-заголовки, такие как Content Security Policy (CSP), флаги компилятора для противостояния атакам (например, -fstack-protector) или флаги компилятора, устраняющие неопределенное поведение. Для наших целей политика наименьших привилегий не считается механизмом упрочнения (использовать наименьшие достаточные привилегии важно, но этому посвящён отдельный критерий).

    Least-privilege permissions on every workflow; an enforced capability boundary forbidding id-token: write in any workflow that runs caller-supplied code, checked by lint:capability-boundary in the gate; every action pinned to a full commit SHA with checksums and attestations; keyless publishing with no standing credentials; secret scanning with push protection enforced organisation-wide. Each mechanism is written up control by control, against the threat it answers, in docs/build-assessment.md. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md


 Анализ 1/2

  • Динамический анализ кода


    Проект ОБЯЗАН применять хотя бы один инструмент динамического анализа к любой предлагаемой основной версии ПО, создаваемого проектом до её выпуска. [dynamic_analysis]
    Инструмент динамического анализа проверяет программное обеспечение, выполняя его с конкретными входными данными. Например, проект МОЖЕТ использовать инструмент фаззинг-тестирования (например, American Fuzzy Lop) или сканер веб-приложений (например, OWASP ZAP или w3af). В некоторых случаях проект OSS-Fuzz может быть готов применить фаззинг-тестирование к вашему проекту. Для целей этого критерия инструмент динамического анализа должен каким-то образом варьировать исходные данные, чтобы искать проблемы разного рода или быть автоматическим набором тестов с покрытием веток исполнения не менее 80%. Страница Википедии о динамическом анализе и cтраница OWASP о фаззинг-тестировании указывают некоторые инструменты динамического анализа. Использование инструмента/ов анализа МОЖЕТ, но не обязано быть сосредоточено на поиске уязвимостей в безопасности.

    Not met under this criterion's own definition, which requires a tool that varies its inputs, or an automated test suite with at least 80% branch coverage. The gate executes the shipped workflows and tasks on every pull request and release-lab runs the release path end to end, but neither varies inputs and branch coverage is not measured. CodeQL is static analysis and is claimed under static_analysis. Measuring branch coverage would close this criterion as well as the coverage ones.



    Проекту СЛЕДУЕТ включать достаточно много утверждений (assertions) времени выполнения в создаваемом им ПО и проверять эти утверждения во время динамического анализа. [dynamic_analysis_enable_assertions]
    Этот критерий не предполагает включения утверждений на этапе эксплуатации; решение об этом полностью лежит на проекте и его пользователях. Вместо этого критерий направлен на улучшение обнаружения ошибок во время динамического анализа перед развертыванием. Использование утверждений при эксплуатации полностью отличается от такового во время динамического анализа (например, при тестировании). В некоторых случаях включать утверждения при эксплуатации крайне неразумно (особенно в компонентах с высокой степенью целостности). Существует множество аргументов против включения утверждений в выпускаемых сборках: например, библиотеки не должны вызывать сбой при вызове, присутствие утверждений может привести к отклонению магазинами приложений и/или активация их при рабочем использовании может привести к раскрытию частных данных, таких как закрытые ключи. Помните, что во многих дистрибутивах Linux NDEBUG не определен, поэтому C/C++assert() в таких рабочих средах по умолчанию будет включен. Может быть важно использовать другой механизм утверждений или определить NDEBUG для эксплуатации в этих средах.

    There is no compiled code with run-time assertion facilities to enable. The nearest equivalent is always on rather than configured: every task runs under set -euo pipefail and the belt's checks fail loudly rather than skip silently.



Эти данные доступны по лицензии Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника Carl Allen и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: Carl Allen.
2026-08-13 07:47:41 UTC, последнее изменение сделано 2026-08-13 19:08:33 UTC. Последний раз условия для получения значка были выполнены 2026-08-13 08:01:08 UTC.