Snyk CLI के साथ शुरुआत करना

Snyk CLI का परिचय

Snyk एक डेवलपर-प्रथम, क्लाउड-नेटिव सुरक्षा उपकरण है जो आपके सॉफ़्टवेयर डेवलपमेंट प्रोजेक्ट्स को सुरक्षा कमजोरियों के लिए स्कैन और मॉनिटर करता है। Snyk सुरक्षा मुद्दों के लिए कई सामग्री प्रकारों को स्कैन करता है:

• Snyk Open Source: ओपन-सोर्स कमजोरियों को खोजें और स्वचालित रूप से ठीक करें
• Snyk Code: अपने एप्लिकेशन कोड में कमजोरियों को रीयल टाइम में खोजें और ठीक करें
• Snyk Container: कंटेनर इमेज और Kubernetes एप्लिकेशन में कमजोरियों को खोजें और ठीक करें
• Snyk IaC: Terraform और Kubernetes कोड में असुरक्षित कॉन्फ़िगरेशन खोजें और ठीक करें

Snyk CLI आपके डेवलपमेंट वर्कफ़्लो में Snyk की कार्यक्षमता लाता है। आप CLI को स्थानीय रूप से कमांड लाइन से या IDE में चला सकते हैं। आप CLI को अपने CI/CD पाइपलाइन में भी चला सकते हैं। निम्नलिखित Snyk CLI परीक्षण कमांड आउटपुट का एक उदाहरण दिखाता है।

Snyk CLI परीक्षण कमांड आउटपुट उदाहरण

Snyk CLI स्कैनिंग कई भाषाओं और उपकरणों का समर्थन करता है। विस्तृत जानकारी के लिए, निम्नलिखित देखें:

• ओपन सोर्स और Snyk Code के लिए समर्थित भाषाएँ, पैकेज मैनेजर और फ्रेमवर्क
• कंटेनर के लिए समर्थित ऑपरेटिंग सिस्टम वितरण
• समर्थित IaC भाषाएँ और क्लाउड प्रदाता

यह पृष्ठ बताता है कि CLI का उपयोग करके कैसे स्थापित, प्रमाणित और स्कैन करना शुरू करें। Snyk में इन चरणों के माध्यम से मार्गदर्शन करने के लिए एक ऑनबोर्डिंग विज़ार्ड भी है। प्रदर्शन के लिए, Snyk के साथ शुरुआत: CLI ऑनबोर्डिंग प्रवाह का अवलोकन देखें।

Snyk CLI स्थापित करें और अपनी मशीन को प्रमाणित करें

CLI का उपयोग करने के लिए, आपको इसे स्थापित करना होगा और अपनी मशीन को प्रमाणित करना होगा। Snyk CLI स्थापित या अपडेट करें और अपने खाते से CLI को प्रमाणित करें देखें। आप प्रत्येक रिलीज में परिवर्तनों के सारांश के लिए रिलीज़ नोट्स देख सकते हैं। अपने कोड को स्कैन करने से पहले, Snyk CLI के लिए कोड निष्पादन चेतावनी की समीक्षा करें।

{% hint style="info" %} CLI का उपयोग ओपन सोर्स स्कैनिंग के लिए करने से पहले, आपको अपना पैकेज मैनेजर स्थापित करना होगा। आवश्यक तृतीय-पक्ष उपकरण, जैसे Gradle या Maven, PATH में होने चाहिए। {% endhint %}

आप CLI को अपने IDE या CI/CD वातावरण में भी स्थापित कर सकते हैं। विवरण के लिए, प्रत्येक एकीकरण के निर्देशों के लिए IDE और CI/CD दस्तावेज़ीकरण देखें।

अपनी स्थापना का परीक्षण करें

प्रमाणित करने के बाद, आप अपनी स्थापना का परीक्षण कर सकते हैं। त्वरित परीक्षण के लिए, snyk --help चलाएँ।

वैकल्पिक रूप से, आप एक सार्वजनिक npm पैकेज पर त्वरित परीक्षण कर सकते हैं, उदाहरण के लिए snyk test ionic।

