compliance-trestle

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

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

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


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

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

        

 Основы 17/17

  • Общая

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

    An opinionated tooling platform for managing compliance as code, using continuous integration and NIST's OSCAL standard.

    Используйте формат выражения лицензии 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]
  • Надзор за проектом


    Проекту СЛЕДУЕТ иметь юридический механизм, через который все авторы содержательных взносов в ПО проекта подтверждают, что они имеют законное право на внесение этих взносов. Самый распространенный и легко реализуемый подход для этого заключается в использовании 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 для проекта меньше, чем их преимущества.

    The project uses the Developer Certificate of Origin (DCO) 1.1 — the same mechanism used by the Linux Kernel community (https://developercertificate.org). This is documented in CONTRIBUTING.md (https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md), which explains what Signed-off-by means for this project, provides an example trailer (Signed-off-by: John Doe john.doe@example.com), and instructs contributors to use git commit --signoff. DCO sign-off is technically enforced on every pull request by a dedicated CI workflow (https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/workflows/verify-signoff.yml) that checks every non-merge commit to confirm the Signed-off-by trailer is present and matches the commit author's email address, blocking the PR if it does not.



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

    URL (primary):
    https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md

    URL (secondary — roles):
    https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md

    Justification text:

    The compliance-trestle project is governed under the OSCAL Compass community governance model, documented at https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md. This document defines all key roles (Member, Reviewer, Maintainer, Oversight Committee), the two-tier decision-making process (lazy consensus for day-to-day decisions; explicit simple or supermajority voting via GitVote for formal decisions), dispute resolution (escalation to the Oversight Committee with binding authority), and the process for electing and removing leadership. Detailed role requirements and responsibilities are in https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md. Active project maintainers are listed in the project-level MAINTAINERS.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.

    URL:
    https://github.com/oscal-compass/community/blob/main/CODE_OF_CONDUCT.md

    Justification text:

    The project adopts the CNCF Code of Conduct, hosted at the OSCAL Compass community level at https://github.com/oscal-compass/community/blob/main/CODE_OF_CONDUCT.md. It is referenced from the project README.md ("Participation in the OSCAL Compass community is governed by the Code of Conduct") and from the project's documentation site at https://oscal-compass.github.io/compliance-trestle/latest/contributing/code_of_conduct/.



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

    URL (primary — role definitions):
    https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md

    Justification text:

    Key roles and their responsibilities are defined in https://github.com/oscal-compass/community/blob/main/MEMBERSHIP.md, which documents the Member, Reviewer, Maintainer, and Oversight Committee roles — including requirements to hold each role, specific responsibilities, and privileges. Who holds each role is publicly named in two places: project-level maintainers (Maintainer role) are listed with their GitHub handles in https://github.com/oscal-compass/compliance-trestle/blob/develop/MAINTAINERS.md, and org-level role holders (Oversight Committee, Org Admins, Community Maintainers) are listed with their GitHub handles and affiliations in https://github.com/oscal-compass/community/blob/main/MAINTAINERS.md.



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

    Access Continuity Explanation for OpenSSF Best Practices [access_continuity]

    The project satisfies the access continuity requirement through shared organization administration, distributed maintainership, and documented governance procedures:

    1. Multi-Admin and Multi-Org Redundancy: Administrative access, credentials, and repository rights across the oscal-compass organization are shared among multiple Org Admins from different member organizations, plus a Linux Foundation backstop account (thelinuxfoundation). This ensures that operations (managing issues, merging pull requests, releasing software) can proceed without disruption if any single person is lost.
    2. Succession and Vacancy Rules: Formal vacancy appointment and governance policies allow the multi-member Oversight Committee to reallocate responsibilities and maintain uninterrupted project continuity within one week.

    Reference URLs



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

    OpenSSF Silver — bus_factor Justification
    Project: OSCAL Compass · Criterion ID: bus_factor

    Criterion
    The project SHOULD have a bus factor of 2 or more.
    URL
    https://github.com/oscal-compass/community/blob/main/GOVERNANCE.md#access-continuity
    Justification
    OSCAL Compass maintains a bus factor of 2 or more. The project's Access Continuity governance section documents that no single person is a point of failure. A six-member Oversight Committee drawn from at least three independent organizations (IBM, Red Hat, Sunstone Secure) collectively holds all necessary repository access, credentials, and legal rights. Multiple Org Admins — including a Linux Foundation backstop — ensure continuity of operations. Project knowledge is actively distributed across contributors from different organizations, so the project can continue to function within one week of losing any individual contributor. Vacancies are filled by appointment per the documented Vacancies process.


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


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

    ROADMAP.md is a dedicated, top-level file that explicitly describes what the OSCAL Compass project intends to do (5 named goals covering codebase maintenance, agentic authoring, community growth, OpenSSF Best Practices, and CNCF Incubation) and not do (enterprise support, certification authority functions, vulnerability scanning, and legacy format support) over the next year.

    Key URL:

    https://github.com/oscal-compass/community/blob/main/ROADMAP.md
    The document is intentionally high-level (not feature-by-feature), which is exactly what the criterion expects — enough for potential users and contributors to understand the project's direction without requiring exhaustive detail.



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

    documentation_architecture — Compliance Evidence
    Project: compliance-trestle (oscal-compass) · Criterion: The project MUST include documentation of the architecture (high-level design) of the software it produces.

    Requirement Summary
    A software architecture explains a program's fundamental structures — its major components, the relationships among them, and the key properties of those components and relationships. The criterion requires at least one URL pointing to that documentation.

    Primary URL (Published Documentation)
    Live architecture page
    https://oscal-compass.github.io/compliance-trestle/latest/architecture/
    This is the publicly hosted, versioned architecture page rendered from the project's MkDocs-Material documentation site. It is permanently accessible under the latest alias managed by mike.

    Secondary URL (Repository Source)
    Markdown source in repository (develop branch)
    https://github.com/oscal-compass/compliance-trestle/blob/develop/docs/architecture.md
    The architecture document is tracked under version control alongside the code it describes at docs/architecture.md.

    What the Architecture Document Covers
    The document addresses all three elements the criterion requires.

    1. Major Components
      Eight distinct architectural layers are identified and mapped to their source locations:

    Layer Location in codebase
    Plugin Extension Point trestle/core/plugins.py
    Entry Points — CLI & Python API trestle/cli.py, trestle/core/repository.py
    Command Layer trestle/core/commands/
    Catalog API trestle/core/catalog/
    Profile Resolver trestle/core/profile_resolver.py, trestle/core/resolver/
    Validator Framework trestle/core/validator.py, trestle/core/validator_factory.py
    Markdown / Jinja / DrawIO Authoring trestle/core/control_{reader,writer}.py, trestle/core/markdown/, trestle/core/jinja/, trestle/core/draw_io.py
    Signing & Canonicalization trestle/core/signing.py, trestle/core/canonicalization.py
    Transform & Task Pipeline trestle/transforms/, trestle/tasks/
    OSCAL Object Model trestle/oscal/, trestle/core/base_model.py
    Workspace & Remote I/O trestle/common/, trestle/core/remote/cache.py
    2. Relationships Among Components
    A full ASCII component map in the document diagrams how the layers connect, with named, annotated edges:

    Plugin packages inject CommandBase subclasses into Trestle.subcommands at module import time.
    The CLI and Python API both dispatch to the Command Layer.
    Commands delegate business logic to Core Services (Catalog API, Profile Resolver, Validators, Authoring, Signing).
    All Core Services read and write through the OSCAL Object Model.
    The OSCAL Object Model serialises to/from Workspace & Remote I/O.
    3. Key Properties of Components and Relationships
    Five named design properties are documented:

    Property Description
    Workspace-centric storage A .trestle/-rooted directory tree; documents may be single files or split into sub-directory hierarchies following the object hierarchy.
    Schema-enforced I/O Every disk read/write passes through the Pydantic v2 model layer, guaranteeing schema validity at the boundary between disk and memory.
    Composable pipelines Pipeline / Filter pattern (trestle/core/pipeline.py) used for profile resolution and OSCAL assembly; stages are independently testable and reusable.
    Separation of concerns: CLI vs. API Commands delegate to core service classes; repository.py exposes the same services to Python callers without going through the CLI argument layer.
    Extensibility via plugins The trestle_* package naming convention allows third-party command packages to be auto-discovered without any core dependency on them.
    The document also includes a Security Requirements & Guarantees section specifying what users can and cannot rely on: input validation, SSRF protection, Jinja sandboxing, cryptographic provenance (DSSE / in-toto), supply chain integrity (SLSA), plugin trust boundaries, and encryption-at-rest limitations.

    Integration with Broader Documentation Site
    The architecture page is a top-level navigation item in the project's documentation site at https://oscal-compass.github.io/compliance-trestle/latest/, which is referenced from the project README.md:

    "Complete documentation, tutorials, and background on compliance can be found here."
    Criterion Satisfaction Summary
    Criterion element Status Evidence
    URL to architecture documentation ✅ Met oscal-compass.github.io/…/architecture/
    Source file in repository ✅ Met docs/architecture.md (develop branch)
    Major components identified ✅ Met 11 layers named and mapped to source paths
    Relationships among components ✅ Met ASCII component map with labeled directional edges
    Key properties of components/relationships ✅ Met 5 named design properties + security guarantees section
    Versioned & publicly accessible ✅ Met MkDocs-Material + mike, always available at /latest/architecture/



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

    documentation_security — Compliance Evidence
    Project: compliance-trestle (oscal-compass) · Criterion: The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required)

    Requirement Summary
    The project must publish documentation that explicitly states the security properties the software is designed to provide (guarantees) and the security properties it explicitly does not provide (boundaries and user responsibilities). At least one URL is required.

    URL 1 — Architecture: Security Requirements & Guarantees Section
    Published documentation page (direct anchor)
    https://oscal-compass.github.io/compliance-trestle/latest/architecture/#security-requirements-guarantees
    Markdown source in repository (develop branch)
    https://github.com/oscal-compass/compliance-trestle/blob/develop/docs/architecture.md#security-requirements--guarantees
    The architecture document contains a dedicated Security Requirements & Guarantees section that directly addresses what users CAN and CANNOT expect. It is structured in exactly the two-part form the criterion requires:

    What Users CAN Expect (Security Guarantees & Capabilities)
    Input Validation & Schema Enforcement — All OSCAL models are parsed and validated via strict Pydantic v2 models derived from official NIST OSCAL schemas. Malformed documents, invalid types, or unexpected structures are rejected at parse time.
    SSRF & Remote Resource Protection — Remote resource retrieval (trestle/core/remote/cache.py and trestle/core/remote/security.py) enforces HTTPS/SFTP and includes SSRF protections. Cloud metadata endpoints (e.g., 169.254.169.254, metadata.google.internal) and loopback addresses are blocked unconditionally. RFC 1918 private IP blocking is configurable via TRESTLE_BLOCK_PRIVATE_IPS.
    Template Sandbox Execution — Jinja2 authoring templates execute within a SandboxedEnvironment, restricting access to dangerous Python attributes and mitigating server-side template injection (SSTI) risks.
    Cryptographic Provenance & Integrity — Built-in sign / verify / sign-manifest / verify-manifest commands use RFC 8785 JSON canonicalization and in-toto / DSSE signatures via securesystemslib to establish tamper-evident document provenance.
    Supply Chain Integrity — Release distributions include SLSA build provenance attestations and PyPI trusted publishing.
    What Users CANNOT Expect (Security Boundaries & User Responsibilities)
    No Execution Isolation for Third-Party Plugins — Trestle discovers and loads trestle_* plugins from sys.path without sandboxing. Users are responsible for ensuring installed plugins are trusted.
    No Protection Against Malicious Local Files / Filesystem Attacks — Trestle runs with the permissions of the invoking user and assumes the host filesystem is secure.
    No Automatic Encryption at Rest — Trestle does not encrypt stored OSCAL models or workspace files; encryption must be provided by the OS or filesystem.
    No Verification of Semantic Content Accuracy — Schema and cross-reference integrity are validated; the accuracy, adequacy, or legal validity of compliance content within documents is not.
    No Network-Level Access Controls — Beyond URL validation during remote fetches, Trestle does not manage network transport security or proxy configuration.
    URL 2 — SECURITY.md (Repository Security Policy)
    SECURITY.md in repository
    https://github.com/oscal-compass/compliance-trestle/blob/develop/SECURITY.md
    SECURITY.md provides deeper technical detail on the security features users can rely on, serving as an additional reference for the "CAN expect" side of the requirement:

    Security Feature Detail
    SSRF Protection — Tier 1 (always blocked) Loopback (127.0.0.0/8, ::1/128), link-local (169.254.0.0/16, fe80::/10), and cloud metadata endpoints (AWS/Azure/GCP/Alibaba) are blocked unconditionally.
    SSRF Protection — Tier 2 (configurable) RFC 1918 private ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) allowed by default; blocked when TRESTLE_BLOCK_PRIVATE_IPS=true. Private-IP accesses are logged as warnings.
    Domain Allowlist Remote fetches can be restricted to a configured set of trusted domains.
    Path Traversal Protection URL path validation blocks .. sequences; cache path validation confines files to the cache directory; workspace boundary enforcement; sensitive file protection (SSH keys, cloud credentials, /etc/passwd, /proc/self/environ, etc.).
    Scheme Restrictions Only HTTPS and SFTP are permitted for remote URLs. HTTP, FTP, and other schemes are rejected.
    Port Restrictions Only standard ports are allowed by default (HTTPS: 443, SFTP: 22). Non-standard ports are blocked unless explicitly configured.
    Security Testing Coverage SSRF and path traversal protections carry 100% code coverage. Tests include all Tier 1/Tier 2 addresses, path traversal vectors, sensitive file access attempts, and real-world attack scenarios from security advisories.
    Vulnerability Disclosure Delegates to the OSCAL Compass Community Security Policy; includes a published advisory (GHSA-w76h-q7c6-jpjp) documenting a past SSRF fix.
    Criterion Satisfaction Summary
    Criterion element Status Evidence
    URL to security requirements documentation ✅ Met (2 URLs) Architecture page § Security Requirements & Guarantees; SECURITY.md
    What users CAN expect (security guarantees) ✅ Met Input validation, SSRF protection, Jinja sandbox, cryptographic provenance, supply chain integrity — documented with implementation details and source paths
    What users CANNOT expect (security boundaries) ✅ Met Plugin isolation, filesystem security, encryption at rest, semantic accuracy, network controls — each explicitly called out as out-of-scope
    Technical depth of security feature documentation ✅ Met SECURITY.md details two-tier SSRF system, path traversal protections, scheme/port restrictions, and test coverage
    Versioned & publicly accessible ✅ Met Architecture page published at /latest/architecture/; SECURITY.md in develop branch on GitHub



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

    REQUIREMENT: documentation_quick_start

    The project MUST provide a "quick start" guide for new users
    to help them quickly do something with the software. (URL required)

    HOW IT IS MET

    File : docs/quick-start.md
    URL : https://oscal-compass.github.io/compliance-trestle/latest/quick-start/

    The guide walks a new user through five steps in under five minutes:

    1. Install: pip install compliance-trestle
    2. Init: trestle init
    3. Import: trestle import -f <NIST SP 800-53 Rev5 Moderate URL> -o nist-800-53-r5-moderate
    4. Validate: trestle validate -f catalogs/nist-800-53-r5-moderate/catalog.json
    5. Explore: trestle describe -f catalogs/nist-800-53-r5-moderate/catalog.json

    Each step includes expected terminal output.
    The guide is also linked from README.md (line 73).

    REFERENCES

    Source : docs/quick-start.md
    URL : https://oscal-compass.github.io/compliance-trestle/latest/quick-start/



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

    This community repository (the OSCAL Compass community repo) uses several complementary mechanisms to keep documentation consistent with the current state of the project:

    1. CI/CD documentation quality gates on every PR
      Every pull request targeting main that touches any *.md file is automatically checked by two GitHub Actions workflows:

    .github/workflows/docs.yml — runs markdownlint-cli2 across all Markdown files. This enforces structural consistency and catches malformed documentation before it can be merged.
    .github/workflows/ci.yml — runs spellcheck (pyspelling + aspell) on every Markdown file. A custom wordlist at .github/wordlist.txt keeps project-specific terminology (tool names, acronyms) from being flagged as errors.
    Taken together, no documentation change can be merged without passing both lint and spell checks, preventing degraded or careless updates from landing.

    1. OSCAL proposal validation keeps structured docs in sync
      .github/workflows/proposals.yml installs Trestle (the project's own tool) from requirements.txt and runs trestle author docs validate against the proposals/ directory on every PR. This means the project eats its own dog food — the same OSCAL compliance tooling the project produces is used to validate the project's own structured documentation artifacts.

    2. README and CONTRIBUTING reflect current project structure
      README.md and CONTRIBUTING.md both list the current four repositories (Trestle, Agentic Agile Authoring, Agile Authoring, C2P) with up-to-date descriptions, including the recently added Agentic Agile Authoring project. This shows that documentation is actively kept in sync as new sub-projects are added to the community.

    3. PR-based change process mandates documentation updates
      CONTRIBUTING.md explicitly calls out documentation as a valid and valued contribution:

    "documentation can always use improvement … If you see something that you think should be fixed, take ownership!"

    All changes — including documentation fixes — go through pull requests, meaning every change is reviewable, trackable, and auditable. Known inconsistencies can be opened as issues and fixed via the standard PR workflow.

    1. Living governance and membership documents
      GOVERNANCE.md, MAINTAINERS.md, MEMBERSHIP.md, and EMERITUS.md are updated through the same PR process whenever the community structure changes (e.g., a maintainer steps down triggers both a MAINTAINERS.md PR and an EMERITUS.md update). This keeps human-readable governance documentation consistent with the actual state of the project.

    Key URLs
    Resource Purpose
    https://github.com/oscal-compass/community/blob/main/README.md Primary community documentation, kept current
    https://github.com/oscal-compass/community/actions/workflows/docs.yml CI lint gate on all Markdown PRs
    https://github.com/oscal-compass/community/actions/workflows/ci.yml CI spellcheck gate on all Markdown PRs
    https://github.com/oscal-compass/community/actions/workflows/proposals.yml Trestle-based validation of structured proposal docs
    https://github.com/oscal-compass/community/blob/main/CONTRIBUTING.md Contributing guide that treats doc fixes as first-class contributions
    In summary: The criterion is met through automated CI gates that block inconsistent documentation from merging, a PR-based change process that tracks and reviews every documentation update, the project's own tooling used to validate its structured docs, and actively maintained community documents (README, CONTRIBUTING, GOVERNANCE, MAINTAINERS) that reflect the current state of all sub-projects and governance structures.



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

    documentation_achievements — Criterion Met
    Project: compliance-trestle (oscal-compass) | OpenSSF Best Practices

    Criterion: The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained.

    ✓ MET
    How It Is Met
    The GitHub repository front page is the project's README.md. Lines 10–11 of that file display two OpenSSF achievement badges at the very top of the page, each hyperlinked to its public recognition/results page. Any visitor to github.com/oscal-compass/compliance-trestle sees these badges immediately without scrolling.

    Achievement Badges in README.md (lines 10–11)
    Line 10: OpenSSF Best Practices
    Line 11: OpenSSF Scorecard
    Key URLs
    Achievement Badge / Recognition URL Location in Repo
    OpenSSF Best Practices https://www.bestpractices.dev/projects/9408 README.md, line 10
    OpenSSF Scorecard https://scorecard.dev/viewer/?uri=github.com/oscal-compass/compliance-trestle README.md, line 11
    Repository front page https://github.com/oscal-compass/compliance-trestle GitHub (renders README.md)
    Both badges are placed at the top of README.md — the de-facto front page for any GitHub-hosted project — satisfying the requirement that achievements are identified and hyperlinked on the project repository front page within 48 hours of public recognition.


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


    Проекту (как на сайтах проекта, так и в результатах работы проекта) СЛЕДУЕТ придерживаться передовой практики общедоступности, чтобы люди с ограниченными возможностями могли участвовать в проекте и использовать результаты проекта, где это имеет смысл. [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). Программы с текстовым интерфейсом пользователя МОГУТ по возможности сокращать переписывание текста на экране, чтобы предотвратить лишнее чтение средствами чтения экрана.

    Accessibility — compliance-trestle
    How the project meets WCAG 2.0 accessibility best practices

    Project type
    Compliance-trestle is primarily a command-line application and Python library. CLI tools are inherently accessible: they emit plain text to stdout/stderr, work in any terminal (including Braille displays), support --help on all sub-commands, and do not use colour as the sole means of conveying information. The project also publishes a documentation website (MkDocs Material) where the WCAG criteria below apply.

    WCAG 2.0 criteria
    Criterion Requirement How it is met
    1.1.1 Text alternatives All images in the documentation carry descriptive alt text that conveys the same information as the visual. Decorative images are labelled as such.
    1.4.1 Use of colour Colour is never the only means of conveying information. Code blocks use contextual labels and prose alongside colour highlighting. CLI messages carry a textual prefix (INFO / WARNING / ERROR).
    1.4.3 Contrast ≥ 4.5:1 The documentation site offers a light/dark theme toggle that respects the user's prefers-color-scheme OS setting. Inline code colours in both palettes meet the 4.5:1 minimum.
    2.1.1 Keyboard accessible The documentation site navigation is fully keyboard-accessible. A "Skip to main content" link is the first focusable element on every page so keyboard-only users can bypass the navigation bar.
    2.4.1 Bypass blocks The skip-navigation link targets the main content container so the first Tab keypress delivers focus directly to page content.
    2.4.7 Focus visible A high-contrast focus ring is applied to all interactive elements, restoring the outline the theme resets by default.
    3.1.1 Language of page Every page is served with <html lang="en"> so screen-readers announce the correct language.
    Additional: reduced motion
    CSS animations and transitions are disabled when the user's OS "reduce motion" preference is active, per prefers-reduced-motion (WCAG 2.3.3).

    Screen-reader testing
    Basic compatibility verified with Orca (GNOME, Linux). The skip-navigation link and ARIA landmark structure allow Orca users to reach the main content without traversing the full sidebar.

    References
    WCAG 2.0 specification
    Understanding WCAG 2.0
    W3C Web Accessibility Initiative (WAI)



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

    Internationalization — compliance-trestle
    How the project meets the i18n best-practices requirement — see W3C: Localization vs. Internationalization

    ✓ Requirement met — partially N/A, partially addressed
    What text the project produces
    Output type Audience i18n applies?
    OSCAL JSON / YAML artifacts Machine-to-machine interchange; content is authored by the user, not generated by trestle N/A — structured data, not trestle-generated natural language
    CLI log messages & --help text Developers and compliance engineers running the tool Applies — English hardcoded today; no gettext wrapping
    Markdown governance output Content is templated and authored by the user; trestle supplies structural scaffolding only N/A — trestle does not generate localizable natural-language prose
    Documentation website English-speaking developers N/A for the requirement — static documentation, not software output
    How the requirement is met
    The dominant output of compliance-trestle is machine-readable OSCAL data (JSON/YAML). This data is structured entirely by the user's own content; trestle acts as a schema-enforcing pipeline and does not inject localizable natural-language text into it. For this majority of the software's output, the i18n criterion is not applicable.

    The CLI does produce a smaller volume of human-readable text — log messages and --help strings — that is currently English-only. The codebase is already prepared for i18n in the following structural ways:

    Every source file declares # -- coding:utf-8 --, ensuring all string literals are UTF-8 and can contain any Unicode character without modification.
    All user-facing strings are plain Python string literals, making them straightforward to wrap with Python's standard gettext module when a translation catalogue is needed — no architectural changes are required.
    No locale-sensitive operations (date formatting, number formatting, sorting of human-readable text) are performed on data that trestle itself generates; where timestamps appear in OSCAL output they follow the ISO 8601 standard, which is locale-neutral.
    The documentation site sets lang="en" explicitly, so the language of all human-readable site content is declared and unambiguous to translation tools.
    Summary
    The bulk of trestle's output (OSCAL artifacts, markdown scaffolding) is N/A for i18n because it carries user-authored content, not software-generated natural language. The small portion that does generate end-user text (CLI messages) is structurally ready for gettext-based localization: UTF-8 source encoding is declared throughout, strings are plain literals with no locale-sensitive formatting, and no architectural changes would be needed to add a translation catalogue.

    References
    W3C: Localization vs. Internationalization
    Python gettext — Internationalization Services
    W3C: Declaring language in HTML


  • Другое


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

    The project uses GitHub for repository hosting and access management, and GitHub Pages for its documentation site. Neither the project itself nor any of its sites store passwords for authenticating external users — all inbound authentication is delegated entirely to GitHub and PyPI, both of which use industry-standard iterated-hash password storage. The use of GitHub directly satisfies this criterion. N/A.


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

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


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

    The compliance-trestle project satisfies this requirement through three overlapping mechanisms: active maintenance of older major versions, explicit upgrade documentation, and clear install instructions for every historical version. Evidence is drawn directly from the repository.

    1. Older versions are actively maintained
      README.md at lines 97–119 declares the support status of every major line:

    Branch Status Notes
    v5 (main) Stable – actively developed Current
    v4 Stable – maintenance mode Security & bug-fix releases until 2026-12-31
    v3 Deprecated No longer supported
    v2 Deprecated No longer supported
    The v4 maintenance branch is a live, release-capable branch—not just an archived tag. docs/contributing/maintenance_releases.md documents the formal procedure for creating and managing these branches, and pyproject.toml lines 342–368 configures the semantic-release pipeline to publish from any branch matching ^v\d+$.

    1. Detailed upgrade path is documented
      docs/upgrading.md provides a dedicated upgrade guide. It covers:

    v4 → v5: Breaking changes (minimum Python raised from 3.10 → 3.11, interface changes), with step-by-step migration instructions.
    Pinned install commands for both the new and the prior version:
    pip install --upgrade "compliance-trestle>=5,<6" # v5
    pip install --upgrade "compliance-trestle>=4,<5" # stay on v4

    A "Still on v4?" section explicitly acknowledging users who cannot yet upgrade.
    3. Install instructions for all historical versions are publicly documented
    docs/index.md lines 55–78 gives exact pip install commands for every major version (0.37.x through 5.x) and maps each to its supported OSCAL schema version, so users can pin to whichever release their toolchain requires.

    1. Version history is publicly traceable
      CHANGELOG.md contains a full release log from v0.x through the current v5.1.0, giving a complete audit trail of changes between versions.

    Supporting URLs
    Resource URL
    PyPI release history https://pypi.org/project/compliance-trestle/#history
    All branches (v4, v5, main, develop) https://github.com/oscal-compass/compliance-trestle/branches/all
    Upgrade guide (docs/upgrading.md rendered) https://oscal-compass.github.io/compliance-trestle/upgrading/
    Maintenance releases process https://oscal-compass.github.io/compliance-trestle/contributing/maintenance_releases/
    CHANGELOG https://github.com/oscal-compass/compliance-trestle/blob/main/CHANGELOG.md
    Conclusion: The project keeps the previous major version (v4) alive with security/bug-fix patches, documents a clear v4→v5 upgrade path with exact pip commands and interface-change details, and publishes install commands for all historical versions on its public documentation site—fully satisfying the [maintenance_or_update] requirement.


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

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


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

    Reports are tracked under GIT issues.
    https://github.com/oscal-compass/compliance-trestle/issues

    New issues are reviewed at least bi-weekly by the maintainers.


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


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


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

    Per security-insights.yml: repository.documentation.security-policy=https://github.com/oscal-compass/community/blob/main/SECURITY.md [osps_vm_01_01]


 Качество 4/19

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


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

    The project identifies specific coding style guides for its primary language (Python) with URLs, and explicitly requires that contributions comply with them.

    The CONTRIBUTING.md file, under the "Code style and formatting" section, states:

    "All contributions must comply with the following coding style guides:"

    and lists the following with direct URLs:

    Scope Style guide URL
    Python — general style PEP 8 – Style Guide for Python Code https://peps.python.org/pep-0008/
    Python — type annotations PEP 484 – Type Hints https://peps.python.org/pep-0484/
    Python — docstrings Google Python Style Guide (docstrings section) https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
    Python — security SEI CERT Python Coding Standard https://wiki.sei.cmu.edu/confluence/display/python/SEI+CERT+Python+Coding+Standard
    Compliance with these guides is mechanically enforced on every pull request through:

    ruff — enforces PEP 8 style (pycodestyle E/W rules), security checks (flake8-bandit S rules aligned with SEI CERT guidance), import ordering, and additional code-quality rules
    mypy — enforces PEP 484 type annotations
    pre-commit hooks — run automatically on every commit and in CI, ensuring no contribution can be merged without passing all style and lint checks
    The full tool configuration is publicly documented in pyproject.toml ([tool.ruff] and [tool.mypy] sections) and .pre-commit-config.yaml.



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

    The project automatically enforces its selected coding style on every pull request and every push to develop and main using multiple FLOSS tools. All tool configuration is committed to the repository.

    Tools and their enforcement scope:

    Tool What it enforces Configuration
    ruff (formatter) PEP 8 formatting, quote style, indent width, import ordering pyproject.toml [tool.ruff.format]
    ruff (linter) PEP 8 errors/warnings, Pyflakes, pep8-naming, bugbear, comprehensions, simplify, security (bandit), pyupgrade, ruff-specific rules pyproject.toml [tool.ruff.lint]
    mypy PEP 484 type annotation correctness pyproject.toml [tool.mypy]
    mdformat Markdown document formatting .pre-commit-config.yaml
    Enforcement layers — no contribution can bypass all three:

    Pre-commit hooks — ruff format + lint and mdformat run automatically on every git commit via .pre-commit-config.yaml. Hooks are installed and kept current by make develop.
    PR CI pipeline — the lint job in .github/workflows/python-test.yml runs make code-format, make code-lint, make code-typing, and make mdformat on every pull request. The build job in .github/workflows/python-push.yml repeats the same checks on every push to develop and main. A PR cannot be merged if these steps fail.
    SonarCloud quality gate — an additional static-analysis scan runs on every PR and must pass before merge.
    Exceptions — rare and documented in-code:

    Where a lint rule must be suppressed, a # noqa: <RULE> inline comment is required with a human-readable justification. Only two such suppressions exist in the entire non-generated source tree:

    trestle/core/commands/author/jinja.py:166 — # noqa: N802 - LUT is an established acronym; renaming is a breaking API change
    trestle/core/remote/cache.py:291 — # noqa: S105 - sentinel value {{_}}, not a real password
    The RUF100 rule (unused/invalid noqa directives) is enabled globally, so any suppression that no longer corresponds to an active violation is itself flagged — ensuring that exceptions cannot silently accumulate. All project-level rule exceptions in pyproject.toml are annotated with FIXME comments tracking the count of violations to be remediated incrementally.


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


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


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


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


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

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


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


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


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

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


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


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


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


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

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


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


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


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

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


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


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

    https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md

    Trestle updating, testing and release logistics

    "Contributors must include test cases to meet at least the minimum code coverage requirements."


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


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

    The project uses Code formatting (yapf) and code linting (flake8) to flag code issues with both errors or warnings, depending on the issue. The project also use sonar https://sonarcloud.io/project/overview?id=compliance-trestle.


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

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


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

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

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

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


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


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


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


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


    В ПО, создаваемом проектом, НЕОБХОДИМО выполнять проверку сертификата 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?" Майкла Катанзаро.


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

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


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

    Per security-insights.yml: repository.release.attestations predicate-uri includes slsa Comment says: "SLSA build provenance attestation generated automatically for all release distribution artifacts via actions/attest.".



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

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


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


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


    Проект ОБЯЗАН предоставить обоснование того, что требования безопасности соблюдаются проектом. В обоснование НЕОБХОДИМО включить: описание модели угроз, четкое указание границ доверия, доказательство того, что использовались принципы безопасного дизайна, и доказательство того, что слабости в безопасности реализации нейтрализованы. (Требуется 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.

 Анализ 2/2

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


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

    Sonar: STATIC APPLICATION SECURITY TESTING reduces the risk of security breaches by scanning and analyzing the source code files to identify issues such as security vulnerabilities, bugs, code smells and other flaws to ensure code quality and security.


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


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

    N/A,language used is Python.



Вы можете использовать инструменты и системы ИИ для предложения изменений через простой URL, например https://www.bestpractices.dev/ru/projects/9408/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Смотрите нашу систему автоматизированных предложений о том, как это сделать. Эти данные доступны по лицензии Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника Lou DeGenaro и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: Lou DeGenaro.
2024-09-02 12:27:57 UTC, последнее изменение сделано 2026-09-09 18:19:33 UTC. Последний раз условия для получения значка были выполнены 2024-11-11 12:03:16 UTC.