WhitePact

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

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

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


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

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

        

 Основы 17/17

  • Общая

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

    WhitePact is an open-source runtime authority, governance, and assurance layer for autonomous systems. It provides deterministic five-way authorization decisions (ALLOW, ALLOW_WITH_REDACTION, REQUIRE_APPROVAL, DENY, QUARANTINE), policy and risk enforcement, human approval workflows, tamper-evident evidence, MCP governance, trust controls, guardrails, and enterprise integration tooling.

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


    Проект ОБЯЗАН получить значок уровня Passing. [achieve_passing]

  • Основная информация на веб-сайте проекта


    В информацию о том, как внести вклад, НЕОБХОДИМО включить требования к приемлемым взносам (например, ссылку на любой требуемый стандарт кодирования). (Требуется URL) [contribution_requirements]

    The contribution requirements are documented in CONTRIBUTING.md, including development setup, testing requirements, pull request guidelines, CI requirements, Ruff formatting/linting, mypy type checking, public-function typing requirements, and security-related engineering principles.https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md


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


    Проекту СЛЕДУЕТ иметь юридический механизм, через который все авторы содержательных взносов в ПО проекта подтверждают, что они имеют законное право на внесение этих взносов. Самый распространенный и легко реализуемый подход для этого заключается в использовании Developer Certificate of Origin (DCO), при котором пользователи добавляют строку "signed-off-by" в свои коммиты, а проект ссылается на веб-сайт DCO. Но этот механизм МОЖЕТ быть реализован и в качестве Лицензионного соглашения с участниками (Contributor License Agreement, CLA) или другого правового механизма. (Требуется URL) [dco]
    DCO является рекомендуемым механизмом, потому что его легко реализовать и отслеживать в исходном коде, а git напрямую поддерживает функцию "signed-off" при помощи "commit -s". Для большей эффективности лучше всего, если проектная документация объясняет, что означает "signed-off" для этого проекта. CLA - это юридическое соглашение, которое определяет условия, на которых произведения умственного труда были лицензированы для организации или проекта. Соглашение о назначении участника (contributor assignment agreement, CAA) является юридическим соглашением, которое передает права на произведения умственного труда другой стороне; проекты не обязаны иметь CAA, поскольку CAA увеличивает риск того, что потенциальные участники не будут вносить свой вклад, особенно если получатель является коммерческой организацией. Лицензии CLA от Apache Software Foundation (лицензия отдельного участника и корпоративное соглашение CLA) являются примерами CLA для проектов, считающих, что риски от такого рода CLA для проекта меньше, чем их преимущества.

    WhitePact adopts the Developer Certificate of Origin (DCO) 1.1 for non-trivial contributions. Contributors are required to certify their right to contribute by adding a Signed-off-by trailer to each commit using git commit -s.

    The requirement and contributor instructions are documented in CONTRIBUTING.md, and pull-request commits are automatically checked by CI.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md



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

    WhitePact publicly documents its project governance model in GOVERNANCE.md. The project is explicitly founder-led and documents decision-making authority, code-change and merge decisions, architecture and roadmap decisions, release authority, contribution rules, security responsibilities, and current governance limitations.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/GOVERNANCE.md



    Проект ОБЯЗАН определить правила поведения и разместить эти правила в стандартном месте. (Требуется URL) [code_of_conduct]
    Проекты могут повысить цивилизованность их сообщества и установить ожидания относительно приемлемого поведения, приняв правила поведения. Это может помочь избежать проблем до их возникновения и сделать проект более привлекательным местом, поощряющим участие. Правила должны быть сосредоточены только на поведении в сообществе или на рабочем месте проекта. Примерами правил поведения являются правила конфликтов на проекте ядра Linux, Contributor Covenant Code of Conduct, Кодекс поведения Debian, Ubuntu Code of Conduct, Правила поведения проекта Fedora, GNOME Code Of Conduct, KDE Community Code of Conduct">, Python Community Code of Conduct, The Ruby Community Conduct Guideline и The Rust Code of Conduct.

    WhitePact has adopted and publicly maintains a Code of Conduct in the repository root. It defines expected and unacceptable behavior, project scope, enforcement responsibilities, confidential reporting instructions, and attribution to Contributor Covenant 2.1.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CODE_OF_CONDUCT.md



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

    WhitePact publicly documents the project's current roles and responsibilities in GOVERNANCE.md, including the founder/maintainer, security contact, incident commander, risk owner, merge/release authority, and responsibility for project decisions.

    The document also clearly identifies who currently holds each role rather than implying roles or committees that do not exist.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/GOVERNANCE.md



    Проект ОБЯЗАН быть в состоянии продолжать работу с минимальным прерыванием, если какой-либо человек окажется недееспособен или убит. В частности, проект ОБЯЗАН быть в состоянии создавать и закрывать вопросы в трекере, принимать предложенные изменения и выпускать версии программного обеспечения через неделю после подтверждения того, что данный человек недееспособен или убит. Это МОЖЕТ быть реализовано через обеспечение кого-то ещё необходимыми ключами, паролами и законными правами для продолжения проекта. Лица, которые запускают проект СПО, МОГУТ сделать это, оставив ключи в сейфе и завещание, передающее все необходимые юридические права (например, для имен DNS). (Требуется URL) [access_continuity]

    WhitePact maintains an established project-continuity mechanism designed to allow the project to continue if the primary maintainer becomes unavailable.

    The continuity arrangement covers recovery and continuity for the source repository, domain/DNS, release publishing, project infrastructure, security reporting, and other critical project assets, with a documented objective of restoring the ability to manage issues, accept changes, and release software within seven days.

    No recovery credentials or secrets are stored in the public repository.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/compliance/PROJECT_CONTINUITY_PLAN.md



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

    WhitePact currently has a bus factor of 1 because its active development and project-maintenance responsibilities are still primarily held by one maintainer. Project continuity mechanisms have been established separately, but a second independent maintainer with equivalent technical project knowledge has not yet been fully established.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/GOVERNANCE.md


  • Документация


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

    WhitePact maintains a public roadmap covering more than the next twelve months. It documents current work, upcoming phases, longer-term phases, dependencies, exit criteria, deferred work, and features or initiatives the project explicitly will not build yet.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/ROADMAP.md



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

    WhitePact maintains a public architecture specification in SPEC.md describing the system's high-level design, runtime governance pipeline, core entities, identity and authority models, policy and risk evaluation, governance decisions, persistence, evidence, approvals, MCP integration, and implementation boundaries.

    The specification explicitly distinguishes implemented capabilities from target architecture.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/SPEC.md



    Проект ОБЯЗАН документировать то, что пользователь может и чего он не должен ожидать с точки зрения безопасности от ПО, создаваемого проектом (его «требования безопасности»). (Требуется URL) [documentation_security]
    Это требования безопасности, выполнение которых ожидается от ПО.

    WhitePact publicly documents what users can and cannot expect from the project's security model. ENTERPRISE_SECURITY.md covers authentication, API-key handling, OIDC/SSO, tenant isolation, encryption responsibilities, TLS, audit integrity, security boundaries, vulnerability handling, deployment responsibilities, and known limitations.

    The documentation explicitly distinguishes actual security guarantees from unsupported assumptions and future controls.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/ENTERPRISE_SECURITY.md



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

    WhitePact provides a public quick-start guide in README.md. It includes installation commands, a 30-second quickstart, instructions for starting the application, an immediately usable API example, expected output, and links to the dashboard and interactive API documentation.

    https://github.com/Guruprasath-Annadurai/Whitepact#30-second-quickstart



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

    WhitePact maintains project documentation alongside the current software implementation. Documentation is reviewed for version, feature-status, architecture, security, installation, compatibility, accessibility, internationalization, and OpenSSF-status consistency, and known stale statements discovered during the Silver review have been corrected.

    Documentation consistency is treated as a project defect when discrepancies are identified.



    НЕОБХОДИМО размещать ссылку на любые свои достижения, включая этот значок передовой практики, на главной странице проекта и/или веб-сайте в течение 48 часов после открытого признания достижения. (Требуется URL) [documentation_achievements]
    Достижением считается любой набор внешних критериев, над выполнением которых проект специально работал, включая некоторые значки. Эта информация не обязательно должна находиться на главной странице веб-сайта проекта. Проект с использованием GitHub может помещать достижения на главную страницу хранилища кода, добавляя их в файл README.

    WhitePact publicly identifies and links its recognized project achievements from the repository front page, including OpenSSF Best Practices, OpenSSF OSPS Baseline, and OpenSSF Scorecard status.

    https://github.com/Guruprasath-Annadurai/Whitepact


  • Общедоступность и интернационализация


    Проекту (как на сайтах проекта, так и в результатах работы проекта) СЛЕДУЕТ придерживаться передовой практики общедоступности, чтобы люди с ограниченными возможностями могли участвовать в проекте и использовать результаты проекта, где это имеет смысл. [accessibility_best_practices]
    Для веб-приложений см. Руководство по обеспечению доступности веб-контента (WCAG) 2.0 и его поддерживающий документ Understanding WCAG 2.0; см. также W3C accessibility information. Для приложений с графическим интерфейсом рассмотрите использование соответствующих вашему окружению рекомендаций по обеспечению доступности (таких как GNOME, KDE, XFCE, Android, iOS, Mac и Windows (на русском)). Некоторые приложения с текстовым интерфейсом пользователя (например, программы на ncurses) могут сделать некоторые вещи, чтобы сделать себя более доступными (например, параметр `force-arrow-cursor` в `alpine`). Большинство приложений командной строки довольно общедоступны как они есть. Этот критерий часто неприменим, например, для библиотек программ. Вот несколько примеров действий или проблем, которые следует учитывать:
    • Должны предоставляться текстовые альтернативы для любого нетекстового контента, так чтобы его можно изменить на другие необходимые формы, например крупная печать, шрифт Брайля, озвучка текста, символы или упрощенный язык (Understanding WCAG 2.0 guideline 1.1)
    • Цвет не должен использоваться в качестве единственного визуального средства передачи информации, указания на действие, запрос реакции пользователя или выделения визуальных элементов. (WCAG 2.0 guideline 1.4.1)
    • Визуальное представление текста и изображений текста должно иметь контрастность не менее 4,5:1, за исключением большого текста, случайного текста и логотипов (WCAG 2.0 guideline 1.4.3)
    • Все функциональные возможности должны быть доступны с клавиатуры (WCAG guideline 2.1)
    • GUI или веб-проект ДОЛЖНЫ тестировать, по крайней мере, одно средство чтения экрана на целевой платформе(ах) (например, NVDA, Jaws или WindowEyes в Windows; VoiceOver на Mac и iOS; Orca на Linux/BSD; TalkBack на Android). Программы с текстовым интерфейсом пользователя МОГУТ по возможности сокращать переписывание текста на экране, чтобы предотвратить лишнее чтение средствами чтения экрана.

    WhitePact follows documented accessibility best practices for its user-facing dashboard. The project targets WCAG 2.1 AA and uses pa11y-ci/axe-based automated accessibility analysis across 30 public and dashboard pages as a hard CI gate.

    The accessibility remediation process identified and fixed real issues involving contrast, accessible names, form controls, and other markup, with both light and dark color schemes verified.

    Known limitations and the process for reporting accessibility defects are publicly documented.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/docs/ACCESSIBILITY.md



    Проекту СЛЕДУЕТ интернационализировать создаваемое ПО, чтобы обеспечить легкую локализацию под культуру, регион или язык целевой аудитории. Выберите «неприменимо» (N/A), если интернационализация (i18n) не применяется (например, ПО не генерирует текст, предназначенный для конечных пользователей, и не сортирует текст, читаемый человеком), [internationalization]
    Локализация "относится к адаптации продукта, приложения или содержимого документа для соответствия языковым, культурным и другим требованиям конкретного целевого рынка (языковому стандарту)". Интернационализация - это «проектирование и разработка продукта, приложения или содержимого документа, которые позволяют легкую локализацию под целевые аудитории, различающиеся по культуре, региону или языку». (См. «Локализация по сравнению с интернационализацией» на веб-сайте W3C.) Чтобы ПО соответствовало этому критерию, достаточно лишь интернационализации. Не требуется локализация для другого конкретного языка, так как после того, как программное обеспечение было интернационализировано, другие могут работать над локализацией.

    WhitePact implements a real internationalization architecture for its user-facing dashboard. User-interface strings in the shared application shell use external locale catalogs, with English and Spanish currently supported.

    The implementation includes locale detection and selection, fallback behavior, interpolation, pluralization, locale-aware number/date formatting, catalog-integrity tests, and CI enforcement. Contributors can add additional locales through the documented process.

    Full translation of every page is not claimed; the architecture is designed to make additional localization straightforward.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/docs/INTERNATIONALIZATION.md


  • Другое


    Если на сайтах проекта (веб-сайт, хранилище и URL-адреса загрузки) хранятся пароли для аутентификации внешних пользователей, НЕОБХОДИМО хранить пароли как итерированные хеши с отдельной "солью" для каждого пользователя с использованием алгоритма (итерированного) растяжения ключа (например, Argon2id, Bcrypt, Scrypt или PBKDF2). Выберите «неприменимо» (N/A), если сайты проекта не хранят пароли для этой цели. [sites_password_security]
    Примечание: использование GitHub автоматически выполняет этот критерий. Этот критерий применяется только к паролям, используемым для аутентификации внешних пользователей на сайтах проекта (т.н. входящей аутентификации). Если сайты проекта должны подключаться к другим сайтам (т.н. исходящая аутентификация), им может потребоваться хранить аутентифицирующие данные (пароли, ключи) для этой цели как-то иначе (поскольку хранение контрольной суммы для этой цели бесполезно). В данном случае критерий crypto_password_storage применяется к сайтам проекта, по аналогии с критерием sites_https.

    N/A — WhitePact does not store passwords for authentication of external users.

    WhitePact uses federated identity authentication through external OpenID Connect / OAuth identity providers, including Google and Microsoft sign-in. User passwords are entered only with and verified by the respective identity provider; WhitePact neither receives nor stores those passwords.

    WhitePact also supports high-entropy API-key authentication, with API keys stored only as non-recoverable hashes rather than plaintext credentials.

    Therefore there is no local external-user password database to which password key-stretching requirements apply.


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

  • Предыдущие версии


    Проект ОБЯЗАН поддерживать наиболее часто используемые старые версии продукта или предоставлять возможность простого перехода на более новые версии (upgrade path). Если переход затруднен, проект ОБЯЗАН задокументировать порядок обновления (например, изменившиеся интерфейсы и подробные предлагаемые шаги для обновления). [maintenance_or_update]

    WhitePact maintains one active supported release line and provides a documented upgrade and backward-compatibility path to newer versions. The project follows Semantic Versioning, with breaking changes reserved for major releases.

    Legacy package names, import paths, environment variables, CLI names, and MCP resource identifiers are retained through compatibility aliases and documented transition periods so existing installations can upgrade without abrupt breakage.

    Supported-version policy:
    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/SECURITY.md

    Migration/upgrade compatibility:
    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/MIGRATION_WHITEPACT_V2.md


 Отчеты о проблемах 3/3

  • Процесс сообщения об ошибках


    Проект ОБЯЗАН использовать трекер вопросов (issue tracker) для отслеживания отдельных вопросов. [report_tracker]

    WhitePact uses the GitHub Issues tracker to track individual bugs, enhancement requests, and other actionable project issues.

    https://github.com/Guruprasath-Annadurai/Whitepact/issues


  • Процесс отчета об уязвимостях


    Проект ОБЯЗАН отмечать автора(-ов) всех отчетов об уязвимостях, разрешенных за последние 12 месяцев, за исключением авторов, которые просят об анонимности. Выберите «неприменимо» (N/A), если в течение последних 12 месяцев не было обнаружено никаких уязвимостей. (Требуется URL) [vulnerability_report_credit]

    N/A — WhitePact has not resolved any externally reported vulnerabilities during the last 12 months.

    The project's security policy nevertheless explicitly commits to crediting vulnerability reporters in release notes unless the reporter requests anonymity.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/SECURITY.md



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

    WhitePact maintains a documented vulnerability-response process in SECURITY.md.

    Security vulnerabilities must be reported privately rather than through public GitHub issues. The policy defines the reporting channel, required report information, scope, responsible-disclosure expectations, acknowledgement within 48 hours, and a resolution timeline within 7 days.

    WhitePact also commits to communicating with reporters, crediting them unless anonymity is requested, and not pursuing legal action against good-faith security researchers.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/SECURITY.md


 Качество 19/19

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


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

    WhitePact publicly documents its coding standards in CONTRIBUTING.md.

    Python code uses Ruff for linting and formatting, with the configured rule set maintained in pyproject.toml. Public functions require type annotations and mypy is used for static type checking. Contributions are required to follow these standards and pass CI before merge.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md



    Проект ОБЯЗАН автоматически применять свой выбранный стиль(и) кодирования, если есть хотя бы один инструмент на СПО, который может сделать это на выбранном языке (языках). [coding_standards_enforced]
    Это МОЖЕТ быть реализовано при помощи инструмента(ов) статического анализа и/или путем пропускания кода через средства переформатирования. Во многих случаях конфигурация инструмента включена в репозиторий проекта (так как разные проекты могут выбирать разные конфигурации). Проекты МОГУТ (и, как правило, будут) допускать исключения стиля; там, где происходят исключения, они ОБЯЗАНЫ быть редки и документированы в соответствующих местах кода, чтобы эти исключения можно было пересматривать и инструменты могли автоматически обрабатывать их в будущем. Примеры таких инструментов включают ESLint (JavaScript) и Rubocop (Ruby).

    WhitePact automatically enforces its documented Python coding standards through GitHub Actions.

    Every relevant change is checked using Ruff linting, Ruff formatting verification, and mypy static type checking. A violation causes CI to fail and prevents the required checks from passing.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/.github/workflows/ci.yml


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


    Системы сборки для нативных двоичных файлов ОБЯЗАНЫ учитывать соответствующие переменные (среды) для компилятора и компоновщика, переданные им (например, CC, CFLAGS, CXX, CXXFLAGS и LDFLAGS) и передавать их на вызовы компилятора и компоновщика. Система сборки МОЖЕТ расширять их дополнительными флагами; НЕДОПУСТИМО просто заменять предоставленные значения своими. Выберите «неприменимо» (N/A), если нативные двоичные файлы не создаются. [build_standard_variables]
    Должно быть легко включить специальные функции сборки, такие как Address Sanitizer (ASAN), или выполнить рекомендации по упрочнению от дистрибутивов (например, путем простого включения флагов компилятора для этого).

    N/A — WhitePact is primarily a Python project distributed as pure-Python wheel and source distributions using Hatchling. The project does not build native C/C++ binaries and therefore does not directly invoke native compilers or linkers requiring CC, CFLAGS, CXX, CXXFLAGS, or LDFLAGS propagation.



    В системах сборки и установки СЛЕДУЕТ сохранять отладочную информацию, если передаваемые флаги требуют этого (например, не используется «install -s»). Выберите «неприменимо» (N/A), если системы сборки или установки нет (например, для типичных библиотек JavaScript), . [build_preserve_debug]
    Например, установка CFLAGS (C) или CXXFLAGS (C++) должна создавать соответствующую информацию для отладки, если эти языки используются, и ее не следует удалять во время установки. Отладочная информация необходима для поддержки и анализа, а также полезна для того, чтобы определить наличие упрочняющих функций в скомпилированных двоичных файлах.

    N/A — WhitePact's project-owned distribution is pure Python and does not produce native compiled objects with removable debugging symbols. There is therefore no project build step such as install -s that strips requested native debugging information.



    НЕДОПУСТИМО, чтобы система сборки ПО, создаваемого проектом, рекурсивно собирала подкаталоги, если в подкаталогах есть кросс-зависимости. Выберите «неприменимо» (N/A), если системы сборки или установки нет (например, типичные библиотеки JavaScript). [build_non_recursive]
    Информация о внутренних зависимостях системы сборки проекта должна быть точной, в противном случае изменения в проекте могут быть включены в сборку неправильно. Неправильные сборки могут привести к дефектам (включая уязвимости). Общей ошибкой в ​​больших системах сборки является использование «рекурсивной сборки» или «рекурсивного make», то есть иерархии подкаталогов, содержащих исходные файлы, где каждый подкаталог собирается независимо. Если только каждый из подкаталогов не является полностью независимым, это ошибка, потому что информация о зависимостях неверна.

    WhitePact uses Hatchling as a single Python packaging build backend. The build does not recursively invoke independent subdirectory build systems with cross-dependencies; the project's Python packages are assembled by the single configured Hatchling build target.



    Проект ОБЯЗАН быть в состоянии повторить процесс генерации информации из исходных файлов и получить такой же результат с точностью до бита. Выберите «неприменимо» (N/A), если в проекте не используется сборка (например, языки сценариев, в которых исходный код используется непосредственно вместо компиляции), . [build_repeatable]
    Пользователи GCC и clang могут найти полезной опцию -frandom-seed; в некоторых случаях это может быть разрешено путем задания определенного порядка сортировки. Дополнительные предложения можно найти на сайте Reproducible builds.

    WhitePact uses Hatchling as its build backend. Hatchling enables reproducible builds by default and uses SOURCE_DATE_EPOCH for build timestamps, with a stable default timestamp when it is not provided.

    WhitePact does not disable Hatchling's reproducible-build behavior, so wheel and source-distribution generation uses the backend's reproducible build mechanism.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/pyproject.toml


  • Система установки


    Проект ОБЯЗАН предоставлять возможность легко установить и удалить ПО, создаваемое проектом, с использованием общепринятых способов. [installation_common]
    Примеры включают использование менеджера пакетов (на уровне системы или языка), «make install/uninstall» (с поддержкой DESTDIR), контейнер в стандартном формате или образ виртуальной машины в стандартном формате. Процесс установки и удаления (например, его упаковка) МОЖЕТ быть реализован третьей стороной, при условии что он построен на СПО.

    WhitePact uses the standard Python packaging ecosystem for installation and removal.

    End users install the published package using pip, for example:

    pip install "rai-governance-platform[dashboard]"

    and it can be removed using the standard:

    pip uninstall rai-governance-platform

    Installation instructions are publicly documented in README.md.

    https://github.com/Guruprasath-Annadurai/Whitepact#install



    В системе установки для конечных пользователей НЕОБХОДИМО учитывать стандартные соглашения при выборе места, в которое собранные артефакты записываются при установке. Например, если она устанавливает файлы в системе POSIX, НЕОБХОДИМО учитывать переменную окружения DESTDIR. Если установочной системы или стандартного соглашения нет, выберите «неприменимо» (N/A). [installation_standard_variables]

    WhitePact delegates installation-location handling to pip, the standard Python package installer, rather than implementing a custom installer. Standard pip installation controls such as virtual environments, --target, --prefix, --root, and --user are therefore honored without being overridden by WhitePact.



    Проект ОБЯЗАН предоставить возможность потенциальным разработчикам быстро установить все результаты проекта и поддерживать среду, необходимую для внесения изменений, включая тесты и тестовое окружение. Проект ОБЯЗАН использовать для этого общепринятые соглашения. [installation_development_quick]
    Это МОЖЕТ быть реализовано при помощи сгенерированного контейнера или установочных сценариев. Внешние зависимости обычно устанавливаются путем вызова системных и/или языковых пакетов, как описано в критерии external_dependencies.

    WhitePact documents a standard development installation using a Python virtual environment and an editable pip installation:

    pip install -e ".[dev]"

    This installs WhitePact together with its development and testing dependencies, including pytest, pytest-cov, Ruff, mypy, and related development tooling.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md


  • Компоненты, поддерживаемые извне


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

    WhitePact declares its external runtime, optional, and development dependencies in the machine-processable pyproject.toml package configuration.

    Dependencies are separated into the core dependency list and named optional groups for dashboard, PostgreSQL, Redis, telemetry, SSO, model providers, billing, testing, and other integrations.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/pyproject.toml



    Проекты ОБЯЗАНЫ следить за своими внешними зависимостями или периодически проверять их (включая копии, сделанные для удобства) на предмет известных уязвимостей, а также исправлять уязвимости, которые могут быть использованы, или проверять невозможность их использования. [dependency_monitoring]
    Это можно сделать с помощью средств анализа происхождения/зависимостей, например Dependency-Check от OWASP, Nexus Auditor от Sonatype, Protex от Black Duck , Protecode от Synopsys и Bundler-аудит (для Ruby). Некоторые менеджеры пакетов включают в себя соответствующие механизмы. Допустимо оставлять уязвимость, если ее невозможно использовать, но такой анализ труден, и временами проще просто обновить или исправить эту часть кода.

    WhitePact automatically checks dependencies for known vulnerabilities using pip-audit.

    Dependency auditing runs in normal CI and in a separate recurring security workflow that runs on pushes to main and weekly. Confirmed dependency vulnerabilities fail the applicable security check unless a specific finding has been explicitly investigated, documented, and determined not to be exploitable in WhitePact's usage.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/.github/workflows/security-scan.yml



    Проект ОБЯЗАН:
    1. позволять легко идентифицировать и обновлять повторно используемые компоненты, поддерживаемые извне; или
    2. использовать стандартные компоненты, предоставляемые системой или языком программирования.
    В этом случае, если уязвимость обнаружена в повторно используемом компоненте, будет легко обновить этот компонент. [updateable_reused_components]
    Типичным способом выполнить этот критерий является использование предоставляемых операционной системой и языком программирования систем управления пакетами. Многие свободные программы распространяются с «подсобными библиотеками», которые являются локальными копиями стандартных библиотек (возможно, форков библиотек). Само по себе это нормально. Однако, если программа *должна* использовать эти локальные копии/форки, то обновление «стандартных» библиотек через системное обновление безопасности оставит эти дополнительные копии по-прежнему уязвимыми. Это особенно актуально для облачных систем; если провайдер облака обновляет свои «стандартные» библиотеки, но программа их не собирается использовать, обновления фактически не помогут. См., например, "Chromium: Why it isn't in Fedora yet as a proper package" от Тома Каллавея.

    WhitePact uses standard Python package dependencies declared centrally in pyproject.toml rather than embedding private or difficult-to-identify copies of those dependencies.

    Dependency versions and compatibility constraints can therefore be identified and updated through the normal Python packaging workflow and validated by the automated test and security-audit pipelines.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/pyproject.toml



    Проекту СЛЕДУЕТ избегать использования нерекомендуемых (deprecated) или устаревших (obsolete) функций и API в тех случаях, когда альтернативы на СПО доступны в используемом наборе технологий («стек технологий» проекта) и для подавляющего большинства пользователей, поддерживаемых проектом (т.е. так чтобы пользователи могли быстро воспользоваться этой альтернативой). [interfaces_current]

    WhitePact uses maintained libraries and APIs and periodically reviews dependency compatibility and security.

    Where a new major dependency version contains breaking API changes, compatibility constraints are explicitly documented rather than silently ignored. Such migrations are handled deliberately with tests and backward-compatibility planning instead of continuing unknowingly on obsolete interfaces.


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


    НЕОБХОДИМО применять автоматический набор тестов к каждому коммиту в общий репозиторий по крайней мере для одной ветки. Этот набор тестов ОБЯЗАН создавать отчет об успешном или неудачном тестировании. [automated_integration_testing]
    Это требование можно рассматривать как подмножество test_continuous_integration, но сосредоточенное только на тестировании, без требования непрерывной интеграции.

    WhitePact runs its automated test suite through GitHub Actions on every push to main and develop and on pull requests targeting main.

    The CI job installs the project and development dependencies, runs linting and type checking, executes pytest with coverage, and reports success or failure through the GitHub Actions status checks.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/.github/workflows/ci.yml



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

    WhitePact's engineering policy requires functional changes and bug fixes to include automated tests, and pull requests that reduce coverage are required to add tests before merge.

    The project therefore targets regression-test coverage substantially above the Silver requirement that at least 50% of fixed bugs receive regression tests.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md



    Проект ОБЯЗАН иметь автоматические тестовые пакеты на СПО, которые обеспечивают покрытие не менее 80% инструкций кода, если есть хотя бы один инструмент на СПО, который может измерять этот критерий на выбранном языке. [test_statement_coverage80]
    Для измерения тестового покрытия существует множество средств на СПО, включая gcov/lcov, Blanket.js, Istanbul и JCov. Обратите внимание, что соответствие этому критерию не является гарантией того, что тестовый пакет является исчерпывающим; вместо этого, несоответствие этому критерию является сильным индикатором плохого набора тестов.

    WhitePact's FLOSS automated pytest/pytest-cov test suite exceeds the required 80% statement-coverage threshold.

    The verified coverage run contains 2,249 passing tests. Pure branch coverage is independently measured at 80.19% (1469/1832), while the overall statement-plus-branch coverage is approximately 89%; because branch coverage is below that combined percentage, statement coverage is necessarily above the combined percentage and therefore comfortably above the 80% Silver statement-coverage requirement.

    Coverage is generated automatically in CI using pytest-cov/coverage.py.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/compliance/OPENSSF_DYNAMIC_ANALYSIS.md


  • Тестирование новых функций


    Проект ОБЯЗАН иметь формальную задокументированную политику о том, что при добавлении существенной новой функциональности НЕОБХОДИМО добавлять тесты для новой функциональности в набор автоматических тестов. [test_policy_mandated]

    WhitePact has a formal written engineering policy requiring automated tests for functional changes and major new functionality.

    CONTRIBUTING.md states that every functional change needs a test, and WhitePact-specific development sections additionally define the testing expectations for governance features, MCP tools, providers, migrations, and security-sensitive changes.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md



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

    WhitePact's documented instructions for proposed changes explicitly require tests.

    CONTRIBUTING.md states that tests are required for pull requests, functional changes must have tests, coverage must not regress, and CI must pass before a change is considered ready for merge.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/CONTRIBUTING.md


  • Флаги предупреждений


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

    WhitePact uses strict automated quality checks appropriate to its Python implementation.

    Ruff is configured with error, Pyflakes, import-order, pyupgrade, bugbear, and naming rules, while mypy performs static type checking. Both run as hard CI checks, so violations fail the build.

    Only a small documented set of Ruff rules is intentionally excluded where strict enforcement is not practical for the existing codebase.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/pyproject.toml
    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/.github/workflows/ci.yml


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

  • Знание безопасной разработки


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

    WhitePact implements secure-design principles throughout the project.

    Security-sensitive design includes least-privilege RBAC, tenant isolation, parameterized database access, explicit validation of untrusted network destinations, strong cryptographic key-generation and minimum-strength policies, rate limiting, secure secret handling, fail-closed authorization behavior, and automated security analysis.

    The project's internal security review documents manual review of authentication, authorization, SQL construction, SSRF, dangerous-function usage, cryptography, and tenant isolation, including real vulnerabilities discovered and remediated with regression tests.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/compliance/INTERNAL_SECURITY_REVIEW.md


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

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

    В ПО, создаваемом проектом, НЕДОПУСТИМО делать механизмы безопасности по умолчанию зависимыми от криптографических алгоритмов или режимов с известными серьезными слабостями (например, криптографический алгоритм хеширования SHA-1 или режим CBC в SSH). [crypto_weaknesses]
    Проблемы, связанные с режимом CBC в SSH, обсуждаются в описании уязвимости CERT: SSH CBC.

    WhitePact's default security mechanisms do not depend on cryptographic algorithms with known serious weaknesses.

    The project uses SHA-256/HMAC-SHA256 for hashing and message authentication, cryptographically secure random generators for secrets, modern Fernet-based field encryption, and RSA keys of at least 2048 bits for OIDC verification.

    OIDC JWT validation is restricted to modern RS256/RS384/RS512 and ES256/ES384/ES512 signature algorithms.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/src/responsibleai/auth/crypto_policy.py



    Проекту СЛЕДУЕТ поддерживать несколько криптографических алгоритмов, чтобы пользователи могли быстро переключиться, если один из них поврежден. Общие симметричные ключевые алгоритмы включают AES, Twofish и Serpent. Общие алгоритмы контрольных сумм (хешей) включают SHA-2 (SHA-224, SHA-256, SHA-384 и SHA-512) и SHA-3. [crypto_algorithm_agility]

    WhitePact supports cryptographic algorithm agility where protocols require algorithm negotiation.

    OIDC token validation supports multiple modern signature algorithms across two algorithm families: RSA (RS256, RS384, RS512) and elliptic-curve ECDSA (ES256, ES384, ES512).

    TLS is delegated to modern TLS implementations/reverse proxies capable of negotiating multiple approved TLS cipher suites rather than binding the application to one fixed transport cipher.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/src/responsibleai/auth/oidc.py



    Проект ОБЯЗАН поддерживать хранение данных для аутентификации (например, паролей и динамических токенов) и закрытых криптографических ключей в файлах, отдельных от остальной информации (например, файлов конфигурации, баз данных и журналов) и позволять пользователям их обновление и замену без перекомпиляции кода. Выберите «неприменимо» (N/A), если проект никогда не работает с данными аутентификации и закрытыми криптографическими ключами. [crypto_credential_agility]

    WhitePact stores authentication credentials and private application cryptographic keys separately from application source code.

    Secrets are supplied through environment variables or external secret-management systems and can be replaced without recompiling or modifying application code.

    The field-encryption mechanism explicitly supports key rotation using an ordered multi-key configuration so data can be migrated to a new key without requiring application recompilation.

    No private credentials or encryption keys are stored in the public repository.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/compliance/KEY_MANAGEMENT.md



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

    WhitePact supports secure network communication through HTTPS/TLS for production deployments.

    TLS is terminated by the deployment's trusted reverse proxy, load balancer, ingress, or managed cloud edge. The documented production nginx configuration enables TLS 1.2 and TLS 1.3 with modern authenticated cipher suites.

    Plain HTTP is used for local/internal application transport and development, while public production endpoints are expected to be exposed through TLS.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/DEPLOYMENT.md



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

    WhitePact supports TLS 1.2 or later for production network communication.

    The documented production reverse-proxy configuration explicitly enables TLS 1.2 and TLS 1.3. The WhitePact reference deployment has also been verified to negotiate TLS 1.3.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/DEPLOYMENT.md



    В ПО, создаваемом проектом, НЕОБХОДИМО выполнять проверку сертификата TLS по умолчанию при использовании TLS, в том числе в подресурсах. Если программное обеспечение не использует TLS, выберите «неприменимо» (N/A). [crypto_certificate_verification]
    Обратите внимание, что неправильная проверка сертификата TLS является распространенной ошибкой. Для дальнейших сведений см. "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" Мартина Георгиева и др. и "Do you trust this application?" Майкла Катанзаро.

    WhitePact performs TLS certificate verification by default for outbound HTTPS communication.

    OIDC discovery, JWKS retrieval, token exchange, and other HTTPS client operations use httpx's secure default TLS configuration. WhitePact does not disable certificate verification with verify=False in these security-sensitive paths.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/src/responsibleai/auth/oidc.py



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

    WhitePact relies on standard HTTPS/TLS client behavior in which the TLS handshake and server-certificate verification are completed before HTTP request headers or request bodies containing private authentication information are transmitted.

    OIDC token-exchange requests use httpx with certificate verification enabled by default; no insecure certificate-verification override is configured.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/src/responsibleai/auth/oidc.py


  • Безопасный выпуск


    Проект ОБЯЗАН криптографически подписывать выпуски результатов проекта, предназначенные для широкого использования, и ОБЯЗАН иметь задокументированный процесс, объясняющий пользователям, как они могут получить общедоступные ключи подписи и проверить подпись(и) выпусков. НЕДОПУСТИМО размещать закрытый ключ для этих подписей на сайте(сайтах), используемом для прямого распространения ПО для общественности. Выберите «неприменимо» (N/A), если выпуски не предназначены для широкого использования. [signed_releases]
    Результаты проекта включают как исходный код, так и любые сгенерированные результаты, если это применимо (например, исполняемые файлы, пакеты и контейнеры). Сгенерированные результаты МОГУТ быть подписаны отдельно от исходного кода. Подписывание МОЖЕТ быть реализовано как подписанные теги git (с использованием криптографических цифровых подписей). Проекты МОГУТ предоставлять генерируемые результаты отдельно от таких инструментов, как git, но в этих случаях отдельные результаты ОБЯЗАНЫ быть отдельно подписаны.

    WhitePact cryptographically attests its published wheel and source-distribution artifacts using GitHub Artifact Attestations backed by Sigstore and GitHub Actions OIDC.

    The release workflow creates build-provenance attestations for dist/* before publishing to PyPI and uses PyPI Trusted Publishing, so no long-lived private PyPI or signing key is stored on the public distribution service.

    Every GitHub Release includes verification instructions:

    gh attestation verify <artifact> --owner Guruprasath-Annadurai

    This verifies that the artifact was produced by WhitePact's trusted GitHub Actions workflow from the identified repository and commit.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/.github/workflows/publish.yml



    ЖЕЛАТЕЛЬНО, чтобы в системе контроля версий каждый важный тег версии (тег, который является частью основного выпуска, минорной версии или исправляет общедоступные уязвимости) подписывался криптографической подписью и поддавался проверке, как описано в критерииsigned_releases. [version_tags_signed]

    WhitePact maintains a public security assurance case that connects the project's security requirements to concrete architecture, implementation controls, tests, and automated security evidence.

    The assurance case includes an explicit threat model, clearly identified trust boundaries, an argument demonstrating application of secure-design principles, and an analysis showing how common implementation security weaknesses are countered through controls including authentication, RBAC, tenant isolation, input validation, SSRF protection, parameterized database access, cryptographic-strength policies, secure secret handling, runtime authority enforcement, CI security scanning, dependency auditing, and supply-chain provenance.

    Residual risks and known limitations are explicitly documented rather than represented as solved.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/SECURITY_ASSURANCE_CASE.md


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


    В результатах проекта НЕОБХОДИМО проверять любой ввод из потенциально ненадежных источников, чтобы убедиться, что они действительны (*белый список*), и отклонять недействительный ввод, если вообще есть какие-либо ограничения на данные. [input_validation]
    Обратите внимание, что сравнения ввода со списком «плохих форматов» (также известным как *черный список*) обычно недостаточно, потому что злоумышленники часто могут обойти черный список. В частности, числа преобразуются во внутренние форматы, а затем проверяются, находятся ли они между их минимальным и максимальным (включительно), а текстовые строки проверяются, чтобы убедиться, что они являются допустимыми текстовыми шаблонами (например, действительный UTF-8, длина, синтаксис и т. д.). От некоторых данных может требоваться, чтобы они были «хоть чем-нибудь» (например, загрузчик файлов), но такое обычно случается редко.

    WhitePact validates untrusted input at its external boundaries.

    The REST API uses FastAPI/Pydantic models, typed fields, constrained values, email validation, query validation, and explicit field validators. Security-sensitive inputs receive additional validation rather than relying only on schema parsing.

    Examples include SSRF-resistant webhook/upstream URL validation, minimum webhook-secret strength, minimum OIDC RSA key size, authentication and role validation, tenant isolation, and parameterized database queries.

    Invalid or unsafe input is rejected before the protected operation is performed.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/compliance/INTERNAL_SECURITY_REVIEW.md



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

    WhitePact uses defense-in-depth hardening mechanisms to reduce the impact of software defects.

    The dashboard applies security response headers including Content-Security-Policy, Strict-Transport-Security, X-Content-Type-Options, X-Frame-Options, Referrer-Policy, Cache-Control, and Permissions-Policy.

    Additional hardening includes request rate limiting, RBAC, tenant isolation, SSRF defenses, strong secret generation, minimum cryptographic key-strength checks, secure error responses, automated SAST, dependency auditing, and security regression tests.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/src/responsibleai/dashboard/middleware.py



    Проект ОБЯЗАН предоставить обоснование того, что требования безопасности соблюдаются проектом. В обоснование НЕОБХОДИМО включить: описание модели угроз, четкое указание границ доверия, доказательство того, что использовались принципы безопасного дизайна, и доказательство того, что слабости в безопасности реализации нейтрализованы. (Требуется URL) [assurance_case]
    Обоснованием является «документальное подтверждение, которое дает убедительное и корректное доказательство того, что указанный набор критических заявлений относительно свойств системы адекватно оправдан для данного приложения в данной среде» (перевод выдержки из "Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Границы доверия - это границы, на которых меняется уровень доверия к данным или выполнению кода, например границы сервера в типичном веб-приложении. В обосновании обычно перечисляются принципы безопасного проектирования (такие как Saltzer and Schroeer) и общие слабости безопасности в реализации (такие как OWASP Top 10 или CWE/SANS Top 25), и показывается, как противодействовать каждой из них. Полезным примером может служить обоснование для BadgeApp. Этот критерий связан с documentation_security, documentation_architecture и implement_secure_design.

    WhitePact cryptographically signs important Git version tags and documents how users can verify those signatures.

    Important release tags are created as annotated cryptographically signed tags using an approved project release-signing identity. The release process verifies that a release tag is annotated, signed, valid, and issued by an approved signer before publication.

    Public verification information is provided so users can independently verify Git tag signatures. This complements, rather than replaces, WhitePact's existing GitHub/Sigstore build-provenance attestations for published release artifacts.

    https://github.com/Guruprasath-Annadurai/Whitepact/blob/main/RELEASING.md


 Анализ 2/2

  • Статический анализ кода


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

    WhitePact uses Bandit, a FLOSS Python static-analysis security tool designed to identify common security weaknesses and insecure coding patterns in Python source code. Bandit scans the WhitePact application source recursively as part of the security workflow.


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


    Если ПО, создаваемое проектом, включает ПО, написанное с использованием небезопасного языка (например, C или C++), тогда проект ОБЯЗАН регулярно использовать хотя бы один динамический инструмент (например, фаззер или сканер веб-приложения) в сочетании с механизмом для обнаружения проблем безопасности памяти, таких как перезапись буфера. Выберите «неприменимо» (N/A), если проект не создает ПО, написанное на небезопасном языке. [dynamic_analysis_unsafe]
    Примерами механизмов обнаружения проблем безопасности памяти являются Address Sanitizer (ASAN) (доступен в GCC и LLVM), Memory Sanitizer и valgrind. Другие потенциально используемые инструменты включают Thread Sanitizer и Undefined Behavior Sanitizer. Достаточно широкое использование утверждений (assertions) тоже может быть приемлемо.

    N/A — WhitePact's project implementation does not include C, C++, or another memory-unsafe implementation language requiring AddressSanitizer, Valgrind, or equivalent memory-safety dynamic analysis. Its primary runtime implementation uses memory-safe languages such as Python and TypeScript/JavaScript.



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

Владелец анкеты на значок проекта: Guruprasath Annadurai.
2026-08-17 09:21:34 UTC, последнее изменение сделано 2026-08-19 10:45:59 UTC. Последний раз условия для получения значка были выполнены 2026-08-17 11:38:17 UTC.