CodeQL के साथ कमजोरियाँ खोजना

मूल कार्यशाला: Sylwia Budzynska

पूर्वापेक्षाएँ • संसाधन • कार्यशाला

• यह किसके लिए है: सुरक्षा इंजीनियर, सुरक्षा शोधकर्ता, डेवलपर।
• आप क्या सीखेंगे: कोड अन्वेषण और सुरक्षा समस्याओं का पता लगाने के लिए CodeQL का उपयोग करना सीखें।
• आप क्या बनाएँगे: कमांड इंजेक्शन खोजने के लिए सुरक्षा सलाह (security advisory) पर आधारित CodeQL क्वेरी बनाएँ।

📣 पूर्वापेक्षाएँ

आप कार्यशाला अभ्यास चलाने के लिए दो विकल्पों में से चुन सकते हैं:

• विकल्प A: स्थानीय इंस्टॉलेशन (VS Code का उपयोग करना - CodeQL आपकी मशीन पर स्थानीय रूप से चलता है)
• विकल्प B: GitHub Codespace (ब्राउज़र या VS Code का उपयोग करना - CodeQL क्लाउड में Linux-आधारित GitHub Codespace पर दूरस्थ रूप से चलता है)

विकल्प A: स्थानीय इंस्टॉलेशन

कार्यशाला अभ्यास पर काम करने के लिए स्थानीय CodeQL इंस्टॉलेशन का उपयोग करें।

पूर्वापेक्षाएँ

• Visual Studio Code (VS Code) और git आपकी स्थानीय मशीन पर इंस्टॉल हो।

निर्देश