अपने टर्मिनल में test कमांड रिपोर्ट देखें। रिपोर्ट पैकेज में Snyk द्वारा पाई गई कमजोरियों को दर्शाती है। प्रत्येक पाए गए मुद्दे के लिए, Snyk मुद्दे की गंभीरता की रिपोर्ट करता है, एक विस्तृत विवरण का लिंक प्रदान करता है, उस पथ की रिपोर्ट करता है जिसके माध्यम से कमजोर मॉड्यूल आपके सिस्टम में आया, और समस्या को ठीक करने के तरीके पर मार्गदर्शन प्रदान करता है।

अपने डेवलपमेंट प्रोजेक्ट को स्कैन करें

Snyk CLI का उपयोग अपने ओपन सोर्स प्रोजेक्ट को कमजोरियों के लिए परीक्षण करने के लिए करने से पहले, सीमित अपवादों के साथ, आपको अपना प्रोजेक्ट बनाना होगा। विवरण के लिए, ओपन सोर्स प्रोजेक्ट जिन्हें परीक्षण से पहले बनाया जाना चाहिए देखें।

इसके अलावा, आपके ओपन-सोर्स प्रोजेक्ट की भाषा के आधार पर, Snyk CLI का उपयोग करने से पहले आपको अपना भाषा वातावरण स्थापित करने की आवश्यकता हो सकती है। विवरण के लिए, समर्थित भाषाएँ, पैकेज मैनेजर और फ्रेमवर्क देखें।

CLI स्थापित करने और अपनी मशीन को प्रमाणित करने के बाद, एक ओपन-सोर्स प्रोजेक्ट को स्कैन करने के लिए, cd /my/project/ का उपयोग करके वर्तमान निर्देशिका को एक समर्थित पैकेज मेनिफेस्ट फ़ाइल वाले फ़ोल्डर में बदलें, जैसे package.json, pom.xml, या composer.lock। फिर snyk test चलाएँ। पाई गई सभी कमजोरियाँ सूचीबद्ध हैं, जिनमें उनका पथ और फिक्स मार्गदर्शन शामिल है।

अपने स्रोत कोड को स्कैन करने के लिए, snyk code test चलाएँ।

आप एक Docker इमेज को उसके टैग द्वारा स्कैन कर सकते हैं, उदाहरण के लिए: snyk container test ubuntu:18.04।

Kubernetes (K8s) फ़ाइल को स्कैन करने के लिए, निम्न चलाएँ:
snyk iac test /path/to/kubernetes_file.yaml

प्रत्येक सामग्री प्रकार को स्कैन करने के लिए Snyk CLI का उपयोग करने के विवरण के लिए, निम्नलिखित देखें:

• Snyk Open Source के लिए Snyk CLI और test और monitor कमांड के लिए CLI सहायता
• Snyk Code के लिए Snyk CLI और Snyk Code CLI सहायता
• Snyk Container के लिए Snyk CLI, जिसमें Docker स्कैनिंग शामिल है, और Snyk Container CLI सहायता
• Snyk IaC के लिए Snyk CLI, जिसमें Terraform और Kubernetes (K8s) प्रोजेक्ट शामिल हैं, और Snyk IAC CLI सहायता

अपने ओपन सोर्स या कंटेनर प्रोजेक्ट की निगरानी करें

Snyk आपके ओपन सोर्स या कंटेनर एकीकृत SCM प्रोजेक्ट की समय-समय पर निगरानी कर सकता है और नई कमजोरियों के बारे में आपको सचेत कर सकता है। अपने प्रोजेक्ट को मॉनिटर करने के लिए सेट करने के लिए, snyk monitor या snyk container monitor चलाएँ।

यह आपकी वर्तमान निर्भरताओं का एक स्नैपशॉट बनाता है ताकि Snyk नियमित रूप से आपके कोड को स्कैन कर सके। Snyk तब आपको नए सामने आने वाली कमजोरियों के बारे में सचेत कर सकता है क्योंकि वे पेश की जाती हैं या जब कोई पहले से अनुपलब्ध पैच या अपग्रेड पथ बनाया जाता है। निम्नलिखित कोड snyk monitor कमांड के आउटपुट का एक उदाहरण दिखाता है।

> snyk monitor
Monitoring /project (project-name)...

Explore this snapshot at
https://app.snyk.io/org/my-org/project/29361c2c-9005-4692
-8df4-88f1c040fa7c/history/e1c994b3-de5d-482b-9281-eab4236c851e

Notifications about newly disclosed issues related to these
dependencies will be emailed to you.

