.github

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

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

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


Это критерии Базового Уровня 3. Это критерии версии v2026.02.19.

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

        

 Основы

  • Общая

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

    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) - это структурированная схема именования для информационных систем, программного обеспечения и пакетов. Она используется в ряде систем и баз данных для отчетов об уязвимостях.

 Элементы управления 20/21

  • Элементы управления


    Когда задаче назначаются разрешения в конвейере CI/CD, исходный код или конфигурация ДОЛЖНЫ назначать только минимальные привилегии, необходимые для соответствующей деятельности. [OSPS-AC-04.02]
    Настройте конвейеры CI/CD проекта так, чтобы по умолчанию назначать пользователям и службам наименьшие доступные разрешения, повышая разрешения только когда это необходимо для конкретных задач. В некоторых системах контроля версий это может быть возможно на уровне организации или репозитория. Если нет, установите разрешения на верхнем уровне конвейера.

    Every workflow declares an explicit permissions: block scoped to what that job actually needs, on top of a read-only default set by the repository baseline. The strongest case is enforced by a lint: no workflow that runs caller-supplied code may hold id-token: write, and lint:capability-boundary fails the build if one ever does.



    Конвейеры CI/CD, принимающие входные данные от доверенных коллабораторов, ДОЛЖНЫ санировать и проверять эти входные данные перед их использованием в конвейере. [OSPS-BR-01.04]
    Конвейеры CI/CD должны санировать (заключать в кавычки, экранировать или завершаться при ожидаемых значениях) все входные данные коллабораторов при явном выполнении рабочих процессов. Хотя коллабораторы в целом являются доверенными, ручные входные данные для рабочего процесса не могут быть проверены и могут быть использованы в злоумышленных целях при захвате учётной записи или угрозе изнутри.

    Collaborator-supplied input is validated rather than trusted: workflow inputs are checked against allowlists (the artifact classes: set, the release-stub shape), and zizmor fails the gate on any pattern that would interpolate untrusted context into a shell.



    Когда создается официальный релиз, все активы в этом релизе ДОЛЖНЫ быть четко связаны с идентификатором релиза или другим уникальным идентификатором для актива. [OSPS-BR-02.02]
    Назначьте уникальный идентификатор версии каждому программному активу, произведенному проектом, следуя единообразному соглашению об именовании или схеме нумерации. Примеры включают SemVer, CalVer или идентификатор git-коммита.

    Verified on the published release: assets are named for the release identifier (github-1.22.2.tar.gz, github-1.22.2.spdx.json) and each is additionally bound by cryptographic digest in checksums.txt and in the attestations.intoto.jsonl evidence bundle, so the association survives a rename. https://github.com/monumental-archive/.github/releases/tag/v1.22.2



    НЕОБХОДИМО, чтобы проект определил политику управления секретами и учетными данными, используемыми проектом. Политика должна включать руководства по хранению, доступу и ротации секретов и учетных данных. [OSPS-BR-07.02]
    Задокументируйте, как секреты и учетные данные управляются и используются в рамках проекта. Это должно включать подробную информацию о том, как хранятся секреты (например, с использованием инструмента управления секретами), как контролируется доступ, и как секреты ротируются или обновляются. Убедитесь, что конфиденциальная информация не встроена в исходный код и не хранится в системах контроля версий.

    docs/continuity.md is the secrets policy in operational form: an asset table naming every credential the project uses, where it is stored, who can reach it, and how it is rotated or recreated — including the one standing token, whose expiry is designed to fail loudly rather than silently under-claim. The policy is short because the architecture removes most secrets: publishing is keyless via OIDC and trusted publishing, and no signing key exists to store. https://github.com/monumental-archive/.github/blob/main/docs/continuity.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА содержать инструкции по проверке целостности и подлинности активов релиза. [OSPS-DO-03.01]
    Инструкции в проекте должны содержать информацию об используемой технологии, командах для выполнения и ожидаемом выводе. По возможности избегайте хранения этой документации в том же месте, что и конвейер сборки и выпуска, чтобы избежать компрометации как программного обеспечения, так и документации для проверки целостности программного обеспечения в случае единичного нарушения безопасности.

    docs/runbook.md has a section written from the consumer's position — 'Verifying as a consumer would' — giving the commands to check a release's attestations and Sigstore evidence bundle against the published digests. https://github.com/monumental-archive/.github/blob/main/docs/runbook.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА содержать инструкции по проверке ожидаемой личности человека или процесса, создающего программный релиз. [OSPS-DO-03.02]
    Ожидаемая личность может быть в форме идентификаторов ключей, используемых для подписи, эмитента и личности из сертификата sigstore или других подобных форм. По возможности избегайте хранения этой документации в том же месте, что и конвейер сборки и выпуска, чтобы избежать компрометации как программного обеспечения, так и документации для проверки целостности программного обеспечения в случае единичного нарушения безопасности.

    The same documentation covers authorship identity, which in a keyless design is the workflow identity: verification checks the signer's workflow ref in the certificate rather than a personal key, and the release tooling exposes an explicit signer-workflow flag so a consumer can assert which identity must have signed. https://github.com/monumental-archive/.github/blob/main/docs/runbook.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать описательное заявление о масштабе и сроках поддержки для каждого релиза. [OSPS-DO-04.01]
    Для информирования о масштабе и сроках поддержки выпущенных программных активов проекта, проект должен иметь файл SUPPORT.md, раздел "Поддержка" в SECURITY.md или другую документацию, объясняющую жизненный цикл поддержки, включая ожидаемую продолжительность поддержки для каждого релиза, типы предоставляемой поддержки (например, исправления ошибок, обновления безопасности) и любые соответствующие политики или процедуры получения поддержки.

    SECURITY.md section 'Supported versions and end of life' states the scope and duration of support: only the latest release of each project receives security updates, fixes ship by rolling forward from main rather than by backporting, and a release is therefore supported exactly until the next release exists. There are no long-term support branches and no announced support windows. A repository with different needs states its own policy in its own SECURITY.md, which then replaces this one for that repository. https://github.com/monumental-archive/.github/blob/main/SECURITY.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА предоставлять описательное заявление о том, когда релизы или версии больше не будут получать обновления безопасности. [OSPS-DO-05.01]
    Для информирования о масштабе и сроках поддержки исправлений безопасности, проект должен иметь SUPPORT.md или другую документацию, объясняющую политику проекта в отношении обновлений безопасности.

    The same section states when a release stops receiving security updates: a release is end-of-life for security purposes at the point the next release exists, since fixes ship only by rolling forward from main. This is a deliberate consequence of the release design - every release stays reproducible and its evidence permanent, but maintenance effort goes to the tip. https://github.com/monumental-archive/.github/blob/main/SECURITY.md



    Пока проект активен, документация проекта ДОЛЖНА содержать политику, согласно которой участники кода проверяются перед предоставлением повышенных разрешений на доступ к критическим ресурсам. [OSPS-GV-04.01]
    Опубликуйте исполняемую политику в документации проекта, которая требует, чтобы участники кода были проверены и одобрены до предоставления повышенных разрешений на доступ к критическим ресурсам, таким как одобрение слияния или доступ к секретам. Рекомендуется, чтобы проверка включала установление обоснованной линии идентичности, такой как подтверждение связи участника с известной доверенной организацией.

    GOVERNANCE.md section 'Escalation and permissions' carries the policy: a collaborator is reviewed before being granted any escalated permission. Concretely, before an account joins @monumental-archive/owners or receives write access anywhere, the maintainer reviews who they are, why the access is needed and what the smallest sufficient grant is - and the grant is then recorded in the settings-as-code baseline so drift is auditable. https://github.com/monumental-archive/.github/blob/main/GOVERNANCE.md#escalation-and-permissions



    Когда проект выпустил релиз, все скомпилированные выпущенные программные активы ДОЛЖНЫ поставляться со списком компонентов программного обеспечения (Software Bill of Materials). [OSPS-QA-02.02]
    Рекомендуется автоматически генерировать SBOM во время сборки с использованием инструмента, который был проверен на точность. Это позволяет пользователям получать эти данные стандартизированным способом наряду с другими проектами в их среде.

    Every release ships an SPDX software bill of materials as a release asset — verified on v1.22.2: github-1.22.2.spdx.json, alongside github-1.22.2.tar.gz, checksums.txt and the attestations.intoto.jsonl evidence bundle. The SBOM is generated by the release pipeline (release/generate-sbom.sh) rather than hand-maintained. Previously answered N/A on the grounds that this repository compiles nothing; that was technically available but less true than the facts — the SBOM is published regardless. https://github.com/monumental-archive/.github/releases/tag/v1.22.2



    Когда проект выпустил релиз, состоящий из нескольких репозиториев исходного кода, все подпроекты ДОЛЖНЫ применять требования безопасности, которые являются столь же строгими или более строгими, чем первичная кодовая база. [OSPS-QA-04.02]
    Любые дополнительные репозитории кода подпроектов, созданные проектом и скомпилированные в релиз, должны применять требования безопасности в соответствии со статусом и целями соответствующей кодовой базы. В дополнение к следованию соответствующим требованиям OSPS Baseline, это может включать требование проверки безопасности, обеспечение отсутствия уязвимостей и обеспечение отсутствия известных проблем безопасности.

    A release of this project comprises this single source repository; there are no subprojects releasing alongside it. Other repositories in the organisation consume this one's governance, which is by construction as strict or stricter.



    Пока проект активен, документация проекта ДОЛЖНА четко документировать, когда и как выполняются тесты. [OSPS-QA-06.02]
    Добавьте раздел в документацию по участию в проекте, объясняющий, как запускать тесты локально и как запускать тесты в конвейере CI/CD. Документация должна объяснять, что тестируют тесты и как интерпретировать результаты.

    Documented in both places a reader would look: README.md states that mise run ci locally is exactly what CI runs, and CONTRIBUTING.md makes a green gate a requirement for every change. When they run is equally explicit — on every pull request and every push to main, with the network-bound checks on a Monday schedule. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md



    Пока проект активен, документация проекта ДОЛЖНА включать политику, согласно которой все значительные изменения программного обеспечения, производимого проектом, должны добавлять или обновлять тесты функциональности в автоматизированном наборе тестов. [OSPS-QA-06.03]
    Добавьте раздел в документацию по участию в проекте, объясняющий политику добавления или обновления тестов. Политика должна объяснять, что представляет собой значительное изменение и какие тесты должны быть добавлены или обновлены.

    CONTRIBUTING.md, item 3 of 'Requirements for acceptable contributions', is the policy and it sits in the contributor-facing documentation: a change that adds or changes behaviour adds the check that holds it - a test that fails without the change where a test suite exists, or a lint, audit task or workflow assertion where the product is configuration and policy - and a bug fix adds the case that reproduced the bug. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md



    Когда совершается коммит в основную ветку, система контроля версий проекта ДОЛЖНА требовать как минимум одного одобрения изменений человеком, не являющимся автором, перед слиянием. [OSPS-QA-07.01]
    Настройте систему контроля версий проекта так, чтобы она требовала как минимум одного одобрения изменений человеком, не являющимся автором, перед слиянием в релизную или основную ветку. Это можно достичь, требуя, чтобы запрос на включение изменений был рассмотрен и одобрен как минимум одним другим участником, прежде чем его можно будет объединить.

    With a single maintainer there is no non-author human approval available, so this is not enforced. It is the headcount wall this project records rather than works around: the same boundary as Gold's two_person_review and SLSA Source L4, tracked as an open issue rather than quietly claimed. https://github.com/monumental-archive/.github/blob/main/docs/slsa-reference.md



    Когда проект выпустил релиз, проект ДОЛЖЕН выполнить моделирование угроз и анализ поверхности атаки для понимания и защиты от атак на критические пути кода, функции и взаимодействия внутри системы. [OSPS-SA-03.02]
    Моделирование угроз - это деятельность, при которой проект рассматривает кодовую базу, связанные процессы и инфраструктуру, интерфейсы, ключевые компоненты и "думает как хакер", проводя мозговой штурм о том, как система может быть взломана или скомпрометирована. Каждая выявленная угроза перечисляется, чтобы проект мог затем подумать о том, как проактивно избежать или закрыть любые бреши/уязвимости, которые могут возникнуть. Убедитесь, что это обновляется для новых функций или критических изменений.

    docs/build-assessment.md and docs/source-assessment.md carry the threat model and attack-surface analysis: the critical paths are named (caller code reaching a privileged signing identity, unpinned supply-chain substitution, silent settings drift, forged signer identities in the transparency log), each with the control that protects it and the residual risk accepted. https://github.com/monumental-archive/.github/blob/main/docs/build-assessment.md



    Пока активен, любые уязвимости в программных компонентах, не затрагивающие проект, ДОЛЖНЫ быть учтены в документе VEX, дополняющем отчет об уязвимостях деталями о неэксплуатируемости. [OSPS-VM-04.02]
    Создайте поток VEX, сообщающий о статусе эксплуатируемости известных уязвимостей, включая детали оценки или любые меры по смягчению, препятствующие выполнению уязвимого кода.

    Exactly this: the dependency track emits VEX documents keyed by package@version recording non-exploitability decisions for advisories that do not affect the project, with coverage derived rather than asserted, and the release path refuses to publish while an advisory in the SBOM is undecided. https://github.com/monumental-archive/.github/blob/main/docs/dependency-track.md



    Пока активна, документация проекта ДОЛЖНА включать политику, определяющую порог для устранения результатов SCA, связанных с уязвимостями и лицензиями. [OSPS-VM-05.01]
    Задокументируйте в проекте политику, определяющую порог для устранения результатов SCA, связанных с уязвимостями и лицензиями. Включите процесс выявления, приоритизации и устранения этих результатов.

    docs/dependency-track.md defines the thresholds: cargo-deny bans and licence rules are deterministic and fail the gate, sources are restricted to a single registry with unknown-registry and unknown-git denied, and every advisory must exit through an explicit decision rather than being left open. https://github.com/monumental-archive/.github/blob/main/docs/dependency-track.md



    Пока активна, документация проекта ДОЛЖНА включать политику для устранения нарушений SCA до любого релиза. [OSPS-VM-05.02]
    Задокументируйте в проекте политику для устранения применимых результатов анализа состава программного обеспечения перед любым релизом и добавьте проверки статуса, которые подтверждают соответствие этой политике перед релизом.

    The policy is enforced at the release boundary, not merely stated: the release path refuses to publish with an undecided advisory in its SBOM. It has already blocked a real release in the lab rather than being theoretical. https://github.com/monumental-archive/.github/blob/main/docs/dependency-track.md



    Пока активны, все изменения в кодовой базе проекта ДОЛЖНЫ автоматически оцениваться на соответствие задокументированной политике по вредоносным зависимостям и известным уязвимостям в зависимостях, а затем блокироваться в случае нарушений, за исключением случаев, когда они объявлены и подавлены как неэксплуатируемые. [OSPS-VM-05.03]
    Создайте проверку статуса в системе контроля версий проекта, которая запускает инструмент анализа состава программного обеспечения для всех изменений в кодовой базе. Требуйте, чтобы проверка статуса проходила успешно, прежде чем изменения могут быть объединены.

    Automatically, on every change: cargo-deny runs deterministically in the gate over the lockfile and the committed deny.toml, dependency-review runs on every pull request, and Renovate and Dependabot raise updates as advisories land. The policy those checks enforce is written in docs/dependency-track.md. https://github.com/monumental-archive/.github/blob/main/docs/dependency-track.md



    Пока активна, документация проекта ДОЛЖНА включать политику, определяющую порог для устранения результатов SAST. [OSPS-VM-06.01]
    Задокументируйте в проекте политику, определяющую порог для устранения результатов статического тестирования безопасности приложений (SAST). Включите процесс выявления, приоритизации и устранения этих результатов.

    SECURITY.md section 'Static analysis policy' defines the remediation threshold, and it is zero: any SAST finding - CodeQL, the lint belt, zizmor and peers - fails the CI gate, and a red gate cannot merge, so findings are remediated or explicitly and reviewably suppressed with a written reason before the change lands. There is no severity triage queue for static findings because there is no state in which one is outstanding on a default branch. https://github.com/monumental-archive/.github/blob/main/SECURITY.md



    Пока активны, все изменения в кодовой базе проекта ДОЛЖНЫ автоматически оцениваться на соответствие задокументированной политике по слабым местам безопасности и блокироваться в случае нарушений, за исключением случаев, когда они объявлены и подавлены как неэксплуатируемые. [OSPS-VM-06.02]
    Создайте проверку статуса в системе контроля версий проекта, которая запускает инструмент статического тестирования безопасности приложений (SAST) для всех изменений в кодовой базе. Требуйте, чтобы проверка статуса проходила успешно, прежде чем изменения могут быть объединены.

    Every change is automatically evaluated and blocked on violation: CodeQL default setup is enforced organisation-wide, and shellcheck, actionlint, zizmor and trivy run in the gate, which is a required status check that a pull request cannot merge past. The requirement that the gate pass is documented in CONTRIBUTING.md; what is missing is only a stated severity threshold, recorded honestly under osps_vm_06_01. https://github.com/monumental-archive/.github/blob/main/CONTRIBUTING.md



Эти данные доступны по лицензии 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.