diff --git a/README.md b/README.md index eb0590f..5824d8a 100644 --- a/README.md +++ b/README.md @@ -10,44 +10,43 @@ - - - + + + + + + + + + + + +
Documentation • - Docker Hub + Docker Hub (User Space) • + Docker Hub (Legacy)

-

A comprehensive suite of containerized security toolkits for various security operations

+

A comprehensive suite of containerized security toolkits for various security operations

Build Status:
- General: General Build - - General ARM Build - -
- Cloud: Cloud Build - - Cloud ARM Build - -
- Rice: Rice Build - - Rice ARM Build - +
+
+ (All ARM images build through CCI until ARM GHA runners are available)

## Overview diff --git a/docs/home/contributing.md b/docs/home/contributing.md index 92adcb1..1c0eb6b 100644 --- a/docs/home/contributing.md +++ b/docs/home/contributing.md @@ -60,19 +60,19 @@ docker buildx build --platform linux/arm64 -t cst-:local . ## Coding Guidelines -1. **Dockerfiles** +- **Dockerfiles** - Use multi-stage builds - Group related installations - Document non-obvious commands - Follow best practices for size optimization -2. **Documentation** +- **Documentation** - Use clear, concise language - Prefer short and bulleted information - Keep formatting consistent - Update relevant sections -3. **Scripts** +- **Scripts** - Include shebang line - Add usage comments - Make scripts portable diff --git a/docs/home/conventions.md b/docs/home/conventions.md index a23b308..a7b10d8 100644 --- a/docs/home/conventions.md +++ b/docs/home/conventions.md @@ -56,22 +56,22 @@ Standard environment details used across variants: ## Best Practices -1. **Data Persistence** +- **Data Persistence** - Store important data in `/persist/` - Use version control for project files - Back up configurations regularly -2. **Resource Management** +- **Resource Management** - Clean up unused containers - Prune Docker images periodically - Monitor disk space usage -3. **Security** +- **Security** - Change SSH password for every run - Use SSH keys when possible - Keep host directory permissions restrictive -4. **Workflow** +- **Workflow** - Use shell functions for container management - Maintain separate instances for different projects - Document custom configurations diff --git a/docs/tools/cloud-tools.md b/docs/tools/cloud-tools.md index f68ac79..7ae59d1 100644 --- a/docs/tools/cloud-tools.md +++ b/docs/tools/cloud-tools.md @@ -80,6 +80,7 @@ The Cloud variant extends the General variant with specialized tools for cloud s ## Python Security Tools Located in Python virtual environment at `/opt/pyenv/`: + - **ScoutSuite**: Multi-cloud security auditing tool - Usage: `/opt/ScoutSuite/scout.py` - Purpose: Cloud security posture assessment @@ -106,6 +107,7 @@ Located in Python virtual environment at `/opt/pyenv/`: ## Development Environment Includes standard development tools: + - Python 3 with specialized libraries - Go language environment - PowerShell Core diff --git a/docs/tools/general-tools.md b/docs/tools/general-tools.md index 1cd7942..bb15673 100644 --- a/docs/tools/general-tools.md +++ b/docs/tools/general-tools.md @@ -5,6 +5,7 @@ The General variant provides a comprehensive set of security and utility tools. ## Core System Tools The base system includes essential utilities installed via apt: + - `curl`, `wget`: Network data transfer - `git`: Version control - `tmux`: Terminal multiplexer @@ -81,6 +82,7 @@ The base system includes essential utilities installed via apt: ## Wordlists and Resources Located in `/opt/lists/`: + - SubDomains: `subdomains_top_110000.txt` - Infrastructure: `common_router_ips.txt`, `common_http_ports.txt` - Web Content: `directory_brute_medium.txt`, `directory_brute_common.txt` @@ -91,6 +93,7 @@ Located in `/opt/lists/`: ## Python Environment A dedicated Python virtual environment is available at `/opt/pyenv/` with: + - Requests: HTTP library - Semgrep: Pattern-based code scanning diff --git a/docs/tools/rice-tools.md b/docs/tools/rice-tools.md index f1fd01c..6207930 100644 --- a/docs/tools/rice-tools.md +++ b/docs/tools/rice-tools.md @@ -81,6 +81,7 @@ Includes all tools from the General variant: ### Shell Improvements The CLI Productivity Suite adds: + - Intelligent command history - Enhanced tab completion - Directory navigation shortcuts @@ -89,6 +90,7 @@ The CLI Productivity Suite adds: ### Editor Enhancements NeoVim configuration includes: + - Code syntax highlighting - File navigation - Split pane management @@ -97,6 +99,7 @@ NeoVim configuration includes: ### Terminal Multiplexer Tmux enhancements include: + - Session management - Window organization - Pane controls @@ -105,6 +108,7 @@ Tmux enhancements include: ## Standard Tools All tools from the General variant remain available: + - Security assessment tools - Network utilities - Development tools @@ -113,6 +117,7 @@ All tools from the General variant remain available: ## Resource Location The standard CST directory structure is maintained: + - `/opt/executables/`: Binary tools - `/opt/pyenv/`: Python environment - `/opt/lists/`: Security wordlists diff --git a/docs/variants/cloud.md b/docs/variants/cloud.md index e27b9e6..bb4d5b5 100644 --- a/docs/variants/cloud.md +++ b/docs/variants/cloud.md @@ -5,6 +5,7 @@ The Cloud variant extends the General variant with specialized tools for cloud s ### Focus Areas Cloud security capabilities include: + - Infrastructure security assessment - Cloud configuration analysis - Identity and access management review @@ -12,6 +13,7 @@ Cloud security capabilities include: - Serverless function analysis This variant excels at: + - Cloud security posture assessments - Cloud penetration testing - Cloud architecture review @@ -21,6 +23,7 @@ This variant excels at: ### Notable Tooling The Cloud variant includes specialized tools for: + - AWS environment assessment - Azure security testing - GCP security analysis diff --git a/docs/variants/dev.md b/docs/variants/dev.md index b78fd68..81129ec 100644 --- a/docs/variants/dev.md +++ b/docs/variants/dev.md @@ -7,6 +7,7 @@ The Dev variant provides a security-focused development environment with compreh ### Development Environment Includes robust support for: + - Python development with Anaconda - Golang development environment - Node.js and npm @@ -14,6 +15,7 @@ Includes robust support for: - Testing frameworks Perfect for: + - Security tool development - Secure application development - Security automation diff --git a/docs/variants/general.md b/docs/variants/general.md index 3e8c82b..7a3be0c 100644 --- a/docs/variants/general.md +++ b/docs/variants/general.md @@ -11,6 +11,7 @@ The General variant serves as both a standalone security operations environment - Base for custom security images This variant is ideal for: + - Security professionals needing a reliable base environment - Teams building custom security toolkits - General security assessment work diff --git a/docs/variants/index.md b/docs/variants/index.md index 3bf2db2..f5b3a65 100644 --- a/docs/variants/index.md +++ b/docs/variants/index.md @@ -5,6 +5,7 @@ The Containerized Security Toolkit provides purpose-built variants for different ## Variant Selection Guide Choose your variant based on primary use case: + - **General**: Basic security operations or base for custom images - **Cloud**: Cloud security assessments and operations - **Dev**: Security tool and application development diff --git a/docs/variants/netsec.md b/docs/variants/netsec.md index 03f2354..3b10326 100644 --- a/docs/variants/netsec.md +++ b/docs/variants/netsec.md @@ -7,6 +7,7 @@ The Network Security variant focuses on network assessment, monitoring, and secu ### Capabilities Specialized for: + - Network vulnerability assessment - Protocol analysis - Traffic monitoring @@ -14,6 +15,7 @@ Specialized for: - Network forensics Ideal applications include: + - Network penetration testing - Security monitoring - Network architecture review diff --git a/docs/variants/rice.md b/docs/variants/rice.md index 8e6b54b..f9af3ca 100644 --- a/docs/variants/rice.md +++ b/docs/variants/rice.md @@ -5,6 +5,7 @@ The Rice variant enhances the General variant with the CLI Productivity Suite, c ### Enhancements The Rice variant adds: + - Customized shell configuration - Enhanced terminal utilities - Productivity shortcuts @@ -12,6 +13,7 @@ The Rice variant adds: - Workflow optimizations Perfect for: + - Daily security operations - Extended terminal sessions - Text-based workflows @@ -21,6 +23,7 @@ Perfect for: ### Rice-Specific Features The integrated CLI Productivity Suite provides: + - Custom shell prompts - Advanced tab completion - Git integrations diff --git a/images/cloud/builder.Dockerfile b/images/cloud/builder.Dockerfile index 16509e2..574e07b 100644 --- a/images/cloud/builder.Dockerfile +++ b/images/cloud/builder.Dockerfile @@ -1,5 +1,7 @@ FROM ubuntu:jammy AS executable_builder -RUN mkdir /testingground && cd /testingground && \ +RUN mkdir /executables && apt update -y && \ + apt install -y wget ninja-build gettext cmake unzip curl git file && \ + mkdir /testingground && cd /testingground && \ a=$(curl -s https://api.github.com/repos/praetorian-inc/noseyparker/releases/latest | grep -E "browser_download_url.*" | grep -i "linux-gnu" | grep -i "aarch64" | cut -d '"' -f4) && \ b=$(curl -s https://api.github.com/repos/praetorian-inc/noseyparker/releases/latest | grep -E "browser_download_url.*" | grep -i "linux-gnu" | grep -i "x86_64" | cut -d '"' -f4) && \ if [ "$(uname -m)" = "aarch64" ]; then wget "$a" -O test.tar.gz; else wget "$b" -O test.tar.gz; fi && \ diff --git a/images/general/builder.Dockerfile b/images/general/builder.Dockerfile index b464d70..3d9c003 100644 --- a/images/general/builder.Dockerfile +++ b/images/general/builder.Dockerfile @@ -1,5 +1,7 @@ FROM ubuntu:jammy AS executable_builder -RUN mkdir /testingground && cd /testingground && \ +RUN mkdir /executables && apt update -y && \ + apt install -y wget ninja-build gettext cmake unzip curl git file && \ + mkdir /testingground && cd /testingground && \ a=$(curl -s https://api.github.com/repos/praetorian-inc/noseyparker/releases/latest | grep -E "browser_download_url.*" | grep -i "linux-gnu" | grep -i "aarch64" | cut -d '"' -f4) && \ b=$(curl -s https://api.github.com/repos/praetorian-inc/noseyparker/releases/latest | grep -E "browser_download_url.*" | grep -i "linux-gnu" | grep -i "x86_64" | cut -d '"' -f4) && \ if [ "$(uname -m)" = "aarch64" ]; then wget "$a" -O test.tar.gz; else wget "$b" -O test.tar.gz; fi && \ diff --git a/mkdocs.yml b/mkdocs.yml index d3396f0..ad40c90 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: Containerized Security Toolkit -site_url: https://tanishq.page/containerized-security-toolkit +site_url: https://tanishq.page/containerized-security-toolkit/home repo_name: tanq16/containerized-security-toolkit repo_url: https://github.com/tanq16/containerized-security-toolkit