Aller au contenu

Checkmarx

Aide-mémoire complet des commandes et workflows Checkmarx pour l’administration système sur toutes les plateformes.

Commandes de base

CommandeDescription
checkmarx --versionAfficher la version de Checkmarx
checkmarx --helpAfficher les informations d’aide
checkmarx initInitialiser Checkmarx dans le répertoire actuel
checkmarx statusVérifier le statut actuel
checkmarx listLister les options disponibles
checkmarx infoAfficher les informations système
checkmarx configAfficher les paramètres de configuration
checkmarx updateMettre à jour vers la dernière version
checkmarx startDémarrer le service Checkmarx
checkmarx stopArrêter le service Checkmarx
checkmarx restartRedémarrer le service Checkmarx
checkmarx reloadRecharger la configuration

Installation

Linux/Ubuntu

# Package manager installation
sudo apt update
sudo apt install checkmarx

# Alternative installation
wget https://github.com/example/checkmarx/releases/latest/download/checkmarx-linux
chmod +x checkmarx-linux
sudo mv checkmarx-linux /usr/local/bin/checkmarx

# Build from source
git clone https://github.com/example/checkmarx.git
cd checkmarx
make && sudo make install

macOS

# Homebrew installation
brew install checkmarx

# MacPorts installation
sudo port install checkmarx

# Manual installation
curl -L -o checkmarx https://github.com/example/checkmarx/releases/latest/download/checkmarx-macos
chmod +x checkmarx
sudo mv checkmarx /usr/local/bin/

Windows

# Chocolatey installation
choco install checkmarx

# Scoop installation
scoop install checkmarx

# Winget installation
winget install checkmarx

# Manual installation
# Download from https://github.com/example/checkmarx/releases
# Extract and add to PATH

Configuration

CommandeDescription
checkmarx config showAfficher la configuration actuelle
checkmarx config listLister toutes les options de configuration
checkmarx config set <key> <value>Définir la valeur de configuration
checkmarx config get <key>Obtenir la valeur de configuration
checkmarx config unset <key>Supprimer la valeur de configuration
checkmarx config resetRéinitialiser à la configuration par défaut
checkmarx config validateValider le fichier de configuration
checkmarx config exportExporter la configuration vers un fichier

Opérations avancées

Opérations sur les fichiers

# Create new file/resource
checkmarx create <name>

# Read file/resource
checkmarx read <name>

# Update existing file/resource
checkmarx update <name>

# Delete file/resource
checkmarx delete <name>

# Copy file/resource
checkmarx copy <source> <destination>

# Move file/resource
checkmarx move <source> <destination>

# List all files/resources
checkmarx list --all

# Search for files/resources
checkmarx search <pattern>

Opérations réseau

# Connect to remote host
checkmarx connect <host>:<port>

# Listen on specific port
checkmarx listen --port <port>

# Send data to target
checkmarx send --target <host> --data "<data>"

# Receive data from source
checkmarx receive --source <host>

# Test connectivity
checkmarx ping <host>

# Scan network range
checkmarx scan <network>

# Monitor network traffic
checkmarx monitor --interface <interface>

# Proxy connections
checkmarx proxy --listen <port> --target <host>:<port>

Gestion des processus

# Start background process
checkmarx start --daemon

# Stop running process
checkmarx stop --force

# Restart with new configuration
checkmarx restart --config <file>

# Check process status
checkmarx status --verbose

# Monitor process performance
checkmarx monitor --metrics

# Kill all processes
checkmarx killall

# Show running processes
checkmarx ps

# Manage process priority
checkmarx priority --pid <pid> --level <level>

Fonctionnalités de sécurité

Authentification

# Login with username/password
checkmarx login --user <username>

# Login with API key
checkmarx login --api-key <key>

# Login with certificate
checkmarx login --cert <cert_file>

# Logout current session
checkmarx logout

# Change password
checkmarx passwd

