Skip to content

Commit

Permalink
fix builds and errors
Browse files Browse the repository at this point in the history
  • Loading branch information
Tanishq Rupaal authored and Tanishq Rupaal committed Dec 11, 2024
1 parent 4a2b743 commit 8ef73ed
Show file tree
Hide file tree
Showing 15 changed files with 54 additions and 29 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,44 +10,43 @@
<a href="https://github.com/tanq16/containerized-security-toolkit/releases">
<img src="https://img.shields.io/github/v/release/tanq16/containerized-security-toolkit?include_prereleases&style=flat-square">
</a>
<a href="https://hub.docker.com/r/tanq16/cst">
<img src="https://img.shields.io/docker/pulls/tanq16/cst?style=flat-square">
</a>
<a href="https://github.com/tanq16/containerized-security-toolkit/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/tanq16/containerized-security-toolkit?style=flat-square">
</a>
<a href="https://hub.docker.com/r/tanq16/sec_docker">
<img src="https://img.shields.io/docker/pulls/tanq16/sec_docker?style=flat-square">
</a>
<a href="https://hub.docker.com/r/tanq16/cst-rice">
<img src="https://img.shields.io/docker/pulls/tanq16/cst-rice?style=flat-square">
</a>
<a href="https://hub.docker.com/r/tanq16/cst-cloud">
<img src="https://img.shields.io/docker/pulls/tanq16/cst-cloud?style=flat-square">
</a>
<a href="https://hub.docker.com/r/tanq16/cst-general">
<img src="https://img.shields.io/docker/pulls/tanq16/cst-general?style=flat-square">
</a>
<br>
<a href="https://tanishq.page/containerized-security-toolkit">Documentation</a> •
<a href="https://hub.docker.com/r/tanq16/cst">Docker Hub</a>
<a href="https://hub.docker.com/r/tanq16/cst">Docker Hub (User Space)</a> •
<a href="https://hub.docker.com/r/tanq16/sec_docker">Docker Hub (Legacy)</a>
</p>

<h4 align="center">A comprehensive suite of containerized security toolkits for various security operations</h4>
<h3 align="center">A comprehensive suite of containerized security toolkits for various security operations</h3>

<p align="center">
<b>Build Status:</b><br>
General:
<a href="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/general-build.yml">
<img src="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/general-build.yml/badge.svg" alt="General Build">
</a>
<a href="https://dl.circleci.com/status-badge/redirect/circleci/YPqXqLMjjXxLwPP9TvpyFc/general/tree/main">
<img src="https://dl.circleci.com/status-badge/img/circleci/YPqXqLMjjXxLwPP9TvpyFc/general/tree/main.svg?style=shield" alt="General ARM Build">
</a>
<br>
Cloud:
<a href="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/cloud-build.yml">
<img src="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/cloud-build.yml/badge.svg" alt="Cloud Build">
</a>
<a href="https://dl.circleci.com/status-badge/redirect/circleci/YPqXqLMjjXxLwPP9TvpyFc/cloud/tree/main">
<img src="https://dl.circleci.com/status-badge/img/circleci/YPqXqLMjjXxLwPP9TvpyFc/cloud/tree/main.svg?style=shield" alt="Cloud ARM Build">
</a>
<br>
Rice:
<a href="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/rice-build.yml">
<img src="https://github.com/tanq16/containerized-security-toolkit/actions/workflows/rice-build.yml/badge.svg" alt="Rice Build">
</a>
<a href="https://dl.circleci.com/status-badge/redirect/circleci/YPqXqLMjjXxLwPP9TvpyFc/rice/tree/main">
<img src="https://dl.circleci.com/status-badge/img/circleci/YPqXqLMjjXxLwPP9TvpyFc/rice/tree/main.svg?style=shield" alt="Rice ARM Build">
</a>
<br>
<a href="https://dl.circleci.com/status-badge/redirect/circleci/YPqXqLMjjXxLwPP9TvpyFc/W1CQsWfrfu4rKFiytoHbs9/tree/main"><img src="https://dl.circleci.com/status-badge/img/circleci/YPqXqLMjjXxLwPP9TvpyFc/W1CQsWfrfu4rKFiytoHbs9/tree/main.svg?style=svg"></a><br>
(All ARM images build through CCI until ARM GHA runners are available)
</p>

## Overview
Expand Down
6 changes: 3 additions & 3 deletions docs/home/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,19 @@ docker buildx build --platform linux/arm64 -t cst-<variant>: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
Expand Down
8 changes: 4 additions & 4 deletions docs/home/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/tools/cloud-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
3 changes: 3 additions & 0 deletions docs/tools/general-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand All @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/tools/rice-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -89,6 +90,7 @@ The CLI Productivity Suite adds:
### Editor Enhancements

NeoVim configuration includes:

- Code syntax highlighting
- File navigation
- Split pane management
Expand All @@ -97,6 +99,7 @@ NeoVim configuration includes:
### Terminal Multiplexer

Tmux enhancements include:

- Session management
- Window organization
- Pane controls
Expand All @@ -105,6 +108,7 @@ Tmux enhancements include:
## Standard Tools

All tools from the General variant remain available:

- Security assessment tools
- Network utilities
- Development tools
Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/variants/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ 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
- Container security scanning
- Serverless function analysis

This variant excels at:

- Cloud security posture assessments
- Cloud penetration testing
- Cloud architecture review
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/variants/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ 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
- Security-focused IDEs and editors
- Testing frameworks

Perfect for:

- Security tool development
- Secure application development
- Security automation
Expand Down
1 change: 1 addition & 0 deletions docs/variants/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/variants/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/variants/netsec.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ The Network Security variant focuses on network assessment, monitoring, and secu
### Capabilities

Specialized for:

- Network vulnerability assessment
- Protocol analysis
- Traffic monitoring
- Wireless network testing
- Network forensics

Ideal applications include:

- Network penetration testing
- Security monitoring
- Network architecture review
Expand Down
3 changes: 3 additions & 0 deletions docs/variants/rice.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ 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
- Improved text editors
- Workflow optimizations

Perfect for:

- Daily security operations
- Extended terminal sessions
- Text-based workflows
Expand All @@ -21,6 +23,7 @@ Perfect for:
### Rice-Specific Features

The integrated CLI Productivity Suite provides:

- Custom shell prompts
- Advanced tab completion
- Git integrations
Expand Down
4 changes: 3 additions & 1 deletion images/cloud/builder.Dockerfile
Original file line number Diff line number Diff line change
@@ -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 && \
Expand Down
4 changes: 3 additions & 1 deletion images/general/builder.Dockerfile
Original file line number Diff line number Diff line change
@@ -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 && \
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 8ef73ed

Please sign in to comment.