Skip to content

Commit b8531e0

Browse files
authored
Enhance README with usage and implementation details
Expanded the README to include detailed usage scenarios, command references, and implementation plans for LucidShell.
1 parent 202e2c3 commit b8531e0

File tree

1 file changed

+89
-2
lines changed

1 file changed

+89
-2
lines changed

readme.md

Lines changed: 89 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,97 @@
11
# LucidShell - White-Hat Security Shell (not optimized)
22

3+
### About;
4+
> This is a **sophisticated white-hat security framework** with exceptional attention to legal compliance and evidence handling. The cryptographic logging, chain-of-custody, and engagement letter system make it suitable for professional security work where legal defensibility matters. This is ment for Windows-based security operations.
5+
6+
Y/N | Use Cases
7+
---|---
8+
✅ | Penetration testing engagements
9+
✅ | Digital forensics investigations
10+
✅ | Security auditing with legal compliance
11+
✅ | Red team operations with documentation
12+
✅ | Incident response with evidence handling
13+
⚠️ | Production use (requires encrypted container. soon)
14+
❌ | Multi-platform operations (MADE FOR WINDOWS)
15+
16+
17+
# Command Reference & Analysis
18+
19+
### **Session Management**
20+
- `init <target> [--engagement-letter <path>]` - Initialize session with authorization
21+
- `status` - Display current session status
22+
- `panic` - Emergency wipe: terminate processes, clear memory, exit
23+
- `repl` - Enter interactive REPL mode
24+
- `exit` / `quit` - Exit REPL mode
25+
- `clear` / `cls` - Clear terminal screen
26+
27+
### **Tool Execution**
28+
- `run <tool> [--network] [--profile <minimal|standard|elevated>] [args...]` - Execute tool in sandbox
29+
- Profiles control filesystem/registry access levels
30+
- `--network` flag enables network (requires verification)
31+
- Built-in tools: `ping`, `ipconfig`, `netstat`, `nslookup`, `tracert`, `whoami`, `systeminfo`
32+
33+
### **Network Control**
34+
- `network tor [-p <port>]` - Connect via Tor SOCKS5 proxy (default port 9050)
35+
- Verifies connection via check.torproject.org
36+
- Enables kill-switch on verification failure
37+
- `network vpn -c <config>` - Configure VPN connection
38+
- `network verify` - Test and verify active connection
39+
- `network status` - Show detailed network status
40+
- `network disable` - Disable all network access
41+
42+
### **Forensics Operations**
43+
- `forensics mount <target> [--vss]` - Mount target for forensic analysis (read-only)
44+
- `--vss` enables Volume Shadow Copy snapshot
45+
- `forensics hash <path> [--sign]` - Compute SHA-256 hashes
46+
- Works on files or entire directories
47+
- `--sign` cryptographically signs the manifest
48+
- `forensics copy <source> <dest>` - Forensic copy with hash verification
49+
- Verifies integrity before and after copy
50+
- Automatic evidence logging
51+
52+
### **Evidence Management**
53+
- `evidence export <output> --format <json|xml>` - Export chain-of-custody
54+
- Includes cryptographic signatures
55+
- Full audit trail with timestamps
56+
- `evidence sign <file> [--rfc3161] [--tsa-url <url>]` - Sign file with legal timestamp
57+
- `--rfc3161` enables RFC 3161 timestamp authority
58+
- `--tsa-url` specifies TSA endpoint (e.g., http://timestamp.digicert.com)
59+
- `evidence report <output>` - Generate comprehensive audit report
60+
- Session details, authorization, full log chain
61+
- Chain-of-custody documentation
62+
- Evidence items and custody log
63+
- `evidence template <output> [--template-type <standard|pentest|forensics>]` - Generate engagement letter template
64+
- **standard**: General security testing
65+
- **pentest**: Penetration testing engagement
66+
- **forensics**: Digital forensics investigation
67+
68+
### **Plugin System**
69+
- `plugin list` - List all installed plugins
70+
- `plugin install <bundle>` - Install plugin from bundle path
71+
- Verifies and signs plugin on installation
72+
- Records capabilities (network, filesystem, registry)
73+
- `plugin remove <id>` - Uninstall plugin by ID
74+
- `plugin verify` - Verify signatures of all installed plugins
75+
- `plugin run <id> [args...]` - Execute plugin in sandbox
76+
- Respects plugin capability restrictions
77+
- Full logging and evidence collection
78+
79+
### **Hidden/Undocumented Features**
80+
- **Session modes** (CLI flag): `--mode <auditor|forensics|developer|minimal>` - Affects default behavior
81+
- **Ephemeral mode** (CLI flag): `--ephemeral` - Memory-only, no disk writes
82+
- **Container support** (CLI flag): `--container <path>` - Encrypted persistent storage with security audit
83+
- **Job object isolation** (Windows): Automatic process containment with kill-on-close
84+
- **WFP firewall integration** (Windows): Per-process network blocking via Windows Filtering Platform
85+
- **Secure memory wiping**: All sensitive data zeroed on drop using volatile writes
86+
- **Hash chain logging**: Every log entry chained with previous hash for tamper detection
87+
- **Automatic evidence collection**: Tool executions auto-generate evidence items
88+
89+
---
90+
391
## Implementation Plan
492

5-
* **WFP Firewall** - Declare it but isn't implemented. The network "security" is just status tracking, not actual OS-level blocking.
693
* **Sandbox Isolation** - Job Objects work, but is not enforcing filesystem/registry restrictions at the Windows API level.
7-
* **RFC 3161** - Currently sends HTTP requests but doesn't actually parse RFC 3161 ASN.1 responses. A real TSA would reject your requests when using this shell. It's a good *stub* though, and i plan on fixing such soon
94+
* **RFC 3161** - Currently sends HTTP requests but doesn't actually parse RFC 3161 ASN.1 responses. A real TSA would reject requests when using this shell. It's a good *stub* though, and i plan on fixing such soon
895
* **Container Encryption** - Verifys the container exists and has correct permissions, but doesn't actually decrypt or use it. *It's just a file check*.
996
* **Plugin Execution** - Install/verify works, but no actual sandboxed execution or API.
1097

0 commit comments

Comments
 (0)