Skip to main content

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

PyPI version GitHub Marketplace GitHub Release License CycloneDX 1.6 PQC Score

Shorless (shorless) est un scanner statique multi-langages (Python AST, Java, Go, Node.js, TypeScript, C# .NET), d'infrastructure (Nginx, Dockerfile, Traefik, Kubernetes Ingress, Terraform), réseau (--check-tls) et d'auto-remédiation (--fix / --auto-pr) conçu pour aider les équipes DevSecOps, RSSI et CTO à cartographier leur dette cryptographique et automatiser leur migration vers la cryptographie post-quantique (ANSSI / NIST FIPS 203 ML-KEM & FIPS 204 ML-DSA).

🔗 Site officiel & Sandbox interactif : https://shorless.io ☁️ Console SaaS CBOM & Télémétrie CI/CD : https://shorless.io/dashboard.html 📘 Documentation complète CLI & GitHub Action : https://shorless.io/scanner-documentation.html


🆕 Nouveautés de la version v1.0.1 (Support Bilingue FR/EN (--lang), Barème de Crédits Unifié (500 Crédits Offerts), Conformité CGV/CGU & Suppression RGPD)

  • Ajout de l'option CLI --lang (-l fr|en) et de la variable d'environnement SHORLESS_LANG=en pour exécuter le scanner, les tableaux Rich et la télémétrie SaaS en Français ou en Anglais.
  • Ajout de l'input lang ('fr' ou 'en') dans la GitHub Action officielle (action.yml) et support bilingue complet dans la Console SaaS (dashboard.html) et la documentation.
  • Alignement sur le modèle par crédits (500 crédits offerts à l'essai, 5 crédits/scan CI/CD, 15 crédits avec --auto-pr, 1 crédit/sonde TLS) détaillé dans les CGV.
  • Ajout du workflow RGPD de suppression définitive de compte et des données associées avec double confirmation (case d'impact + lien sécurisé par email).

🚀 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 (6 langages) + Infra (5 formats 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 sur les 11 technologies sans modifier les fichiers (--dry-run)
shorless ./mon_projet --fix --dry-run

# 4. Application automatique des correctifs PQC sur le code et l'IaC (--fix)
shorless ./mon_projet --fix

# 5. Synchronisation Cloud SaaS + Auto-Remédiation + Ouverture automatique d'une Pull Request GitHub (--auto-pr)
shorless ./mon_projet --api-key VOTRE_CLE_SAAS --fix --auto-pr --pr-base main

# 6. 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 . Dossier projet analysé récursivement (.py, .java, .go, .js, .ts, .cs, .conf, Dockerfile*, .yml/.yaml, .tf).
--cbom TEXT Option cbom.json Chemin du fichier JSON généré au standard officiel OWASP CycloneDX 1.6.
--sarif TEXT Option None Génère un rapport OASIS SARIF 2.1.0 pour annoter les Pull Requests dans GitHub Code Scanning.
--project TEXT Option Auto Nom du projet/dépôt Git pour segmenter la télémétrie dans la Console SaaS et générer le badge SVG.
--webhook-url TEXT Option None URL de Webhook Slack / Microsoft Teams / Discord pour recevoir une alerte de score PQC.
--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 11 technologies (6 langages Backend + 5 formats IaC) vers TLS 1.3 & ML-KEM (FIPS 203).
--dry-run Flag False Simule l'option --fix et affiche les correctifs prévus dans le terminal sans modifier aucun fichier sur le disque.
--api-key TEXT Option None Clé d'API Shorless SaaS pour synchroniser le Score PQC avec la Console Cloud (https://shorless.io/dashboard.html).
--auto-pr Flag False Crée une branche Git shorless-pqc-fix-..., commit les patchs --fix et ouvre automatiquement une Pull Request GitHub.
--pr-base TEXT Option main Branche cible pour la Pull Request automatique ouverte par --auto-pr.
--verbose / -v Flag False Affiche la liste des fichiers analysés, leur type détecté et la probabilité (%) qu'ils contiennent des références cryptographiques.
--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 / @v1.0.1)

Disponible sur le GitHub Marketplace. Ajoutez ce workflow dans .github/workflows/shorless-pqc.yml :

name: Post-Quantum Readiness, Auto-PR & CBOM Audit
on:
  push:
    branches: [ main ]
  pull_request:

permissions:
  contents: write
  pull-requests: write

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

      - name: Run Shorless PQC Scanner & Auto-PR
        uses: Shorless/scanner@v0
        with:
          target-dir: "."
          output-cbom: "cbom-cyclonedx.json"
          report-html: "pqc-report.html"
          check-tls: "https://shorless.io"
          api-key: ${{ secrets.SHORLESS_API_KEY }}
          auto-fix: "true"
          auto-pr: "true"
          pr-base: "main"
          dry-run: "false"
          fail-on-critical: "false"
          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).
api-key Non "" Clé d'API Shorless SaaS pour activer la télémétrie Cloud et l'ouverture de Pull Requests (--api-key).
auto-fix Non "false" Applique automatiquement les correctifs PQC sur les 11 technologies Code & IaC (--fix).
auto-pr Non "false" Pousse une branche dédiée et ouvre automatiquement une Pull Request GitHub (--auto-pr).
pr-base Non "main" Branche de base cible pour la Pull Request automatique (--pr-base).
dry-run Non "false" Prévisualise les patchs dans les logs sans modifier les fichiers (--dry-run).
verbose Non "false" Affiche l'inventaire des fichiers analysés, leur type et leur probabilité crypto (--verbose).
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 les rapports cbom.json et pqc-report.html en artefacts GitHub Actions.

📊 Score de Maturité PQC & Console SaaS CBOM

Le score de maturité Post-Quantique (0 à 100) est calculé selon une courbe d'amortissement pondérée prenant en compte les vulnérabilités résiduelles (recalculée automatiquement après --fix) :

Score PQC = round( 100 * (100 / (100 + 12 * N_critiques + 4 * N_autres)) )
  • 100/100 (Grade A) : Zéro vulnérabilité quantique détectée (conforme aux recommandations ANSSI / NIST FIPS 203).
  • Console Cloud SaaS : Consultez l'historique de vos audits CI/CD et inspectez vos rapports CBOM sur https://shorless.io/dashboard.html.

📄 Licence

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

Metadata

Release files for shorless 1.0.1

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 1.0.1
File Size Uploaded Provenance Actions
shorless-1.0.1.tar.gz 34.5 kB Without provenance Details for shorless-1.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 69.6 kB

Release files / shorless-1.0.1.tar.gz

Download URL shorless-1.0.1.tar.gz
Size 34.5 kB
Tags Source
SHA-256 checksum
How to use checksums
384f78a2e2445fbe721828213168a661f5b4bdd81c3cab096b85b8168bc19ece
BLAKE2b-256 checksum
How to use checksums
adf974f3bb1170817ea57d7a5867e7080ed6c63fe93d39afc66bc177bfe353b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.3

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

Download URL shorless-1.0.1-py3-none-any.whl
Size 35.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b910c8cb00adc0324452ac98bee201efee039bd30a5d6f82ed9b04205f29ea5e
BLAKE2b-256 checksum
How to use checksums
f514649a748526a4b613b90ebf0b315d336b8a2615aed7479df6f2188dcfafdd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.3

Security for shorless 1.0.1

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