Codetective

This application leverages AI to analyze C/C++ code within public or private repositories on platforms like GitHub, GitLab, Gitea, and Bitbucket. It identifies potentially vulnerable functions by referencing functions from previous CVEs. The tool automates the detection process to enhance code security across various repository platforms.

Table of Contents

1. About The Project
   • Preview
   • Built With
2. Getting Started
   • Prerequisites
   • Environment Variables
   • Setup
   • Start
   • Stop

About The Project

Preview

Preview.mp4

Screenshots

Landing Page

Register Page

Login Page

Home Page

Settings Page

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Docker Desktop includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.

(back to top)

Environment Variables

Name	Default Value	Description
HTTP_LISTEN_ADDRESS	:8000	Backend API Port
MONGO_DB_NAME	codetective	Database Name
MONGO_DB_URL	mongodb://database:27017	Database URL
MODEL_ENDPOINT_URL	http://model:8080	AI Model Endpoint
JWT_SECRET	JWT_PLACE	HMAC Signing Key
MAX_ACTIVE_SESSIONS	2	Max. Parallel Scans

(back to top)

Setup

# Clone repository
$ git clone https://github.com/sudonite/Codetective

# Change dir
$ cd Codetective

# Copy example env
$ cp .env.example .env

# Generate random jwt secret key
$ sed -i "s/JWT_PLACE/$(uuidgen | tr -d '-')/g" .env

(back to top)

Start

# Start containers
$ sudo docker compose up -d

# Run database seeding (optional)
$ sudo docker exec codetective-backend make seed <new_admin_passwd>

# Visit http://127.0.0.1

(back to top)

Stop

# Stop containers
$ sudo docker compose down

# Remove images
$ sudo docker rmi -f $(sudo docker images -q -f "reference=codetective-*")

(back to top)