आप अपने Snyk खाते में लॉग इन कर सकते हैं और नवीनतम स्नैपशॉट और स्कैन परिणाम खोजने के लिए Projects पृष्ठ पर नेविगेट कर सकते हैं:

Snyk मॉनिटर स्नैपशॉट और स्कैन परिणाम

अधिक जानकारी के लिए, नियमित अंतराल पर अपने प्रोजेक्ट की निगरानी करें देखें।

परीक्षण समाप्त हो रहे हैं

परीक्षण सीमाएँ सार्वजनिक रिपॉजिटरी पर लागू नहीं होती हैं। यदि आप देखते हैं कि आपके निजी रिपॉजिटरी (जहाँ लागू हो) से संबंधित परीक्षण सीमाएँ सार्वजनिक रिपॉजिटरी पर परीक्षणों द्वारा उपयोग की जा रही हैं, तो आप Snyk को Snyk CLI द्वारा स्कैन किए जा रहे रिपॉजिटरी का सार्वजनिक URL बताकर इसे ठीक कर सकते हैं। यह सुनिश्चित करता है कि Snyk एक सार्वजनिक रिपॉजिटरी को परीक्षण सीमाओं की ओर नहीं गिनता है।

यदि आप किसी ओपन-सोर्स प्रोजेक्ट पर परीक्षण समाप्त कर लेते हैं, तो इन चरणों का पालन करें:

• snyk monitor चलाएँ।
• Snyk वेब UI में, प्रोजेक्ट की Settings पर नेविगेट करें।
• Git remote URL के अंतर्गत अपने ओपन-सोर्स रिपॉजिटरी का URL दर्ज करें।

Snyk CLI के बारे में अतिरिक्त जानकारी

snyk help चलाएँ या CLI कमांड और विकल्प सारांश देखें।

त्वरित वीडियो प्रशिक्षण सत्र के लिए पाठ्यक्रम Snyk CLI का परिचय देखें।

Snyk एक चीट शीट (ब्लॉग पोस्ट) भी प्रदान करता है।

विशेष रूप से, निम्नलिखित विकल्पों के बारे में जानकारी देखें जो आपको उपयोगी लग सकते हैं:

• --severity-threshold=low|medium|high|critical: केवल निर्दिष्ट स्तर या उससे अधिक की कमजोरियों की रिपोर्ट करें।
• --json: परिणाम JSON प्रारूप में प्रिंट करें।
• --all-projects: कार्यशील निर्देशिका में सभी प्रोजेक्ट का स्वचालित रूप से पता लगाएं।

CLI के बारे में विस्तृत जानकारी के लिए, CLI दस्तावेज़ीकरण देखें।

Snyk CLI के लिए सहायता प्राप्त करना

Snyk CLI या सामान्य रूप से Snyk का उपयोग करने में सहायता पाने के लिए Snyk सहायता पृष्ठ पर संसाधनों का उपयोग करें। ध्यान दें कि Snyk सहायता किसी भी Snyk डेवलपमेंट प्रोजेक्ट पर GitHub Issues की सक्रिय रूप से निगरानी नहीं करती है।

Snyk CLI योगदान के लिए बंद है

22 जुलाई, 2024 से प्रभावी, Snyk CLI अब बाहरी योगदान स्वीकार नहीं करता है।

CLI के व्यापक उपयोग और जटिल प्रकृति के कारण, मामूली संशोधनों के भी अप्रत्याशित परिणाम हो सकते हैं। अप्रैल 2024 में CLI कोड में रिलीज़ चैनल शुरू करने के बाद से, Snyk का ध्यान रिलीज़ को स्थिर करने पर रहा है। Snyk का मानना है कि यह ओपन-सोर्स, बंद-योगदान मॉडल इस लक्ष्य की सर्वोत्तम सेवा करता है।

Snyk ग्राहकों और CLI उपयोगकर्ताओं के प्रति पारदर्शिता की भावना से, Snyk सार्वजनिक रूप से काम करना जारी रखेगा। हालांकि, आगे बढ़ते हुए, Snyk CLI योगदान के लिए बंद है।

Snyk Snyk समुदाय की सराहना करता है और आभार व्यक्त करता है।

सुरक्षा

किसी भी सुरक्षा मुद्दे या चिंता के लिए, GitHub रिपॉजिटरी में SECURITY.md फ़ाइल देखें।