compliance-trestle

Miradi inayofuata mazoea bora hapa chini inaweza kujihakikisha kwa hiari na kuonyesha kuwa wamepata nishani ya mazoea bora ya Open Source Security Foundation (OpenSSF).

Hakuna seti ya mazoea yawezayo kuhakikisha kuwa programu haitakuwa na kasoro au udhaifu; hata mbinu rasmi zinaweza kushindwa ikiwa vipimo au dhana ni sahihi. Wala hakuna seti ya mazoea yawezayo kuhakikisha kuwa mradi utaendelea kuwa na jamii ya maendeleo yenye afya na inayofanya kazi vizuri. Hata hivyo, kufuata mazoea bora kunaweza kusaidia kuboresha matokeo ya miradi. Kwa mfano, baadhi ya mazoea huwezesha ukaguzi wa watu wengi kabla ya kutolewa, ambayo inaweza kusaidia kupata udhaifu wa kiufundi ambao vinginevyo ni vigumu kupata na kusaidia kujenga uaminifu na hamu ya mwingiliano wa kurudia kati ya wasanidi programu kutoka makampuni tofauti. Ili kupata nishani, vigezo vyote vya LAZIMA na LAZIMA WALA USIWAHI lazima vifuatwe, vigezo vyote vya INAPASWA lazima vifuatwe AU visivyo fufufutiliana na thibitisho, na vigezo vyote vya PENDEKEZA lazima vifuatwe AU visivyo fufufutiliana (tunataka vifikiwe angalau). Ikiwa unataka kuingiza maandishi ya thibitisho kama maoni ya jumla, badala ya kuwa maelezo ya busara kwamba hali ni inakubaliwa, anza kifungu cha maandishi na '//' ikifuatiwa na nafasi. Maoni ni karibu kupitia tovuti ya GitHub kama masuala au maombi ya kuvuta Kuna pia orodha ya barua pepe kwa majadiliano ya jumla.

