docksec 0.0.1__py3-none-any.whl

docksec-0.0.1.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: docksec
+Version: 0.0.1
+Summary: AI-Powered Docker Security Analyzer
+Home-page: https://github.com/advaitpatel/DockSec
+Author: Advait Patel
+Project-URL: Bug Tracker, https://github.com/advaitpatel/DockSec/issues
+Project-URL: Documentation, https://github.com/advaitpatel/DockSec/blob/main/README.md
+Project-URL: Source Code, https://github.com/advaitpatel/DockSec
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain
+Requires-Dist: langchain-openai
+Requires-Dist: python-dotenv
+Requires-Dist: pandas
+Requires-Dist: tqdm
+Requires-Dist: colorama
+Requires-Dist: rich
+Requires-Dist: fpdf
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DockSec - AI-Powered Docker Security Analyzer
+
+## Overview
+DockSec is an open-source AI-powered tool designed to analyze Dockerfiles for security vulnerabilities, misconfigurations, and inefficiencies. It provides automated recommendations to enhance container security, reduce the attack surface, and improve compliance with industry best practices.
+
+## Features
+- AI/ML-Powered Analysis: Uses AI models to detect vulnerabilities and suggest security improvements.
+- Security Vulnerability Detection: Scans Dockerfiles for known security issues, CVEs, and misconfigurations.
+- Best Practice Recommendations: Provides actionable insights to enhance security, minimize image size, and improve efficiency.
+- Integration with Development Tools:
+  - VS Code extension for inline security suggestions.
+  - CI/CD pipeline support (GitHub Actions, GitLab CI, Jenkins).
+- Compliance Checks: Aligns with CIS Benchmarks, Docker Security Best Practices, and OWASP guidelines.
+
+
+## Installation
+
+Create a virtual environment
+```bash
+python -m venv env
+```
+Activate the environment
+```bash
+env\Scripts\activate # for mac use "source env\bin\activate"
+```
+
+Install the tool using pip:
+
+```bash
+pip install -e .
+```
+
+This will install the `docksec` using setup.py from local files.
+
+To install Docksec using pypi you can simply run 
+
+```bash
+pip install docksec # it will load the docksec tool from pypi
+```
+
+To completely use the AI scanning of docksec you have to setup the OPENAI-API-KEY 
+
+🔹 PowerShell (Windows):
+    `$env:OPENAI_API_KEY = "your-secret-key"`
+
+🔹 Command Prompt (CMD on Windows):
+    `set OPENAI_API_KEY=your-secret-key`
+
+🔹 Bash/Zsh (Linux/macOS):
+    `export OPENAI_API_KEY="your-secret-key"`
+
+🔹 Or create a `.env` file with:
+    `OPENAI_API_KEY=your-secret-key`
+
+## Requirements
+
+The following dependencies will be automatically installed:
+- langchain
+- langchain-openai
+- python-dotenv
+- pandas
+- tqdm
+- colorama
+- rich
+- fpdf
+- setuptools
+
+## Usage
+
+### CLI Tool
+
+After installation, you can use DockSec with a simple command:
+
+```bash
+docksec path\to\Dockerfile
+```
+
+#### Options:
+- `-i, --image`: Specify Docker image ID for scanning (optional)
+- `-o, --output`: Specify output file for the report (default: security_report.txt)
+- `--ai-only`: Run only AI-based recommendations
+- `--scan-only`: Run only Dockerfile/image scanning
+
+### Examples:
+
+```bash
+# Basic analysis
+docksec path\to\Dockerfile
+
+# Analyze both Dockerfile and a specific image
+docksec path\to\Dockerfile -i myimage:latest
+
+# Only run AI recommendations
+docksec path\to\Dockerfile --ai-only
+
+# Only scan for vulnerabilities with custom output file
+docksec path\to\Dockerfile --scan-only -o custom_report.txt
+```
+
+### Legacy Usage
+
+You can still use the original commands:
+
+```bash
+# For AI-based recommendations
+python .\main.py "path\to\your\dockerfile"
+
+# For scanning both Dockerfile and images
+python docker_scanner.py <dockerfile_path> <image_name> [severity]
+# Example: python docker_scanner.py .\Dockerfile myapp:latest CRITICAL,HIGH
+```
+
+#### External Tools Setup
+
+To check the Dockerfile as well as images for vulnerabilities, you need to setup Trivy and hadolint:
+
+```bash
+python .\setup_external_tools.py
+```
+
+For manual installation, refer to [Trivy](https://trivy.dev/v0.18.3/installation/) and [hadolint](https://github.com/hadolint/hadolint?tab=readme-ov-file#install) documentation.
+
+## CI/CD Integration
+TBD
+
+## Roadmap
+TBD
+
+## Contributing
+We welcome contributions! To get started:
+1. Fork the repository.
+2. Create a new branch for your feature or fix.
+3. Commit your changes and submit a pull request.
+
+## License
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Get Involved
+- ⭐ Star this repository to show support!
+- 📢 Share your feedback via GitHub Issues.
+- 📝 Write about DockSec and contribute to our documentation.
+
+## Contact
+For questions or collaborations, reach out via:
+- GitHub Discussions: DockSec Community
+- Twitter: @yourhandle
+- LinkedIn: Your Profile

docksec-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+docksec.py,sha256=rQSf_BcXVwUS76MazUk4BMJK2uLv0Sv4IMD0vK9GvCk,1765
+docksec-0.0.1.dist-info/licenses/LICENSE,sha256=11h_Oz6X6j1DxdOWme157skoj5e1P9yb71Xqc6lt5Gs,1068
+docksec-0.0.1.dist-info/METADATA,sha256=B6BIzupkuIzRBRQVEvNT7UqdJgJBhbJih6B-BJ5ORZs,5088
+docksec-0.0.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+docksec-0.0.1.dist-info/entry_points.txt,sha256=t8ASf9QV8iqE7-2Nn79QJk4YfA6zFlrlkHptCB2Znkc,41
+docksec-0.0.1.dist-info/top_level.txt,sha256=aFyNrvoEHDR8xgYZ9-shzNHheGji-V7HTqF8Nlo9gLM,8
+docksec-0.0.1.dist-info/RECORD,,

docksec-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

docksec-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docksec = docksec:main

docksec-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Advait Patel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docksec-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+docksec

docksec.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+import sys
+import os
+import argparse
+import subprocess
+
+def main():
+    parser = argparse.ArgumentParser(description='Docker Security Analysis Tool')
+    parser.add_argument('dockerfile', help='Path to the Dockerfile to analyze')
+    parser.add_argument('-i', '--image', help='Docker image ID to scan (optional)')
+    parser.add_argument('-o', '--output', help='Output file for the report (default: security_report.txt)')
+    parser.add_argument('--ai-only', action='store_true', help='Run only AI-based recommendations')
+    parser.add_argument('--scan-only', action='store_true', help='Run only Dockerfile/image scanning')
+    
+    args = parser.parse_args()
+    
+    # Validate that the Dockerfile exists
+    if not os.path.isfile(args.dockerfile):
+        print(f"Error: Dockerfile not found at {args.dockerfile}")
+        sys.exit(1)
+    
+    # Determine which tools to run
+    run_ai = not args.scan_only
+    run_scan = not args.ai_only
+    
+    if not run_ai and not run_scan:
+        run_ai = run_scan = True  # Run both by default
+    
+    # Run the AI-based recommendation tool
+    if run_ai:
+        print("Running AI-based Dockerfile analysis...")
+        # Using list form to avoid shell parsing issues on Windows
+        subprocess.run([sys.executable, "main.py", args.dockerfile])
+    
+    # Run the scanner tool
+    if run_scan:
+        print("Running Dockerfile and image scanner...")
+        output_file = args.output or "security_report.txt"
+        image_id = args.image or ""
+        
+        cmd = [sys.executable, "docker_scanner.py", args.dockerfile]
+        if image_id:
+            cmd.append(image_id)
+        
+        subprocess.run(cmd)
+    
+    print("Analysis complete!")
+
+if __name__ == "__main__":
+    main()