# Generate new API key
checkmarx generate-key --name <key_name>

# List active sessions
checkmarx sessions

# Revoke session
checkmarx revoke --session <session_id>

Chiffrement

# Encrypt file
checkmarx encrypt --input <file> --output <encrypted_file>

# Decrypt file
checkmarx decrypt --input <encrypted_file> --output <file>

# Generate encryption key
checkmarx keygen --type <type> --size <size>

# Sign file
checkmarx sign --input <file> --key <private_key>

# Verify signature
checkmarx verify --input <file> --signature <sig_file>

# Hash file
checkmarx hash --algorithm <algo> --input <file>

# Generate certificate
checkmarx cert generate --name <name> --days <days>

# Verify certificate
checkmarx cert verify --cert <cert_file>

Surveillance et journalisation

Surveillance système

# Monitor system resources
checkmarx monitor --system

# Monitor specific process
checkmarx monitor --pid <pid>

# Monitor network activity
checkmarx monitor --network

# Monitor file changes
checkmarx monitor --files <directory>

# Real-time monitoring
checkmarx monitor --real-time --interval 1

# Generate monitoring report
checkmarx report --type monitoring --output <file>

# Set monitoring alerts
checkmarx alert --threshold <value> --action <action>

# View monitoring history
checkmarx history --type monitoring

Journalisation

# View logs
checkmarx logs

# View logs with filter
checkmarx logs --filter <pattern>

# Follow logs in real-time
checkmarx logs --follow

# Set log level
checkmarx logs --level <level>

# Rotate logs
checkmarx logs --rotate

# Export logs
checkmarx logs --export <file>

# Clear logs
checkmarx logs --clear

# Archive logs
checkmarx logs --archive <archive_file>

Dépannage

Problèmes courants

Problème : Commande non trouvée

# Check if checkmarx is installed
which checkmarx
checkmarx --version

# Check PATH variable
echo $PATH

# Reinstall if necessary
sudo apt reinstall checkmarx
# or
brew reinstall checkmarx

Problème : Permission refusée

# Run with elevated privileges
sudo checkmarx <command>

# Check file permissions
ls -la $(which checkmarx)

# Fix permissions
chmod +x /usr/local/bin/checkmarx

# Check ownership
sudo chown $USER:$USER /usr/local/bin/checkmarx

Problème : Erreurs de configuration

# Validate configuration
checkmarx config validate

# Reset to default configuration
checkmarx config reset

# Check configuration file location
checkmarx config show --file

# Backup current configuration
checkmarx config export > backup.conf

# Restore from backup
checkmarx config import backup.conf

Problème : Service ne démarre pas

# Check service status
checkmarx status --detailed

# Check system logs
journalctl -u checkmarx

# Start in debug mode
checkmarx start --debug

# Check port availability
netstat -tulpn|grep <port>

# Kill conflicting processes
checkmarx killall --force

Commandes de débogage

CommandeDescription
checkmarx --debugActiver la sortie de débogage
checkmarx --verboseActiver la journalisation détaillée
checkmarx --traceActiver la journalisation des traces
checkmarx testExécuter les tests intégrés
checkmarx doctorExécuter la vérification de santé du système
checkmarx diagnoseGénérer un rapport de diagnostic
checkmarx benchmarkExécuter des benchmarks de performance
checkmarx validateValider l’installation et la configuration

Optimisation des performances

Gestion des ressources

# Set memory limit
checkmarx --max-memory 1G <command>

# Set CPU limit
checkmarx --max-cpu 2 <command>

# Enable caching
checkmarx --cache-enabled <command>

# Set cache size
checkmarx --cache-size 100M <command>

# Clear cache
checkmarx cache clear

# Show cache statistics
checkmarx cache stats

# Optimize performance
checkmarx optimize --profile <profile>

# Show performance metrics
checkmarx metrics

Traitement parallèle