Tunafuraha kutoa habari katika lugha nyingi, hata hivyo, ikiwa kuna mgongano au kutokuwa na usawa kati ya tafsiri, toleo la Kiingereza ni toleo lenye mamlaka.
Ikiwa huu ni mradi wako, tafadhali onyesha hadhi ya nishani yako kwenye ukurasa wa mradi wako! Hadhi ya nishani inaonekana kama hii: Kiwango cha nishani kwa mradi 9408 ni passing Hapa ni jinsi ya kuiweka:
Unaweza kuonyesha hali ya nishani yako kwa kuweka hii katika faili yako ya markdown:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9408/badge)](https://www.bestpractices.dev/projects/9408)
au kwa kuweka hii katika HTML yako:
<a href="https://www.bestpractices.dev/projects/9408"><img src="https://www.bestpractices.dev/projects/9408/badge"></a>


Hizi ni vigezo vya kiwango cha Fedha. Unaweza pia kuangalia vigezo vya kiwango cha Kupita au Dhahabu.

Baseline Series: Kiwango cha Msingi 1 Kiwango cha Msingi 2 Kiwango cha Msingi 3

        

 Misingi 17/17 ●

  • Jumla

    Kumbuka kwamba miradi mingine inaweza kutumia jina sawa.

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

    Tafadhali tumia muundo wa maneno ya leseni ya SPDX; mifano ni pamoja na "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", na "(BSD-2-Clause OR Ruby)". Usitumie alama za nukuu za moja au mbili.
    Ikiwa kuna lugha zaidi ya moja, ziorodhe kama thamani zilizotengwa kwa koma (nafasi ni za hiari) na ziorodhe kuanzia iliyotumiwa zaidi hadi iliyotumiwa kidogo. Ikiwa kuna orodha ndefu, tafadhali orodhesha angalau tatu za kawaida zaidi. Ikiwa hakuna lugha (k.m., huu ni mradi wa nyaraka tu au wa majaribio tu), tumia herufi moja "-". Tafadhali tumia herufi kubwa za kawaida kwa kila lugha, k.m., "JavaScript".
    Common Platform Enumeration (CPE) ni mpango wa kuweka majina yenye muundo kwa mifumo ya teknolojia ya habari, programu, na vifurushi. Inatumika katika mifumo na hifadhidata nyingi wakati wa kuripoti udhaifu.

  • Mahitaji ya awali


    Ya kutosha kwa nishani!

    Mradi LAZIMA ufikie nishani ya kiwango cha kuhitimu. [achieve_passing]

  • Maudhui ya kimsingi ya tovuti ya mradi


    Ya kutosha kwa nishani!

    Habari juu ya jinsi ya kuchangia LAZIMA ijumuishe mahitaji ya michango inayokubalika (k.m., rejea kwa kiwango chochote kinachohitajika cha msimbo). (URL inahitajika) [contribution_requirements]

    https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md#code-style-and-formating


  • Usimamizi wa mradi


    Ya kutosha kwa nishani!

    Mradi UNAPASWA kuwa na utaratibu wa kisheria ambapo wasanidi wote wa kiasi kisicho kidogo cha programu ya mradi wanathibitisha kwamba wameruhusiwa kisheria kufanya michango hii. Mbinu ya kawaida na rahisi ya kutekeleza hii ni kwa kutumia Cheti cha Msanidi cha Asili (DCO), ambapo watumiaji huongeza "signed-off-by" katika ahadi zao na mradi unaunganisha kwenye tovuti ya DCO. Hata hivyo, hii YAWEZA kutekelezwa kama Makubaliano ya Leseni ya Mchangiaji (CLA), au utaratibu mwingine wa kisheria. (URL inahitajika) [dco]
    DCO ni utaratibu unaopendekeza kwa sababu ni rahisi kutekeleza, kufuatilia katika msimbo wa chanzo, na git inasaidia moja kwa moja kipengele cha "signed-off" kwa kutumia "commit -s". Ili kuwa na ufanisi zaidi ni bora ikiwa nyaraka za mradi zinaeleza maana ya "signed-off" kwa mradi huo. CLA ni makubaliano ya kisheria yanayofafanua masharti ambayo kazi za kiakili zimetolewa leseni kwa shirika au mradi. Makubaliano ya mgawo wa mchangiaji (CAA) ni makubaliano ya kisheria yanayohamisha haki katika kazi ya kiakili kwa chama kingine; miradi haihitajiki kuwa na CAA, kwa kuwa kuwa na CAA huongeza hatari kwamba wachangiaji watarajiwa hawatachangia, hasa ikiwa mpokeaji ni shirika la faida. Apache Software Foundation CLAs (leseni ya mchangiaji wa mtu binafsi na CLA ya kampuni) ni mifano ya CLA, kwa miradi ambayo inaamua kwamba hatari za aina hizi za CLA kwa mradi ni chini ya manufaa yao.

    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.


    Ya kutosha kwa nishani!

    Mradi LAZIMA ufafanue kwa uwazi na kuandika muundo wake wa utawala wa mradi (njia ya kufanya maamuzi, ikiwa ni pamoja na majukumu muhimu). (URL inahitajika) [governance]
    Kunahitaji kuwa na njia fulani iliyowekwa vyema ya kuandikwa ya kufanya maamuzi na kutatua migogoro. Katika miradi midogo, hii inaweza kuwa rahisi kama "mmiliki wa mradi na kiongozi hufanya maamuzi yote ya mwisho". Kuna miundo mbalimbali ya utawala, ikiwa ni pamoja na dictator wa wema na meritocracy rasmi; kwa maelezo zaidi, angalia Miundo ya utawala. Mbinu zote mbili za kati (k.m., mtunzaji mmoja) na zisizo za kati (k.m., watunzaji wa kikundi) zimetumika kwa mafanikio katika miradi. Habari za utawala hazihitajiki kuandika uwezekano wa kuunda uma wa mradi, kwa kuwa hiyo ni iwezekanavyo kila wakati kwa miradi ya FLOSS.

    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.


    Ya kutosha kwa nishani!

    Mradi LAZIMA upitishe kanuni ya mwenendo na kuiweka mahali pa kawaida. (URL inahitajika) [code_of_conduct]
    Miradi inaweza kuweza kuboresha uadilifu wa jamii yao na kuweka matarajio kuhusu tabia inayokubalika kwa kupitisha kanuni ya mwenendo. Hii inaweza kusaidia kuepuka matatizo kabla hayajatokea na kufanya mradi kuwa mahali pa kukaribishwa zaidi ili kuhimiza michango. Hii inapaswa kuzingatia tu tabia ndani ya jamii/mahali pa kazi pa mradi. Mifano ya kanuni za mwenendo ni kanuni ya mwenendo ya kernel ya Linux, Kanuni ya Mwenendo ya Agano la Mchangiaji, Kanuni ya Mwenendo ya Debian, Kanuni ya Mwenendo ya Ubuntu, Kanuni ya Mwenendo ya Fedora, Kanuni ya Mwenendo ya GNOME, Kanuni ya Mwenendo ya Jamii ya KDE, Kanuni ya Mwenendo ya Jamii ya Python, Mwongozo wa Mwenendo wa Jamii ya Ruby, na Kanuni ya Mwenendo ya Rust.

    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/.


    Ya kutosha kwa nishani!

    Mradi LAZIMA ufafanue kwa uwazi na kuandika hadharani majukumu muhimu katika mradi na wajibu wao, ikiwa ni pamoja na kazi zozote ambazo majukumu hayo lazima yafanywe. Lazima iwe wazi ni nani ana jukumu lipi, ingawa hii haiwezi kuandikwa kwa njia ile ile. (URL inahitajika) [roles_responsibilities]
    Nyaraka kwa utawala na majukumu na wajibu zinaweza kuwa mahali pamoja.

    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.


    Ya kutosha kwa nishani!

    Mradi LAZIMA uweze kuendelea kwa usumbufu mdogo ikiwa mtu yeyote anakufa, anakuwa katika hali ya kudhoofika, au vinginevyo hawezi au hataki kuendelea kusaidia mradi. Hasa, mradi LAZIMA uweze kuunda na kufunga masuala, kukubali mabadiliko yaliyopendekezwa, na kutoa matoleo ya programu, ndani ya wiki moja ya uthibitishaji wa upotevu wa msaada kutoka kwa mtu yeyote mmoja. Hii INAWEZA kufanywa kwa kuhakikisha mtu mwingine ana funguo zozote zinazohitajika, nywila, na haki za kisheria ili kuendelea mradi. Watu binafsi wanaoendesha mradi wa FLOSS WANAWEZA kufanya hii kwa kuweka funguo katika sanduku la kufungia na wosia unaowezesha haki zozote zinazohitajika za kisheria (k.m., kwa majina ya DNS). (URL inahitajika) [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


    Ya kutosha kwa nishani!

    Mradi INAPASWA kuwa na "bus factor" ya 2 au zaidi. (URL inahitajika) [bus_factor]
    "Bus factor" (pia inajulikana kama "truck factor") ni idadi ya chini ya washiriki wa mradi ambao wanapaswa kutoweka ghafla kutoka kwenye mradi ("kupigwa na basi") kabla ya mradi kusimama kwa sababu ya ukosefu wa wafanyakazi wenye elimu au wenye uwezo. Zana ya truck-factor inaweza kukadiria hii kwa miradi kwenye GitHub. Kwa maelezo zaidi, angalia Kutathmini Bus Factor ya Hifadhi za Git na Cosentino et al.

    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.


  • Nyaraka


    Ya kutosha kwa nishani!

    Mradi LAZIMA uwe na ramani ya barabara iliyoandikwa inayoeleza kile mradi unakusudia kufanya na kutofanya kwa angalau mwaka unaofuata. (URL inahitajika) [documentation_roadmap]
    Mradi huenda usitimiza ramani ya barabara, na hiyo ni sawa; kusudi la ramani ya barabara ni kusaidia watumiaji na wachangiaji watarajiwa kuelewa mwelekeo unaokusudiwa wa mradi. Haihitaji kuwa na maelezo mengi.

    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.


    Ya kutosha kwa nishani!

    Mradi LAZIMA ujumuishe nyaraka za muundo (pia inajulikana kama muundo wa kiwango cha juu) wa programu inayozalishwa na mradi. Ikiwa mradi hauzalishi programu, chagua "haihusiki" (N/A). (URL inahitajika) [documentation_architecture]
    Muundo wa programu unaeleza miundo ya msingi ya programu, yaani, vipengele vikuu vya programu, uhusiano kati yao, na mali muhimu za vipengele na uhusiano hivi.

    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/


    Ya kutosha kwa nishani!

    Mradi LAZIMA uandike kile mtumiaji anaweza na asiweze kutarajia kwa suala la usalama kutoka kwa programu inayozalishwa na mradi ("mahitaji yake ya usalama"). (URL inahitajika) [documentation_security]
    Haya ni mahitaji ya usalama ambayo programu inakusudiwa kukidhi.

    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


    Ya kutosha kwa nishani!

    Mradi LAZIMA utoe mwongozo wa "kuanza haraka" kwa watumiaji wapya kuwasaidia kufanya kitu haraka na programu. (URL inahitajika) [documentation_quick_start]
    Wazo ni kuonyesha watumiaji jinsi ya kuanza na kufanya programu ifanye chochote. Hii ni muhimu sana kwa watumiaji watarajiwa kuanza.

    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/


    Ya kutosha kwa nishani!

    Mradi LAZIMA ufanye jitihada ya kuweka nyaraka kulingana na toleo la sasa la matokeo ya mradi (ikiwa ni pamoja na programu inayozalishwa na mradi). Kasoro yoyote inayojulikana ya nyaraka inayofanya isilingane LAZIMA irekebishwe. Ikiwa nyaraka kwa ujumla ni za sasa, lakini kwa makosa inajumuisha baadhi ya maelezo ya zamani ambayo sio ya kweli tena, ichukue tu kama kasoro, kisha ifuatilie na urekebishe kama kawaida. [documentation_current]
    Nyaraka ZINAWEZA kujumuisha habari kuhusu tofauti au mabadiliko kati ya matoleo ya programu na/au kuunganisha kwa matoleo ya zamani ya nyaraka. Kusudi la kigezo hiki ni kwamba jitihada inafanywa ili kuweka nyaraka kulingana, siyo kwamba nyaraka lazima ziwe kamili.

    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.


    Ya kutosha kwa nishani!

    Ukurasa wa mbele wa hifadhi ya mradi na/au tovuti LAZIMA utambulishe na kuunganisha kiungo kwa mafanikio yoyote, ikiwa ni pamoja na nishani hii ya mazoea bora, ndani ya masaa 48 ya kutambua hadharani kwamba ufanikio umepatikana. (URL inahitajika) [documentation_achievements]
    Ufanikio ni seti yoyote ya vigezo vya nje ambavyo mradi umefanya kazi mahususi kukidhi, ikiwa ni pamoja na nishani fulani. Habari hii haihitaji kuwa kwenye ukurasa wa mbele wa tovuti ya mradi. Mradi unaotumia GitHub unaweza kuweka mafanikio kwenye ukurasa wa mbele wa hifadhi kwa kuyaongeza kwenye faili ya 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.


  • Ufikiaji na kimataifa


    Ya kutosha kwa nishani!

    Mradi (tovuti zote za mradi na matokeo ya mradi) INAPASWA kufuata mazoea bora ya ufikiaji ili watu wenye ulemavu bado waweze kushiriki katika mradi na kutumia matokeo ya mradi ambapo ni busara kufanya hivyo. [accessibility_best_practices]
    Kwa programu za wavuti, angalia Miongozo ya Ufikiaji wa Maudhui ya Wavuti (WCAG 2.0) na hati yake inayosaidia Kuelewa WCAG 2.0; angalia pia habari za ufikiaji za W3C. Kwa programu za GUI, zingatia kutumia miongozo ya ufikiaji ya mazingira maalum (kama vile Gnome, KDE, XFCE, Android, iOS, Mac, na Windows). Baadhi ya programu za TUI (k.m., programu za `ncurses`) zinaweza kufanya mambo fulani ili kuzifanya kufikika zaidi (kama mpangilio wa `force-arrow-cursor` wa `alpine`). Programu nyingi za mstari wa amri zinafikika vizuri kama zilivyo. Kigezo hiki mara nyingi ni N/A, k.m., kwa maktaba za programu. Hapa kuna baadhi ya mifano ya hatua za kuchukua au masuala ya kuzingatia:
    • Toa mbadala za maandishi kwa maudhui yoyote yasiyo ya maandishi ili yaweze kubadilishwa kuwa aina nyingine watu wanahitaji, kama vile chapa kubwa, braille, hotuba, alama au lugha rahisi zaidi ( mwongozo wa WCAG 2.0 1.1)
    • Rangi haitumiwi kama njia pekee ya kuona ya kuwasilisha habari, kuashiria kitendo, kuchochea jibu, au kutofautisha kipengele cha kuona. ( mwongozo wa WCAG 2.0 1.4.1)
    • Uwasilishaji wa kuona wa maandishi na picha za maandishi una uwiano wa tofauti wa angalau 4.5:1, isipokuwa kwa maandishi makubwa, maandishi ya bahati mbaya, na nembo ( mwongozo wa WCAG 2.0 1.4.3)
    • Fanya kazi zote zipatikane kutoka kwenye kibodi (mwongozo wa WCAG 2.1)
    • Mradi wa GUI au wa wavuti INAPASWA kupima na angalau kipaza sauti kimoja cha skrini kwenye jukwaa la lengo (k.m., NVDA, Jaws, au WindowEyes kwenye Windows; VoiceOver kwenye Mac & iOS; Orca kwenye Linux/BSD; TalkBack kwenye Android). Programu za TUI ZINAWEZA kufanya kazi kupunguza uchanganyiko wa ziada ili kuzuia usomaji wa ziada na vipaza sauti vya skrini.

    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)


    Ya kutosha kwa nishani!

    Programu iliyozalishwa na mradi INAPASWA kuwa kimataifa ili kuwezesha upatanifu wa lugha wa rahisi kwa utamaduni, eneo, au lugha ya hadhira lengo. Ikiwa kimataifa (i18n) haihusiki (k.m., programu haizalishi maandishi yanayokusudiwa kwa watumiaji wa mwisho na haipangi maandishi yanayosomeka na binadamu), chagua "haihusiki" (N/A). [internationalization]
    Upatanifu wa lugha "unarejelea upatanifu wa bidhaa, programu au maudhui ya hati ili kukidhi lugha, utamaduni na mahitaji mengine ya soko mahususi la lengo (eneo)." Kimataifa ni "muundo na maendeleo ya bidhaa, programu au maudhui ya hati ambayo huwezesha upatanifu wa lugha wa rahisi kwa hadhira lengo zinazotofautiana katika utamaduni, eneo, au lugha." (Ona "Upatanifu wa Lugha dhidi ya Kimataifa" ya W3C.) Programu inakidhi kigezo hiki kwa kuwa kimataifa tu. Hakuna upatanifu wa lugha kwa lugha nyingine mahususi unaohitajika, kwa kuwa mara tu programu imekuwa kimataifa inawezekana kwa wengine kufanya kazi kwenye upatanifu wa lugha.

    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


  • Mengine


    Ya kutosha kwa nishani!

    Ikiwa tovuti za mradi (tovuti, hifadhi, na URL za kupakua) zinahifadhi nywila kwa ajili ya uthibitishaji wa watumiaji wa nje, nywila LAZIMA zihifadhiwe kama mificho iliyorudiwa na chumvi kwa-mtumiaji kwa kutumia kanuni ya upanuaji (iliyorudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, au PBKDF2). Ikiwa tovuti za mradi hazihifadhi nywila kwa kusudi hili, chagua "haihusiki" (N/A). [sites_password_security]
    Kumbuka kwamba matumizi ya GitHub yanakidhi kigezo hiki. Kigezo hiki kinatumika tu kwa nywila zinazotumika kwa ajili ya uthibitishaji wa watumiaji wa nje kwenye tovuti za mradi (pia inaitwa uthibitishaji wa ndani). Ikiwa tovuti za mradi lazima ziingie kwenye tovuti zingine (pia inaitwa uthibitishaji wa nje), zinaweza kuhitaji kuhifadhi ishara za uidhinishaji kwa kusudi hilo kwa njia tofauti (kwa kuwa kuhifadhi mficho hakuna maana). Hii inatumia kigezo cha crypto_password_storage kwa tovuti za mradi, sawa na 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.


 Udhibiti wa Mabadiliko 1/1 ●

  • Matoleo ya awali


    Ya kutosha kwa nishani!

    Mradi LAZIMA utunze matoleo ya zamani yaliyotumika mara nyingi ya bidhaa au kutoa njia ya usasishaji kwa matoleo mapya. Ikiwa njia ya usasishaji ni ngumu, mradi LAZIMA uandike jinsi ya kufanya usasishaji (k.m., violesura vilivyobadilika na hatua zilizoanishwa kwa undani ili kusaidia usasishaji). [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.


 Kuripoti 2/3 ●

  • Mchakato wa kuripoti hitilafu


    Ya kutosha kwa nishani!

    Mradi LAZIMA utumie kifuatiliaji cha masuala kwa ajili ya kufuatilia masuala ya mtu binafsi. [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.


  • Mchakato wa kuripoti udhaifu


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA utoe sifa kwa waripoti wa ripoti zote za udhaifu zilizotatuliwa katika miezi 12 iliyopita, isipokuwa kwa waripoti wanaoomba kutojulikana. Ikiwa hakuna udhaifu uliotatuliwa katika miezi 12 iliyopita, chagua "haihusiki" (N/A). (URL inahitajika) [vulnerability_report_credit]

    Ya kutosha kwa nishani!

    Mradi LAZIMA uwe na mchakato ulioandikwa kwa ajili ya kujibu ripoti za udhaifu. (URL inahitajika) [vulnerability_response_process]
    Hii ina uhusiano mkubwa na vulnerability_report_process, ambayo inahitaji kuwa kuna njia iliyoandikwa ya kuripoti udhaifu. Pia inahusiana na vulnerability_report_response, ambayo inahitaji majibu kwa ripoti za udhaifu ndani ya kipindi fulani cha muda.

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


 Ubora 4/19 ●

  • Viwango vya msimbo


    Ya kutosha kwa nishani!

    Mradi LAZIMA utambulishe miongozo mahususi ya mtindo wa kuandika msimbo kwa lugha kuu inazotumia, na uhitaji kwamba michango kwa ujumla ikidhi. (URL inahitajika) [coding_standards]
    Katika hali nyingi hii inafanywa kwa kurejelea baadhi ya miongozo ya mtindo iliyopo, huenda ikiorodhesha tofauti. Miongozo hii ya mtindo inaweza kujumuisha njia za kuboresha usomaji na njia za kupunguza uwezekano wa kasoro (ikiwa ni pamoja na udhaifu). Lugha nyingi za programu zina miongozo moja au zaidi ya mtindo inayotumika sana. Mifano ya miongozo ya mtindo ni pamoja na miongozo ya mtindo ya Google na Viwango vya Kuandika Msimbo wa 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.


    Ya kutosha kwa nishani!

    Mradi LAZIMA utekeleze kiotomatiki mtindo wake wa kuandika msimbo uliochaguliwa ikiwa kuna angalau zana moja ya FLOSS inayoweza kufanya hivyo katika lugha zilizochaguliwa. [coding_standards_enforced]
    Hii INAWEZA kutekelezwa kwa kutumia zana za uchambuzi mkako na/au kwa kulazimisha msimbo kupitia vifaa vya kurekebisha msimbo. Katika hali nyingi usanidi wa zana umejumuishwa katika hifadhi ya mradi (kwa kuwa miradi tofauti inaweza kuchagua usanidi tofauti). Miradi INAWEZA kuruhusu vighairi vya mtindo (na kwa kawaida itaruhusu); ambapo vighairi vinatokea, LAZIMA viwe nadra na viandikwe katika msimbo katika maeneo yao, ili vighairi hivi viweze kukaguliwa na ili zana ziweze kuzishughulikia kiotomatiki baadaye. Mifano ya zana kama hizo ni pamoja na ESLint (JavaScript), Rubocop (Ruby), na devtools check (R).

    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.


  • Mfumo wa ujenzi unaofanya kazi


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mifumo ya kujenga kwa binari za asili LAZIMA iheshimu vigezo (vya mazingira) vya mkusanyaji na vya kiunganishi vilivyopitishwa kwao (k.m., CC, CFLAGS, CXX, CXXFLAGS, na LDFLAGS) na kuvipitisha kwenye viito vya mkusanyaji na vya kiunganishi. Mfumo wa kujenga UNAWEZA kuvipanua na bendera za ziada; LAZIMA USIBADILISHE thamani zilizotolewa na zake mwenyewe. Ikiwa hakuna binari za asili zinazozalishwa, chagua "haihusiki" (N/A). [build_standard_variables]
    Inapaswa kuwa rahisi kuwezesha vipengele maalum vya kujenga kama Address Sanitizer (ASAN), au kutii mazoea bora ya ugumu wa usambazaji (k.m., kwa kuwezesha kwa urahisi bendera za mkusanyaji kufanya hivyo).

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mfumo wa kujenga na usakinishaji UNAPASWA kuhifadhi taarifa za utatuzi ikiwa zimeombwa katika bendera husika (k.m., "install -s" haitumiwa). Ikiwa hakuna mfumo wa kujenga au usakinishaji (k.m., maktaba za kawaida za JavaScript), chagua "haihusiki" (N/A). [build_preserve_debug]
    K.m., kuweka CFLAGS (C) au CXXFLAGS (C++) inapaswa kuunda taarifa husika za utatuzi ikiwa lugha hizo zinatumika, na hazipaswi kuondolewa wakati wa usakinishaji. Taarifa za utatuzi zinahitajika kwa msaada na uchambuzi, na pia ni muhimu kwa kupima uwepo wa vipengele vya ugumu katika binari zilizokusanywa.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mfumo wa kujenga kwa programu iliyozalishwa na mradi LAZIMA USIJENGA kwa njia ya kujirudia saraka ndogo ikiwa kuna utegemezi wa kukatana katika saraka ndogo. Ikiwa hakuna mfumo wa kujenga au usakinishaji (k.m., maktaba za kawaida za JavaScript), chagua "haihusiki" (N/A). [build_non_recursive]
    Taarifa ya utegemezi wa ndani ya mfumo wa kujenga wa mradi inahitaji kuwa sahihi, vinginevyo, mabadiliko ya mradi huenda yasijenge vizuri. Mijengo isiyo sahihi inaweza kusababisha kasoro (ikiwa ni pamoja na udhaifu). Kosa la kawaida katika mifumo mikubwa ya kujenga ni kutumia "ujenzi wa kujirudia" au "make ya kujirudia", yaani, mlingano wa saraka ndogo zinazojumuisha faili za chanzo, ambapo kila saraka ndogo inajengwa kwa uhuru. Isipokuwa kila saraka ndogo ni huru kabisa, hii ni kosa, kwa sababu taarifa ya utegemezi si sahihi.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA uweze kurudia mchakato wa kuzalisha taarifa kutoka faili za chanzo na kupata matokeo sawa ya biti-kwa-biti. Ikiwa hakuna ujenzi unaofanyika (k.m., lugha za uandishi ambapo msimbo wa chanzo unatumika moja kwa moja badala ya kukusanywa), chagua "haihusiki" (N/A). [build_repeatable]
    Watumiaji wa GCC na clang wanaweza kupata chaguo la -frandom-seed kuwa na manufaa; katika hali fulani, hii inaweza kutatuliwa kwa kulazimisha aina fulani ya mpangilio. Mapendekezo zaidi yanaweza kupatikana kwenye tovuti ya ujenzi unaorudiwa.

  • Mfumo wa usakinishaji


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA utoe njia ya kusakinisha na kuondoa kwa urahisi programu iliyozalishwa na mradi kwa kutumia mkataba unaotumika sana. [installation_common]
    Mifano ni pamoja na kutumia meneja wa kifurushi (kwa mfumo au kiwango cha lugha), "make install/uninstall" (inasaidia DESTDIR), chombo katika muundo wa kawaida, au picha ya mashine pepe katika muundo wa kawaida. Mchakato wa usakinishaji na uondoaji (k.m., kifurushi chake) UNAWEZA kutekelezwa na mtu wa tatu mradi tu ni FLOSS.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mfumo wa usakinishaji kwa watumiaji wa mwisho LAZIMA uheshimu mkataba wa kawaida kwa kuchagua eneo ambapo vitu vilivyojengwa vinaandikwa kwa wakati wa usakinishaji. Kwa mfano, ikiwa inasakinisha faili kwenye mfumo wa POSIX lazima iheshimu kigezo cha mazingira cha DESTDIR. Ikiwa hakuna mfumo wa usakinishaji au hakuna mkataba wa kawaida, chagua "haihusiki" (N/A). [installation_standard_variables]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA utoe njia kwa wasanidi programu wanaoweza kusakinisha haraka matokeo yote ya mradi na mazingira ya msaada yanayohitajika kufanya mabadiliko, ikiwa ni pamoja na majaribio na mazingira ya majaribio. Hii LAZIMA ifanywe kwa kutumia mkataba unaotumika sana. [installation_development_quick]
    Hii INAWEZA kutekelezwa kwa kutumia chombo kilichozalishwa na/au hati za usakinishaji. Utegemezi wa nje kwa kawaida utasakinishwa kwa kuita mfumo na/au meneja wa kifurushi cha lugha, kwa external_dependencies.

  • Vipengee vilivyotunzwa nje


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA uorodheshe utegemezi wa nje kwa njia inayoweza kuchakatwa na kompyuta. (URL inahitajika) [external_dependencies]
    Kwa kawaida hii inafanywa kwa kutumia mkataba wa meneja wa kifurushi na/au mfumo wa ujenzi. Kumbuka kwamba hii inasaidia kutekeleza installation_development_quick.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Miradi LAZIMA ifuatilie au kwa muda mrefu iangalie utegemezi wao wa nje (ikiwa ni pamoja na nakala za urahisi) kugundua udhaifu unaojulikana, na kurekebisha udhaifu unaoweza kutumiwa vibaya au kuthibitisha kuwa hauwezi kutumiwa vibaya. [dependency_monitoring]
    Hii inaweza kufanywa kwa kutumia zana ya kichambua chanzo / zana ya kuangalia utegemezi / zana ya uchambuzi wa muundo wa programu kama OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, na Bundler-audit (kwa Ruby). Baadhi ya waendesha kifurushi wanajumuisha taratibu za kufanya hii. Ni kubaliwa ikiwa udhaifu wa vipengele hauwezi kutumiwa vibaya, lakini uchambuzi huu ni mgumu na wakati mwingine ni rahisi kusasisha au kurekebisha sehemu.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA au:
    1. fanya iwe rahisi kutambua na kusasisha vipengele vinavyotumiwa tena vilivyotunzwa nje; au
    2. tumia vipengele vya kawaida vinavyotolewa na mfumo au lugha ya programu.
    Kisha, ikiwa udhaifu unapatikana katika kipengele kilichotumiwa tena, itakuwa rahisi kusasisha kipengele hicho. [updateable_reused_components]
    Njia ya kawaida ya kutimiza kigezo hiki ni kutumia mifumo ya usimamizi wa kifurushi ya mfumo na lugha ya programu. Programu nyingi za FLOSS zinasambazwa na "maktaba za urahisi" ambazo ni nakala za ndani za maktaba za kawaida (labda zilizoachana). Kwa yenyewe, hiyo ni sawa. Hata hivyo, ikiwa programu *lazima* itumie nakala hizi za ndani (zilizoachanishwa), basi kusasisha maktaba za "kawaida" kama sasisho la usalama litaacha nakala hizi za ziada bado zenye udhaifu. Hii ni suala hasa kwa mifumo ya wingu; ikiwa mtoa huduma ya wingu anasasisha maktaba zao za "kawaida" lakini programu haitazitumia, basi masasisho hayasaidii kweli. Angalia, k.m., "Chromium: Kwa nini bado haiko katika Fedora kama kifurushi sahihi" na Tom Callaway.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi UNAPASWA kuepuka kutumia vitendakazi na API zilizokubaliwa kuwa hazitumiki tena au zilizopitwa na wakati ambapo mbadala wa FLOSS zinapatikana katika seti ya teknolojia inayotumia ("kifurushi cha teknolojia" yake) na kwa wengi wa watumiaji ambao mradi unasaidia (ili watumiaji wawe na ufikiaji wa haraka wa mbadala). [interfaces_current]

  • Seti ya majaribio otomatiki


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Seti ya majaribio ya kiotomatiki LAZIMA itumike kwenye kila ukaguzi wa kuingia kwenye hifadhi iliyoshirikiwa kwa angalau tawi moja. Seti hii ya majaribio LAZIMA itoe ripoti ya mafanikio au kushindwa kwa majaribio. [automated_integration_testing]
    Mahitaji haya yanaweza kuonekana kama sehemu ndogo ya test_continuous_integration, lakini yanazingatia majaribio tu, bila kuhitaji uunganisho wa kuendelea.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA uongeze majaribio ya kurudi nyuma kwa seti ya majaribio ya kiotomatiki kwa angalau 50% ya hitilafu zilizorekebisha ndani ya miezi sita iliyopita. [regression_tests_added50]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA uwe na seti ya majaribio ya kiotomatiki ya FLOSS inayotoa angalau 80% ya usakinishaji wa taarifa ikiwa kuna angalau zana moja ya FLOSS inayoweza kupima kigezo hiki katika lugha iliyochaguliwa. [test_statement_coverage80]
    Zana nyingi za FLOSS zinapatikana kupima usakinishaji wa majaribio, ikiwa ni pamoja na gcov/lcov, Blanket.js, Istanbul, JCov, na covr (R). Kumbuka kwamba kutimiza kigezo hiki sio uhakika kwamba seti ya majaribio ni ya kina, badala yake, kushindwa kutimiza kigezo hiki ni kiashiria kizito cha seti ya majaribio mbaya.

  • Upimaji wa utendaji mpya


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA uwe na sera rasmi iliyoandikwa kwamba kadri utendakazi mkubwa mpya unaongezwa, majaribio ya utendakazi mpya LAZIMA yaongezwe kwenye seti ya majaribio ya kiotomatiki. [test_policy_mandated]

    Ya kutosha kwa nishani!

    Mradi LAZIMA ujumuishe, katika maelekezo yake yaliyoandikwa kwa mapendekezo ya mabadiliko, sera kwamba majaribio yataongezwa kwa utendakazi mkubwa mpya. [tests_documented_added]
    Hata hivyo, hata sheria isiyo rasmi inakubaliwa mradi majaribio yaongezwe kimakosa.

    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."


  • Bendera za maonyo


    Ya kutosha kwa nishani!

    Miradi LAZIMA iwe na ukali wa juu zaidi na maonyo katika programu iliyozalishwa na mradi, iwezekanavyo vitendo. [warnings_strict]
    Baadhi ya maonyo hayawezi kuwashwa kwa ufanisi kwenye miradi fulani. Kinachohitajika ni ushahidi kwamba mradi unajitahidi kuwasha bendera za onyo ambapo inaweza, ili makosa yagundulika mapema.

    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.


 Usalama 2/13 ●

  • Maarifa ya maendeleo yenye usalama


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA utekeleze kanuni za muundo salama (kutoka "know_secure_design"), pale inapohusika. Ikiwa mradi hauzalishi programu, chagua "haihusiki" (N/A). [implement_secure_design]
    Kwa mfano, matokeo ya mradi yanapaswa kuwa na mipangilio salama ya kuzuia makosa (maamuzi ya ufikiaji yanapaswa kukataa kwa chaguo-msingi, na usakinishaji wa mradi unapaswa kuwa salama kwa chaguo-msingi). Pia yanapaswa kuwa na kikuu cha kati kikamilifu (kila ufikiaji ambao unaweza kuwekwa kikomo lazima ufanyiwe ukaguzi wa mamlaka na usiweze kuvukwa). Kumbuka kwamba katika hali fulani kanuni zitagombana, na katika hali hiyo chaguo lazima lifanywe (k.m., taratibu nyingi zinaweza kufanya mambo kuwa magumu zaidi, kukiuka "uchumi wa utaratibu" / iweke rahisi).

  • Tumia mazoea mazuri ya msingi ya usimbuaji

    Kumbuka kwamba programu fulani haihitaji kutumia taratibu za usimbuaji. Ikiwa mradi wako unazalisha programu ambayo (1) inajumuisha, inaamilisha, au inafanya usimbuaji kuwa hai, na (2) inaweza kutolewa kutoka Marekani (US) kwenda nje ya Marekani au kwa raia asiye wa Marekani, inaweza kuwa ni lazima kisheria kuchukua hatua chache za ziada. Kawaida hii inahusisha tu kutuma barua pepe. Kwa maelezo zaidi, tazama sehemu ya usimbuaji ya Kuelewa Teknolojia ya Chanzo Wazi & Udhibiti wa Usafirishaji wa Marekani.

    Ya kutosha kwa nishani!

    Mifumo ya usalama ya chaguo-msingi ndani ya programu inayozalishwa na mradi LAZIMA ISITEGEMEE algoriti za kriptologia au hali zenye udhaifu mkubwa unaojulikana (k.m., algoriti ya hash ya kriptologia ya SHA-1 au hali ya CBC katika SSH). [crypto_weaknesses]
    Wasiwasi kuhusu hali ya CBC katika SSH unajadiliwa katika CERT: SSH CBC vulnerability.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi INAPASWA kusaidia algoriti nyingi za kriptologia, ili watumiaji waweze kubadilisha haraka ikiwa moja imevunjwa. Algoriti za kawaida za funguo za simetria ni pamoja na AES, Twofish, na Serpent. Mbadala wa algoriti za hash za kriptologia za kawaida ni pamoja na SHA-2 (ikiwa ni pamoja na SHA-224, SHA-256, SHA-384 NA SHA-512) na SHA-3. [crypto_algorithm_agility]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA usaidie kuhifadhi vitambulisho vya uthibitishaji (kama vile nywila na ishara za nguvu) na funguo za kibinafsi za kriptologia katika mafaili ambayo yametengwa na habari nyingine (kama vile mafaili ya usanidi, hifadhidata, na kumbukumbu), na kuruhusu watumiaji kusasisha na kubadilisha bila ukusanyaji upya wa msimbo. Ikiwa mradi haufanyi usindikaji wa vitambulisho vya uthibitishaji na funguo za kibinafsi za kriptologia, chagua "haihusiki" (N/A). [crypto_credential_agility]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Programu iliyozalishwa na mradi INAPASWA kusaidia itifaki salama kwa mawasiliano yake yote ya mtandao, kama vile SSHv2 au zaidi, TLS1.2 au zaidi (HTTPS), IPsec, SFTP, na SNMPv3. Itifaki zisizo salama kama vile FTP, HTTP, telnet, SSLv3 au mapema zaidi, na SSHv1 ZINAPASWA kuzimwa kwa chaguo-msingi, na kuzimwa tu ikiwa mtumiaji anaisanidi mahususi. Ikiwa programu iliyozalishwa na mradi haiesaidii mawasiliano ya mtandao, chagua "haihusiki" (N/A). [crypto_used_network]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Programu iliyozalishwa na mradi INAPASWA, ikiwa inasaidia au inatumia TLS, kusaidia angalau toleo la TLS 1.2. Kumbuka kuwa kilichotangulia TLS kiliitwa SSL. Ikiwa programu haitumii TLS, chagua "haihusiki" (N/A). [crypto_tls12]

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Programu iliyozalishwa na mradi LAZIMA, ikiwa inasaidia TLS, ifanye uthibitishaji wa cheti cha TLS kwa chaguo-msingi inapotumia TLS, ikiwa ni pamoja na rasilimali ndogo. Ikiwa programu haitumii TLS, chagua "haihusiki" (N/A). [crypto_certificate_verification]
    Kumbuka kuwa uthibitishaji usio sahihi wa cheti cha TLS ni kosa la kawaida. Kwa maelezo zaidi, angalia "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" na Martin Georgiev et al. na "Do you trust this application?" na Michael Catanzaro.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Programu iliyozalishwa na mradi LAZIMA, ikiwa inasaidia TLS, ifanye uthibitishaji wa cheti kabla ya kutuma vichwa vya HTTP na habari ya kibinafsi (kama vile vidakuzi salama). Ikiwa programu haitumii TLS, chagua "haihusiki" (N/A). [crypto_verification_private]

  • Kutolewa kwa usalama


    Ya kutosha kwa nishani!

    Mradi LAZIMA uweke saini kwa kriptologia matoleo ya matokeo ya mradi yanayokusudiwa kwa matumizi ya kila mahali, na LAZIMA kuwe na mchakato ulioandikwa unaoweleza watumiaji jinsi wanaweza kupata funguo za umma za saini na kuthibitisha saini. Funguo ya kibinafsi kwa saini hizi LAZIMA ISIWE kwenye tovuti zinazosambaza moja kwa moja programu kwa umma. Ikiwa matoleo hayakusudiwa kwa matumizi ya kila mahali, chagua "haihusiki" (N/A). [signed_releases]
    Matokeo ya mradi ni pamoja na msimbo wa chanzo na matokeo yoyote yaliyozalishwa pale inapohusika (k.m., mifumo inayotekelezeka, vifurushi, na vyombo). Matokeo yaliyozalishwa YANAWEZA kuwekwa saini tofauti na msimbo wa chanzo. Hizi ZINAWEZA kutekelezwa kama lebo za git zilizowekwa saini (kwa kutumia saini za kidijitali za kriptologia). Miradi YAWEZA kutoa matokeo yaliyozalishwa tofauti na zana kama vile git, lakini katika hali hizo, matokeo tofauti LAZIMA yawekwe saini tofauti.

    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.".


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    INAPENDEKEZWA kuwa katika mfumo wa udhibiti wa toleo, kila lebo muhimu ya toleo (lebo ambayo ni sehemu ya toleo kuu, toleo dogo, au kurekebishwa udhaifu uliotangazwa hadharani) iwekwe saini kwa kriptologia na iweze kuthibitishwa kama ilivyoelezwa katika signed_releases. [version_tags_signed]

  • Masuala mengine ya usalama


    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Matokeo ya mradi LAZIMA yafanye ukaguzi wa pembejeo zote kutoka vyanzo visivyoaminika ili kuhakikisha ni halali (*orodha zinazokubalika*), na kukataa pembejeo zisizo halali, ikiwa kuna vizuizi vyovyote kwenye data kabisa. [input_validation]
    Kumbuka kuwa kulinganisha ingizo dhidi ya orodha ya "miundo mibaya" (aka *orodha za kukataza*) kwa kawaida haitoshi, kwa sababu washambuliaji mara nyingi wanaweza kuepuka orodha ya kukataza. Hasa, nambari zinabadilishwa kuwa miundo ya ndani na kisha kuangaliwa ikiwa ziko kati ya chini na juu zao (ikiwa ni pamoja), na vifungu vya maandishi vinaangaliwa ili kuhakikisha kuwa ni ruwaza halali za maandishi (k.m., UTF-8 halali, urefu, sintaksia, n.k.). Baadhi ya data inaweza kuhitaji kuwa "chochote kabisa" (k.m., kipakia faili), lakini hizi kwa kawaida zingekuwa nadra.

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Taratibu za kuimarisha ZINAPASWA kutumiwa katika programu iliyozalishwa na mradi ili kasoro za programu ziwe na uwezekano mdogo wa kusababisha udhaifu wa usalama. [hardening]
    Taratibu za kuimarisha zinaweza kujumuisha vichwa vya HTTP kama Sera ya Usalama wa Maudhui (CSP), bendera za mkusanyaji ili kupunguza mashambulizi (kama vile -fstack-protector), au bendera za mkusanyaji ili kuondoa tabia isiyofafanuliwa. Kwa madhumuni yetu upendeleo mdogo hauhesabiwi kuwa utaratibu wa kuimarisha (upendeleo mdogo ni muhimu, lakini tofauti).

    Taarifa inayohitajika haijulikani, si ya kutosha kwa nishani.

    Mradi LAZIMA utoe kesi ya uhakika inayosababisha kwa nini mahitaji yake ya usalama yanakidhi. Kesi ya uhakika LAZIMA ijumuishe: maelezo ya muundo wa tishio, utambulisho wazi wa mipaka ya kuaminiwa, hoja kwamba kanuni za muundo salama zimetumika, na hoja kwamba udhaifu wa kawaida wa utekelezaji wa usalama umekabiliana nao. (URL inahitajika) [assurance_case]
    Kesi ya uhakika ni "mwili wa ushahidi ulioandikwa unaotoa hoja inayoshawishi na halali kwamba seti maalum ya madai muhimu kuhusu mali za mfumo ziko na sababu za kutosha kwa programu maalum katika mazingira maalum" ("Uhakika wa Programu Kwa kutumia Miundo ya Kesi ya Uhakika Iliyopangwa", Thomas Rhodes et al, NIST Interagency Report 7608). Mipaka ya kuaminiwa ni mipaka ambapo data au utekelezaji hubadilisha kiwango chake cha kuaminiwa, k.m., mipaka ya seva katika programu ya kawaida ya wavuti. Ni ya kawaida kuorodhesha kanuni za muundo salama (kama vile Saltzer na Schroeer) na udhaifu wa kawaida wa utekelezaji wa usalama (kama vile OWASP top 10 au CWE/SANS top 25), na kuonyesha jinsi kila moja unavyokabiliana. Kesi ya uhakika ya BadgeApp inaweza kuwa mfano wenye manufaa. Hii inahusiana na documentation_security, documentation_architecture, na implement_secure_design.

 Uchanganuzi 2/2 ●

  • Uchambuzi tuli wa msimbo


    Ya kutosha kwa nishani!

    Mradi LAZIMA utumie angalau zana moja ya uchanganuzi tuli yenye sheria au mbinu za kutafuta udhaifu wa kawaida katika lugha au mazingira yaliyochanganuliwa, ikiwa kuna angalau zana moja ya FLOSS inayoweza kutekeleza kigezo hiki katika lugha iliyochaguliwa. [static_analysis_common_vulnerabilities]
    Zana za uchambuzi tuli ambazo zimeundwa hasa kutafuta udhaifu wa kawaida zina uwezekano mkubwa wa kuzipata. Hata hivyo, kutumia zana zozote za tuli kwa kawaida itasaidia kupata baadhi ya matatizo, kwa hivyo tunashauri lakini hatunahitaji hii kwa kiwango cha nishani ya 'kupita'.

    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.


  • Uchambuzi wa msimbo wa nguvu za ziada


    Ya kutosha kwa nishani!

    Ikiwa programu iliyozalishwa na mradi inajumuisha programu iliyoandikwa kwa kutumia lugha isiyosalama ya kumbukumbu (k.m., C au C++), basi angalau zana moja ya nguvu (k.m., fuzzer au kitafutaji cha programu ya wavuti) LAZIMA itumike kwa kawaida kwa pamoja na utaratibu wa kugundua matatizo ya usalama wa kumbukumbu kama vile uandikaji zaidi wa kipengele. Ikiwa mradi hauzalishi programu iliyoandikwa katika lugha isiyosalama ya kumbukumbu, chagua "haihusiki" (N/A). [dynamic_analysis_unsafe]
    Mifano ya taratibu za kugundua matatizo ya usalama wa kumbukumbu ni pamoja na Address Sanitizer (ASAN) (inapatikana katika GCC na LLVM), Memory Sanitizer, na valgrind. Zana nyingine zinazoweza kutumika ni pamoja na thread sanitizer na undefined behavior sanitizer. Madai ya kila mahali pia yaweza kufanya kazi.

    N/A,language used is Python.



Unaweza kutumia zana na mifumo ya AI kupendekeza mabadiliko kupitia URL rahisi, kama vile https://www.bestpractices.dev/sw/projects/9408/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Angalia mfumo wetu wa mapendekezo ya otomatiki kwa jinsi ya kufanya hivyo. Data hii inapatikana chini ya Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Hii inamaanisha kuwa Mpokeaji wa Data anaweza kushiriki Data, na au bila marekebisho, mradi Mpokeaji wa Data anapatanisha maandishi ya mkataba huu na Data iliyoshirikiwa. Tafadhali tambua Lou DeGenaro na wachangiaji wa nishani ya Mazoea Bora ya OpenSSF.

Ingizo la nishani ya mradi linamilikiwa na: Lou DeGenaro.
Ingizo liliundwa siku 2024-09-02 12:27:57 UTC, iliyosasishwa mara ya mwisho siku 2026-09-09 18:19:33 UTC. Ilipata mara ya mwisho nishani ya kupita siku 2024-11-11 12:03:16 UTC.