ओपन सोर्स प्रोजेक्ट क्रिटिकैलिटी स्कोर (बीटा)

यह प्रोजेक्ट Securing Critical Projects WG के सदस्यों द्वारा अनुरक्षित है।

लक्ष्य

1. हर ओपन सोर्स प्रोजेक्ट के लिए एक क्रिटिकैलिटी स्कोर तैयार करें।

2. उन महत्वपूर्ण प्रोजेक्ट्स की सूची बनाएं जिन पर ओपन सोर्स समुदाय निर्भर है।

3. इन महत्वपूर्ण प्रोजेक्ट्स की सुरक्षा स्थिति को सक्रिय रूप से बेहतर बनाने के लिए इस डेटा का उपयोग करें।

क्रिटिकैलिटी स्कोर

किसी प्रोजेक्ट का क्रिटिकैलिटी स्कोर उस प्रोजेक्ट के प्रभाव और महत्व को परिभाषित करता है। यह 0 (सबसे कम महत्वपूर्ण) और 1 (सबसे अधिक महत्वपूर्ण) के बीच की संख्या है। यह Rob Pike द्वारा निम्नलिखित एल्गोरिदम पर आधारित है:

हम किसी ओपन सोर्स प्रोजेक्ट के लिए क्रिटिकैलिटी स्कोर प्राप्त करने हेतु निम्नलिखित डिफ़ॉल्ट पैरामीटर का उपयोग करते हैं:

नोट:

• आप नीचे बताए अनुसार रनटाइम पर उन डिफ़ॉल्ट मानों को ओवरराइड कर सकते हैं।
• इन पैरामीटरों को बेहतर बनाने के लिए हम समुदाय के विचारों की तलाश कर रहे हैं।
• व्यक्तिगत तर्क नियमों के हमेशा कुछ अपवाद होंगे।

उपयोग

$ go install github.com/ossf/criticality_score/v2/cmd/criticality_score@latest

$ export GITHUB_TOKEN=...         # requires a GitHub token to work
$ gcloud auth login --update-adc  # optional, add -depsdev-disable to skip

$ criticality_score -gcp-project-id=[your projectID] https://github.com/kubernetes/kubernetes
repo.name: kubernetes
repo.url: https://github.com/kubernetes/kubernetes
repo.language: Go
repo.license: Apache License 2.0
legacy.created_since: 87
legacy.updated_since: 0
legacy.contributor_count: 3999
legacy.watchers_count: 79583
legacy.org_count: 5
legacy.commit_frequency: 97.2
legacy.recent_releases_count: 70
legacy.updated_issues_count: 5395
legacy.closed_issues_count: 3062
legacy.comment_frequency: 5.5
legacy.dependents_count: 454393
default_score: 0.99107

स्कोर की गणना कैसे की जाए यह निर्दिष्ट करने के लिए -scoring-config पैरामीटर का उपयोग करके और एक अलग कॉन्फ़िगरेशन फ़ाइल प्रदान करके स्कोर बदला जा सकता है।

डिफ़ॉल्ट रूप से original_pike.yml कॉन्फ़िगरेशन का उपयोग स्कोर की गणना के लिए किया जाता है। हालाँकि, अलग-अलग स्कोर उत्पन्न करने के लिए अन्य कॉन्फ़िगरेशन फ़ाइलें भी प्रदान की जा सकती हैं। अधिक जानकारी के लिए config/scorer देखें।

बेझिझक किसी एक कॉन्फ़िगरेशन की प्रतिलिपि बनाएं और अपनी आवश्यकताओं के अनुसार भार (weights) और थ्रेशोल्ड (thresholds) समायोजित करें।

प्रमाणीकरण

क्रिटिकैलिटी स्कोर चलाने से पहले, आपको यह करना होगा:

