vfhe

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 hali ya nishani yako ya msingi kwenye ukurasa wa mradi wako! Hali ya nishani ya msingi inaonekana kama hii: Kiwango cha nishani ya msingi kwa mradi 13712 ni baseline-3 Huu ndiyo jinsi ya kuweka nishani ya msingi:
Unaweza kuonyesha hali ya nishani yako ya msingi kwa kuweka hii katika faili yako ya markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/13712/baseline)](https://www.bestpractices.dev/projects/13712)
au kwa kuweka hii katika HTML yako:
<a href="https://www.bestpractices.dev/projects/13712"><img src="https://www.bestpractices.dev/projects/13712/baseline"></a>


Hizi ni vigezo vya Kiwango cha Msingi 3. Hizi ni vigezo vya toleo v2026.08.28.

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

        

 Misingi

  • Jumla

    Kumbuka kwamba miradi mingine inaweza kutumia jina sawa.

    A library for Zero-Knowledge Proofs, (verifiable) Fully Homomorphic Encryption, and related techniques.

    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.

 Udhibiti 21/21

  • Udhibiti


    Ruhusa zinapopeana kwa kazi katika mfumo wa CI/CD, msimbo wa chanzo au usanidi LAZIMA upee tu ruhusa za chini zaidi zinazohitajika kwa shughuli zinazohusiana. [OSPS-AC-04.02]
    Sanidi mifumo ya CI/CD ya mradi ili kupea ruhusa za chini zinazopatikana kwa watumiaji na huduma kwa chaguomsingi, ukipandisha ruhusa tu inapohitajika kwa kazi maalum. Katika baadhi ya mifumo ya udhibiti wa toleo, hii inaweza kufanyika katika kiwango cha shirika au hifadhi. Ikiwa sivyo, weka ruhusa katika kiwango cha juu cha mfumo.

    Every workflow declares an explicit permissions: block; the top-level default is minimal (contents: read) and individual jobs elevate only what they need — id-token: write for Trusted Publishing, attestations: write for provenance, pull-requests: write for the coverage comment. No job runs with broader scope than its task requires.



    Mifuko ya CI/CD inayokubali pembejeo za mshirika anayeaminika LAZIMA isafishe na kuthibitisha pembejeo hiyo kabla ya kutumia katika mfuko. [OSPS-BR-01.04]
    Mifuko ya CI/CD inapaswa kusafisha (kunukuu, kutoroka au kutoka kwa maadili yanayotarajiwa) pembejeo zote za mshirika kwenye utekelezaji wa mtiririko wa kazi wa wazi. Ingawa washirika kwa ujumla wanaaminika, pembejeo za mwongozo kwa mtiririko wa kazi haiwezi kukaguliwa na inaweza kutumiwa vibaya na utekaji wa akaunti au tishio la ndani.

    The release workflow's manual inputs are validated before use: target is a fixed choice list, and a dedicated first step exits non-zero unless the pypi target runs from a tag and the testpypi target supplies a version. All collaborator inputs enter shell steps only as quoted environment variables, never interpolated into the script body.



    Toleo rasmi linapobuniwa, mali zote ndani ya toleo hilo LAZIMA zihusianishwe wazi na kitambulisho cha toleo au kitambulisho kingine cha kipekee kwa mali hiyo. [OSPS-BR-02.02]
    Panga kitambulisho cha kipekee cha toleo kwa kila mali ya programu inayozalishwa na mradi, ukifuata kawaida ya uainishaji thabiti au mpango wa nambari. Mifano ni pamoja na SemVer, CalVer, au kitambulisho cha git commit.

    Every release asset is associated with the version identifier: the sdist filename embeds it, the immutable git tag and PyPI version fix it, and the SBOM and Sigstore provenance are attached to that tagged GitHub release. The version is derived from the tag by setuptools-scm, so all assets of a release share one identifier.



    Mradi LAZIMA ufafanue sera ya kudhibiti siri na ushahidi unaotumika na mradi. Sera inapaswa kujumuisha mwongozo wa kuhifadhi, kufikia, na kuzungusha siri na ushahidi. [OSPS-BR-07.02]
    Eleza jinsi siri na ushahidi vinavyodhibitiwa na kutumika ndani ya mradi. Hii inapaswa kujumuisha maelezo ya jinsi siri zinavyohifadhiwa (k.m., kwa kutumia zana ya usimamizi wa siri), jinsi ufikiaji unavyodhibitiwa, na jinsi siri zinavyozungushwa au kusasishwa. Hakikisha kwamba habari nyeti haziingizwi kwa msimbo katika msimbo wa chanzo au kuhifadhiwa katika mifumo ya udhibiti wa toleo.

    The secrets policy is documented in SECURITY.md ("Secrets and credentials"). The project stores no long-lived secrets: PyPI publishing uses Trusted Publishing (short-lived OIDC tokens minted per run) and releases are signed with Sigstore's ephemeral keys, so there is nothing to rotate. GitHub Actions runs with a read-only default token, elevated per job only where needed; a detect-private-key pre-commit hook and GitHub push protection block accidental credential commits; nothing sensitive is hard-coded.



    Mradi ulipotoa toleo, nyaraka za mradi LAZIMA ziwe na maelekezo ya kuthibitisha uadilifu na uhalali wa mali za toleo. [OSPS-DO-03.01]
    Maelekezo katika mradi yanapaswa kuwa na habari kuhusu teknolojia iliyotumika, amri za kuendesha, na matokeo yanayotarajiwa. Inapowezekana, epuka kuhifadhi nyaraka hizi katika mahali pamoja na mfumo wa ujenzi na utoaji wa toleo ili kuepuka ukiukaji mmoja kuhatarisha programu na nyaraka za kuthibitisha uadilifu wa programu.

    README ("Verifying a release") gives the technology, exact commands, and expected output to verify integrity and authenticity: download the sdist and run gh attestation verify <sdist> --repo vfhe/vfhe, which validates the Sigstore build provenance against the artifact's digest. PyPI additionally records these attestations on the project files page.



    Mradi unapotoa toleo, nyaraka za mradi LAZIMA ziwe na maelekezo ya kuthibitisha utambulisho unaotarajiwa wa mtu au mchakato unaothibitisha toleo la programu. [OSPS-DO-03.02]
    Utambulisho unaotarajiwa unaweza kuwa katika muundo wa vitambulisho vya funguo vilivyotumika kusaini, mtoa na utambulisho kutoka cheti cha sigstore, au aina nyingine zinazofanana. Inapowezekana, epuka kuhifadhi nyaraka hii mahali palipo sawa na mirija ya kujenga na kutoa ili kuepuka ukiukaji mmoja kuhatarisha programu na nyaraka za kuthibitisha uadilifu wa programu.

    The same README section documents the expected authoring identity: successful verification shows the signer as the .github/workflows/release.yml workflow of vfhe/vfhe, issued through GitHub Actions' OIDC (https://token.actions.githubusercontent.com). A mismatched or absent identity indicates the artifact is not a genuine release.



    Mradi unapotoa toleo, nyaraka za mradi LAZIMA zijumuishe kauli ya maelezo kuhusu wigo na muda wa msaada kwa kila toleo. [OSPS-DO-04.01]
    Ili kuwasilisha wigo na muda wa msaada kwa rasilimali za programu zilizotolewa za mradi, mradi unapaswa kuwa na faili ya SUPPORT.md, sehemu ya "Msaada" katika SECURITY.md, au nyaraka nyingine zinazoweka wazi mzunguko wa maisha wa msaada, ikijumuisha muda unaotarajiwa wa msaada kwa kila toleo, aina za msaada zinazotolewa (k.m., marekebisho ya hitilafu, sasisho za usalama), na sera au taratibu yoyote husika ya kupata msaada.

    SUPPORT.md describes the support scope and duration: as pre-release (0.x) software, only the latest PyPI release is supported and receives bug fixes and security updates; there are no back-branches or long-term support, and every 0.x release may contain breaking changes. The types of support and channels (Zulip, issues, private security reporting) are stated, and the policy will be revised at 1.0.



    Mradi unapotoa toleo, nyaraka za mradi LAZIMA zitoe kauli ya maelezo ya wakati matoleo au matoleo hayatapokea tena sasisho za usalama. [OSPS-DO-05.01]
    Ili kuwasilisha wigo na muda wa msaada kwa marekebisho ya usalama, mradi unapaswa kuwa na SUPPORT.md au nyaraka nyingine zinazoweka wazi sera ya mradi ya sasisho za usalama.

    SUPPORT.md (and SECURITY.md "Supported versions") states that a release stops receiving security updates as soon as a newer release supersedes it; upgrading to the latest release is the supported remediation path for any fixed issue.



    Nyaraka za mradi LAZIMA ziwe na sera kwamba washirikiano wa msimbo wanakaguliwa kabla ya kupewa ruhusa za juu zaidi za rasilimali nyeti. [OSPS-GV-04.01]
    Chapisha sera inayoweza kutekelezwa katika nyaraka za mradi inayohitaji washirikiano wa msimbo kupimwa na kuidhinishwa kabla ya kupewa ruhusa zilizopandishwa kwa rasilimali nyeti, kama vile idhini ya kuunganisha au ufikiaji kwa siri. Inashauriwa kwamba upimaji ujumuishe kuanzisha mfululizo wa utambulisho unaoweza kuhalalishwa kama vile kuthibitisha ushirikiano wa mchangiaji na shirika linalojulikana na kuaminika.

    AUTHORS.md documents the policy: escalated permissions (merge rights and access to the GitHub organization, the PyPI project, or the release pipeline) are granted only after review and approval by the existing maintainers, only to contributors with an established, identifiable track record on the project, scoped to what the role requires and revoked when no longer needed.



    Mradi unapotoa toleo, rasilimali zote za programu zilizotolewa na zilizokusanywa LAZIMA zikabidhi pamoja na orodha ya bili ya programu. [OSPS-QA-02.02]
    Inashauriwa kuzalisha SBOM kiotomatiki wakati wa kujenga kwa kutumia zana ambayo imepimwa kwa usahihi. Hii huwezesha watumiaji kuingiza data hii kwa njia ya kiwango pamoja na miradi mingine katika mazingira yao.

    Each release ships a CycloneDX SBOM, auto-generated at build time by cyclonedx-py (the OWASP CycloneDX project's Python tool) from the installed package environment, and attached to the GitHub release. Reproducible output is enabled for deterministic SBOMs.



    Mradi unapotoa toleo linalojumuisha hifadhi nyingi za chanzo cha msimbo, miradi yote midogo LAZIMA ilazimishe mahitaji ya usalama ambayo ni kali au kali zaidi kuliko msimbo wa msingi. [OSPS-QA-04.02]
    Hifadhi yoyote ya ziada ya msimbo wa miradi midogo iliyozalishwa na mradi na kukusanywa katika toleo lazima ilazimishe mahitaji ya usalama kama inavyolingana na hali na nia ya msimbo husika. Kwa kuongeza kufuata mahitaji ya msingi wa OSPS yanayolingana, hii inaweza kujumuisha kuhitaji ukaguzi wa usalama, kuhakikisha kuwa haina udhaifu, na kuhakikisha kuwa haina masuala ya usalama yanayojulikana.

    The project is a single source-code repository. Third-party components are vendored as declared git submodules pinned to specific commits, not additional project subprojects, so there are no subproject repositories to which this requirement applies.



    Nyaraka za mradi LAZIMA zieleze kwa uwazi ni lini na jinsi gani majaribio yanaendeshwa. [OSPS-QA-06.02]
    Ongeza sehemu kwenye nyaraka za kuchangia inayoweka wazi jinsi ya kutekeleza majaribio kienyeji na jinsi ya kutekeleza majaribio katika mirija ya CI/CD. Nyaraka zinapaswa kuweka wazi majaribio yanajaribu nini na jinsi ya kutafsiri matokeo.

    CONTRIBUTING.md and docs/DEVELOPMENT.md (p.6) document when and how tests run: locally via make test (complete) and make test-fast, and in CI on every pull request across Linux and macOS on Python 3.10–3.14. The docs explain what the suites cover (C unit tests, the Python suite including heavy FHE bootstraps, sdist install-and-smoke) and how to read the result, the single CI OK gate.



    Nyaraka za mradi LAZIMA zijumuishe sera kwamba mabadiliko yote makubwa kwenye programu inayotengenezwa na mradi yanapaswa kuongeza au kusasisha majaribio ya utendaji katika seti ya majaribio otomatiki. [OSPS-QA-06.03]
    Ongeza sehemu kwenye nyaraka za kuchangia inayoweka wazi sera ya kuongeza au kusasisha majaribio. Sera inapaswa kuweka wazi ni nini kinachojumuisha mabadiliko makubwa na majaribio yapi yanapaswa kuongezwa au kusasishwa.

    CONTRIBUTING.md ("Testing policy") states that any change adding or altering functionality MUST add or update automated tests covering it, a new kernel, a new Python API, a bug fix (a test that fails before and passes after), or a behavioural change, while pure refactors, documentation, and CI changes are exempt. Reviewers hold pull requests to this.



    Wakati kuruhusu kumefanywa kwa tawi kuu, mfumo wa udhibiti wa toleo la mradi LAZIMA uhitaji angalau idhini moja ya binadamu asiye mwandishi ya mabadiliko kabla ya kuunganisha. [OSPS-QA-07.01]
    Sanidi mfumo wa udhibiti wa toleo la mradi kuhitaji angalau idhini moja ya binadamu asiye mwandishi ya mabadiliko kabla ya kuunganisha katika toleo au tawi kuu. Hii inaweza kupatikana kwa kuhitaji ombi la kuvuta kupimwa na kuidhinishwa na angalau mshirikiano mmoja mwingine kabla ya kunaweza kuunganishwa.

    The branch ruleset on the default branch requires a pull request with at least one approving review from a non-author before merging; direct pushes are rejected.



    Mradi unapotoa toleo, mradi LAZIMA ufanye ufuatiliaji wa tisho na uchambuzi wa uso wa shambulio ili kuelewa na kulinda dhidi ya mashambulizi kwenye njia za msimbo muhimu, majukumu, na mwingiliano ndani ya mfumo. [OSPS-SA-03.02]
    Ufuatiliaji wa tisho ni shughuli ambapo mradi unaangalia msimbo, michakato na miundombinu inayohusiana, viunganishi, vipengele muhimu na "kufikiria kama kibogoyo" na kufanya mapendekezo ya jinsi mfumo unaweza kuvunjwa au kuhatarisha. Kila tisho iliyotambuliwa imeorodheshwa ili mradi uweze kufikiria jinsi ya kuepuka au kufunga pengo/udhaifu wowote unaoweza kutokea kwa kujihadhari. Hakikisha hii imesasishwa kwa vipengele vipya au mabadiliko ya kuvunja.

    docs/THREAT_MODEL.md provides the threat modeling and attack-surface analysis: it enumerates actors and trust boundaries (identifying the Python→C cffi boundary as primary), the assets, and each threat class (memory-safety bugs reachable from inputs, cryptographic incorrectness, weak randomness, engine-mode mismatch, malicious runtime compilation, supply-chain tampering) with its mitigations and residual gaps. It is maintained as features and breaking changes land.



    Udhaifu wowote katika vipengele vya programu usioathiri mradi LAZIMA uzingatiwe katika hati ya VEX, ikiongeza kwenye ripoti ya udhaifu maelezo ya kutoweza kutumika vibaya (non-exploitability). [OSPS-VM-04.02]
    Weka mfumo wa mlisho wa VEX unaowasiliana hali ya utumiaji vibaya wa udhaifu unaojulikana, ikiwa ni pamoja na maelezo ya tathmini au marekebisho yoyote yaliyowekwa kusimamisha msimbo ulio na udhaifu usiotekelezwa.

    The project maintains an OpenVEX feed (docs/vex/vfhe.openvex.json) with a documented policy (docs/vex/README.md): when a scanner reports a vulnerability in a dependency that review finds VFHE does not execute, a not_affected statement with justification and impact statement is published there rather than treated as a release blocker. The feed is empty while no such vulnerability is outstanding.



    Nyaraka za mradi LAZIMA zijumuishe sera inayofafanua kiwango cha chini cha kurekebisha matokeo ya SCA yanayohusiana na udhaifu na leseni. [OSPS-VM-05.01]
    Andika sera katika mradi inayofafanua kiwango cha marekebisho ya matokeo ya SCA yanayohusiana na udhaifu na leseni. Jumuisha mchakato wa kutambua, kutanguliza, na kurekebisha matokeo haya.

    SECURITY.md ("Dependency and static-analysis policy") defines the SCA remediation threshold: no dependency with a known high- or critical-severity vulnerability, and no dependency under a license incompatible with Apache-2.0, may be merged or released; lower-severity findings are triaged and tracked. Identification is via dependency-review and Dependabot; prioritization is by severity; remediation is by update or documented non-exploitability.



    Nyaraka za mradi LAZIMA zijumuishe sera ya kushughulikia ukiukaji wa SCA kabla ya toleo lolote. [OSPS-VM-05.02]
    Andika sera katika mradi wa kushughulikia matokeo ya Uchambuzi wa Muundo wa Programu yanayotumika kabla ya toleo lolote, na ongeza ukaguzi wa hali unaothibitisha kufuata sera hiyo kabla ya toleo.

    The SECURITY.md policy states that a release is blocked while any unresolved high/critical dependency finding applies to the shipped code, and compliance is enforced by the dependency-review status check required on every pull request that reaches the default branch.



    Mabadiliko yote kwenye msingi wa msimbo wa mradi LAZIMA yatathminiwe kiotomatiki dhidi ya sera iliyoandikwa kuhusu utegemezi hasidi na udhaifu unaojulikana katika utegemezi, kisha kuzuiliwa endapo kuna ukiukaji, isipokuwa pale ilipotangazwa na kufichwa kama isiyoweza kutumika vibaya. [OSPS-VM-05.03]
    Unda ukaguzi wa hali katika mfumo wa kudhibiti toleo la mradi unaoendesha zana ya Uchambuzi wa Muundo wa Programu kwenye mabadiliko yote ya msingi wa msimbo. Hitaji kwamba ukaguzi wa hali upite kabla mabadiliko kusanywa.

    All changes are automatically evaluated by the dependency-review status check, which runs a Software Composition Analysis on every pull request and blocks merge when it detects a dependency with a known vulnerability or an incompatible license; non-exploitable findings are suppressed via the project's VEX feed. The check is required by the default-branch ruleset.



    Nyaraka za mradi LAZIMA zijumuishe sera inayofafanua kiwango cha chini cha kurekebisha matokeo ya SAST. [OSPS-VM-06.01]
    Andika sera katika mradi inayofafanua kiwango cha marekebisho ya matokeo ya Upimaji wa Usalama wa Programu Tuli (SAST). Jumuisha mchakato wa kutambua, kutanguliza, na kurekebisha matokeo haya.

    SECURITY.md ("Dependency and static-analysis policy") defines the SAST remediation threshold: no CodeQL alert of high severity or above may be merged unresolved; each is fixed, or, if a true false positive, dismissed with a written justification recorded in the alert. CodeQL analyses every pull request and the default branch.



    Mabadiliko yote kwenye msingi wa msimbo wa mradi LAZIMA yatathminiwe kiotomatiki dhidi ya sera iliyoandikwa kuhusu udhaifu wa usalama na kuzuiliwa endapo kuna ukiukaji isipokuwa pale ilipotangazwa na kufichwa kama isiyoweza kutumika vibaya. [OSPS-VM-06.02]
    Unda ukaguzi wa hali katika mfumo wa kudhibiti toleo la mradi unaoendesha zana ya Upimaji wa Usalama wa Programu Tuli (SAST) kwenye mabadiliko yote ya msingi wa msimbo. Hitaji kwamba ukaguzi wa hali upite kabla mabadiliko kusanywa.

    All changes are automatically evaluated by CodeQL (SAST) on every pull request; the analysis blocks merge on unresolved high-or-above alerts, with non-exploitable results dismissed and justified in the alert. The CodeQL checks are required by the default-branch ruleset.



Unaweza kutumia zana na mifumo ya AI kupendekeza mabadiliko kupitia URL rahisi, kama vile https://www.bestpractices.dev/sw/projects/13712/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 Alin-Petru Roșu na wachangiaji wa nishani ya Mazoea Bora ya OpenSSF.

Ingizo la nishani ya mradi linamilikiwa na: Alin-Petru Roșu.
Ingizo liliundwa siku 2026-07-21 12:32:30 UTC, iliyosasishwa mara ya mwisho siku 2026-07-23 13:20:44 UTC. Ilipata mara ya mwisho nishani ya kupita siku 2026-07-23 13:20:44 UTC.