Skip to content

Commit 11c0cd2

Browse files
committed
feat(docs): add GitHub Pages with Jekyll Minimal theme
- Add Jekyll configuration with Minimal theme - Create comprehensive documentation pages - Add GitHub Pages workflow for automated deployment - Organize documentation into structured sections: - Getting Started - Core Features - Intelligence & Reconnaissance - Reverse Engineering - Security Patterns - Integration - API Reference - Contributing - Add responsive navigation and search - Optimize for mobile and desktop viewing
1 parent 21952bd commit 11c0cd2

47 files changed

Lines changed: 14781 additions & 78 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/pages.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ tinybrain-githubpages ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Setup Ruby
27+
uses: ruby/setup-ruby@v1
28+
with:
29+
ruby-version: '3.1'
30+
bundler-cache: true
31+
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v4
34+
35+
- name: Build with Jekyll
36+
uses: actions/jekyll-build-pages@v1
37+
with:
38+
source: ./
39+
destination: ./_site
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
runs-on: ubuntu-latest
49+
needs: build
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

ENHANCED_MEMORY_CATEGORIES.md

Lines changed: 312 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,312 @@
1+
# Enhanced Memory Categories for TinyBrain
2+
3+
This document outlines the expanded memory categories and content types for TinyBrain's intelligence and reconnaissance capabilities.
4+
5+
## Overview
6+
7+
TinyBrain's memory system has been enhanced to support comprehensive intelligence gathering, reconnaissance, and reverse engineering activities. The expanded categories provide structured storage for various types of security intelligence and analysis data.
8+
9+
## Core Memory Categories
10+
11+
### 1. Intelligence Categories
12+
- **intelligence**: General intelligence findings and analysis
13+
- **osint**: Open Source Intelligence findings
14+
- **humint**: Human Intelligence findings
15+
- **sigint**: Signals Intelligence findings
16+
- **geoint**: Geospatial Intelligence findings
17+
- **masint**: Measurement and Signature Intelligence findings
18+
- **techint**: Technical Intelligence findings
19+
- **finint**: Financial Intelligence findings
20+
- **cybint**: Cyber Intelligence findings
21+
22+
### 2. Reconnaissance Categories
23+
- **reconnaissance**: General reconnaissance activities
24+
- **target_analysis**: Target-specific analysis and profiling
25+
- **infrastructure_mapping**: Network and infrastructure mapping
26+
- **vulnerability_assessment**: Vulnerability discovery and assessment
27+
- **threat_hunting**: Proactive threat hunting activities
28+
- **incident_response**: Incident response and forensics
29+
30+
### 3. Analysis Categories
31+
- **malware_analysis**: Malware analysis and reverse engineering
32+
- **binary_analysis**: Binary file analysis and disassembly
33+
- **vulnerability_research**: Vulnerability research and exploit development
34+
- **protocol_analysis**: Network protocol analysis and reverse engineering
35+
- **code_analysis**: Source code analysis and review
36+
- **behavioral_analysis**: Behavioral analysis and pattern recognition
37+
38+
### 4. Intelligence Objects
39+
- **threat_actor**: Threat actor profiles and attribution
40+
- **attack_campaign**: Attack campaign analysis and tracking
41+
- **ioc**: Indicators of Compromise
42+
- **ttp**: Tactics, Techniques, and Procedures
43+
- **pattern**: Security patterns and behaviors
44+
- **correlation**: Correlations between findings and events
45+
46+
### 5. Technical Categories
47+
- **exploit**: Exploit code and proof-of-concepts
48+
- **payload**: Malicious payloads and shellcode
49+
- **technique**: Attack techniques and methods
50+
- **tool**: Security tools and utilities
51+
- **reference**: Reference materials and documentation
52+
- **context**: Contextual information and background
53+
54+
### 6. Research Categories
55+
- **hypothesis**: Research hypotheses and theories
56+
- **evidence**: Evidence and supporting data
57+
- **recommendation**: Recommendations and mitigation strategies
58+
- **note**: General notes and observations
59+
- **finding**: Security findings and discoveries
60+
- **vulnerability**: Vulnerability information and details
61+
62+
## Content Types
63+
64+
### 1. Intelligence Content Types
65+
- **intelligence_report**: Structured intelligence reports
66+
- **threat_briefing**: Threat intelligence briefings
67+
- **situation_report**: Situational awareness reports
68+
- **intelligence_summary**: Intelligence summaries and assessments
69+
- **threat_landscape**: Threat landscape analysis
70+
- **intelligence_feed**: Real-time intelligence feeds
71+
72+
### 2. Analysis Content Types
73+
- **malware_sample**: Malware samples and analysis
74+
- **binary_file**: Binary files and executables
75+
- **source_code**: Source code and scripts
76+
- **network_capture**: Network traffic captures
77+
- **memory_dump**: Memory dumps and forensics
78+
- **log_file**: Log files and system logs
79+
80+
### 3. Structured Content Types
81+
- **json**: JSON data and structured information
82+
- **yaml**: YAML configuration and data
83+
- **xml**: XML data and structured documents
84+
- **csv**: CSV data and tabular information
85+
- **stix**: STIX threat intelligence data
86+
- **maec**: MAEC malware analysis data
87+
88+
### 4. Document Content Types
89+
- **markdown**: Markdown documents and reports
90+
- **pdf**: PDF documents and reports
91+
- **docx**: Word documents and reports
92+
- **txt**: Plain text documents
93+
- **html**: HTML documents and web content
94+
- **rtf**: Rich text format documents
95+
96+
### 5. Media Content Types
97+
- **image**: Images and screenshots
98+
- **video**: Video recordings and captures
99+
- **audio**: Audio recordings and captures
100+
- **archive**: Compressed archives and files
101+
- **binary_ref**: References to binary files
102+
- **url**: URLs and web references
103+
104+
## Intelligence Types
105+
106+
### 1. OSINT (Open Source Intelligence)
107+
- **social_media**: Social media intelligence
108+
- **news_media**: News and media intelligence
109+
- **public_records**: Public records and databases
110+
- **academic_research**: Academic and research publications
111+
- **government_reports**: Government and official reports
112+
- **commercial_intelligence**: Commercial intelligence sources
113+
114+
### 2. HUMINT (Human Intelligence)
115+
- **source_report**: Human source reports
116+
- **interrogation**: Interrogation and debriefing
117+
- **surveillance**: Surveillance and observation
118+
- **infiltration**: Infiltration and undercover operations
119+
- **recruitment**: Source recruitment and development
120+
- **debriefing**: Source debriefing and assessment
121+
122+
### 3. SIGINT (Signals Intelligence)
123+
- **communications**: Communications intelligence
124+
- **electronic_signals**: Electronic signals intelligence
125+
- **radar_signals**: Radar and electronic warfare
126+
- **cyber_signals**: Cyber signals and network intelligence
127+
- **satellite_signals**: Satellite communications intelligence
128+
- **radio_signals**: Radio frequency intelligence
129+
130+
### 4. GEOINT (Geospatial Intelligence)
131+
- **satellite_imagery**: Satellite imagery and analysis
132+
- **aerial_photography**: Aerial photography and reconnaissance
133+
- **geographic_data**: Geographic and mapping data
134+
- **location_intelligence**: Location-based intelligence
135+
- **terrain_analysis**: Terrain and geographic analysis
136+
- **geospatial_mapping**: Geospatial mapping and visualization
137+
138+
### 5. MASINT (Measurement and Signature Intelligence)
139+
- **acoustic_signatures**: Acoustic and sound signatures
140+
- **magnetic_signatures**: Magnetic field signatures
141+
- **nuclear_signatures**: Nuclear and radiation signatures
142+
- **chemical_signatures**: Chemical and biological signatures
143+
- **electromagnetic_signatures**: Electromagnetic signatures
144+
- **infrared_signatures**: Infrared and thermal signatures
145+
146+
### 6. TECHINT (Technical Intelligence)
147+
- **weapons_systems**: Weapons and military systems
148+
- **technology_assessment**: Technology and capability assessment
149+
- **equipment_analysis**: Equipment and hardware analysis
150+
- **software_analysis**: Software and system analysis
151+
- **communications_equipment**: Communications and electronic equipment
152+
- **sensors_and_detection**: Sensors and detection systems
153+
154+
### 7. FININT (Financial Intelligence)
155+
- **financial_transactions**: Financial transaction analysis
156+
- **money_laundering**: Money laundering and financial crimes
157+
- **cryptocurrency**: Cryptocurrency and digital assets
158+
- **banking_intelligence**: Banking and financial institution intelligence
159+
- **economic_intelligence**: Economic and financial intelligence
160+
- **sanctions_intelligence**: Sanctions and compliance intelligence
161+
162+
### 8. CYBINT (Cyber Intelligence)
163+
- **cyber_threats**: Cyber threat intelligence
164+
- **malware_analysis**: Malware and malicious code analysis
165+
- **network_intelligence**: Network and infrastructure intelligence
166+
- **vulnerability_intelligence**: Vulnerability and exploit intelligence
167+
- **incident_intelligence**: Cyber incident intelligence
168+
- **attribution_intelligence**: Cyber attribution and threat actor intelligence
169+
170+
## Classification Levels
171+
172+
### 1. Unclassified
173+
- **public**: Publicly available information
174+
- **open_source**: Open source intelligence
175+
- **commercial**: Commercial and business intelligence
176+
- **academic**: Academic and research information
177+
- **media**: News and media information
178+
179+
### 2. Confidential
180+
- **internal**: Internal organizational information
181+
- **restricted**: Restricted access information
182+
- **sensitive**: Sensitive but unclassified information
183+
- **proprietary**: Proprietary and confidential information
184+
- **business_confidential**: Business confidential information
185+
186+
### 3. Secret
187+
- **classified**: Classified government information
188+
- **national_security**: National security information
189+
- **defense_information**: Defense and military information
190+
- **intelligence_information**: Intelligence community information
191+
- **law_enforcement**: Law enforcement sensitive information
192+
193+
### 4. Top Secret
194+
- **compartmented**: Compartmented information
195+
- **sci**: Sensitive Compartmented Information
196+
- **sap**: Special Access Programs
197+
- **codeword**: Codeword classified information
198+
- **eyes_only**: For your eyes only information
199+
200+
## Threat Levels
201+
202+
### 1. Low
203+
- **informational**: Informational only
204+
- **minimal_risk**: Minimal risk to operations
205+
- **routine**: Routine security considerations
206+
- **baseline**: Baseline security posture
207+
- **standard**: Standard security measures
208+
209+
### 2. Medium
210+
- **elevated**: Elevated security concerns
211+
- **moderate_risk**: Moderate risk to operations
212+
- **increased_vigilance**: Increased vigilance required
213+
- **enhanced_measures**: Enhanced security measures
214+
- **monitoring**: Active monitoring required
215+
216+
### 3. High
217+
- **significant**: Significant security concerns
218+
- **high_risk**: High risk to operations
219+
- **immediate_attention**: Immediate attention required
220+
- **protective_measures**: Protective measures necessary
221+
- **threat_mitigation**: Threat mitigation required
222+
223+
### 4. Critical
224+
- **severe**: Severe security concerns
225+
- **critical_risk**: Critical risk to operations
226+
- **emergency_response**: Emergency response required
227+
- **maximum_protection**: Maximum protection necessary
228+
- **threat_elimination**: Threat elimination required
229+
230+
## Geographic Scope
231+
232+
### 1. Local
233+
- **city**: City-level operations
234+
- **county**: County-level operations
235+
- **regional**: Regional operations
236+
- **metropolitan**: Metropolitan area operations
237+
- **district**: District-level operations
238+
239+
### 2. Regional
240+
- **state**: State-level operations
241+
- **province**: Province-level operations
242+
- **territory**: Territory-level operations
243+
- **multi_state**: Multi-state operations
244+
- **cross_border**: Cross-border operations
245+
246+
### 3. National
247+
- **country**: Country-level operations
248+
- **federal**: Federal-level operations
249+
- **national**: National-level operations
250+
- **domestic**: Domestic operations
251+
- **homeland**: Homeland security operations
252+
253+
### 4. International
254+
- **global**: Global operations
255+
- **multinational**: Multinational operations
256+
- **transnational**: Transnational operations
257+
- **worldwide**: Worldwide operations
258+
- **international**: International operations
259+
260+
## Usage Guidelines
261+
262+
### 1. Category Selection
263+
- Choose the most specific category that applies
264+
- Use multiple categories when appropriate
265+
- Consider the primary purpose of the information
266+
- Align with organizational classification schemes
267+
268+
### 2. Content Type Selection
269+
- Match content type to the actual data format
270+
- Use structured types for machine-readable data
271+
- Use document types for human-readable content
272+
- Use media types for non-text content
273+
274+
### 3. Intelligence Type Selection
275+
- Select based on the source of information
276+
- Use multiple types when information comes from multiple sources
277+
- Consider the collection method and source reliability
278+
- Align with intelligence community standards
279+
280+
### 4. Classification and Threat Level
281+
- Follow organizational classification guidelines
282+
- Use appropriate classification levels
283+
- Set threat levels based on risk assessment
284+
- Consider the sensitivity and impact of information
285+
286+
### 5. Geographic Scope
287+
- Define the geographic scope of operations
288+
- Consider the reach and impact of threats
289+
- Use appropriate scope for the intelligence type
290+
- Align with operational requirements
291+
292+
## Integration with Existing Categories
293+
294+
### 1. Backward Compatibility
295+
- Maintain existing category definitions
296+
- Extend rather than replace existing categories
297+
- Provide migration paths for existing data
298+
- Ensure compatibility with existing tools
299+
300+
### 2. Enhanced Functionality
301+
- Add intelligence-specific features
302+
- Integrate with threat intelligence feeds
303+
- Support advanced search and filtering
304+
- Enable correlation and analysis
305+
306+
### 3. Future Extensibility
307+
- Design for future category additions
308+
- Support custom category definitions
309+
- Enable category hierarchies
310+
- Allow for category evolution
311+
312+
This enhanced memory category system provides TinyBrain with comprehensive capabilities for intelligence gathering, reconnaissance, and security analysis, enabling structured storage and analysis of various types of security intelligence data.

0 commit comments

Comments
 (0)