1. CodeQL के लिए VS Code एक्सटेंशन इंस्टॉल करें
2. टर्मिनल में चलाएँ:```bash git clone https://github.com/sylwia-budzynska/codeql-workshop cd codeql-workshop git submodule init git submodule update --recursive --depth 1

Download CodeQL databases

curl -L -O "https://github.com/sylwia-budzynska/codeql-workshop/releases/download/v1/test-app-db.zip" curl -L -O "https://github.com/sylwia-budzynska/codeql-workshop/releases/download/v1/kohya_ss-db.zip"

3. VS Code में: File -> **Open Workspace from File...** `vscode-codeql-starter.code-workspace`
4. [CodeQL डेटाबेस चुनने](#select-codeql-database) पर आगे बढ़ें
5. फिर [अपनी इंस्टॉलेशन का परीक्षण करें](#test-your-installation)

### विकल्प B: GitHub Codespace

कार्यशाला अभ्यासों पर काम करने के लिए एक दूरस्थ GitHub Codespace का उपयोग करें।

#### पूर्वापेक्षाएँ

* GitHub खाता ([साइन अप करें](https://github.com/) निःशुल्क)
* ब्राउज़र (आप पूरी कार्यशाला ब्राउज़र में कर सकते हैं - यह सबसे तेज़ तरीका है) या [Visual Studio Code](https://code.visualstudio.com/download) (VS Code) जिसमें आपकी स्थानीय मशीन पर [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) एक्सटेंशन स्थापित हो।

नोट: Codespace उपयोग के पहले 120 घंटे प्रति कोर प्रति माह निःशुल्क हैं, हम इस कार्यशाला के लिए 4 कोर वाले codespace का उपयोग करते हैं क्योंकि मुफ्त खातों के लिए 4 कोर वर्तमान अधिकतम है। (यदि आपके पास Pro खाता है, तो हम 8-कोर मशीन पर स्विच करने की सलाह देते हैं।)

#### निर्देश

1. अपने [GitHub](https://github.com/login) खाते में लॉग इन करें
2. रेपो पर जाएँ https://github.com/sylwia-budzynska/codeql-workshop
3. Code -> Codespaces पर क्लिक करें
4. नया codespace बनाने के लिए प्लस चिह्न (+) पर क्लिक करें।

<img src="https://assets.kitploit.com/production/public/readmes/33098/c86e537f9e7891fb6bdb5da727cae5b6ad0b2c9ac94f67854d48296f2dad89cb.png"  width="439" alt="स्क्रीनशॉट: Codespace बनाएँ, प्लस पर क्लिक करें">

VS Code आपके ब्राउज़र में शुरू होगा और एक दूरस्थ Codespace बनाया जाएगा। इसमें कुछ मिनट लग सकते हैं।
यदि आपसे `vscode-codeql-starter.code-workspace` कार्यस्थान खोलने के लिए कहा जाए तो "Open Workspace" पर क्लिक करें।

5. यदि आप VS Code का स्थानीय रूप से उपयोग करना चाहते हैं, तो ऊपरी बाएँ कोने में तीन पंक्तियों वाले बटन को दबाएँ और "Open VS Code Desktop" चुनें। यह विकल्प दिखने में कुछ मिनट तक का समय ले सकता है।

<img src="https://assets.kitploit.com/production/public/readmes/33098/f2c8c2fe6da80142344b17c208da31a23c3fa68a3917a124f0e2f7871b6a20f7.png" width="300" alt="स्क्रीनशॉट: तीन पंक्तियों वाला बटन दबाएँ और VS Code Desktop में खोलें">

6. [CodeQL डेटाबेस चुनने](#select-codeql-database) पर आगे बढ़ें
7. फिर [अपनी इंस्टॉलेशन का परीक्षण करें](#test-your-installation)

आप अपने codespaces को [github.com/codespaces](https://github.com/codespaces) पर देख सकते हैं। कुछ घंटों तक उपयोग न करने पर codespace अपने आप बंद हो जाएगा, लेकिन यह सुनिश्चित करने के लिए कि आप 120h मुफ्त घंटों में से अतिरिक्त घंटों का उपयोग नहीं कर रहे हैं, कार्यशाला के बाद [github.com/codespaces](https://github.com/codespaces) > तीन बिंदु > "Stop codespace" पर जाना याद रखें।

#### इंस्टॉलेशन की समस्या निवारण

यदि आपको इस तरह की त्रुटियाँ दिखाई दें:
* `Failed to run query: Could not resolve library path for [..]`
* `Could not resolve module [..]`
* `Could not resolve type [..]`

यह बहुत संभव है कि आपने git सबमॉड्यूल्स (अर्थात् ql रेपो) क्लोन करना भूल गए हैं। इसे ठीक करने के लिए `git submodule init && git submodule update --recursive` चलाएँ।

### CodeQL डेटाबेस चुनें

1. सुनिश्चित करें कि VS Code में `vscode-codeql-starter.code-workspace` कार्यस्थान खुला है।
2. CodeQL दृश्य पर जाने के लिए बाएँ टैब फलक में "QL" आइकन पर क्लिक करें।
3. "Choose Database from Archive" पर क्लिक करें और रिपॉजिटरी के रूट में `test-app-db.zip` फ़ाइल चुनें।
   नोट: इस बिंदु पर आपको VSCode में CodeQL CLI स्थापित करने के लिए कहने वाले पॉप-अप संदेश के साथ एक त्रुटि मिल सकती है।  इस इंस्टॉल को स्वीकार करने से समस्या ठीक हो जानी चाहिए।  CLI इंस्टॉल समाप्त होने के बाद, आप उपरोक्त डेटाबेस चयन को पूरा करने में सक्षम होंगे।
   <img src="https://assets.kitploit.com/production/public/readmes/33098/65cc5790b8b49113623bc9a9b34a1be61575b05bea2428c46f83115e2271148b.png"  alt="स्क्रीनशॉट: CodeQL के संबंध में VSCode त्रुटि संदेश">
   <img src="https://assets.kitploit.com/production/public/readmes/33098/c3bf9c304d9c1f6199f591c9bcbf6e446ee4f5388ab209e30887326698129f84.png"  alt="स्क्रीनशॉट: VSCode CodeQL CLI स्थापित कर रहा है">

### अपने इंस्टॉलेशन का परीक्षण करें

#### पूर्वापेक्षाएँ

सुनिश्चित करें कि पहले चुना गया CodeQL डेटाबेस CodeQL दृश्य में चयनित है। (यदि नहीं, तो "Select" पर क्लिक करें)

जब डेटाबेस चयनित होता है, तो यह इस प्रकार दिखना चाहिए (चेकमार्क पर ध्यान दें):

<img src="https://assets.kitploit.com/production/public/readmes/33098/fee6e47c0d9b0754c7ac9e29e2f0b3a721093aa5ce882615b3839a99f4862506.png"  alt="स्क्रीनशॉट: CodeQL डेटाबेस चयनित">

#### निर्देश

1. VS Code में: कार्यस्थान फ़ोल्डर पर जाएँ: `codeql-custom-queries-python`
2. एक नई फ़ाइल बनाएँ `test.ql`
3. निम्नलिखित सामग्री जोड़ें: `select "Hello World!"`
4. फ़ाइल सहेजें, फ़ाइल क्षेत्र में राइट-क्लिक करें और "CodeQL: Run Query on Selected Database" चुनें
5. आपको परिणाम "Hello World!" के साथ एक नया टैब खुला देखना चाहिए

## :books: संसाधन

- [QL ट्यूटोरियल](https://codeql.github.com/docs/writing-codeql-queries/ql-tutorials/)
- [Python के लिए CodeQL भाषा गाइड](https://codeql.github.com/docs/codeql-language-guides/codeql-for-python/)
- [CodeQL दस्तावेज़ीकरण](https://codeql.github.com/docs/)
- [QL भाषा संदर्भ](https://codeql.github.com/docs/ql-language-reference/)
- [Python के लिए CodeQL लाइब्रेरी](https://codeql.github.com/codeql-standard-libraries/python/)
- [Python कोड के लिए मूल क्वेरी](https://codeql.github.com/docs/codeql-language-guides/basic-query-for-python-code/)
- [QL क्लासेस](https://codeql.github.com/docs/ql-language-reference/types/#classes)
- [CodeQL zero to hero भाग 1: भेद्यता अनुसंधान के लिए स्थैतिक विश्लेषण की मूल बातें](https://github.blog/2023-03-31-codeql-zero-to-hero-part-1-the-fundamentals-of-static-analysis-for-vulnerability-research/)
- [CodeQL zero to hero भाग 2: CodeQL के साथ शुरुआत](https://github.blog/2023-06-15-codeql-zero-to-hero-part-2-getting-started-with-codeql/)
- [CodeQL zero to hero भाग 3: सुरक्षा अनुसंधान](https://github.blog/2024-04-29-codeql-zero-to-hero-part-3-security-research-with-codeql/)
- [CodeQL zero to hero भाग 4: Gradio केस स्टडी](https://github.blog/security/vulnerability-research/codeql-zero-to-hero-part-4-gradio-framework-case-study/)
- [CodeQL zero to hero भाग 5: क्वेरी डीबग करना](https://github.blog/security/vulnerability-research/codeql-zero-to-hero-part-5-debugging-queries/)

## कार्यशाला

कार्यशाला "CodeQL के साथ भेद्यता खोजना" में आपका स्वागत है!