

项目说明
# OffsecDEV — Obsidian Pentesting Vault





![Last commit]()
![Open issues]()
A complete, opinionated Obsidian knowledge system for offensi, networking, and automation. It’s built to guide true beginners into the field while staying useful for seasoned professionals during real assessments.
Central “Map of Content” indexes that tie e togetherProduction-ready templates for tools, workflows, , and reportsAutomation for e collection and campaign organizationCompatible with Obsidian community plugins (Dataview, Templater)> Goal: Turn scattered learning and ad‑hoc notes into a coherent, searchable operational knowledge system you can actually run campaigns with.
---
Quickstart
1) Install Obsidian and enable community plugins (Settings → Community Plugins)
Recommended: Dataview, Templater, (optional) QuickAdd2) Clone this repository and open it as a vault:
git clone C:\OffsecDEIn Obsidian: Open folder as vault → select C:\OffsecDE3) Start at the hub:
Open Master IndexBrowse Index and Workflow Index4) Create notes with templates:
Use Templater to instantiate items from the Templates folder---
What’s Inside
00_Index — Master na and dashboards - Master Index (Map of Content)
- Index (catalog + taxonomy + Dataview dashboards)
- Workflow Index (procedures + go + roll‑ups)
- Reading Log (structured learning tracker)
Templates — Ready‑to‑use structures for: - Tools: Nmap, Metasploit, Wireshark, Snort, Zsh, Dockerfile
- Languages: Python, Ja, Java, C#, C++, Ruby, Perl, Zsh
- Reports: Pentest report, Findings blocks, Lab notes, Flowcharts
- Knowledge: General reading, Links, Networking, Firewall, NIDS
Automation — E and campaign helpers -
Automation/Scripts/se_e.py - Example runner:
Pentest Campaign/Reports/Example Campaign/Scripts/Run_E.ps1Pentest Campaign — Example structure for running assessmentsFlowcharts — Obsidian Canvas maps for workflows and architectureTags — Tag index and taxonomy reference for consistent metadataNotes — Your working knowledge base and research---
Core Ideas and Workflow
Map‑of‑Content First: Use the Master Index as your control tower. Each hub links out to tools, domains, and dashboards.Templates E: Every recurring thing has a template — tools, workflows, , reports — so your notes stay consistent.E is a First‑Class Citizen: Automation scripts collect and normalize raw e into Reports/<Campaign>/E/ with a Markdown index.Metadata + Queries: Dataview turns metadata into dashboards (acti, workflows, reading queues) to keep you oriented.Campaign‑Ready: Move from reconnaissance → exploitation → reporting with a structure that mirrors how real assessments are run.---
Key Templates (Selected)
Pentest_Report_Template.md — Assessment structure, findings tables, methodology, and summary sections ready to fill.Tool_Template.md — Standardized way to document any tool: install, usage, flags, examples.Nmap_Note.md / Metasploit_Note.md — Focused operator checklists with copy‑paste commands and result fields.General_Reading_Note.md — Capture structured insights, tags, and follow‑ups from any source.All templates live in Templates and are compatible with Templater prompts.
---
Templates O (Full)
Programming Languages - Python:
Templates/Python.md,
Templates/Python_Note.md - Ja:
Templates/Ja.md,
Templates/Ja.md - Java:
Templates/Java.md,
Templates/Ja.md - C#:
Templates/C_Sharp.md,
Templates/C_Sharp_Note.md - C++:
Templates/C++.md,
Templates/C++_Note.md - Ruby:
Templates/Ruby.md,
Templates/Ruby_Note.md - Perl:
Templates/Perl.md,
Templates/Perl_Note.md - Zsh:
Templates/Zsh_Note.md - Dockerfile reference:
Templates/Dockerfile.md,
Templates/Dockerfile_Note.mdOperational Tools - Metasploit:
Templates/Metasploit_Note.md - Nmap:
Templates/Nmap_Note.md - Wireshark:
Templates/Wireshark_Note.md - Snort/NIDS:
Templates/Snort_Note.md,
Templates/NIDS_Note.md - Nessus:
Templates/Nessus_Note.md - Obsidian:
Templates/Obsidian_Note.md - Generic Tool:
Templates/Tool_Template.mdReporting & Documentation - Pentest Report:
Templates/Pentest_Report_Template.md - Exploit Write-up:
Templates/Exploit_Template.md - Lab Notes:
Templates/Lab Notes.md - Book/Chapter:
Templates/Book_Template.md,
Templates/Chapter_Template.mdInfrastructure & Networking - Networking:
Templates/Networking_Note.md - Firewall:
Templates/Firewall_Note.mdKnowledge & Learning - General Reading:
Templates/General_Reading_Note.md - New Reading Entry:
Templates/New_Reading_Entry.md - Links collector:
Templates/Links.md - Packages/Dependencies:
Templates/Packages_Note.md - Social Engineering:
Templates/Social_Engineering.md - Language generic:
Templates/Language_Template.mdWorkflow & - Flowchart/Can:
Templates/Flowchart_Template.mdTips
Use Templater to instantiate any of these quickly; most include prompts for metadata/frontmatter.If you want, I can wire QuickAdd capture commands for each template.Automation: SE E Finder
Python utility to copy and normalize social‑engineering or campaign e into the vault with an index and JSON manifest.
Input: any --src folder (images, pcaps, logs, emails, audio, docs)Output: Reports/<campaign>/E/{images,pcap,logs,emails,attachments,audio,other}Index: E.md + e.jsonUsage:
Tip: Keep originals — this script copies by default.
---
Learning Path (Use the Vault As Your Syllabus)
Foundations: Networking basics, Linux/Windows essentials, scripting (see Notes + Templates)Discovery: Nmap fundamentals → service fingerprints → targeted enumerationExploitation: Metasploit workflow → PoCs → post‑exploitation checkpointsAnalysis: Wireshark/Snort workflows → e capture and correlationReporting: Findings → recommendations → export from report templatesAutomation: Add your own scripts and link them into WorkflowsEach step links back into the vault’s indices and templates to reinforce a single, coherent workflow.
---
Plugins and Compatibility
Dataview: Dri and indexes (queries are included in index pages)Templater: Prompts and dynamic frontmatter for templatesCanvas: Flowcharts in /Flowcharts (.can)E works offline with Obsidian. No lock‑in; it’s just Markdown.
---
Contributing / Personalizing
Fork the repo, or clone and iterate locallyAdjust tags to your taxonomy (see Tags/Index.md and Tags/Taxonomy Reference.md)Add tools and workflows by copying templatesKeep sensiti out if publishing publicly (e.g., real client data)If you’re new: start by reading, templating one tool, and writing one mini‑workflow. Iterate daily.
---
Folder Map (High‑Level)
00_Index/ — Global na, dashboards, and goTemplates/ — Reusable formats (tools, reports, languages, workflows)Automation/ — Scripts and helpers for e/campaignsPentest Campaign/ — Project/campaign organization and examplesFlowcharts/ — Obsidian Can mapsTags/ — Tag index and taxonomyNotes/ — Your knowledge base---
License and Use
This is an educational and operational structure intended to accelerate learning and standardize execution. Use responsibly and ethically.
---
Recommended Community Plugins
Dataview: Query notes to build dashboards, tables, and task views. Used across all index pages to surface “active” content from metadata.Templater: Powerful templating and prompts that generate consistent frontmatter and scaffolds. This vault’s templates are Templater-ready.QuickAdd (optional): Create capture commands to instantly spawn Tool, , Workflow, and Reading notes from templates.Tag Wrangler (optional): Rename and merge tags safely, keeping your taxonomy consistent.Canvas / Ad Canvas: architectures and workflows. This repo includes .can under Flowcharts/.Tasks (optional): Rich task management in Markdown; great for campaign checklists.Admonition (optional): Clean callout blocks for warnings, tips, and notes in reports and guides.Obsidian Git (optional): your vault directly from Obsidian if you prefer in‑app commits.Setup tips
Enable Dataview and Templater first; most dashboards and templates depend on them.In Templater settings, enable “Trigger Templater on new file creation” for smooth template workflows.With QuickAdd, create capture macros mapped to the Templates folder to speed up note creation.Additional
Vault structure (Obsidian sidebar):!Vault Structure (Obsidian Sidebar)
Knowledge graph (Obsidian Graph View):!Knowledge Graph (Obsidian Graph View)
项目信息
开发语言:Python
Star 数:2
技术要点
该项目属于防护思路方向的开源资源,代码结构清晰,适合安全研究人员学习参考。项目围绕OffsecDEV (Offensive Security Development Vault) is a structured Obsidian-based knowledge system where the goal is to maintain a unified operational intelligence layer for offensive and defensive security activities — blending documentation, automation, and analytics into one cohesive environment.展开,提供了可运行的实现,对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。
从技术实现角度看,此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论,梳理项目的初始化流程、核心模块职责与数据流转,逐步掌握其中的技术细节与设计思路。
使用与学习建议
1. 下载源码压缩包,解压到本地环境。
2. 根据项目类型准备对应的运行环境与依赖。
3. 按照 README 中的步骤完成配置与部署。
4. 在隔离的测试环境中运行验证,避免影响生产系统。
免责声明
本资源来源于开源社区,仅供安全研究、技术学习与合法授权范围内的攻防演练使用,请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。