Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Acerca del examen de código con CodeQL

Puedes utilizar CodeQL para identificar las vulnerabilidades y errores en tu código. Los resultados se muestran como alertas del code scanning en GitHub.

Code scanning está disponible para repositorios que son propiedad de una organización en GitHub Enterprise Server. Esta característica requiere una licencia para la GitHub Advanced Security. Para más información, consulte "Acerca de GitHub Advanced Security".

Nota: El administrador del sitio debe habilitar code scanning para your GitHub Enterprise Server instance para puedas utilizar esta característica. Para más información, vea "Configuración de code scanning para el dispositivo".

Acerca de code scanning con CodeQL

CodeQL es el motor de análisis de código que desarrolló GitHub para automatizar las verificaciones de seguridad. Puedes analizar tu código utilizando CodeQL y mostrando los resultados como alertas del code scanning.

Hay dos formas principales para utilizar el análisis de CodeQL para el code scanning:

En GitHub Enterprise Server 3.7, la acción CodeQL utiliza la versión de CodeQL CLI 2.10.5 de forma predeterminada. Se recomienda usar la misma versión de CodeQL CLI si ejecutas análisis en un sistema de CI externo.

Acerca de CodeQL

El CodeQL trata el código como datos, permitiéndote encontrar vulnerabilidades potenciales en tu código con mayor confianza que los analizadores estáticos tradicionales.

  1. Generas una base de datos de CodeQL para representar tu base de código.
  2. Entonces, ejecutarás consultas de CodeQL en esa base de datos para identificar problemas en la base de código.
  3. Estos resultados de consulta se muestran como alertas del code scanning en GitHub Enterprise Server cuando utilizas al CodeQL con el code scanning.

CodeQL es compatible tanto con lenguajes compilados como interpretados, y puede buscar vulnerabilidades y errores en el código escrito en los lenguajes compatibles.

  • C/C++
  • C#
  • Go
  • Java
  • JavaScript/TypeScript
  • Python
  • Ruby

Notas:

  • El análisis de CodeQL para Ruby se encuentra actualmente en versión beta. Durante el beta, el análisis para Ruby será menos exhaustivo que el análisis de CodeQL para otros lenguajes.
  • Usa javascript para analizar el código escrito en JavaScript, TypeScript o ambos.

Para más información, vea la documentación en el sitio web de CodeQL: "Lenguajes y marcos admitidos".

Acerca de las consultas de CodeQL

Los expertos de GitHub, investigadores de seguridad y contribuyentes comunitarios escriben y mantienen las consultas predeterminadas de CodeQL que se utilizan para el code scanning. Las consultas se actualizan frecuentemente para mejorar el análisis y reducir cualquier resultado falso positivo. Las consultas son código abierto, por lo que puede ver y contribuir en ellas en el repositorio de github/codeql. Para obtener más información, consulte CodeQL en el sitio web de CodeQL. También puede escribir consultas propias. Para obtener más información, consulte "Acerca de las consultas de CodeQL" en la documentación de CodeQL.

Si vas a examinar el código con la configuración avanzada o un sistema de CI externo, puedes ejecutar consultas adicionales como parte del análisis. Estas consultas deben pertenecer a un paquete de consultas (beta) de CodeQL publicado o un paquete de CodeQL en un repositorio. Los paquetes (beta) de CodeQL proporcionan los siguientes beneficios con respecto a los paquetes de QL tradicionales:

  • Cuando un paquete de consultas de CodeQL (beta) se publica en el Container registry de GitHub, todas las dependencias transitivas que requieren las consultas y un caché de compilación se incluyen en el paquete. Esto mejora el rendimiento y garantiza que el ejecutar las consultas del paquete proporciona resultados idénticos cada vez que actualizas a una versión nueva del paquete o de CLI.
  • Los paquetes de QL no incluyen dependencias transitivas, por lo que las consultas del paquete pueden depender únicamente de las bibliotecas estándar (es decir, a las que se hace referencia mediante una instrucción import LANGUAGE en la consulta), o bien de bibliotecas del mismo paquete de QL que la consulta.
  • Los paquetes de consulta (beta) de CodeQL se pueden descargar de varios registros de contenedor de GitHub. Para más información, consulta "Personalización de code scanning".

Para obtener más información, consulta "Acerca de los paquetes de CodeQL".