Skip to main content

⚡ Shorless — Post-Quantum (PQC) DevSecOps Scanner & CycloneDX 1.6 CBOM Generator

PyPI version GitHub Release License CycloneDX 1.6

Shorless (shorless) est un scanner statique (AST Python), d'infrastructure (Nginx, Dockerfile, Traefik, Kubernetes Ingress, Terraform), réseau (--check-tls) et d'auto-remédiation (--fix) Open Source conçu pour aider les équipes DevSecOps de PME et d'ETI à cartographier leur dette cryptographique et préparer leur transition vers la cryptographie post-quantique (ANSSI / NIST FIPS 203 ML-KEM & FIPS 204 ML-DSA).

🔗 Site officiel & Sandbox interactif : https://shorless.io 📘 Documentation complète CLI & GitHub Action : https://shorless.io/scanner-documentation.html


🆕 Nouveautés de la version v0.9.5 (Authentification SaaS (--api-key) & Pull Requests Automatiques (--auto-pr))

  • Ajout de l'authentification SaaS (--api-key / SHORLESS_API_KEY) reliée à l'endpoint api_verify.php
  • Ajout de l'option --auto-pr pour créer une branche Git dédiée et ouvrir automatiquement les Pull Requests de remédiation PQC
  • Mise à jour de la GitHub Action officielle (action.yml) avec injection automatique de GITHUB_TOKEN
  • Ajout des auto-remdiations de code multi-language

🚀 Installation Rapide (PyPI / pipx)

# Exécution instantanée sans installation permanente via pipx
pipx run shorless . --cbom cbom.json

# Ou installation / mise à jour globale via PyPI
pip install -U shorless

💻 Référence complète des Commandes & Options CLI

# 1. Audit complet Code (Python AST) + Multi-IaC + Rapport Exécutif HTML/PDF
shorless ./mon_projet --cbom cbom.json --report-html pqc-report.html

# 2. Inspection en direct d'un endpoint TLS distant (TLS 1.3, KEM hybride X25519MLKEM768 & certificat X.509)
shorless . --check-tls https://shorless.io --cbom cbom-live.json

# 3. Simulation d'auto-remédiation IaC sans modifier les fichiers sur le disque (--dry-run)
shorless ./mon_projet --fix --dry-run

# 4. Application automatique des correctifs PQC sur Nginx, Dockerfile, Traefik, K8s Ingress et Terraform (--fix)
shorless ./mon_projet --fix

# 5. Mode bloqueur CI/CD (renvoie exit code 1 si au moins 1 risque CRITIQUE face à Shor est détecté)
shorless . --check-tls https://api.entreprise.fr --cbom cbom.json --ci
Argument / Option Type Défaut Description
TARGET_DIR Argument . Chemin du dossier projet ou dépôt Git à analyser récursivement (.py, .conf, Dockerfile*, .yml/.yaml, .tf).
--cbom TEXT Option cbom.json Chemin du fichier JSON généré au standard officiel OWASP CycloneDX 1.6.
--report-html TEXT Option None Génère un Rapport d'Audit Exécutif HTML/PDF autonome (Score PQC /100, NIS 2, DORA, ANSSI) pour RSSI & CTO.
--check-tls TEXT Option None URL ou domaine:port à inspecter en direct (handshake TLS 1.3, groupe hybride X25519MLKEM768, certificat X.509).
--fix Flag False Corrige automatiquement les fichiers IaC (Nginx, Dockerfile, Traefik, K8s Ingress, Terraform) vers TLS 1.3 & ML-KEM.
--dry-run Flag False Simule l'option --fix et affiche les correctifs prévus dans le terminal sans modifier aucun fichier sur le disque.
--ci Flag False Interrompt le pipeline CI/CD (exit code 1) si au moins une vulnérabilité CRITIQUE est détectée.
--help Flag - Affiche l'aide interactive et la liste complète des options dans le terminal.

🤖 Intégration GitHub Action Officielle (Shorless/scanner@v0.9.5)

Ajoutez ce workflow dans .github/workflows/shorless-pqc.yml pour auditer chaque Pull Request et archiver automatiquement le CBOM CycloneDX 1.6 :

name: Post-Quantum Readiness & CBOM Audit
on: [push, pull_request]

jobs:
  shorless-pqc-audit:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Run Shorless PQC & CBOM Scanner
        uses: Shorless/scanner@v0.9.5
        with:
          target-dir: "."
          output-cbom: "cbom-cyclonedx.json"
          check-tls: "https://shorless.io"
          auto-fix: "false"
          dry-run: "true"
          fail-on-critical: "true"
          upload-artifact: "true"

Paramètres (inputs) de la GitHub Action

Input Requis Défaut Option CLI associée & Description
target-dir Non "." Répertoire projet à analyser (TARGET_DIR).
output-cbom Non "cbom.json" Chemin du fichier CBOM CycloneDX 1.6 généré (--cbom).
report-html Non "pqc-report.html" Chemin du rapport d'audit exécutif HTML/PDF généré (--report-html).
check-tls Non "" Endpoint TLS distant à auditer en direct (--check-tls).
auto-fix Non "false" Applique automatiquement les correctifs PQC sur les fichiers IaC (--fix).
dry-run Non "false" Prévisualise les patchs IaC dans les logs sans modifier les fichiers (--dry-run).
fail-on-critical Non "true" Bloque la Pull Request (exit code 1) si un risque critique est trouvé (--ci).
upload-artifact Non "true" Téléverse automatiquement le fichier cbom.json en artefact de build GitHub Actions.

📄 Licence

Distribué sous licence Apache 2.0. © 2026 Shorless Security.

Metadata

Release files for shorless 0.9.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shorless 0.9.5
File Size Uploaded Provenance Actions
shorless-0.9.5.tar.gz 19.1 kB Without provenance Details for shorless-0.9.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for shorless 0.9.5
File Interpreter ABI Platform Actions
shorless-0.9.5-py3-none-any.whl Python 3 none any Details for shorless-0.9.5-py3-none-any.whl

Total release size: 38.6 kB

Release files / shorless-0.9.5.tar.gz

Download URL shorless-0.9.5.tar.gz
Size 19.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9669739c8282d16465621414d9110908750a4ec7ea448cad7698d734c63562d5
BLAKE2b-256 checksum
How to use checksums
28fb39b46c2c450dc5168ee8624c6bf530374b7d96f136aae07fe53f332a4ba6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / shorless-0.9.5-py3-none-any.whl

Download URL shorless-0.9.5-py3-none-any.whl
Size 19.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1dccae41a8053b0495ff54c96415c1293cc765306df4263897244d104e5dbf0a
BLAKE2b-256 checksum
How to use checksums
5087f16f498979c4b9c56f3bc0dbae0d5547c11788a85205a836fd8567a5a6d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for shorless 0.9.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page