À propos de l’analyse du code avec CodeQL

Remarque : Votre administrateur de site doit activer l’code scanning avant de pouvoir utiliser cette fonctionnalité. Pour plus d’informations, consultez « Configuration de l’analyse de code pour votre appliance ».

Vous ne pourrez peut-être pas activer ou désactiver lcode scanning si un propriétaire d’entreprise a défini une stratégie GitHub Advanced Security (GHAS) au niveau de l’entreprise. Pour plus d’informations, consultez « Application de stratégies de sécurité et d’analyse du code pour votre entreprise ».

CodeQL est le moteur d’analyse de code développé par GitHub pour automatiser les vérifications de sécurité. Vous pouvez analyser votre code à l’aide de CodeQL et afficher les résultats sous forme d’alertes d’code scanning.

Il existe trois façons principales d’utiliser l’analyse CodeQL pour l’code scanning :

Utilisez la configuration par défaut afin de configurer rapidement l’analyse CodeQL pour l’code scanning dans votre dépôt. La configuration par défaut choisit automatiquement les langages à analyser, la suite de requêtes à exécuter et les événements qui déclenchent les analyses. Si vous préférez, vous pouvez sélectionner manuellement la suite de requêtes à exécuter et les langues à analyser. Une fois que vous avez activé CodeQL, GitHub Actions effectue les exécutions de workflow pour analyser votre code. Pour plus d’informations, consultez « Définition de la configuration par défaut pour l’analyse du code ».
Utilisez la configuration avancée pour ajouter le workflow CodeQL à votre dépôt. Cela génère un fichier de workflow personnalisable qui utilise github/codeql-action pour exécuter CodeQL CLI. Pour plus d’informations, consultez « Configuration de la configuration par défaut pour l’analyse du code ».
Exécutez l’interface CLI CodeQL CLI directement dans un système CI externe et chargez les résultats sur GitHub. Pour plus d’informations, consultez « Utilisation de l'analyse du code avec votre système CI existant ».

Sur GitHub Enterprise Server 3.14,, l’action CodeQL utilise CodeQL CLI version 2.17.6 par défaut. Nous vous recommandons d’utiliser la même version de l’interface CodeQL CLI si vous exécutez une analyse dans un système CI externe.

Pour plus d’informations sur les alertes code scanning, consultez « À propos des alertes d’analyse du code ».

À propos de CodeQL

CodeQL est un langage de programmation et des outils associés qui traitent du code comme des données. Il a été créé explicitement pour faciliter l’analyse du code et trouver des vulnérabilités potentielles dans votre code avec une plus grande confiance que les analyseurs statiques traditionnels.

Vous générez une base de données CodeQL pour représenter votre codebase.
Ensuite, vous exécutez des requêtes CodeQL sur cette base de données pour identifier les problèmes dans le codebase.
Les résultats des requêtes sont affichés sous la forme d’alertes d’code scanning dans GitHub Enterprise Server quand vous utilisez CodeQL avec l’code scanning.

CodeQL prend en charge les langages compilés et interprétés, et peut trouver des vulnérabilités et des erreurs dans le code écrit dans les langages pris en charge.

C/C++
C#
Go
Java/Kotlin
JavaScript/TypeScript
Python
Ruby
Swift

Note

Utilisez java-kotlin pour analyser le code écrit dans Java, Kotlin ou les deux.
Utilisez javascript-typescript pour analyser le code écrit dans JavaScript, TypeScript ou les deux.

Pour plus d’informations, consultez la documentation disponible sur le site web de CodeQL : « Langages et frameworks pris en charge ».

Modélisation de frameworks personnalises ou de niche

Les experts GitHub, les chercheurs en sécurité et les contributeurs de la communauté écrivent des bibliothèques pour modéliser le flux de données dans les frameworks et bibliothèques populaires. Si vous utilisez des dépendances personnalisées qui ne sont pas modélisées, vous pouvez utiliser l’extension CodeQL pour Visual Studio Code afin de créer des modèles pour ces dépendances et les utiliser pour étendre votre analyse. Pour plus d’informations, consultez « Utilisation de l’éditeur de modèle CodeQL ».

Requêtes CodeQL

Les experts GitHub, les chercheurs en sécurité et les contributeurs de la communauté écrivent et gèrent les requêtes CodeQL par défaut utilisées pour l’code scanning. Les requêtes sont régulièrement mises à jour pour améliorer l’analyse et réduire les faux positifs. Pour plus d’informations sur les requêtes disponibles dans les packs par défaut et étendus, consultez « Requêtes incluses dans les suites de requêtes par défaut et de sécurité étendues ».

Écriture de vos propres requêtes

Les requêtes sont open source. Vous pouvez donc afficher et contribuer aux requêtes dans le référentiel github/codeql. Pour plus d’informations, consultez « À propos des requêtes CodeQL » dans la documentation CodeQL.

Exécution de requêtes supplémentaires

Si vous analysez votre code avec la configuration avancé ou un système CI externe, vous pouvez exécuter des requêtes supplémentaires dans le cadre de votre analyse.

Ces requêtes doivent faire partie d’un pack de requêtes CodeQL publié ou d’un pack CodeQL dans un référentiel.

Quand un pack de requêtes CodeQL est publié sur le Container registry GitHub, toutes les dépendances transitives requises par les requêtes et un cache de compilation sont inclus dans le package. Cela améliore les performances et garantit que l’exécution des requêtes dans le pack donne systématiquement des résultats identiques jusqu’à ce que vous effectuiez une mise à niveau vers une nouvelle version du pack ou de l’interface CLI.
Vous pouvez télécharger les packs de requêtes CodeQL à partir de plusieurs registres de conteneurs GitHub. Pour plus d’informations, consultez « Personnalisation de votre configuration avancée pour l’analyse de code ».

Pour plus d’informations, consultez « Personnalisation de l’analyse avec des packs CodeQL ».