cpace

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

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

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


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

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

        

 Основы

  • Общая

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

    The README at https://github.com/the-sarge/cpace clearly states: “CPace draft-irtf-cfrg-cpace-21 implementation for the CPACE-RISTR255-SHA512 suite, written in Go. It provides an auditable draft implementation that is not yet production-ready.”

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

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

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


    Когда задача CI/CD выполняется без указания прав доступа, система CI/CD ОБЯЗАНА по умолчанию назначать задаче минимальные права, предоставленные в конвейере. [OSPS-AC-04.01]
    Настройте параметры проекта для назначения минимальных доступных прав новым конвейерам по умолчанию, предоставляя дополнительные права только при необходимости для конкретных задач.

    GitHub Actions workflows for this project follow the principle of least privilege. When permissions are not explicitly defined at the job level, the workflows default to the minimum required permissions (read-only where possible). The project’s CI security policy and practices are documented in docs/ci-policy.md.
    https://github.com/the-sarge/cpace/blob/main/docs/ci-policy.md



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

    Official releases are created using Git tags with unique version identifiers following semantic versioning (e.g. v0.1.0, v0.2.0). Each release is documented in CHANGELOG.md and follows the release process defined in docs/release-checklist.md.
    https://github.com/the-sarge/cpace/tags
    https://github.com/the-sarge/cpace/blob/main/CHANGELOG.md



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН содержать описательный журнал функциональных изменений и изменений безопасности. [OSPS-BR-04.01]
    Убедитесь, что все выпуски содержат описательный журнал изменений. Рекомендуется обеспечить, чтобы журнал изменений был читаемым человеком и содержал более подробные сведения, чем сообщения коммитов, такие как описания влияния на безопасность или релевантность для различных сценариев использования. Для обеспечения машиночитаемости размещайте содержимое под заголовком markdown, таким как "## Changelog".

    Non-trivial release notes file in repository: https://github.com/the-sarge/cpace/blob/main/CHANGELOG.md. [release_notes]



    Когда конвейер сборки и выпуска загружает зависимости, он ОБЯЗАН использовать стандартизированные инструменты, где они доступны. [OSPS-BR-05.01]
    Используйте общие инструменты для вашей экосистемы, такие как менеджеры пакетов или инструменты управления зависимостями для загрузки зависимостей во время сборки. Это может включать использование файла зависимостей, lock-файла или манифеста для указания требуемых зависимостей, которые затем подключаются системой сборки.

    The project uses Go modules as the standardized tooling for ingesting dependencies. All builds, tests, and CI pipelines use the official Go toolchain (go mod, go build, go test, etc.) via go.mod and go.sum.
    https://github.com/the-sarge/cpace/blob/main/go.mod



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН быть подписан или учтен в подписанном манифесте, включающем криптографические хеши каждого актива. [OSPS-BR-06.01]
    Подписывайте все выпущенные программные активы во время сборки с использованием криптографической подписи или аттестаций, таких как подпись GPG или PGP, подписи Sigstore, происхождение SLSA или SLSA VSA. Включите криптографические хеши каждого актива в подписанный манифест или файл метаданных.

    Official releases are signed annotated Git tags, verified with git verify-tag. The project currently publishes no attached binary release assets; future release assets will be signed directly or listed in a signed hash manifest. No binary release assets are attached. Users can verify the release with git verify-tag vX.Y.Z.



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

    The project uses Go modules for selecting, obtaining, and tracking dependencies via go.mod and go.sum. The process for reviewing and managing dependencies is documented in docs/dependency-review.md.
    https://github.com/the-sarge/cpace/blob/main/docs/dependency-review.md
    https://github.com/the-sarge/cpace/blob/main/go.mod



    Документация проекта ДОЛЖНА включать инструкции по сборке программного обеспечения, включая необходимые библиотеки, фреймворки, SDK и зависимости. [OSPS-DO-07.01]
    Рекомендуется публиковать эту информацию вместе с документацией для участников проекта, например в файле CONTRIBUTING.md или другой документации по задачам разработчика. Это также может быть задокументировано с помощью целей Makefile или других сценариев автоматизации.

    Build instructions are provided via Taskfile.yml (commands such as task quick, task check, task check:changed) and the README. The project uses the standard Go toolchain and documents validation steps. Full build documentation will be expanded as the project approaches production readiness.
    https://github.com/the-sarge/cpace/blob/main/Taskfile.yml
    https://github.com/the-sarge/cpace/blob/main/README.md



    Пока проект активен, документация проекта ОБЯЗАНА включать список членов проекта с доступом к критическим ресурсам. [OSPS-GV-01.01]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта. Это может быть просто включение имен или учетных записей в список сопровождающих или более сложное в зависимости от управления проектом.

    The project is currently maintained by a single individual (the repository owner the-sarge). This person has administrative access to all sensitive resources (repository settings, secrets, branch protection, etc.). There are no additional project members or collaborators with access to sensitive resources at this time.



    Пока проект активен, документация проекта ОБЯЗАНА включать описания ролей и обязанностей для членов проекта. [OSPS-GV-01.02]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта.

    The project is maintained by a single individual who serves as the primary maintainer and owner. Key responsibilities include code development and review, release management, security oversight, dependency management, responding to issues and vulnerability reports, and maintaining project documentation.



    Пока проект активен, документация проекта ОБЯЗАНА включать руководство для участников кода, которое включает требования к приемлемым вкладам. [OSPS-GV-03.02]
    Расширьте содержимое CONTRIBUTING.md или CONTRIBUTING/ в документации проекта, чтобы изложить требования к приемлемым вкладам, включая стандарты кодирования, требования к тестированию и руководства по отправке для участников кода. Рекомендуется, чтобы это руководство было источником истины как для участников, так и для утверждающих.

    The project maintains a detailed contributor guide in CONTRIBUTING.md that outlines the contribution process, coding standards, and requirements for acceptable contributions.
    https://github.com/the-sarge/cpace/blob/main/CONTRIBUTING.md



    Пока проект активен, система контроля версий ОБЯЗАНА требовать от всех участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. [OSPS-LE-01.01]
    Включите DCO в репозиторий проекта, требуя от участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. Используйте проверку статуса, чтобы убедиться, что утверждение сделано. CLA также удовлетворяет этому требованию. Некоторые системы контроля версий, такие как GitHub, могут включать это в условия обслуживания платформы.

    The project requires DCO signoff for contributions. GitHub web-based commit signoff is enabled, CONTRIBUTING.md documents git commit -s, the repository includes the DCO text, and pull requests are checked by a required DCO GitHub Actions status that verifies every PR commit has a Signed-off-by trailer.
    https://github.com/the-sarge/cpace/blob/main/CONTRIBUTING.md
    https://github.com/the-sarge/cpace/blob/main/DCO



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

    Branch protection rules are enabled on the primary branch (main). All automated status checks from the CI pipeline (including tests and security scans) must pass before changes can be merged to the primary branch. Administrators may manually bypass checks when necessary.
    https://github.com/the-sarge/cpace/settings/branches



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

    The project’s GitHub Actions CI pipeline automatically runs the full test suite (go test ./..., vector tests, fuzz tests, and validation via Taskfile.yml) on every pull request before changes are merged to the primary branch.
    https://github.com/the-sarge/cpace/blob/main/Taskfile.yml



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

    The project maintains design and security documentation, including docs/threat-model.md and docs/security-assessment.md, which describe the system architecture, actions, actors, and security boundaries.
    https://github.com/the-sarge/cpace/blob/main/docs/threat-model.md



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

    The external interfaces of the library are documented in the README.md, which describes the public API usage (Initiator/Responder flow, Start/Respond/Finish methods, Session handling, etc.). Additional details are available in the Go source code via godoc comments.
    https://github.com/the-sarge/cpace/blob/main/README.md



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

    The project has conducted a security assessment, documented in docs/security-assessment.md, which identifies the most likely and impactful potential security problems along with associated mitigations and controls.
    https://github.com/the-sarge/cpace/blob/main/docs/security-assessment.md



    Пока проект активен, документация проекта ДОЛЖНА включать политику координированного раскрытия уязвимостей (CVD) с четко определенными сроками ответа. [OSPS-VM-01.01]
    Создайте файл SECURITY.md в корневом каталоге, описывающий политику проекта для координированного раскрытия уязвимостей. Включите метод сообщения об уязвимостях. Установите ожидания относительно того, как проект будет реагировать и решать сообщенные проблемы.

    The project maintains a vulnerability disclosure policy in SECURITY.md. Reports are directed to private channels (email or GitHub private vulnerability reporting). The project commits to acknowledging vulnerability reports within 7 calendar days, providing initial triage/status within 14 calendar days, coordinating disclosure timing with reporters, and providing periodic updates while confirmed issues are unresolved.
    https://github.com/the-sarge/cpace/blob/main/SECURITY.md



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

    Private vulnerability reporting is available directly to the project’s security contact via email (the-sarge@the-sarge.com) and through GitHub’s private vulnerability reporting feature, as documented in SECURITY.md.
    https://github.com/the-sarge/cpace/blob/main/SECURITY.md



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

    The project commits to publicly disclosing discovered vulnerabilities through GitHub Security Advisories and updates to the CHANGELOG.md. No vulnerabilities have been publicly disclosed to date as the project remains in draft stage.
    https://github.com/the-sarge/cpace/blob/main/CHANGELOG.md



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

Владелец анкеты на значок проекта: Joshua Sargent.
2026-05-07 03:42:31 UTC, последнее изменение сделано 2026-05-08 06:16:03 UTC. Последний раз условия для получения значка были выполнены 2026-05-08 06:16:03 UTC.