Documentation

Documentation SecuScan

Guides de démarrage, référence API et configuration pour tirer le meilleur de SecuScan.

Guides de démarrage

Suivez ces guides pour configurer rapidement chaque module de SecuScan.

Démarrage rapide

Créez votre compte, ajoutez votre première cible et lancez un scan en 5 minutes.

1Créez votre compte sur secuscan.secuaas.dev
2Ajoutez votre domaine comme cible
3Lancez votre premier scan
4Consultez les résultats et recommandations

Installer un agent

Déployez un agent léger sur vos serveurs pour une surveillance continue.

1Téléchargez le binaire pour votre OS
2Configurez votre API key: --key YOUR_TOKEN
3Lancez: ./secuscan-agent --api https://secuscan.secuaas.dev
4Visualisez l'agent dans votre dashboard

Scanner votre code

Connectez vos repositories Git pour détecter secrets et vulnérabilités.

1Ajoutez votre clé SSH dans Paramètres > Clés SSH
2Ajoutez votre repository Git (GitHub, GitLab, Bitbucket)
3Lancez un scan de code
4Consultez les issues détectées avec recommandations IA

Référence API REST

Tous les endpoints disponibles. Authentification via JWT Bearer token. Base URL : https://secuscan.secuaas.dev/v1

Authentification

Méthode	Endpoint	Description
POST	`/v1/auth/register`	Créer un compte
POST	`/v1/auth/login`	Obtenir un JWT token
POST	`/v1/auth/refresh`	Rafraîchir le token

Cibles

Méthode	Endpoint	Description
GET	`/v1/targets`	Lister les cibles
POST	`/v1/targets`	Ajouter une cible
DELETE	`/v1/targets/{id}`	Supprimer une cible

Agents

Méthode	Endpoint	Description
POST	`/v1/agents/register`	Enregistrer un agent
GET	`/v1/agents`	Lister les agents
POST	`/v1/agents/{id}/inventory`	Upload inventaire
POST	`/v1/agents/{id}/analysis`	Upload analyse
GET	`/v1/agents/{id}/analysis/latest`	Dernière analyse

Code Scanning

Méthode	Endpoint	Description
GET	`/v1/code-repositories`	Lister les repositories
POST	`/v1/code-repositories`	Ajouter un repository
GET	`/v1/code-scans`	Lister les scans de code
POST	`/v1/code-scans`	Lancer un scan
GET	`/v1/code-issues`	Lister les issues

Clés SSH

Méthode	Endpoint	Description
GET	`/v1/ssh-keys`	Lister les clés SSH
POST	`/v1/ssh-keys`	Ajouter une clé SSH
DELETE	`/v1/ssh-keys/{id}`	Supprimer une clé

Agent CLI

L'agent SecuScan est un binaire léger (5-7MB) disponible pour Linux, macOS et Windows.

Installation

# Linux amd64
curl -L -o secuscan-agent https://secuscan.secuaas.dev/downloads/agent/linux-amd64
chmod +x secuscan-agent

# macOS Apple Silicon
curl -L -o secuscan-agent https://secuscan.secuaas.dev/downloads/agent/darwin-arm64
chmod +x secuscan-agent

Utilisation

# Scan unique (one-shot)
./secuscan-agent --api https://secuscan.secuaas.dev --key YOUR_JWT_TOKEN

# Mode daemon (surveillance continue, scan toutes les 6h)
./secuscan-agent --api https://secuscan.secuaas.dev --key YOUR_JWT_TOKEN --daemon --interval 6h

# Avec debug logs
./secuscan-agent --api https://secuscan.secuaas.dev --key YOUR_JWT_TOKEN --log-level debug

Plateformes supportées

Linux - amd64, arm64 (5.3-5.5 MB)

macOS - Intel, Apple Silicon (5.4-5.6 MB)

Windows - amd64 (5.7 MB)

Prêt à commencer?

Créez votre compte gratuitement et lancez votre premier scan en quelques minutes.

Essai gratuit 14 jours Consulter la FAQ