• GitHub रिपॉजिटरी के लिए, आपको GitHub एक्सेस टोकन बनाना होगा और इसे पर्यावरण चर GITHUB_AUTH_TOKEN में सेट करना होगा। यह बिना प्रमाणीकरण के अनुरोधों के साथ GitHub की एपीआई दर सीमाओं से बचने में मदद करता है।

# For posix platforms, e.g. linux, mac:
export GITHUB_AUTH_TOKEN=<your access token>

# For windows:
set GITHUB_AUTH_TOKEN=<your access token>

परिणामों की फ़ॉर्मेटिंग

वर्तमान में तीन प्रारूप हैं: text, json, और csv। भविष्य में अन्य जोड़े जा सकते हैं।

इन्हें -format फ़्लैग के साथ निर्दिष्ट किया जा सकता है।

अन्य कमांड

क्रिटिकैलिटी स्कोर प्रोजेक्ट में क्रिटिकैलिटी स्कोर डेटा उत्पन्न करने और उसके साथ काम करने के लिए अन्य कमांड भी शामिल हैं।

• enumerate_github: न्यूनतम संख्या में स्टार वाले GitHub रिपॉजिटरी के समूह को सटीक रूप से एकत्र करने के लिए एक उपकरण
• collect_signals: Scorecard प्रोजेक्ट के बुनियादी ढांचे का लाभ उठाकर बड़े पैमाने पर कच्चे सिग्नल एकत्र करने के लिए एक वर्कर।
• scorer: इनपुट CSV फ़ाइल के आधार पर क्रिटिकैलिटी स्कोर की पुनर्गणना करने के लिए एक उपकरण।

सार्वजनिक डेटा

यदि आप उनके क्रिटिकैलिटी स्कोर के साथ महत्वपूर्ण प्रोजेक्ट्स की सूची देखने में रुचि रखते हैं, तो हम उन्हें csv प्रारूप और BigQuery डेटासेट में प्रकाशित करते हैं।

यह डेटा GCP में चल रहे क्रिटिकैलिटी स्कोर प्रोजेक्ट के प्रोडक्शन इंस्टेंस का उपयोग करके उत्पन्न किया गया है। इसे कैसे तैनात किया जाता है, इसका विवरण infra निर्देशिका में पाया जा सकता है।

नोट: वर्तमान में, ये सूचियाँ केवल GitHub पर होस्ट किए गए प्रोजेक्ट्स से ली गई हैं। हम निकट भविष्य में अन्य सोर्स कंट्रोल सिस्टम पर होस्ट किए गए प्रोजेक्ट्स को शामिल करने के लिए इनका विस्तार करने की योजना बना रहे हैं।

CSV डेटा

डेटा Google Cloud Storage पर उपलब्ध है और इसे इसके माध्यम से डाउनलोड किया जा सकता है:

• वेब ब्राउज़र: commondatastorage.googleapis.com/ossf-criticality-score/index.html
• gsutil कमांड-लाइन टूल: gsutil ls gs://ossf-criticality-score/

BigQuery डेटासेट

यह डेटा सार्वजनिक BigQuery डेटासेट में उपलब्ध है।

GCP खाते के साथ आप डेटा पर क्वेरी चला सकते हैं। उदाहरण के लिए, यहाँ एक क्वेरी है जो स्कोर के आधार पर शीर्ष 100 रिपॉजिटरी लौटाती है:

  SELECT repo.url, default_score
    FROM `openssf.criticality_score_cron.criticality-score-v0-latest`
ORDER BY default_score DESC
   LIMIT 100;

योगदान

यदि आप शामिल होना चाहते हैं या आपके पास चर्चा के लिए विचार हैं, तो हम इस प्रोजेक्ट पर Securing Critical Projects WG बैठकों में चर्चा करते हैं।

शेड्यूल और मीटिंग आमंत्रण के लिए सामुदायिक कैलेंडर देखें।

योगदान करने के तरीके के मार्गदर्शन के लिए योगदान दस्तावेज़ देखें।