者快速上手與社區(qū)貢獻指南)
【免費下載鏈接】cain-agentReal-world AI penetration testing engineer for authorized assessments — built-in cloud module covering AWS/Azure/GCP Aliyun/Tencent/Huawei clouds. Built on Claude Agent SDK項目地址https://gitcode.com/gh_mirrors/ca/cain-agent點擊查看免費下載cain-agent 是一個面向真實授權安全評估的實戰(zhàn)型 AI 滲透測試工程師AI Penetration Testing Engineer基于 Claude Agent SDK 構建內置覆蓋 AWS / Azure / GCP / 阿里云 / 騰訊云 / 華為云 的云滲透模塊。無論你是想親手跑通它的第一次授權測試還是準備為這個開源項目提交第一個 PR這份 cain-agent 開發(fā)者快速上手指南都能幫你在半小時內走完「克隆 → 安裝 → 本地三綠 → 提交 PR」的完整路徑。?? 先劃重點cain-agent 僅用于已獲授權的安全測試。貢獻與使用都必須遵守這一邊界詳見 docs/community.md。一、5 分鐘完成克隆與安裝最快上手步驟1. 克隆倉庫并 editable 安裝cain-agent 要求Python ≥ 3.11見 pyproject.toml??寺『蠼ㄗh用 editable 模式安裝方便你直接改源碼調試git clone https://gitcode.com/gh_mirrors/ca/cain-agent cd cain-agent pip install -e . # 或用 uv: uv pip install -e .按需啟用可選組件pip install -e .[cloud] # 可選AWS S3 / 華為 OBS / Kubernetes 檢測 pip install -e .[dev] # 可選ruff / pyright / pytest 開發(fā)工具鏈 如果你使用 pi 執(zhí)行后端還需要 Node.js ≥ 20 并一次性安裝橋依賴npm ci --prefix toolchain/pi說明見 toolchain/pi/README.md。2. 驗證安裝一行命令確認版本cain-agent --version # 輸出形如cain-agent 0.2.0看到版本號即安裝成功。CLI 入口定義在 src/cain_agent/cli.py。3. 第一次運行先用 dry-run 預覽執(zhí)行計劃不必急著真跑。--dry-run會打印目標 / 工作區(qū) / 階段計劃 / 后端配置但不啟動任何 Agent是理解 cain-agent 三階段流水線recon → test → report的最低成本方式cain-agent run --target https://app.example.com --dry-run正式運行時目標會寫入scope.yaml并在每次工具調用前被 PreToolUse 鉤子強制校驗——范圍控制是工程強制的不依賴模型自覺。完整參數與輸出產物說明見用戶指南 docs/usage.md。二、讀懂項目結構貢獻前先熟悉這張地圖目錄 / 文件作用貢獻新手關注度src/cain_agent/核心源碼CLI、編排器、門禁、報告???skills/技能知識庫OWASP Top 10 各云攻擊面???tests/100 測試文件含技能格式校驗???bench/自建 vulnerable-terraform 靶場與基準評測??toolchain/pi/pi 執(zhí)行后端的 Node 橋?docs/用戶指南、社區(qū)指引、技能編寫規(guī)范???其中幾個高頻接觸的核心模塊src/cain_agent/orchestrator.py — 確定性狀態(tài)機驅動 recon → test → reportsrc/cain_agent/gates.py — 覆蓋率退出門等「驗證紀律」純函數src/cain_agent/cloud/ — 七大云廠商檢測模塊aliyun_oss.py、aws_s3.py、huawei_obs.py等。三、提交前的「本地三綠」cain-agent 開發(fā)環(huán)境標準流程1. 一鍵配置開發(fā)環(huán)境pip install -e .[dev,cloud]這一條命令裝齊 lint、類型檢查、測試與云依賴與 CI 保持一致CI 工作流見 .github/workflows/ci.yml。2. 提交前本地三綠社區(qū)約定docs/community.md要求 PR 提交前在本地跑通ruff check src tests # 1. 代碼風格 pytest -q # 2. 全量測試 python -m bench.run_benchmark --suite vuln-tf \ --output /tmp/bench.md # 3. 涉及檢測邏輯時當前測試基線已 1000 用例全綠演進記錄見 CHANGELOG.md新增邏輯必須有測試修 bug 時先寫復現測試再修。3. 分支命名與提交約定從main拉獨立分支命名規(guī)范feat/主題/fix/主題/test/主題。commit 使用真實姓名 noreply 郵箱。四、你的第一個 PR從 Issue 到合入的完整流程第一步提 Issue選對模板倉庫提供三套 Issue 模板.github/ISSUE_TEMPLATE/模板適用場景必填信息bug_report復現行為異常版本cain-agent --version、復現步驟、期望 vs 實際行為feature_request新能力 / 改進使用場景、為什么現有能力不夠security_issue檢測規(guī)則 / 脫敏 / scope 缺陷?? 不要公開描述可利用細節(jié)走 Security Advisory 私下報告通用要求一個 Issue 一個主題先搜索是否已有同類標題一句話說清問題。第二步開發(fā)并跑通「本地三綠」第三步寫好 PR 描述PR 模板.github/pull_request_template.md固定四個問題逐條回答即可改了什么— 改動清單為什么— 動機與背景怎么驗證的— 附本地三綠輸出安全語義影響— scope / 只讀約束 / 雙會話校驗是否受影響不受影響請注明。第四步等待 review涉及安全語義scope、只讀約束、finder≠validator 雙會話校驗的改動會被重點審查這是該項目質量護城河的一部分請對較長的 review 周期保持耐心。五、新手友好四類高價值貢獻方向1. 新增一個技能SKILL.md? 最推薦技能是 cain-agent 的知識單元放在skills/分類/技能名/SKILL.md。編寫規(guī)范有統一模板且由測試強制校驗——寫完跑一次pytest tests/test_skill_format.py綠了才算達標。要點詳見 docs/skill-authoring-guide.mdfrontmatter 四字段齊全正文必含「觸發(fā)條件 / 三層測試模型L1 探測 → L2 驗證 → L3 繞過/ 證據要求 / 禁止事項」四節(jié)。可參考已落地的 skills/web/sqli/ 等 13 個 OWASP Top 10 技能。2. 修 Bug從 Issue 里挑good first issue類的行為異常先寫復現測試再修復附ruffpytest輸出提 PR。3. 云模塊擴展src/cain_agent/cloud/ 下各廠商模塊結構清晰新增檢測邏輯需同步補測試并保持「零憑證」——測試與 fixture 一律 mock不出現真實 AK/SK/token。4. 文檔完善面向用戶的行為變更需同步更新 README.md 與 README.zh-CN.md。中文文檔的貢獻門檻最低非常適合作為第一個 PR。六、合規(guī)紅線安全測試項目貢獻者必讀 不在 Issue / PR / 討論中粘貼真實憑證、內網拓撲或未脫敏證據 不測試未授權目標——任何貢獻討論都圍繞授權測試場景展開 檢測到檢測繞過、憑證泄露、scope 逃逸類問題不要開公開 Issue走倉庫 Security → Report a vulnerability 私下報告72 小時內響應 單元測試不得依賴外網零觸網新增第三方依賴需在 PR 中說明理由。 想了解項目下一步做什么查看任務看板 ROADMAP.md 與近期交付記錄 CHANGELOG.md從中找未勾選的條目就是你的下一個 Issue。下一步行動清單克隆并pip install -e .[dev,cloud]跑通cain-agent --version--dry-run看一遍執(zhí)行計劃讀懂 docs/usage.md在 docs/community.md 對照貢獻約定從修文檔或補一個SKILL.md開始你的第一個 PR。祝你在 cain-agent 社區(qū)寫出漂亮的第一個 PR 贊分享【免費下載鏈接】cain-agentReal-world AI penetration testing engineer for authorized assessments — built-in cloud module covering AWS/Azure/GCP Aliyun/Tencent/Huawei clouds. Built on Claude Agent SDK項目地址https://gitcode.com/gh_mirrors/ca/cain-agent點擊查看免費下載相關推薦從克隆聲音到貢獻代碼OpenVoice社區(qū)貢獻者成長指南從克隆聲音到貢獻代碼OpenVoice社區(qū)貢獻者成長指南 你是否曾想過參與開源項目卻被復雜的貢獻流程嚇退作為MyShell AI開源的即時語音克隆技術O人工智能語音音頻深度學習1小時上手GitHub社區(qū)貢獻從克隆到PR的新手通關指南1小時上手GitHub社區(qū)貢獻從克隆到PR的新手通關指南 你是否在開源社區(qū)門外徘徊看著別人提交PRPull Request拉取請求卻不知從何下手本文教程PMD 新手貢獻者指南從克隆倉庫到合并第一個 Pull Request 的完整流程PMD 新手貢獻者指南從克隆倉庫到合并第一個 Pull Request 的完整流程 本篇指南以 PMD 官方為 GSoC 學生和新貢獻者編寫的入門文檔為主線靜態(tài)分析代碼質量上一篇MDN學習區(qū)深入理解JavaScript ES2015類繼承機制下一篇Material Components Web 的 Tab Indicator 組件完全指南安裝、動畫原理與定制創(chuàng)作聲明:本文部分內容由AI輔助生成(AIGC),僅供參考