Would you like me to continue with specific translations for the numbered sections?```bash

Enable parallel processing

checkmarx —parallel

Set number of workers

checkmarx —workers 4

Process in batches

checkmarx —batch-size 100

Queue management

checkmarx queue add checkmarx queue process checkmarx queue status checkmarx queue clear


## Intégration

### Scripting
```bash
#!/bin/bash
# Example script using checkmarx

set -euo pipefail

# Configuration
CONFIG_FILE="config.yaml"
LOG_FILE="checkmarx.log"

# Check if checkmarx is available
if ! command -v checkmarx &> /dev/null; then
    echo "Error: checkmarx is not installed" >&2
    exit 1
fi

# Function to log messages
log() \\\\{
    echo "$(date '+%Y-%m-%d %H:%M:%S') - $1"|tee -a "$LOG_FILE"
\\\\}

# Main operation
main() \\\\{
    log "Starting checkmarx operation"

    if checkmarx --config "$CONFIG_FILE" run; then
        log "Operation completed successfully"
        exit 0
    else
        log "Operation failed with exit code $?"
        exit 1
    fi
\\\\}

# Cleanup function
cleanup() \\\\{
    log "Cleaning up"
    checkmarx cleanup
\\\\}

# Set trap for cleanup
trap cleanup EXIT

# Run main function
main "$@"

Intégration d’API

#!/usr/bin/env python3
"""
Python wrapper for the tool
"""

import subprocess
import json
import logging
from pathlib import Path
from typing import Dict, List, Optional

class ToolWrapper:
    def __init__(self, config_file: Optional[str] = None):
        self.config_file = config_file
        self.logger = logging.getLogger(__name__)

    def run_command(self, args: List[str]) -> Dict:
        """Run command and return parsed output"""
        cmd = ['tool_name']

        if self.config_file:
            cmd.extend(['--config', self.config_file])

        cmd.extend(args)

        try:
            result = subprocess.run(
                cmd,
                capture_output=True,
                text=True,
                check=True
            )
            return \\\\{'stdout': result.stdout, 'stderr': result.stderr\\\\}
        except subprocess.CalledProcessError as e:
            self.logger.error(f"Command failed: \\\\{e\\\\}")
            raise

    def status(self) -> Dict:
        """Get current status"""
        return self.run_command(['status'])

    def start(self) -> Dict:
        """Start service"""
        return self.run_command(['start'])

    def stop(self) -> Dict:
        """Stop service"""
        return self.run_command(['stop'])

# Example usage
if __name__ == "__main__":
    wrapper = ToolWrapper()
    status = wrapper.status()
    print(json.dumps(status, indent=2))

Variables d’environnement

VariableDescriptionDéfaut
CHECKMARX_CONFIGChemin du fichier de configuration~/.checkmarx/config.yaml
CHECKMARX_HOMERépertoire personnel~/.checkmarx
CHECKMARX_LOG_LEVELNiveau de journalisationINFO
CHECKMARX_LOG_FILEChemin du fichier journal~/.checkmarx/logs/checkmarx.log
CHECKMARX_CACHE_DIRRépertoire de cache~/.checkmarx/cache
CHECKMARX_DATA_DIRRépertoire de données~/.checkmarx/data
CHECKMARX_TIMEOUTDélai par défaut30s
CHECKMARX_MAX_WORKERSTravailleurs maximum4

Fichier de configuration

# ~/.checkmarx/config.yaml
version: "1.0"

# General settings
settings:
  debug: false
  verbose: false
  log_level: "INFO"
  log_file: "~/.checkmarx/logs/checkmarx.log"
  timeout: 30
  max_workers: 4

# Network configuration
network:
  host: "localhost"
  port: 8080
  ssl: true
  timeout: 30
  retries: 3

# Security settings
security:
  auth_required: true
  api_key: ""
  encryption: "AES256"
  verify_ssl: true

