caas-api

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 13334 ni in_progress 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/13334/badge)](https://www.bestpractices.dev/projects/13334)
au kwa kuweka hii katika HTML yako:
<a href="https://www.bestpractices.dev/projects/13334"><img src="https://www.bestpractices.dev/projects/13334/badge"></a>


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

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

        

 Misingi 13/13

  • Jumla

    Kumbuka kwamba miradi mingine inaweza kutumia jina sawa.

    Crypto as a Service API — ERC-20/721/1155 token operations via REST (Rust/Axum)

    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.
  • Maudhui ya kimsingi ya tovuti ya mradi


    Tovuti ya mradi LAZIMA ieleze kwa ufupi programu inafanya nini (inasuluhu tatizo gani?). [description_good]
    Hii LAZIMA iwe katika lugha ambayo watumiaji watarajiwa wanaweza kuelewa (k.m., inatumia lugha ya kiufundi kidogo).

    How to obtain the software:
    The source code is available at https://github.com/alexjavabraz/caas-api. Clone the repository and follow the Quick Start
    instructions in the README to run the API locally using cargo run. A Docker image is also available via the CI/CD pipeline
    documented in the README.

    How to provide feedback (bug reports or enhancements):
    Bug reports and feature requests are submitted through GitHub Issues (https://github.com/alexjavabraz/caas-api/issues). The
    CONTRIBUTING.md file describes what information to include in a bug report. Security vulnerabilities must be reported privately
    via email (alexjavabraz@gmail.com) or through GitHub Private Security Advisories
    (https://github.com/alexjavabraz/caas-api/security/advisories/new), as described in SECURITY.md.

    How to contribute:
    Contribution instructions are in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md). The
    process is: fork the repository, create a branch from main, make changes following the code standards (cargo fmt, clippy,
    tests), and open a Pull Request. The file covers coding standards, commit message format, security checklist, and the local
    development setup.



    Tovuti ya mradi LAZIMA itoe habari juu ya jinsi ya: kupata, kutoa maoni (kama ripoti za hitilafu au maboresho), na kuchangia kwenye programu. [interact]

    How to obtain the software:
    The source code is available at https://github.com/alexjavabraz/caas-api. Clone the repository and follow the Quick Start
    instructions in the README to run the API locally using cargo run. A Docker image is also available via the CI/CD pipeline
    documented in the README.

    How to provide feedback (bug reports or enhancements):
    Bug reports and feature requests are submitted through GitHub Issues (https://github.com/alexjavabraz/caas-api/issues). The
    CONTRIBUTING.md file describes what information to include in a bug report. Security vulnerabilities must be reported privately
    via email (alexjavabraz@gmail.com) or through GitHub Private Security Advisories
    (https://github.com/alexjavabraz/caas-api/security/advisories/new), as described in SECURITY.md.

    How to contribute:
    Contribution instructions are in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md). The
    process is: fork the repository, create a branch from main, make changes following the code standards (cargo fmt, clippy,
    tests), and open a Pull Request. The file covers coding standards, commit message format, security checklist, and the local
    development setup.



    Habari juu ya jinsi ya kuchangia LAZIMA ieleze mchakato wa uchangiaji (kwa mfano, je! Maombi ya kuvuta yanatumika?) (URL inahitajika) [contribution]
    Tunafikiria kuwa miradi kwenye GitHub hutumia maswala na kuvuta maombi isipokuwa palipoonyeshwa vingine. Habari hii inaweza kuwa fupi, kwa mfano, ikisema kuwa mradi hutumia maombi ya kuvuta, msako wa suala, au machapisho kwenye orodha ya barua (ipi?)

    Non-trivial contribution file in repository: https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md.



    Habari juu ya jinsi ya kuchangia INAPASWA kujumuisha mahitaji ya michango inayokubalika (k.m., rejeleo la kiwango chochote kinachohitajika cha usimbaji). (URL inahitajika) [contribution_requirements]
  • Leseni ya FLOSS


    Programu iliyozalishwa na mradi LAZIMA itolewa kama FLOSS. [floss_license]
    FLOSS ni programu iliyotolewa kwa njia inayokidhi Ufafanuzi wa Chanzo Wazi au Ufafanuzi wa Programu Huria. Mifano ya leseni kama hizo ni pamoja na CC0, MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), na GNU General Public License (GPL). Kwa madhumuni yetu, hii inamaanisha kuwa leseni LAZIMA iwe: Programu YAWEZA pia kupatiwa leseni kwa njia nyingine (k.m., "GPLv2 au ya kibinafsi" inakubaliwa).

    The MIT license is approved by the Open Source Initiative (OSI).



    INAPENDEKEZA kwamba leseni yoyote inayohitajika kwa programu iliyozalishwa na mradi iwe imeidhinishwa na Open Source Initiative (OSI). [floss_license_osi]
    OSI inatumia mchakato mgumu wa uidhinishaji kuamua ni leseni zipi ni OSS.

    The MIT license is approved by the Open Source Initiative (OSI).



    Mradi LAZIMA uweke leseni za matokeo yake mahali pa kawaida katika hazina yake ya chanzo. (URL inahitajika) [license_location]
    Desturi moja ni kuweka leseni kama faili ya ngazi ya juu inayoitwa LICENSE au COPYING, ambayo YAWEZA kufuatiwa na kiendelezi kama ".txt" au ".md". Desturi mbadala ni kuwa na saraka inayoitwa LICENSES inayohifadhi faili za leseni; faili hizi kwa kawaida zinaitwa kama kitambulisho chao cha leseni ya SPDX kikifuatiwa na kiendelezi kinachofaa, kama ilivyoelezwa katika Maelezo ya REUSE. Kumbuka kwamba kigezo hiki ni mahitaji tu kwenye hazina ya chanzo. Huhitaji kuingiza faili ya leseni wakati wa kuzalisha kitu kutoka kwenye msimbo wa chanzo (kama programu inayotekelezeka, kifurushi, au chombo). Kwa mfano, wakati wa kuzalisha kifurushi cha R kwa Mtandao wa Kumbukumbu Kamili wa R (CRAN), fuata mazoea ya kawaida ya CRAN: ikiwa leseni ni leseni ya kawaida, tumia maelezo mafupi ya kawaida ya leseni (ili kuepuka kusakinisha nakala nyingine ya maandishi) na orodhesha faili ya LICENSE katika faili ya kutengwa kama .Rbuildignore. Vivyo hivyo, wakati wa kuunda kifurushi cha Debian, unaweza kuweka kiungo katika faili ya hakimiliki kwa maandishi ya leseni katika /usr/share/common-licenses, na utenge faili ya leseni kutoka kwenye kifurushi kilichoundwa (k.m., kwa kufuta faili baada ya kuita dh_auto_install). Tunashauri jumuisha maelezo ya leseni yanayoweza kusomwa na mashine katika miundo iliyozalishwa mahali inapofaa.

    Non-trivial license location file in repository: https://github.com/alexjavabraz/caas-api/blob/main/LICENSE.


  • Nyaraka


    Mradi LAZIMA utoe nyaraka za msingi za programu iliyozalishwa na mradi. [documentation_basics]
    Nyaraka hizi lazima ziwe katika vyombo fulani (kama maandishi au video) vinavyojumuisha: jinsi ya kuisakinisha, jinsi ya kuianzisha, jinsi ya kuitumia (huenda ikijumuisha mafunzo kwa kutumia mifano), na jinsi ya kuitumia kwa usalama (k.m., nini cha kufanya na nini cha kutofanya) ikiwa hiyo ni mada inayofaa kwa programu. Nyaraka za usalama lazima zisiwe ndefu. Mradi YAWEZA kutumia viungo vya hypertext kwa nyenzo zisizo za mradi kama nyaraka. Ikiwa mradi hauzalishi programu, chagua "haihusiki" (N/A).

    No appropriate folder found for documentation basics.



    Mradi LAZIMA utoe nyaraka za marejeleo zinazofafanua kiolesura cha nje (ingizo na matokeo) cha programu iliyozalishwa na mradi. [documentation_interface]
    Nyaraka za kiolesura cha nje zinaeleza kwa mtumiaji wa mwisho au msanidi jinsi ya kuitumia. Hii itajumuisha kiolesura chake cha programu ya programu (API) ikiwa programu ina. Ikiwa ni maktaba, andika madarasa/aina kuu na mbinu/vitendakazi vinavyoweza kuitwa. Ikiwa ni programu ya wavuti, fafanua kiolesura chake cha URL (mara nyingi kiolesura chake cha REST). Ikiwa ni kiolesura cha mstari wa amri, andika vigezo na chaguo zinazosaidia. Katika hali nyingi ni bora ikiwa nyingi ya nyaraka hizi zinazalishwa kiotomatiki, ili nyaraka hizi zibaki zikisawazishwa na programu inavyobadilika, lakini hii haihitajiki. Mradi YAWEZA kutumia viungo vya hypertext kwa nyenzo zisizo za mradi kama nyaraka. Nyaraka ZIWEZA kuzalishwa kiotomatiki (ambapo ni vitendo hii mara nyingi ndiyo njia bora ya kufanya hivyo). Nyaraka za kiolesura cha REST zinaweza kuzalishwa kwa kutumia Swagger/OpenAPI. Nyaraka za kiolesura cha msimbo ZINAWEZA kuzalishwa kwa kutumia zana kama vile JSDoc (JavaScript), ESDoc (JavaScript), pydoc (Python), devtools (R), pkgdown (R), na Doxygen (nyingi). Kuwa na maoni tu katika msimbo wa utekelezaji haitoshi kutosheleza kigezo hiki; kunahitaji kuwa na njia rahisi ya kuona habari bila kusoma kupitia msimbo wote wa chanzo. Ikiwa mradi hauzalishi programu, chagua "haihusiki" (N/A).
  • Mengine


    Tovuti za mradi (tovuti, hifadhi, na URL za kupakua) LAZIMA zisaidie HTTPS kwa kutumia TLS. [sites_https]
    Hii inahitaji kwamba URL ya ukurasa wa nyumbani wa mradi na URL ya hifadhi ya udhibiti wa toleo vianze na "https:", si "http:". Unaweza kupata vyeti vya bure kutoka Let's Encrypt. Miradi YAWEZA kutekeleza kigezo hiki kwa kutumia (kwa mfano) GitHub pages, GitLab pages, au SourceForge project pages. Ikiwa unasaidia HTTP, tunakuhimiza uelekeze trafiki ya HTTP kwenda HTTPS.

    Given only https: URLs.



    Mradi LAZIMA uwe na taratibu moja au zaidi za majadiliano (ikiwa ni pamoja na mabadiliko yaliyopendekezwa na masuala) yenye utafutaji, inaruhusu ujumbe na mada kuelekezwa kwa URL, inaruhusu watu wapya kushiriki katika baadhi ya majadiliano, na haihitaji usakinishaji wa upande wa mteja wa programu ya kibinafsi. [discussion]
    Mifano ya taratibu zinazokubalika ni pamoja na orodha za barua pepe zilizohifadhiwa, majadiliano ya suala la GitHub na ombi la kuvuta, Bugzilla, Mantis, na Trac. Taratibu za majadiliano yasiyo ya wakati mmoja (kama IRC) zinakubaliwa ikiwa zinakidhi vigezo hivi; hakikisha kuna utaratibu wa kuhifadhi unaoelekezwa kwa URL. JavaScript ya kibinafsi, ingawa haikubalika, inaruhusiwa.

    GitHub supports discussions on issues and pull requests.



    Mradi UNAPASWA kutoa nyaraka kwa Kiingereza na uweze kukubali ripoti za hitilafu na maoni kuhusu msimbo kwa Kiingereza. [english]
    Kiingereza kwa sasa ni lingua franca ya teknolojia ya kompyuta; kusaidia Kiingereza huongeza idadi ya wasanidi na wakaguzi tofauti wa uwezekano duniani kote. Mradi unaweza kukidhi kigezo hiki hata ikiwa lugha ya msingi ya wasanidi wake wakuu si Kiingereza.

    Mradi LAZIMA utunzwe. [maintained]
    Kama kiwango cha chini, mradi unapaswa kujaribu kujibu ripoti za tatizo muhimu na udhaifu. Mradi unaofuata kwa bidii nishani pengine unatengenezwa. Miradi yote na watu wana rasilimali zilizowekewa mipaka, na miradi ya kawaida lazima ikatae baadhi ya mabadiliko yaliyopendekezwa, hivyo rasilimali zilizowekewa mipaka na kukataa mapendekezo sio ishara ya mradi usiotekelezwa.

    Mradi unapojua kwamba hautatengenezwa tena, unapaswa kuweka kigezo hiki kama "Haikidhi" na utumie utaratibu sahihi ili kuwaonyesha wengine kwamba hautengenezwi. Kwa mfano, tumia "DEPRECATED" kama kichwa cha kwanza cha README yake, ongeza "DEPRECATED" karibu na mwanzo wa ukurasa wake wa nyumbani, ongeza "DEPRECATED" mwanzoni mwa maelezo ya mradi wa hifadhi ya msimbo, ongeza nishani isiyolindwa katika README yake na/au ukurasa wa nyumbani, iweke kama iliyolemewa katika hifadhi yoyote ya kifurushi (k.m., npm deprecate), na/au utumie mfumo wa alama wa hifadhi ya msimbo ili kuihifadhi (k.m., mpangilio wa "archive" wa GitHub, alama ya "archived" ya GitLab, hali ya "readonly" ya Gerrit, au hali ya mradi wa "abandoned" wa SourceForge). Majadiliano ya ziada yanaweza kupatikana hapa.

    The project is actively maintained. Evidence:

    https://github.com/alexjavabraz/caas-api/commits/main


 Udhibiti wa Mabadiliko 3/9

  • Hifadhi ya chanzo ya kudhibiti toleo ya hadharani


    Mradi LAZIMA uwe na hifadhi ya chanzo ya kudhibiti toleo ambayo inaweza kusomwa hadharani na ina URL. [repo_public]
    URL YAWEZA kuwa sawa na URL ya mradi. Mradi YAWEZA kutumia matawi ya faragha (yasiyo ya umma) katika hali maalum wakati mabadiliko hayajatolewa hadharani (k.m., kwa kurekebisha udhaifu kabla haujafichuliwa kwa umma).

    Repository on GitHub, which provides public git repositories with URLs.



    Hifadhi ya chanzo ya mradi LAZIMA ifuatilie mabadiliko yaliyofanywa, nani alifanya mabadiliko, na mabadiliko yalifanywa lini. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    Ili kuwezesha ukaguzi wa ushirikiano, hifadhi ya chanzo ya mradi LAZIMA ijumuishe matoleo ya kati kwa ukaguzi kati ya matoleo; HAIPASWA kujumuisha matoleo ya mwisho tu. [repo_interim]
    Miradi YAWEZA kuchagua kuondoa matoleo maalum ya kati kutoka hifadhi zao za chanzo za umma (k.m., zile zinazorekebi udhaifu maalum usiokuwa wa umma, huenda zisitolewe hadharani, au zijumuishe nyenzo ambazo haziwezi kuwekwa kisheria na haziko katika toleo la mwisho).


    INASHAURIWA kwamba programu ya kawaida ya udhibiti wa toleo iliyosambazwa itumike (k.m., git) kwa hifadhi ya chanzo ya mradi. [repo_distributed]
    Git haihitajiki kihususa na miradi inaweza kutumia programu ya udhibiti wa toleo iliyokusanyika (kama subversion) na sababu.

    Repository on GitHub, which uses git. git is distributed.


  • Unambari wa toleo wa kipekee


    Matokeo ya mradi LAZIMA yawe na kitambulisho cha kipekee cha toleo kwa kila toleo linalokusudiwa kutumiwa na watumiaji. [version_unique]
    Hii YAWEZA kukidhi kwa njia mbalimbali ikiwa ni pamoja na vitambulisho vya kuwasilisha (kama kitambulisho cha kuwasilisha cha git au kitambulisho cha seti ya mabadiliko cha mercurial) au nambari ya toleo (ikiwa ni pamoja na nambari za toleo zinazotumia uainishaji wa maana au mipango ya tarehe kama YYYYMMDD).


    INASHAURIWA kwamba muundo wa nambari ya toleo ya Semantic Versioning (SemVer) au Calendar Versioning (CalVer) itumike kwa matoleo. INASHAURIWA kwamba wale wanaotumia CalVer wajumuishe thamani ya kiwango cha mdogo. [version_semver]
    Miradi kwa ujumla inapaswa kupendelea muundo wowote unaotarajiwa na watumiaji wao, k.m., kwa sababu ni muundo wa kawaida unaotumiwa na ikolojia yao. Ikolojia nyingi zinapendelea SemVer, na SemVer kwa ujumla hupendelewa kwa kiolesura cha programu ya programu (API) na zana za maendeleo ya programu (SDK). CalVer hutumiwa na miradi ambayo ni kubwa, ina idadi kubwa ya utegemezi ulioundwa kwa uhuru, ina upeo wa mara kwa mara unaobadilika, au ni ya muda muhimu. INASHAURIWA kwamba wale wanaotumia CalVer wajumuishe thamani ya kiwango cha mdogo, kwa sababu kujumuisha kiwango cha mdogo kunasaidia matawi yaliyotunzwa kwa wakati mmoja wakati wowote hilo linakuwa lazima. Miundo mingine ya nambari ya toleo inaweza kutumiwa kama nambari za toleo, ikiwa ni pamoja na vitambulisho vya kuwasilisha cha git au vitambulisho vya seti ya mabadiliko cha mercurial, mradi tu vikitambulisha matoleo kwa kipekee. Hata hivyo, baadhi ya mbadala (kama vitambulisho vya kuwasilisha cha git) vinaweza kusababisha matatizo kama vitambulisho vya toleo, kwa sababu watumiaji huenda wasiwe na uwezo wa kuamua kwa urahisi ikiwa wako na toleo la hivi karibuni. Muundo wa kitambulisho cha toleo unaweza kutokuwa wa maana kwa kutambulisha matoleo ya programu ikiwa wapokeaji wote wanaendesha toleo la hivi karibuni tu (k.m., ni msimbo wa tovuti moja au huduma ya mtandao ambayo inasasishwa mara kwa mara kupitia utoaji wa kuendelea).


    INASHAURIWA kwamba miradi itambulishe kila toleo ndani ya mfumo wao wa udhibiti wa toleo. Kwa mfano, INASHAURIWA kwamba wale wanaotumia git watambulishe kila toleo kwa kutumia lebo za git. [version_tags]

  • Maelezo ya kutolewa


    Mradi LAZIMA utoe, katika kila toleo, maelezo ya toleo ambayo ni muhtasari unaosomeka na binadamu wa mabadiliko makuu katika toleo hilo ili kuwasaidia watumiaji kuamua ikiwa wanapaswa kusasisha na athari ya kusasisha itakuwa nini. Maelezo ya toleo LAZIMA yasiwe matokeo ghafi ya kumbukumbu ya udhibiti wa toleo (k.m., matokeo ya amri ya "git log" si maelezo ya toleo). Miradi ambayo matokeo yake hayakusudiwa kutumika tena katika maeneo mengi (kama programu kwa tovuti moja au huduma) NA wanaotumia utoaji wa kuendelea WAWEZA kuchagua "N/A". (URL inahitajika) [release_notes]
    Maelezo ya toleo YAWEZA kutekelezwa kwa njia mbalimbali. Miradi mingi hutoa katika faili inayoitwa "NEWS", "CHANGELOG", au "ChangeLog", kwa hiari na viendelezi kama ".txt", ".md", au ".html". Kihistoria neno "change log" lilimaanisha kumbukumbu ya kila mabadiliko, lakini ili kukidhi vigezo hivi kinachohitajika ni muhtasari unaosomeka na binadamu. Maelezo ya toleo YAWEZA badala yake kutolewa na taratibu za mfumo wa udhibiti wa toleo kama mtiririko wa Matoleo ya GitHub.

    No release notes file found.



    Maelezo ya toleo LAZIMA yatambulishe kila udhaifu wa muda wa kutekeleza uliojulikana hadharani uliorekebishwa katika toleo hili ambao tayari ulikuwa na mgawanyo wa CVE au sawa wakati toleo lilipobuniwa. Kigezo hiki kinaweza kuwekwa alama kama haihusiki (N/A) ikiwa watumiaji kwa kawaida hawawezi kwa vitendo kusasisha programu wao wenyewe (k.m., kama inavyokuwa kweli mara nyingi kwa masasisho ya kernel). Kigezo hiki kinatumika tu kwa matokeo ya mradi, si kwa utegemezi wake. Ikiwa hakuna maelezo ya toleo au hakujawa na udhaifu uliojulikana hadharani, chagua N/A. [release_notes_vulns]
    Kigezo hiki kinawasaidia watumiaji kuamua ikiwa sasisho fulani litarekebisha udhaifu ambao unajulikana hadharani, ili kuwasaidia watumiaji kufanya uamuzi wa habari kuhusu kusasisha. Ikiwa watumiaji kwa kawaida hawawezi kwa vitendo kusasisha programu wao wenyewe kwenye kompyuta zao, lakini badala yake lazima wategemee wapatanishi mmoja au zaidi kutekeleza sasisho (kama inavyokuwa mara nyingi kwa kernel na programu ya kiwango cha chini ambayo imefungwa na kernel), mradi unaweza kuchagua "haihusiki" (N/A) badala yake, kwani habari hii ya ziada haitakuwa ya msaada kwa watumiaji hao. Vivyo hivyo, mradi unaweza kuchagua N/A ikiwa wapokeaji wote wanaendesha toleo la hivi karibuni tu (k.m., ni msimbo wa tovuti moja au huduma ya mtandao ambayo inasasishwa mara kwa mara kupitia utoaji wa kuendelea). Kigezo hiki kinatumika tu kwa matokeo ya mradi, si kwa utegemezi wake. Kuorodhesha udhaifu wa utegemezi wote wa mpito wa mradi unakuwa mgumu kadiri utegemezi unavyoongezeka na kutofautiana, na haihitajiki kwani zana zinazochunguza na kufuatilia utegemezi zinaweza kufanya hivi kwa njia inayopanuka.

 Kuripoti 8/8

  • Mchakato wa kuripoti hitilafu


    Mradi LAZIMA utoe mchakato kwa watumiaji kuwasilisha ripoti za hitilafu (k.m., kwa kutumia kifuatiliaji cha masuala au orodha ya barua pepe). (URL inahitajika) [report_process]

    Non-trivial SECURITY[.md] file found file in repository: https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md. [osps_do_02_01]



    Mradi UNAPASWA kutumia kifuatiliaji cha masuala kwa kufuatilia masuala ya mtu binafsi. [report_tracker]

    The project uses GitHub Issues as its issue tracker:

    https://github.com/alexjavabraz/caas-api/issues

    GitHub Issues is the official tracker for bug reports, feature requests, and enhancements. It is referenced in both
    CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#reporting-bugs) and SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md).



    Mradi LAZIMA uthibitishe wengi wa ripoti za hitilafu zilizowasilishwa katika miezi 2-12 iliyopita (ikiwemo); jibu halihitaji kuwa na marekebisho. [report_responses]

    The project currently has no open or closed bug reports submitted in the last 2–12 months. All issues raised during development
    have been addressed directly through commits and pull requests, with no unacknowledged reports outstanding.

    As the project grows its user base, all bug reports submitted via GitHub Issues will be acknowledged within 48 hours,
    consistent with the response timeline documented in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md).



    Mradi UNAPASWA kujibu wengi (>50%) wa maombi ya maboresho katika miezi 2-12 iliyopita (ikiwemo). [enhancement_responses]
    Jibu LIWEZA kuwa 'hapana' au majadiliano kuhusu manufaa yake. Lengo ni kwamba kuwe na jibu fulani kwa baadhi ya maombi, ambayo inaonyesha kwamba mradi bado unaishi. Kwa madhumuni ya kigezo hiki, miradi haihitaji kuhesabu maombi ya bandia (k.m., kutoka kwa wafanyabiashara haramu au mifumo ya kiotomatiki). Ikiwa mradi hauendelei kufanya maboresho tena, tafadhali chagua "haijatimizwa" na jumuisha URL inayofanya hali hii kuwa wazi kwa watumiaji. Ikiwa mradi huwa na msongo wa maombi ya maboresho, tafadhali chagua "haijatimizwa" na eleza.

    The project currently has no open enhancement requests submitted in the last 2–12 months. Feature additions and improvements
    have been proposed and implemented directly by the maintainer through commits to main, with no unaddressed requests
    outstanding.

    Going forward, all enhancement requests submitted via GitHub Issues (https://github.com/alexjavabraz/caas-api/issues) will
    receive a response (acknowledgement, acceptance, or rejection with rationale) within 7 days.



    Mradi LAZIMA uwe na kumbukumbu inayopatikana hadharani kwa ripoti na majibu kwa utaftaji wa baadaye. (URL inahitajika) [report_archive]

    https://github.com/alexjavabraz/caas-api/issues?q=is%3Aissue

    GitHub Issues serves as the publicly available archive for all bug reports, enhancement requests, and maintainer responses. All
    issues and comments are permanently stored, publicly searchable, and accessible without authentication — including closed
    issues.


  • Mchakato wa kuripoti udhaifu


    Mradi LAZIMA uchapishe mchakato wa kuripoti udhaifu kwenye tovuti ya mradi. (URL inahitajika) [vulnerability_report_process]
    Miradi iliyohifadhiwa kwenye GitHub INAPASWA kuzingatia kuwezesha kuripoti udhaifu wa usalama kwa faragha. Miradi kwenye GitLab INAPASWA kuzingatia kutumia uwezo wake wa kuripoti udhaifu kwa faragha. Miradi YAWEZA kutambulisha anwani ya barua pepe kwenye https://PROJECTSITE/security, mara nyingi katika muundo wa security@example.org. Mchakato huu wa kuripoti udhaifu UWEZA kuwa sawa na mchakato wake wa kuripoti hitilafu. Ripoti za udhaifu ZIWEZA kuwa za umma kila wakati, lakini miradi mingi ina utaratibu wa kuripoti udhaifu wa faragha.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md

    The vulnerability reporting process is documented in SECURITY.md and covers: private disclosure via email
    (alexjavabraz@gmail.com) or GitHub Private Security Advisories, response timeline (acknowledgement within 48h, fix within 30
    days for critical issues), and scope of covered vulnerabilities.



    Ikiwa ripoti za udhaifu wa faragha zinasaidiwa, mradi LAZIMA ujumuishe jinsi ya kutuma habari kwa njia ambayo inawekwa faragha. (URL inahitajika) [vulnerability_report_private]
    Mifano ni pamoja na ripoti ya kasoro ya faragha iliyowasilishwa kwenye wavuti kwa kutumia HTTPS (TLS) au barua pepe iliyosimbwa kwa kutumia OpenPGP. Ikiwa ripoti za udhaifu ni za umma kila wakati (kwa hiyo hakuna ripoti za udhaifu za faragha), chagua "haihusiki" (N/A).

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#reporting-a-vulnerability

    SECURITY.md explicitly instructs reporters not to use public GitHub Issues and provides two private channels: direct email to
    alexjavabraz@gmail.com and GitHub Private Security Advisories at
    https://github.com/alexjavabraz/caas-api/security/advisories/new.



    Muda wa majibu ya awali ya mradi kwa ripoti yoyote ya udhaifu iliyopokelewa katika miezi 6 iliyopita LAZIMA uwe chini ya au sawa na siku 14. [vulnerability_report_response]
    Ikiwa hakujawa na udhaifu ulioripotiwa katika miezi 6 iliyopita, chagua "haihusiki" (N/A).

    The project has not received any vulnerability reports in the last 6 months. The documented response commitment in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md) guarantees acknowledgement within 48 hours of any report
    received — well within the 14-day requirement.


 Ubora 13/13

  • Mfumo wa ujenzi unaofanya kazi


    Ikiwa programu iliyotengenezwa na mradi inahitaji ujenzi wa matumizi, mradi LAZIMA utoe mfumo wa kujenga ambao unaweza kujenga programu kiotomatiki kutoka kwa chanzo-msimbo. [build]
    Mfumo wa kujenga huamua ni hatua gani zinahitaji kutendeka ili kujenga tena programu (na kwa mpangilio gani), na kisha kutekeleza hatua hizo. Kwa mfano, inaweza kuomba kikusanyaji kukusanya fumbo-chanzo. Ikiwa inayoweza kutekelezwa imeundwa kutoka kwa fumbo-chanzo, lazima iwezeshe marekebisho kwenye fumbo-chanzo ya mradi na kisha itengeneze msasisho inayoweza kutekelezwa na marekebisho hayo. Ikiwa programu iliyotolewa na mradi unategemea maktaba ya nje, mfumo wa kujenga haina haja ya kujenga maktaba hizo za nje. Ikiwa hakuna haja ya kujenga chochote kutumia programu baada ya fumbo-chanzo kubadilishwa, chagua "haitumiki" (N / A).

    The project is written in Rust. Building from source requires only:

    cargo build --release

    Cargo (Rust's built-in build system) automatically resolves and downloads all dependencies declared in Cargo.toml, compiles the
    project, and produces a self-contained binary. No additional build tools or manual steps are required.

    The CI pipeline at .github/workflows/ci.yml (https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml)
    validates a successful cargo build --release on every push to main.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    INAPENDEKEZWA kuwa zana za kawaida zitumike kujenga programu. [build_common_tools]
    Kwa mfano, Maven, Ant, cmake, autotools, make, rake (Ruby), au devtools (R).

    Yes. The project uses Cargo, the standard build tool for the Rust ecosystem and the only officially supported build system for
    Rust projects. It is universally used across the Rust community for dependency management, compilation, testing, and release
    builds.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Mradi UNAPASWA kujengwa kwa kutumia zana za FLOSS pekee yake. [build_floss_tools]

    Yes. The project builds exclusively with free/libre/open-source tools:

    • Cargo (MIT/Apache-2.0) — build system and dependency manager
    • rustc (MIT/Apache-2.0) — Rust compiler
    • Docker (Apache-2.0) — container build (optional, for deployment)

    All dependencies declared in Cargo.toml are FLOSS-licensed (MIT, Apache-2.0, or ISC). No proprietary tools are required at any
    stage of the build.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml


  • Seti ya majaribio otomatiki


    Mradi LAZIMA utumie angalau seti moja ya majaribio ya kiotomatiki ambayo imetolewa hadharani kama FLOSS (seti hii ya majaribio inaweza kutunzwa kama mradi tofauti wa FLOSS). Mradi LAZIMA uonyeshe wazi au uandike jinsi ya kuendesha seti za majaribio (k.m., kupitia hati ya uingizaji wa kuendelea (CI) au kupitia nyaraka katika faili kama BUILD.md, README.md, au CONTRIBUTING.md). [test]
    Mradi YAWEZA kutumia seti nyingi za majaribio ya kiotomatiki (k.m., moja inayoendesha haraka, dhidi ya nyingine ambayo ni ya kina zaidi lakini inahitaji vifaa maalum). Kuna mifumo mingi ya majaribio na mifumo ya kusaidia majaribio inayopatikana, ikiwemo Selenium (uendeshaji kiotomatiki wa kivinjari cha wavuti), Junit (JVM, Java), RUnit (R), testthat (R).

    The project uses cargo test, the built-in FLOSS test runner included with Rust (MIT/Apache-2.0). Tests are defined inline using
    Rust's native #[test] and #[cfg(test)] attributes.

    How to run the test suite:

    cargo test

    This is documented in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests) and is
    automatically executed on every push to main via the CI pipeline:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml

    The relevant CI step:

    • name: Run tests
      run: cargo test


    Seti ya majaribio INAPASWA kuwa inaweza kuitwa kwa njia ya kawaida kwa lugha hiyo. [test_invocation]
    Kwa mfano, "make check", "mvn test", au "rake test" (Ruby).

    Tests are invoked with:

    cargo test

    This is the standard, universally adopted command for running tests in any Rust project. No custom scripts, environment
    variables, or additional configuration are required.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    INAPENDEKEZWA kwamba seti ya majaribio ifuate wengi (au kwa kawaida wote) matawi ya msimbo, sehemu za kuingiza, na utendakazi. [test_most]

    The current test suite covers the core authentication logic (credential hashing, JWT issuance, and token validation). Coverage
    of all branches and input fields is not yet complete — integration tests for the HTTP endpoints (register, login, token,
    deploy, mint, burn, transfer) are planned as the project matures.

    Code coverage is tracked via CI on every push. Contributions adding test coverage are explicitly welcomed in CONTRIBUTING.md
    (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests), which requires that all new behaviour include unit
    or integration tests before a PR is accepted.



    INAPENDEKEZWA kwamba mradi utekeleze ujumuishaji wendeleo (ambapo msimbo mpya au uliobadiishwa unajumuishwa mara kwa mara katika hifadhi ya msimbo ya kati na majaribio otomatiki hufanyika kwenye matokeo). [test_continuous_integration]

    The project implements continuous integration via GitHub Actions. On every push to main, the CI pipeline automatically
    runs:

    1. cargo fmt --check — formatting verification
    2. cargo clippy -- -D warnings — linting with zero-warning policy
    3. cargo build --release — full release build
    4. cargo test — test suite

    A passing CI run is required before the automated deployment workflow triggers.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml


  • Upimaji wa utendaji mpya


    Mradi LAZIMA uwe na sera ya jumla (rasmi au la) kwamba utendakazi mkubwa mpya unavyoongezwa kwenye programu inayotengenezwa na mradi, majaribio ya utendakazi huo unapaswa kuongezwa kwenye seti ya majaribio otomatiki. [test_policy]
    Mradi uwe na sera tu, hata kwa maneno ya mdomo, inayosema wasanidi programu wanapaswa kuongeza majaribio kwenye seti ya majaribio otomatiki kwa utendakazi mkubwa mpya, chagua "Kukidhi."

    This policy is documented in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests):

    ▎ "New behaviour must include unit or integration tests. Run cargo test and ensure all tests pass before opening a PR."

    This applies to all pull requests — no new functionality is accepted without accompanying tests. Compliance is enforced during
    PR review.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests



    Mradi LAZIMA uwe na ushahidi kwamba test_policy ya kuongeza majaribio imefuatwa katika mabadiliko makubwa ya hivi karibuni kwenye programu inayotengenezwa na mradi. [tests_are_added]
    Utendakazi mkubwa kawaida ungetajwa katika maelezo ya toleo. Ukamilifu hauhitajiki, ni ushahidi tu kwamba majaribio kawaida huongezwa kimakosa kwenye seti ya majaribio otomatiki utendakazi mkubwa mpya unavyoongezwa kwenye programu inayotengenezwa na mradi.

    The most recent major addition — the /auth/register and /auth/developer/login endpoints — was accompanied by unit tests
    committed in the same release cycle:

    • src/routes/auth.rs — 11 tests covering validate_safe_text (accepts normal names; rejects HTML tags, javascript:, event
      handlers, SQL DDL keywords, and path traversal) and validate_password_strength (accepts strong passwords; rejects inputs
      missing uppercase, lowercase, digit, or special character)
    • src/services/auth.rs — 4 tests covering hash_secret (determinism, distinctness) and generate_credentials (correct prefixes,
      uniqueness)

    All tests run automatically in CI on every push:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml

    Commit with tests:

    https://github.com/alexjavabraz/caas-api/commit/57c93a7



    INAPENDEKEZWA kwamba sera hii ya kuongeza majaribio (angalia test_policy) iwe imeandikwa katika maelekezo ya mapendekezo ya mabadiliko. [tests_documented_added]
    Hata hivyo, hata sheria isiyo rasmi inakubaliwa mradi majaribio yaongezwe kimakosa.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests

    The test policy is explicitly documented in the Tests section of CONTRIBUTING.md, which is the project's instructions for
    change proposals:

    ▎ "New behaviour must include unit or integration tests. Run cargo test and ensure all tests pass before opening a PR."

    It is also referenced in the security checklist that contributors must complete before submitting a pull request.


  • Bendera za maonyo


    Mradi LAZIMA uwashe bendera moja au zaidi za onyo la mkusanyaji, hali ya lugha "salama", au tumia zana tofauti ya "linter" kutafuta makosa ya ubora wa msimbo au makosa rahisi ya kawaida, ikiwa kuna angalau zana moja ya FLOSS inaweza kutekeleza kigezo hiki katika lugha iliyochaguliwa. [warnings]
    Mifano ya bendera za onyo la mkusanyaji ni pamoja na gcc/clang "-Wall". Mifano ya hali ya lugha "salama" ni pamoja na JavaScript "use strict" na perl5's "use warnings". Zana tofauti ya "linter" ni zana tu inayoangalia msimbo wa chanzo kutafuta makosa ya ubora wa msimbo au makosa rahisi ya kawaida. Hizi kawaida huwashwa ndani ya msimbo wa chanzo au maelekezo ya ujenzi.

    The project enables compiler warnings via cargo clippy with the -D warnings flag, which treats every warning as a hard error.
    This is enforced in CI on every push:

    • name: Clippy
      run: cargo clippy -- -D warnings

    Additionally, cargo fmt --check enforces consistent formatting and catches common style issues.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Mradi LAZIMA ukabiliane na maonyo. [warnings_fixed]
    Haya ni maonyo yaliyotambuliwa na utekelezaji wa kigezo cha warnings. Mradi unapaswa kurekebisha maonyo au kuyaweka alama katika msimbo wa chanzo kama hasi za uwongo. Kwa kawaida pasingeweza kuwa na maonyo, lakini mradi YAWEZA kukubali baadhi ya maonyo (kawaida chini ya onyo 1 kwa mistari 100 au chini ya maonyo 10).

    All warnings are addressed by policy — the CI pipeline runs cargo clippy -- -D warnings, which causes the build to fail if any
    warning exists. A passing CI run is therefore proof that zero warnings are present in the codebase.

    The current CI status is passing:

    https://github.com/alexjavabraz/caas-api/actions/workflows/ci.yml



    INAPENDEKEZWA kwamba miradi iwe na ukali mkubwa sana na maonyo katika programu inayotengenezwa na mradi, ambapo ni ya 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 the maximum strictness available in the Rust toolchain:

    • cargo clippy -- -D warnings — every clippy warning is a hard build failure; no warnings are silenced globally
    • cargo fmt --check — formatting deviations fail CI
    • #[allow(...)] attributes are used only where unavoidable (e.g., dead code in public API structs that will be used by future
      endpoints), and each use is a deliberate, visible decision in the source code

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml


 Usalama 16/16

  • Maarifa ya maendeleo yenye usalama


    Mradi LAZIMA uwe na angalau msanidi mmoja mkuu anayejua jinsi ya kuunda programu salama. (Angalia 'maelezo' kwa mahitaji halisi.) [know_secure_design]
    Hii inahitaji kuelewa kanuni zifuatazo za muundo, ikiwa ni pamoja na kanuni 8 kutoka Saltzer na Schroeder:
    • uchumi wa utaratibu (weka muundo kuwa rahisi na mdogo iwezekanavyo, k.m., kwa kupitisha urahisishaji wa kufunga)
    • mipangilio ya kuzuia makosa (maamuzi ya kuingia yanapaswa kukataa kwa chaguo-msingi, na usakinishaji wa miradi unapaswa kuwa salama kwa chaguo-msingi)
    • kikuu cha kati kikamilifu (kuingia kote kunaweza kuwekwa kikomo lazima kufanyiwa ukaguzi wa mamlaka na kutowezesha kuvukwa)
    • muundo wazi (taratibu za usalama hazipaswi kutegemea ujinga wa mshambuliaji wa muundo wake, lakini badala yake kwenye habari iliyolindwa na kubadilishwa kwa urahisi kama funguo na nywila)
    • kutenganisha kwa upendeleo (kwa kawaida, ufikiaji kwa vitu muhimu unapaswa kutegemea zaidi ya sharti moja, ili kushinda mfumo mmoja wa ulinzi hautawasha ufikiaji kamili. K.m., uthibitishaji wa vipengele vingi, kama vile kuhitaji nywila na ishara za vifaa, ni imara zaidi kuliko uthibitishaji wa kipengele kimoja)
    • upendeleo mdogo zaidi (michakato inapaswa kufanya kazi na upendeleo mdogo zaidi unaohitajika)
    • utaratibu wa kawaida mdogo zaidi (muundo unapaswa kupunguza utaratibu wa kawaida kwa zaidi ya mtumiaji mmoja na kutegemewa na watumiaji wote, k.m., saraka za mafaili ya muda)
    • kukubalika kwa kisaikolojia (kiolesura cha binadamu lazima kiwe kimeundwa kwa urahisi wa matumizi - kuunda kwa "mshangao mdogo" kunaweza kusaidia)
    • uso wa shambulio uliowekewa mipaka (uso wa shambulio - seti ya sehemu tofauti ambapo mshambuliaji anaweza kujaribu kuingia au kutoa data - unapaswa kuwekwa mipaka)
    • uthibitishaji wa ingizo na orodha zinazokubalika (pembejeo kawaida zinapaswa kuangaliwa ili kuamua kama ni halali kabla ya kukubalika; uthibitishaji huu unapaswa kutumia orodha zinazokubalika (zinazokubali tu thamani zinazojulikana-nzuri), siyo orodha zinazokana (zinaozojaribu kuorodhesha thamani zinazojulikana-mbaya)).
    "Msanidi mkuu" katika mradi ni mtu yeyote ambaye anajua msingi wa msimbo wa mradi, ana faraja kufanya mabadiliko kwake, na anatambuliwa hivyo na washiriki wengine wengi katika mradi. Msanidi mkuu kawaida atafanya michango mingi kwa mwaka uliopita (kupitia msimbo, nyaraka, au kujibu maswali). Wasanidi kawaida wangeweza kuchukuliwa wasanidi wakuu ikiwa walianzisha mradi (na hawajatoka kwenye mradi zaidi ya miaka mitatu iliyopita), wana chaguo la kupokea habari kwenye kituo cha kuripoti udhaifu wa kibinafsi (ikiwa kuna), wanaweza kukubali ahadi kwa niaba ya mradi, au kufanya matoleo ya mwisho ya programu ya mradi. Ikiwa kuna msanidi mmoja tu, mtu huyo ndiye msanidi mkuu. Vitabu vingi na kozi zinapatikana kukusaidia kuelewa jinsi ya kuunda programu salama zaidi na kujadili muundo. Kwa mfano, kozi ya Misingi ya Maendeleo ya Programu Salama ni seti huru ya kozi tatu zinazoeleza jinsi ya kuunda programu salama zaidi (ni bure ukiifanyia ukaguzi; kwa ada ya ziada unaweza kupata cheti kuthibitisha ulijifunza nyenzo).

    The primary developer and maintainer (alexjavabraz@gmail.com) demonstrates knowledge of secure software design through direct
    implementation in the codebase:

    • Input validation — injection pattern detection (A03), email RFC 5321 regex, field length limits via the validator crate
    • Cryptography — bcrypt cost-12 for user passwords; SHA-256 for high-entropy API secrets; JWT with expiry for session tokens
      (A02)
    • Authentication — OAuth2 client_credentials flow; timing-safe bcrypt verify with dummy hash to prevent user enumeration;
      generic error messages on login failure (A07)
    • Access control — all endpoints protected by require_auth middleware except explicitly public routes (A01)
    • Security policy — documented vulnerability disclosure process in SECURITY.md with private reporting channels and defined
      response SLAs

    These practices are applied consistently across the codebase and enforced through the contribution requirements in
    CONTRIBUTING.md.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs



    Angalau mmoja wa wasanidi wakuu wa mradi LAZIMA wajue aina za kawaida za makosa ambayo husababisha udhaifu katika aina hii ya programu, pamoja na angalau mbinu moja ya kukabiliana au kupunguza kila moja. [know_common_errors]
    Mifano (kulingana na aina ya programu) ni pamoja na uvamizi wa SQL, uvamizi wa OS, mtiririko wa kipengele cha kawaida, uandishi wa tovuti-tofauti, uthibitishaji unaokosekana, na uidhinishaji unaokosekana. Angalia CWE/SANS top 25 au OWASP Top 10 kwa orodha zinazotumika kawaida. Vitabu vingi na kozi zinapatikana kukusaidia kuelewa jinsi ya kuunda programu salama zaidi na kujadili makosa ya kawaida ya utekelezaji ambayo husababisha udhaifu. Kwa mfano, kozi ya Misingi ya Maendeleo ya Programu Salama ni seti huru ya kozi tatu zinazoeleza jinsi ya kuunda programu salama zaidi (ni bure ukiifanyia ukaguzi; kwa ada ya ziada unaweza kupata cheti kuthibitisha ulijifunza nyenzo).

    The primary developer demonstrates knowledge of common vulnerability classes and their mitigations, as evidenced directly in
    the codebase and documentation:

    ┌─────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────┐
    │ Vulnerability class │ Mitigation implemented │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ SQL injection (A03) │ SQLx parameterized queries — no string interpolation in database calls │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Input injection / XSS (A03) │ Regex validation rejecting HTML tags, javascript:, event handlers, and SQL DDL in all │
    │ │ free-text inputs │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Broken authentication (A07) │ Timing-safe bcrypt verify with dummy hash; generic error messages; JWT expiry; OAuth2 │
    │ │ client_credentials flow │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Cryptographic failures │ bcrypt cost-12 for passwords; SHA-256 for high-entropy secrets; TLS enforced at the │
    │ (A02) │ reverse proxy │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Broken access control (A01) │ require_auth middleware applied globally; public routes explicitly opted out │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Security misconfiguration │ CORS restricted to explicit allowed origins; secrets via environment variables only; no │
    │ (A05) │ hardcoded credentials │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Sensitive data exposure │ Secrets never stored in plaintext; logs never include credentials; client secret shown │
    │ │ only once at registration │
    └─────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────┘

    The security checklist in CONTRIBUTING.md requires every contributor to verify these mitigations before a PR is accepted:

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs


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

    Programu iliyotengenezwa na mradi LAZIMA itumie, kwa chaguo-msingi, tu itifaki za kriptografia na mifumbo ambazo zimechapishwa hadharani na kukaguliwa na wataalam (ikiwa itifaki za kriptografia na mafumbo imetumika). [crypto_published]
    Vigezo hivi vya kriptografia mara mingi havitumiki kwa sababu programu zingine hazina haja ya kutumia moja kwa moja uwezo wa kriptografia.

    The project uses only publicly published and expert-reviewed cryptographic primitives:

    ┌────────────────────┬──────────────────────────────┬─────────────────────────────────────────────────────────┐
    │ Usage │ Algorithm │ Standard │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Password hashing │ bcrypt (cost 12) │ Published — Provos & Mazières, USENIX 1999 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ API secret hashing │ SHA-256 │ NIST FIPS 180-4 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Session tokens │ JWT with HMAC-SHA256 (HS256) │ RFC 7519 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Transport security │ TLS 1.2/1.3 │ RFC 5246 / RFC 8446 (enforced at the ALB/reverse proxy) │
    └────────────────────┴──────────────────────────────┴─────────────────────────────────────────────────────────┘

    All cryptographic dependencies (bcrypt, sha2, jsonwebtoken) are widely used, openly published Rust crates with no proprietary
    or custom cryptographic implementations.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Ikiwa programu iliyotengenezwa na mradi ni programu au maktaba, na kusudi lake la msingi sio kutekeleza usimbuaji, basi INAPASWA tu kuita programu iliyoundwa kihususa kutekeleza kazi za kielelezo; HAIPASWI kutekeleza-upya shughuli hiyo. [crypto_call]

    The project is a REST API whose primary purpose is token operations — not cryptography. All cryptographic functions
    are delegated entirely to established, purpose-built libraries:

    • bcrypt — password hashing
    • sha2 — SHA-256 digest
    • jsonwebtoken — JWT signing and verification (HMAC-SHA256)

    No cryptographic algorithms are re-implemented anywhere in the codebase. All calls go through these dedicated crates.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Utendaji wote katika programu iliyotengenezwa na mradi ambayo inategemea usimbuaji LAZIMA iweze kutekelezwa kwa kutumia FLOSS. [crypto_floss]

    Every cryptographic dependency is FLOSS-licensed:

    ┌──────────────┬──────────────────┐
    │ Crate │ License │
    ├──────────────┼──────────────────┤
    │ bcrypt │ Apache-2.0 │
    ├──────────────┼──────────────────┤
    │ sha2 │ MIT / Apache-2.0 │
    ├──────────────┼──────────────────┤
    │ jsonwebtoken │ MIT │
    ├──────────────┼──────────────────┤
    │ hmac │ MIT / Apache-2.0 │
    └──────────────┴──────────────────┘

    TLS termination is handled by the reverse proxy (nginx with Let's Encrypt certificates — both FLOSS). No proprietary
    cryptographic library is required at any layer.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Mifumo ya usalama ndani ya programu inayozalishwa na mradi LAZIMA itumie kwa msingi keylengths ambazo angalau zinakidhi mahitaji ya chini ya NIST kufikia mwaka wa 2030 (kama ilivyoelezwa mnamo 2012). LAZIMA iwe rahisi kusanidi programu ili keylengths ndogo zimezimwa kabisa. [crypto_keylength]
    Vipimo hivi vya urefu wa charaza ni: symmetric key 112, factoring modulus 2048, discrete logarithm key 224, discrete logarithmic group 2048, elliptic curve 224, na hash 224 (ufichuzi wa nywila haujashughulikiwa kwenye urefu wa charaza hii, maelezo zaidi ya ufichuzi wa nywila yanapatikana ndani ya kigezo cha crypto_password_storage). Ona https://www.keylength.com kwa mliganisho wa mapendekezo ya funguo-refu kutoka mashirika mbali mbali. Programu YAWEZA kubali funguo-refu ndogo katika usanidi (haifai kukubali, maana hii huwacha mashambulizi ya kushusha, lakini funguo-refu fupi wakati mwingine ina manufaa ya upatanifu).

    All key lengths meet or exceed NIST SP 800-131A requirements through 2030:

    ┌──────────────────┬────────────────┬─────────────────────┬─────────────────────────────────────┐
    │ Mechanism │ Algorithm │ Key / output length │ NIST minimum │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Password hashing │ bcrypt cost-12 │ 192-bit output │ N/A — bcrypt is a KDF, not a cipher │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Secret hashing │ SHA-256 │ 256-bit digest │ ≥ 112 bits ✓ │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ JWT signing │ HMAC-SHA256 │ 256-bit key │ ≥ 112 bits ✓ │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Transport │ TLS 1.2/1.3 │ ≥ 128-bit symmetric │ ≥ 112 bits ✓ │
    └──────────────────┴────────────────┴─────────────────────┴─────────────────────────────────────┘

    No short or deprecated key lengths (e.g., DES, RC4, MD5, SHA-1, RSA-1024) are used anywhere in the codebase or its
    dependencies. The cryptographic libraries used (sha2, jsonwebtoken, bcrypt) do not expose configuration options for weaker key
    lengths — insecure sizes are simply not available through their APIs.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Mifumo ya usalama ya chaguo-msingi ndani ya programu inayozalishwa na mradi LAZIMA ISITEGEMEE algoriti zilizovunjika za kriptologia (k.m., MD4, MD5, DES moja, RC4, Dual_EC_DRBG), au kutumia hali za cipher ambazo si sahihi kwa muktadha, isipokuwa ni muhimu kutekeleza itifaki inayoweza kushirikiana (ambapo itifaki iliyotekelezwa ni toleo la hivi karibuni zaidi la kiwango hicho kinachotegemeana sana na mfumo wa mtandao, mfumo huo unahitaji matumizi ya algoriti au hali hiyo, na mfumo huo haupatii chaguo lolote salama zaidi). Nyaraka LAZIMA zieleze hatari zozote za usalama husika na upungufu wowote unaojulikana ikiwa algoriti hizi zilizovunjika au hali ni muhimu kwa itifaki inayoweza kushirikiana. [crypto_working]
    Hali ya ECB ni karibu kamwe haifai kwa sababu inaonyesha block zinazofanana ndani ya ciphertext kama ilivyoonyeshwa na penguin wa ECB, na hali ya CTR mara nyingi si sahihi kwa sababu haifanyi uthibitishaji na husababisha nakala ikiwa hali ya ingizo inarudiwa. Katika hali nyingi ni bora kuchagua hali ya algoriti ya block cipher iliyoundwa kuchanganya siri na uthibitishaji, k.m., Galois/Counter Mode (GCM) na EAX. Miradi YAWEZA kuwaruhusu watumiaji kuwasha taratibu zilizovunjika (k.m., wakati wa usanidi) ambapo ni muhimu kwa upatanifu, lakini hapo watumiaji wanajua wanafanya hivyo.

    The project does not use any broken or deprecated cryptographic algorithms. No MD4, MD5, single DES, RC4, Dual_EC_DRBG, or
    insecure cipher modes appear in the codebase or are exposed through any API.

    All algorithms in use (bcrypt, SHA-256, HMAC-SHA256, TLS 1.2/1.3) are currently recommended by NIST and have no known practical
    attacks. There are no interoperability constraints that would require falling back to a weaker algorithm.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Mifumo ya usalama ya chaguo-msingi ndani ya programu inayozalishwa na mradi INAPASWA 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.

    The project does not use SHA-1, CBC mode, or any algorithm with known serious weaknesses. Every cryptographic primitive in use
    (SHA-256, HMAC-SHA256, bcrypt, TLS 1.3) is currently recommended with no known serious weaknesses.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi INAPASWA kutekeleza kwa ukamilifu usiri wa umbele ya itifaki za makubaliano ya funguo ili funguo la kipindi kilicho tokana na kikao cha vifungo muda-mrefu haziwezi kuridhi mabaya ikiwa mojawapo ya vifunguo vya muda-mrefu imeridhi mabaya katika usoni. [crypto_pfs]

    Perfect forward secrecy is provided at the transport layer by TLS 1.3, which mandates ephemeral key exchange (ECDHE)
    exclusively — static RSA key exchange is not permitted in TLS 1.3. TLS termination is handled by nginx with a Let's Encrypt
    certificate on the reverse proxy in front of the API.

    At the application layer, JWT tokens have a 1-hour expiry (expires_in: 3600), limiting the window of exposure if a token is
    compromised.

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs



    Ikiwa programu iliyotengenezwa na mradi imesababisha uhifadhi wa nywila kwa minajili ya uthibitishaji ya watumiaji wa kutoka nje, nywila LAZIMA zihifadhiwe kwa mficho uliorudiarudia na chumvi kwa kila-mtumiaji kwa kutumia kanuni ya upanuaji (rudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, or PBKDF2). Ona pia Kurasadogo ya Uhifadhi wa Nywila la OWASP). [crypto_password_storage]
    Kigezo hili linatumika tu wakati programu linatekeleza uthibitishaji wa watumiaji kutumia nywila kwa watumiaji wa nje (ambayo pia ni uthibitishaji unaelekezwa ndani), kama vile programu za tovuti zinazobakia seva). Haitumiki katika visa ambavyo programu inahifadhi nywila ili kudhibitisha ndani ya mifumo mingine (ambayo pia ni ithibitishaji unaelekezwa nje, k.m., programu inatekeleza teja la mfumo lingineyo), maana angalau sehemu za programu lazima ziwe na njia ya kupata hiyo nywila isigalifichwa.

    Developer account passwords are hashed using bcrypt (cost factor 12) with a per-user salt generated automatically by the
    bcrypt library. Plaintext passwords are never stored or logged.

    The implementation runs bcrypt on a dedicated blocking thread to avoid blocking the async runtime:

    let password_hash =
    tokio::task::spawn_blocking(move || bcrypt::hash(password, BCRYPT_COST))
    .await
    .context("bcrypt spawn failed")?
    .context("bcrypt hash failed")?;

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs



    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi LAZIMA itoe funguo zote za kriptologia na nonces kwa kutumia kitengeneza cha nambari za bahati kuptia kriptologia salama, na ISIWEZE kufanya hivo kutumia vitengenezi zisizo salama kikriptologia. [crypto_random]
    Kitengeneza cha nambari za bahati nasibu za kriptologia salama kinaweza kuwa kitengeneza cha nambari za bahati nasibu za vifaa, au kinaweza kuwa kitengeneza cha nambari za bahati nasibu za kriptologia salama (CSPRNG) kwa kutumia algoriti kama vile Hash_DRBG, HMAC_DRBG, CTR_DRBG, Yarrow, au Fortuna. Mifano ya simu kwa vitengeneza cha nambari za bahati nasibu salama ni pamoja na java.security.SecureRandom ya Java na window.crypto.getRandomValues ya JavaScript. Mifano ya simu kwa vitengeneza cha nambari za bahati nasibu zisizo salama ni pamoja na java.util.Random ya Java na Math.random ya JavaScript.

    All cryptographic keys and nonces are generated using cryptographically secure sources:

    • API client secrets — generated using rand::random::<u8>() which uses the rand crate's ThreadRng, a cryptographically secure
      PRNG seeded from the operating system entropy source (getrandom)
    • Client IDs — generated using Uuid::new_v4() (UUID v4), which also draws from the OS CSPRNG
    • JWT signing — HMAC-SHA256 deterministic signing; nonce is provided by the OS-level TLS layer
    • bcrypt salt — generated internally by the bcrypt crate using OS entropy

    No insecure generators (rand::thread_rng seeded from time, Math.random(), srand(), or similar) are used anywhere.

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs


  • Utoaji salama dhidi ya mashambulizi ya mtu-katikati (MITM)


    Mradi LAZIMA utumie utaratibu wa utoaji ambao unakabiliana na mashambulizi ya MITM. Kutumia https au ssh+scp ni inakubaliwa. [delivery_mitm]
    Utaratibu wenye nguvu zaidi ni kutoa programu na vifurushi vilivyosainiwa kidigitali, kwa kuwa hiyo inapunguza mashambulizi kwenye mfumo wa usambazaji, lakini hii inafanya kazi tu ikiwa watumiaji wanaweza kuwa na uhakika kwamba funguo za umma kwa saini ni sahihi na ikiwa watumiaji watakagua saini kweli kweli.

    Distribution channels use HTTPS exclusively. [osps_br_03_02]



    Hash ya kriptologia (k.m., sha1sum) LAZIMA ISICHUKULIWE kupitia http na kutumika bila kuangalia saini ya kriptologia. [delivery_unsigned]
    Hash hizi zinaweza kurekebishwa wakati wa usafiri.

    The project does not retrieve any cryptographic hashes over HTTP. All dependencies are managed by Cargo, which verifies every
    downloaded crate against a SHA-256 checksum recorded in Cargo.lock before use. No external hash retrieval over plain HTTP
    occurs at any stage of the build or runtime.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.lock


  • Udhaifu uliofahamika hadharani umeshughulikiwa


    LAZIMA kuwe hakuna udhaifu usiorekebishwa wa kiwango cha kati au juu zaidi ambao umejulikana hadharani kwa zaidi ya siku 60. [vulnerabilities_fixed_60_days]
    Udhaifu lazima urekebishwe na kutolewa na mradi wenyewe (rekebisho zinaweza kutengenezwa mahali pengine). Udhaifu unakuwa unajulikana hadharani (kwa kusudi hili) mara tu unapata CVE yenye taarifa zilizotolewa hadharani zisizolipwa (zilizoripotiwa, kwa mfano, katika Hifadhidata ya Taifa ya Udhaifu) au wakati mradi umefahamishwa na taarifa imetolewa kwa umma (labda na mradi). Udhaifu unazingatiwa kuwa wa kiwango cha kati au juu ikiwa alama yake ya Common Vulnerability Scoring System (CVSS) ya msingi ya ubora ni kati au juu. Katika matoleo ya CVSS 2.0 hadi 3.1, hii ni sawa na alama ya CVSS ya 4.0 au zaidi. Miradi inaweza kutumia alama ya CVSS kama ilivyochapishwa katika hifadhidata ya udhaifu inayotumika sana (kama vile Hifadhidata ya Taifa ya Udhaifu) kwa kutumia toleo la hivi karibuni la CVSS lililoripotiwa katika hifadhidata hiyo. Miradi badala yake inaweza kuhesabu ukali wao wenyewe kwa kutumia toleo la hivi karibuni la CVSS wakati wa ufunuzi wa udhaifu, ikiwa ingizo la hesabu linatangazwa hadharani mara tu udhaifu unajulikana hadharani. Kumbuka: hii inamaanisha kwamba watumiaji wanaweza kuachwa katika hatari kwa washambuliaji wote duniani kwa siku hadi 60. Kigezo hiki ni rahisi zaidi kukidhi kuliko yale Google inapendekeza katika Rebooting responsible disclosure, kwa sababu Google inapendekeza kwamba kipindi cha siku 60 kianze wakati mradi unafahamishwa hata ikiwa ripoti si ya umma. Pia kumbuka kwamba kigezo hiki cha nishani, kama vigezo vingine, kinatumika kwa mradi wa mtu binafsi. Baadhi ya miradi ni sehemu ya mashirika makubwa ya mwavuli au miradi mikubwa, labda katika safu nyingi, na miradi mingi inatoa matokeo yao kwa mashirika mengine na miradi kama sehemu ya mnyororo wa usambazaji wenye utata. Mradi wa mtu binafsi mara nyingi hauwezi kudhibiti wengine, lakini mradi wa mtu binafsi unaweza kufanya kazi kutoa rekebisho ya udhaifu kwa wakati. Kwa hiyo, tunazingatia tu muda wa jibu wa mradi wa mtu binafsi. Mara tu rekebisho inapatikana kutoka kwa mradi wa mtu binafsi, wengine wanaweza kuamua jinsi ya kushughulikia rekebisho (k.m., wanaweza kusasisha kwenye toleo jipya au wanaweza kutumia rekebisho tu kama suluhisho lililochaguliwa-cherry).

    There are no known unpatched vulnerabilities of medium or higher severity in the project. Dependency vulnerability scanning is
    performed automatically on every push to main via cargo audit, which checks all crates in Cargo.lock against the RustSec
    Advisory Database (https://rustsec.org/). The CI build fails if any advisory of medium or higher severity is found.

    The cargo audit step was added to CI in commit 1bae20e (https://github.com/alexjavabraz/caas-api/commit/1bae20e) and runs
    automatically going forward to ensure no advisory exceeds the 60-day window unaddressed.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Miradi INAPASWA kurekebisha udhaifu wote muhimu haraka baada ya kuripotiwa. [vulnerabilities_critical_fixed]

    The vulnerability response policy documented in SECURITY.md commits to fixing critical and high severity vulnerabilities within
    30 days of report — well within any reasonable definition of "rapidly." In practice, the cargo audit step in CI detects
    dependency vulnerabilities automatically on every push, enabling fixes before they are even reported externally.

    No critical vulnerabilities have been reported or identified to date.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline


  • Masuala mengine ya usalama


    Hazina za umma LAZIMA ZISIVUJE uthibitisho halali wa faragha (k.m., nywila inayofanya kazi au funguo ya faragha) ambayo imekusudiwa kupunguza upatikanaji wa umma. [no_leaked_credentials]
    Mradi UNAWEZA kuvuja uthibitisho wa "sampuli" kwa majaribio na hifadhidata zisizo muhimu, mradi tu hazikusudiwa kupunguza upatikanaji wa umma.

    No credentials, private keys, or secrets are present in the repository. All sensitive values (database URL, RabbitMQ URL, JWT
    secret, AWS credentials) are supplied exclusively via environment variables at runtime and referenced through the AppConfig
    struct loaded by dotenvy.

    The .gitignore excludes .env files, and the CONTRIBUTING.md security checklist explicitly requires:

    ▎ "No secrets or credentials in code or tests"

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs


 Uchanganuzi 8/8

  • Uchambuzi tuli wa msimbo


    Angalau zana moja ya uchambuzi wa msimbo tuli (zaidi ya maonyo ya mkusanyaji na hali za lugha "salama") LAZIMA itumike kwa toleo lolote lililopendekezwa kubwa la uzalishaji wa programu kabla ya toleo lake, ikiwa kuna angalau zana moja ya FLOSS inayotekeleza kigezo hiki katika lugha iliyochaguliwa. [static_analysis]
    Zana ya uchambuzi wa msimbo tuli inachunguza msimbo wa programu (kama msimbo wa chanzo, msimbo wa kati, au utekelezaji) bila kuutekeleza na ingizo maalum. Kwa madhumuni ya kigezo hiki, maonyo ya mkusanyaji na hali za lugha "salama" hazihesabiwi kama zana za uchambuzi wa msimbo tuli (hizi kwa kawaida huepuka uchambuzi wa kina kwa sababu kasi ni muhimu). Baadhi ya zana za uchambuzi wa msimbo tuli zinazingatia kugundua hitilafu za jumla, nyingine zinazingatia kupata aina fulani za hitilafu (kama vile udhaifu), na baadhi hufanya mchanganyiko. Mifano ya zana hizo za uchambuzi wa msimbo tuli ni pamoja na cppcheck (C, C++), clang static analyzer (C, C++), SpotBugs (Java), FindBugs (Java) (ikiwa ni pamoja na FindSecurityBugs), PMD (Java), Brakeman (Ruby on Rails), lintr (R), goodpractice (R), Coverity Quality Analyzer, SonarQube, Codacy, na HP Enterprise Fortify Static Code Analyzer. Orodha kubwa za zana zinaweza kupatikana katika maeneo kama vile orodha ya Wikipedia ya zana za uchambuzi wa msimbo tuli, taarifa za OWASP kuhusu uchambuzi wa msimbo tuli, orodha ya NIST ya vichambua usalama wa msimbo wa chanzo, na orodha ya Wheeler ya zana za uchambuzi tuli. Ikiwa hakuna zana za uchambuzi tuli za FLOSS zinazopatikana kwa lugha za utekelezaji zilizotumika, unaweza kuchagua 'N/A'.

    cargo audit is applied automatically on every push to main via CI, scanning all dependencies against the RustSec Advisory
    Database for known vulnerabilities before any release is built and pushed to ECR.

    Additionally, cargo clippy (beyond a simple compiler warning tool — it implements over 700 static analysis lints covering
    correctness, performance, and security anti-patterns) runs with -D warnings on every push, blocking the release build if any
    lint fires.

    Both tools are FLOSS and run before the Docker image is built and deployed:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    INAPENDEKEZWA kwamba angalau moja ya zana za uchambuzi tuli zilizotumika kwa kigezo cha static_analysis ijumuishe sheria au njia za kutafuta udhaifu wa kawaida katika lugha au mazingira yaliyochambuliwa. [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'.

    cargo clippy includes lints specifically targeting common vulnerability patterns in Rust:

    • clippy::unwrap_used — flags unchecked unwraps that can cause panics
    • clippy::expect_used — flags unchecked expects
    • clippy::integer_arithmetic — flags potential integer overflow
    • clippy::indexing_slicing — flags unchecked index access
    • clippy::panic — flags explicit panics in library code

    Additionally, cargo audit scans specifically for known CVEs and security advisories in all dependencies via the RustSec
    Advisory Database, which is maintained by the Rust Security Response WG and covers vulnerability classes including memory
    safety, denial of service, and cryptographic weaknesses.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Udhaifu wote wenye ukali wa kati na juu zaidi unaoweza kudhoofishwa uliogundulika kupitia uchambuzi wa msimbo tuli LAZIMA urekebishwe kwa wakati baada ya kuthibitishwa. [static_analysis_fixed]
    Udhaifu unazingatiwa kuwa wa kiwango cha kati au juu zaidi ikiwa alama yake ya Common Vulnerability Scoring System (CVSS) ya msingi ya ubora ni kati au juu. Katika matoleo ya CVSS 2.0 hadi 3.1, hii ni sawa na alama ya CVSS ya 4.0 au zaidi. Miradi inaweza kutumia alama ya CVSS kama ilivyochapishwa katika hifadhidata ya udhaifu inayotumika sana (kama vile Hifadhidata ya Taifa ya Udhaifu) kwa kutumia toleo la hivi karibuni la CVSS lililoripotiwa katika hifadhidata hiyo. Miradi badala yake inaweza kuhesabu ukali wao wenyewe kwa kutumia toleo la hivi karibuni la CVSS wakati wa ufunuzi wa udhaifu, ikiwa ingizo la hesabu linatangazwa hadharani mara tu udhaifu unajulikana hadharani. Kumbuka kwamba kigezo cha vulnerabilities_fixed_60_days kinahitaji kwamba udhaifu wote kama huo urekebishwe ndani ya siku 60 baada ya kuwa wa umma.

    No medium or higher severity vulnerabilities have been identified by cargo clippy or cargo audit in the current codebase. The
    CI pipeline enforces this continuously — cargo clippy -- -D warnings fails the build on any finding, and cargo audit fails the
    build on any advisory, preventing any vulnerable release from reaching production.

    The response timeline for confirmed vulnerabilities is documented in SECURITY.md: critical/high within 30 days, medium/low
    within 90 days.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline



    INAPENDEKEZWA kwamba uchambuzi wa msimbo wa chanzo tuli ufanyike kwenye kila ahadi au angalau kila siku. [static_analysis_often]

    There are no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. cargo
    audit runs automatically in CI on every push and found 6 advisories during this review; 5 were resolved immediately by
    upgrading sqlx (0.7→0.8) and validator (0.18→0.20):

    • RUSTSEC-2024-0363 (sqlx) — fixed by upgrading to 0.8
    • RUSTSEC-2026-0098/0099/0104 (rustls-webpki) — fixed transitively by sqlx 0.8
    • RUSTSEC-2024-0421 (idna) — fixed by upgrading validator to 0.20

    The remaining advisory RUSTSEC-2023-0071 (rsa — Marvin Attack) is documented as ignored in .cargo/audit.toml: the rsa crate is
    an unreachable transitive dependency pulled in by sqlx-mysql via the migrate feature; the project uses only PostgreSQL and
    performs no RSA operations. No fix is available upstream.

    https://github.com/alexjavabraz/caas-api/blob/main/.cargo/audit.toml


  • Uchambuzi wa msimbo wa nguvu za ziada


    INAPENDEKEZWA kwamba angalau zana moja ya uchambuzi wa nguvu itumike kwenye toleo kubwa lolote la uzalishaji lililopendekezwa la programu kabla ya kutolewa kwake. [dynamic_analysis]
    Zana ya uchambuzi wa nguvu inachunguza programu kwa kuitekeleza na ingizo maalum. Kwa mfano, mradi YAWEZA kutumia zana ya fuzzing (k.m., American Fuzzy Lop) au kitafutaji cha programu ya wavuti (k.m., OWASP ZAP au w3af). Katika hali fulani mradi wa OSS-Fuzz unaweza kuwa tayari kutumia majaribio ya fuzz kwenye mradi wako. Kwa madhumuni ya kigezo hiki zana ya uchambuzi wa nguvu inahitaji kubadilisha ingizo kwa njia fulani kutafuta aina mbalimbali za matatizo au kuwa seti kiotomatiki ya majaribio yenye angalau asilimia 80 ya ukaguzi wa tawi. Ukurasa wa Wikipedia kuhusu uchambuzi wa nguvu na ukurasa wa OWASP kuhusu fuzzing hutambulisha baadhi ya zana za uchambuzi wa nguvu. Zana za uchambuzi ZINAWEZA kuzingatia kutafuta udhaifu wa usalama, lakini hii haihitajiki.


    INAPENDEKEZWA kwamba 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) 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.

    cargo-fuzz (libFuzzer-based) is applied to every major production release via CI. Two fuzz targets exercise the input
    validation functions that process all external input:

    • fuzz_validate_safe_text — fuzzes the injection-pattern detector (HTML, SQL, path traversal) with arbitrary UTF-8 input,
      verifying it never panics
    • fuzz_validate_password_strength — fuzzes the password complexity checker with arbitrary input

    Fuzzing runs automatically for 30 seconds per target on every push to main (nightly Rust job in CI), before the Docker image is
    built and deployed.

    https://github.com/alexjavabraz/caas-api/tree/main/fuzz

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    INAPENDEKEZWA kwamba mradi utumie usanidi wa angalau baadhi ya uchambuzi wa nguvu (kama vile majaribio au fuzzing) ambao huwezesha madai mengi. Katika hali nyingi madai haya yasipaswi kuwa yamewezeshwa katika mijengo ya uzalishaji. [dynamic_analysis_enable_assertions]
    Kigezo hiki hakipendekezi kuwezesha madai wakati wa uzalishaji; hilo ni kabisa kwa mradi na watumiaji wake kuamua. Lengo la kigezo hiki ni badala yake kuboresha ugunduzaji wa hitilafu wakati wa uchambuzi wa nguvu kabla ya kusambazwa. Kuwezesha madai katika matumizi ya uzalishaji ni tofauti kabisa na kuwezesha madai wakati wa uchambuzi wa nguvu (kama vile majaribio). Katika hali fulani kuwezesha madai katika matumizi ya uzalishaji ni busara sana (hasa katika vipengele vya uadilifu wa juu). Kuna hoja nyingi dhidi ya kuwezesha madai katika uzalishaji, k.m., maktaba hazipaswi kuvuruga waita, uwepo wao unaweza kusababisha kukataliwa na maduka ya programu, na/au kuamilisha madai katika uzalishaji kunaweza kufunua data za faragha kama vile funguo za faragha. Kumbuka kwamba katika usambazaji mwingi wa Linux NDEBUG haijafafanuliwa, hivyo C/C++ assert() kwa chaguo-msingi itawezeshwa kwa uzalishaji katika mazingira hayo. Inaweza kuwa muhimu kutumia utaratibu tofauti wa madai au kufafanua NDEBUG kwa uzalishaji katika mazingira hayo.

    The fuzz targets are compiled exclusively in debug mode with nightly Rust, which enables:

    • Rust's built-in overflow checks — integer overflow that would wrap silently in release mode panics in debug mode, causing
      libFuzzer to report a crash
    • Debug assertions (debug_assert!) — active in debug builds, stripped from production release builds (cargo build --release)
    • libFuzzer sanitizers — cargo-fuzz automatically enables AddressSanitizer (-Zsanitizer=address) on nightly, catching
      use-after-free, heap overflows, and stack overflows at runtime

    Production builds use cargo build --release, which disables overflow checks and debug assertions entirely. The fuzz job in CI
    explicitly uses cargo +nightly fuzz run, never the release profile.

    https://github.com/alexjavabraz/caas-api/blob/main/fuzz/Cargo.toml



    Udhaifu wote wenye ukali wa kati na juu zaidi unaoweza kudhoofishwa uliogundulika kupitia uchambuzi wa msimbo wa nguvu LAZIMA urekebishwe kwa wakati baada ya kuthibitishwa. [dynamic_analysis_fixed]
    Ikiwa haujafanya uchambuzi wa msimbo wa nguvu na kwa hivyo hukupata udhaifu wowote kwa njia hii, chagua "haihusiki" (N/A). Udhaifu unazingatiwa kuwa wa kiwango cha kati au juu zaidi ikiwa alama yake ya Common Vulnerability Scoring System (CVSS) ya msingi ya ubora ni kati au juu. Katika matoleo ya CVSS 2.0 hadi 3.1, hii ni sawa na alama ya CVSS ya 4.0 au zaidi. Miradi inaweza kutumia alama ya CVSS kama ilivyochapishwa katika hifadhidata ya udhaifu inayotumika sana (kama vile Hifadhidata ya Taifa ya Udhaifu) kwa kutumia toleo la hivi karibuni la CVSS lililoripotiwa katika hifadhidata hiyo. Miradi badala yake inaweza kuhesabu ukali wao wenyewe kwa kutumia toleo la hivi karibuni la CVSS wakati wa ufunuzi wa udhaifu, ikiwa ingizo la hesabu linatangazwa hadharani mara tu udhaifu unajulikana hadharani.

    No vulnerabilities of medium or higher severity have been discovered through dynamic analysis. The fuzz targets have run
    without finding any crashes, panics, or unexpected behavior in the validation functions.

    The response timeline documented in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline) applies equally to findings from dynamic
    analysis: critical/high within 30 days, medium/low within 90 days.



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 Alex Braz na wachangiaji wa nishani ya Mazoea Bora ya OpenSSF.

Ingizo la nishani ya mradi linamilikiwa na: Alex Braz.
Ingizo liliundwa siku 2026-06-22 14:49:42 UTC, iliyosasishwa mara ya mwisho siku 2026-06-22 22:43:19 UTC.