# Performance settings
performance:
  cache_enabled: true
  cache_size: "100M"
  cache_dir: "~/.checkmarx/cache"
  max_memory: "1G"

# Monitoring settings
monitoring:
  enabled: true
  interval: 60
  metrics_enabled: true
  alerts_enabled: true

Exemples

Workflow de base

# 1. Initialize checkmarx
checkmarx init

# 2. Configure basic settings
checkmarx config set host example.com
checkmarx config set port 8080

# 3. Start service
checkmarx start

# 4. Check status
checkmarx status

# 5. Perform operations
checkmarx run --target example.com

# 6. View results
checkmarx results

# 7. Stop service
checkmarx stop

Workflow avancé

# Comprehensive operation with monitoring
checkmarx run \
  --config production.yaml \
  --parallel \
  --workers 8 \
  --verbose \
  --timeout 300 \
  --output json \
  --log-file operation.log

# Monitor in real-time
checkmarx monitor --real-time --interval 5

# Generate report
checkmarx report --type comprehensive --output report.html

Exemple d’automatisation

#!/bin/bash
# Automated checkmarx workflow

# Configuration
TARGETS_FILE="targets.txt"
RESULTS_DIR="results/$(date +%Y-%m-%d)"
CONFIG_FILE="automation.yaml"

# Create results directory
mkdir -p "$RESULTS_DIR"

# Process each target
while IFS= read -r target; do
    echo "Processing $target..."

    checkmarx \
        --config "$CONFIG_FILE" \
        --output json \
        --output-file "$RESULTS_DIR/$\\\\{target\\\\}.json" \
        run "$target"

done < "$TARGETS_FILE"

# Generate summary report
checkmarx report summary \
    --input "$RESULTS_DIR/*.json" \
    --output "$RESULTS_DIR/summary.html"

Meilleures pratiques

Sécurité

  • Toujours vérifier les sommes de contrôle lors du téléchargement de binaires
  • Utiliser des méthodes d’authentification robustes (clés API, certificats)
  • Mettre à jour régulièrement vers la dernière version
  • Suivre le principe du moindre privilège
  • Activer la journalisation d’audit pour la conformité
  • Utiliser des connexions chiffrées si possible
  • Valider tous les intrants et configurations
  • Implémenter des contrôles d’accès appropriés

Performance

  • Utiliser des limites de ressources appropriées pour votre environnement
  • Surveiller régulièrement les performances du système
  • Optimiser la configuration pour votre cas d’utilisation
  • Utiliser le traitement parallèle quand c’est bénéfique
  • Implémenter des stratégies de mise en cache appropriées
  • Maintenance et nettoyage réguliers
  • Identifier les goulots d’étranglement de performance
  • Utiliser des algorithmes et structures de données efficaces

Opérationnel

  • Maintenir une documentation complète
  • Implémenter des stratégies de sauvegarde appropriées
  • Utiliser le contrôle de version pour les configurations
  • Surveiller et alerter sur les métriques critiques
  • Implémenter une gestion des erreurs appropriée
  • Utiliser l’automatisation pour les tâches répétitives
  • Audits de sécurité et mises à jour réguliers
  • Planifier la reprise après sinistre

Développement

  • Suivre les normes et conventions de codage
  • Écrire des tests complets
  • Utiliser l’intégration/déploiement continu
  • Implémenter une journalisation et un monitoring appropriés
  • Documenter les API et interfaces
  • Utiliser efficacement le contrôle de version
  • Revue de code régulière
  • Maintenir la compatibilité ascendante

Ressources

Documentation officielle

Ressources communautaires

Ressources d’apprentissage

Outils Associés

  • Git - Fonctionnalité complémentaire
  • Docker - Solution alternative
  • Kubernetes - Partenaire d’intégration

*Dernière mise à jour : 2025-07-06|Modifier sur GitHubhttps://github.com/perplext/1337skills/edit/main/docs/cheatsheets/checkmarx.md)