Referencia de paquetes de consulta de CodeQL

CodeQL compatibilidad de paquetes

Cuando se publica un paquete de consultas, incluye representaciones precompiladas de todas las consultas en él para aumentar la velocidad de análisis. Sin embargo, si la versión de CodeQL que realiza el análisis es superior a 6 meses más reciente que la versión que ejecutó codeql pack publish, puede ser necesario compilar las consultas desde el origen durante el análisis, ralentizando significativamente el proceso.

Un paquete publicado por la versión pública más reciente de CodeQL será utilizable por la versión de CodeQL que usa code scanning y GitHub Actions, aunque a menudo es una versión ligeramente anterior.

Si el análisis contiene líneas como las siguientes, se CodeQL usa correctamente consultas precompiladas:

[42/108] Loaded /long/path/to/query/Filename.qlx.

Si en su lugar el análisis contiene líneas similares a las siguientes, CodeQL vuelva a compilar manualmente las consultas desde el origen:

Compiling query plan for /long/path/to/query/Filename.ql.
[42/108 comp 25s] Compiled /long/path/to/query/Filename.ql.

Para ayudar a los usuarios del paquete de consultas a beneficiarse de las consultas precompiladas, se recomienda usar una versión reciente de CodeQL para publicar los paquetes. Además, debería publicar una nueva versión de su paquete con una versión CodeQL actualizada cada 6 meses.

Si publica paquetes de consultas con la intención de usarlos en una instalación de GitHub Enterprise Server que utiliza los binarios de CodeQL incluidos, use la misma versión de CodeQL para ejecutar codeql pack publish.

Archivos qlpack.yml

Al ejecutar comandos relacionados con las consultas, CodeQL primero busca archivos qlpack.yml en los directorios del mismo nivel que el directorio de instalación (y en sus subdirectorios) y, a continuación, comprueba la caché de paquetes en busca de paquetes CodeQL descargados. Esto significa que, cuando los paquetes locales en el directorio de instalación reemplazan los paquetes del mismo nombre en la caché de paquetes, puede probar los cambios locales.

Los metadatos de cada archivo qlpack.yml indican a CodeQL cómo compilar las consultas del paquete, de qué bibliotecas depende el paquete y dónde encontrar las definiciones del conjunto de consultas.

El contenido del CodeQL paquete (consultas o bibliotecas usadas en CodeQL el análisis) se incluye en el mismo directorio que qlpack.yml, o en sus subdirectorios.

El directorio que contiene el qlpack.yml archivo actúa como directorio raíz para el contenido del CodeQL paquete. Es decir, para todos los .ql archivos y .qll del paquete, CodeQL resolverá todas las instrucciones de importación relativas al directorio que contiene el qlpack.yml archivo en la raíz del paquete.

propiedades de qlpack.yml

Se admiten las propiedades siguientes en los archivos qlpack.yml.

name

• Propiedad requerida por todos los paquetes.

• Define el ámbito del paquete, dónde se publica el paquete CodeQL y el nombre del paquete, definido mediante caracteres alfanuméricos y guiones. Debe ser único, ya que CodeQL no puede diferenciar entre CodeQL paquetes con nombres idénticos. Use el nombre del paquete para especificar las consultas que se van a ejecutar mediante database analyze y para definir dependencias entre CodeQL paquetes (consulte los ejemplos siguientes). Por ejemplo:

  name: octo-org/security-queries
  

version

• Propiedad requerida por todos los paquetes que se publican.

• Define una versión semántica para este CodeQL paquete que debe cumplir la especificación SemVer v2.0.0. Por ejemplo:

  version: 0.0.0
  

dataExtensions

• Propiedad requerida por los paquetes de modelos.
• Toma una lista de patrones globales que especifican dónde se encuentran los archivos de extensión de datos en relación con la raíz del paquete de consultas o del paquete de biblioteca.

dependencies

• Necesario para los paquetes de consultas y de bibliotecas que definen CodeQL dependencias de paquetes respecto de otros paquetes. Los paquetes de modelos no pueden definir dependencias ni usar extensionTargets en su lugar.

• Define una asignación de referencias del paquete al intervalo de versiones semánticas que es compatible con este paquete. Compatible con CodeQL CLI las versiones v2.6.0 y posteriores. Por ejemplo:

  dependencies:
    codeql/cpp-all: ^0.0.2
  

  Si no estás seguro o no importa qué versión se debe usar, puedes usar "*", lo que indica que cualquier versión de esta dependencia es compatible con este paquete. En la práctica, esto normalmente se resolverá en la versión publicada más alta de la dependencia.

  Hay un marcador de posición de versión especial, ${workspace}, que indica que este paquete CodeQL depende de la versión de la dependencia que esté en el mismo espacio de trabajo. Para más información, consulta Áreas de trabajo de CodeQL.

defaultSuiteFile

• Propiedad requerida por los paquetes que exportan un conjunto de consultas predeterminadas que se van a ejecutar.

• Define la ruta de acceso a un archivo de conjunto de consultas relativa a la raíz del paquete, que contiene todas las consultas que se ejecutan de forma predeterminada cuando este paquete se pasa al comando codeql database analyze. Es compatible con la CLI v2.6.0 y versiones posteriores. Solo se puede definir un elemento defaultSuiteFile o defaultSuite. Por ejemplo:

  defaultSuiteFile: cpp-code-scanning.qls
  

defaultSuite

• Propiedad requerida por los paquetes que exportan un conjunto de consultas predeterminadas que se van a ejecutar.

• Define un conjunto de consultas insertado que contiene todas las consultas que se ejecutan de forma predeterminada cuando este paquete se pasa al comando codeql database analyze. Es compatible con la CLI v2.6.0 y versiones posteriores. Solo se puede definir un elemento defaultSuiteFile o defaultSuite. Por ejemplo:

  defaultSuite:
    queries: .
    exclude:
      precision: medium
  

extensionTargets

• Propiedad requerida por los paquetes de modelos.
• Declara a qué consulta se empaquetan las extensiones del paquete de modelos. El paquete de extensiones insertará sus extensiones de datos en cada paquete denominado en el diccionario extensionTargets, si el paquete está dentro del intervalo de versiones especificado y se usa en la evaluación.

groups

• Opcional.

• Define agrupaciones lógicas de paquetes en un espacio de trabajo CodeQL. El uso de grupos es una manera de aplicar operaciones de paquete a subconjuntos de paquetes de un área de trabajo. Por ejemplo, el siguiente paquete se ha definido para formar parte de los grupos java y experimental:

  groups:
    - java
    - experimental
  

  Al ejecutar codeql pack publish --groups java,-experimental, se publicarán todos los paquetes del grupo java, excepto los paquetes experimental. Puedes ejecutar el comando codeql pack ls --groups [-]<group>[,[-]<group>...] para enumerar los paquetes de un área de trabajo que coincidan con el conjunto de grupos especificado.

  Un CodeQL paquete en el área de trabajo indicada se incluye en la lista si:

  • Está en al menos uno de los grupos enumerados sin un signo menos (esta condición se cumple automáticamente si no hay grupos enumerados sin el signo menos) y
  • No está en ningún grupo enumerado con un signo menos.

library

• Propiedad requerida por los paquetes de biblioteca.

• Define un valor booleano que indica si este paquete es un paquete de biblioteca. Los paquetes de biblioteca no contienen consultas y no se compilan. Los paquetes de consultas pueden omitir este campo o establecerlo explícitamente en false. Por ejemplo:

  library: true
  

suites

• Opcional para los paquetes que definen conjuntos de consultas. Esto permite a los usuarios ejecutar conjuntos de consultas almacenados en el directorio especificado indicando el nombre del paquete, sin proporcionar la ruta de acceso completa.
• Actualmente solo se admite para los paquetes de consultas estándar incluidos en el paquete de la CLI CodeQL.
• Esta opción no se admite para los paquetes CodeQL descargados del registro de contenedores GitHub.

tests

• Opcional para los paquetes que contienen pruebas de CodeQL. Se omite para los paquetes sin pruebas.

• Indica la ruta de acceso a un directorio dentro del paquete que contiene pruebas, definida en relación con el directorio del paquete. Usa . para especificar todo el paquete. Las consultas de este directorio se ejecutan como pruebas cuando test run se ejecuta con la opción --strict-test-discovery. Las definiciones de conjuntos de consultas que usan instrucciones queries o qlpack para solicitar todas las consultas de un paquete determinado omiten estas consultas. Si falta esta propiedad, el elemento . se da por supuesto. Por ejemplo:

  tests: .
  

extractor

• Obligatorio para todos los paquetes que contengan pruebas CodeQL.

• Define el extractor de idioma CodeQL que se va a usar al ejecutar las pruebas CodeQL del paquete. Para obtener más información sobre las pruebas de consultas, consulte Testing custom queries. Por ejemplo:

  extractor: javascript-typescript
  

authors

• Opcional.

• Define los metadatos que se mostrarán en la página de búsqueda de paquetes en la sección de paquetes de la cuenta en la que se publica el paquete CodeQL. Por ejemplo:

  authors: [email protected],[email protected]
  

license

• Opcional.

• Define los metadatos que se mostrarán en la página de búsqueda de paquetes, en la sección Paquetes de la cuenta en la que se publique el paquete CodeQL. Para obtener una lista de las licencias permitidas, consulta Lista de licencias de SPDX en la especificación de SPDX. Por ejemplo:

  license: MIT
  

description

• Opcional.

• Define los metadatos que se mostrarán en la página de búsqueda de paquetes, en la sección Paquetes de la cuenta en la que se publica el paquete CodeQL. Por ejemplo:

  description: Human-readable description of the contents of the CodeQL pack.
  

libraryPathDependencies

• Opcional, cerrar definitivamente. Utilice la propiedad dependencies en su lugar.

• Anteriormente se usaba para definir los nombres de los CodeQL paquetes de los que depende este CodeQL paquete, como una matriz. Esto proporciona al paquete acceso a las bibliotecas, el esquema de la base de datos y los conjuntos de consultas definidos en la dependencia. Por ejemplo:

  libraryPathDependencies: codeql/javascript-all
  

dbscheme

• Propiedad requerida solo por los paquetes de lenguaje principales.

• Define la ruta de acceso al esquema de base de datos para todas las bibliotecas y consultas escritas para este CodeQL lenguaje (vea el ejemplo siguiente). Por ejemplo:

  dbscheme: semmlecode.python.dbscheme
  

upgrades

• Propiedad requerida solo por los paquetes de lenguaje principales.

• Indica la ruta de acceso a un directorio dentro del paquete que contiene scripts de actualización de la base de datos, definida en relación con el directorio del paquete. Las actualizaciones de base de datos se usan internamente para asegurarse de que una base de datos creada con una versión diferente de CodeQL CLI es compatible con la versión actual de la CLI. Por ejemplo:

  upgrades: .
  

warnOnImplicitThis

• Opcional. El valor predeterminado es false si la propiedad warnOnImplicitThis no está definida.

• Define un valor booleano que especifica si el compilador debe emitir advertencias sobre las llamadas de predicado de miembro con receptores de llamadas implícitos this, es decir, sin un receptor explícito. Disponible desde CodeQL CLI v2.13.2. Por ejemplo:

  warnOnImplicitThis: true
  

Archivos codeql-pack.lock.yml

codeql-pack.lock.yml los archivos almacenan las versiones de las dependencias transitivas resueltas de un CodeQL paquete. El comando codeql pack install crea este archivo si aún no existe, que debe agregarse al sistema de control de versiones. La sección dependencies del archivo qlpack.yml contiene intervalos de versiones que son compatibles con el paquete. El archivo codeql-pack.lock.yml bloquea las versiones en dependencias precisas. Esto garantiza que la ejecución de codeql pack install en este paquete siempre recuperará las mismas versiones de las dependencias, incluso si existen versiones compatibles más recientes.

Por ejemplo, si un archivo qlpack.yml contiene las dependencias siguientes:

dependencies:
  codeql/cpp-all: ^0.1.2
  my-user/my-lib: ^0.2.3
  other-dependency/from-source: "*"

El archivo codeql-pack.lock.yml contendrá algo similar a lo siguiente:

dependencies:
  codeql/cpp-all:
    version: 0.1.4
  my-user/my-lib:
    version: 0.2.4
  my-user/transitive-dependency:
    version: 1.2.4

La dependencia codeql/cpp-all está bloqueada en la versión 0.1.4. La dependencia my-user/my-lib está bloqueada en la versión 0.2.4. La dependencia my-user/transitive-dependency, que es transitiva y no se especifica en el archivo qlpack.yml, está bloqueada en la versión 1.2.4. Falta other-dependency/from-source en el archivo de bloqueo, ya que se resuelve desde el origen. Esta dependencia debe estar disponible en el mismo CodeQL espacio de trabajo que el paquete. Para obtener más información sobre los CodeQLespacios de trabajo y sobre cómo resolver dependencias desde el código fuente, consulte Áreas de trabajo de CodeQL.

En la mayoría de los casos, el archivo codeql-pack.lock.yml solo es pertinente para los paquetes de consultas, ya que los paquetes de biblioteca no son ejecutables y normalmente no necesitan que se corrijan sus dependencias transitivas. La excepción a esto son los paquetes de biblioteca que contienen pruebas. En este caso, el archivo codeql-pack.lock.yml se usa para asegurarse de que las pruebas siempre se ejecutan con las mismas versiones de dependencias, con el fin de evitar errores falsos cuando hay dependencias no coincidentes.

Paquetes personalizados CodeQL de ejemplo

Debe guardar archivos para consultas y pruebas personalizadas en paquetes independientes y organizar paquetes personalizados en carpetas específicas para cada idioma de destino.

CodeQL paquetes para bibliotecas personalizadas

Un paquete personalizado CodeQL que contenga bibliotecas personalizadas de C++, sin consultas ni pruebas, puede tener un qlpack.yml archivo que contenga:

name: my-github-user/my-custom-libraries
version: 1.2.3
library: true
dependencies:
  codeql/cpp-all: ^0.1.2

donde codeql/cpp-all es el nombre del paquete para el CodeQL análisis de C/C++ incluido en el CodeQL repositorio. El intervalo de versiones ^0.1.2 indica que este paquete es compatible con todas las versiones de codeql/cpp-all que son mayores o iguales que 0.1.2 y menores que 0.2.0. Cualquier CodeQL archivo de biblioteca (un archivo con una .qll extensión) definido en este paquete estará disponible para las consultas definidas en cualquier paquete de consultas que incluya este paquete en su bloque de dependencias.

La propiedad library indica que se trata de un paquete de biblioteca y que no contiene ninguna consulta.

CodeQL paquetes para consultas personalizadas

Un paquete personalizado que contiene consultas y bibliotecas de C++ personalizadas CodeQL puede tener un qlpack.yml archivo que contenga:

name: my-github-user/my-custom-queries
version: 1.2.3
dependencies:
  codeql/cpp-all: ^0.1.2
  my-github-user/my-custom-libraries: ^1.2.3

donde codeql/cpp-all es el nombre del paquete para el CodeQL análisis de C/C++ incluido en el CodeQL repositorio. El intervalo de versiones ^0.1.2 indica que este paquete es compatible con todas las versiones de codeql/cpp-all que son mayores o iguales que 0.1.2 y menores que 0.2.0. my-github-user/my-custom-libraries es el nombre de un CodeQL paquete que contiene bibliotecas personalizadas CodeQL para C++. Cualquier CodeQL archivo de biblioteca (un archivo con una .qll extensión) definido en este paquete estará disponible para las consultas del my-github-user/my-custom-queries paquete.

CodeQL paquetes para pruebas personalizadas

En el caso de los paquetes personalizados CodeQL que contienen archivos de prueba, también debe incluir una extractor propiedad para que el test run comando sepa cómo crear bases de datos de prueba. También podría interesarte especificar la propiedad tests.

El siguiente archivo qlpack.yml indica que my-github-user/my-query-tests depende de my-github-user/my-custom-queries una versión mayor o igual que 1.2.3 y menor que 2.0.0. También declara que la CLI debe usar el extractor (extractor) de Java al crear bases de datos de prueba. La línea tests: . declara que todos los archivos .ql del paquete se deben ejecutar como pruebas cuando codeql test run se ejecuta con la opción --strict-test-discovery. Normalmente, los paquetes de prueba no contienen una propiedad version. Esto evita que se publiquen accidentalmente.

name: my-github-user/my-query-tests
dependencies:
  my-github-user/my-custom-queries: ^1.2.3
extractor: java-kotlin
tests: .

Para obtener más información sobre la ejecución de pruebas, consulte Testing custom queries.

Paquetes de ejemplo CodeQL en el CodeQL repositorio

Cada uno de los idiomas del CodeQL repositorio tiene cuatro paquetes principales CodeQL :

• Paquete de bibliotecas principales para el lenguaje, con el esquema de la base de datos utilizado por el lenguaje, y bibliotecas en CodeQL, y consultas en <language>/ql/lib

• Paquete de consultas principal para el lenguaje, que incluye las consultas predeterminadas para el lenguaje junto con sus conjuntos de consultas en <language>/ql/src.

• Pruebas para las consultas y bibliotecas de lenguaje principales en <language>/ql/test.

• Consultas de ejemplo para el lenguaje en <language>/ql/examples.

Paquete de biblioteca principal

Este es un archivo qlpack.yml de ejemplo para el paquete de lenguaje principal de bibliotecas de análisis de C/C++:

name: codeql/cpp-all
version: x.y.z-dev
dbscheme: semmlecode.cpp.dbscheme
library: true
upgrades: upgrades

Notas adicionales sobre las propiedades siguientes:

• library: indica que se trata de un paquete de biblioteca sin consultas ejecutables. Está concebido únicamente para usarse como una dependencia para otros paquetes.

• dbscheme y upgrades: estas propiedades son internas de CodeQL CLI y solo deben definirse en el paquete de consultas principal CodeQL de un idioma.

Paquete de consultas principal

Este es un archivo qlpack.yml de ejemplo para el paquete de consultas principal de consultas de análisis de C/C++:

name: codeql/cpp-queries
version: x.y.z-dev
dependencies:
    codeql/cpp-all: "*"
    codeql/suite-helpers: "*"
suites: codeql-suites
defaultSuiteFile: codeql-suites/cpp-code-scanning.qls

Notas adicionales sobre las propiedades siguientes:

• dependencies: este paquete de consultas depende de codeql/cpp-all y codeql/suite-helpers. Dado que estas dependencias se resuelven a partir del código fuente, no importa con qué versión del paquete CodeQL sean compatibles. Para obtener más información sobre cómo resolver dependencias del origen, consulte Dependencias de origen.

• suites: indica el directorio que contiene conjuntos de consultas "conocidos".

• defaultSuiteFile: nombre del archivo de conjunto de consultas predeterminado que se usa cuando no se especifica ningún conjunto de consultas.

Pruebas para el paquete base CodeQL

Este es un archivo qlpack.yml de ejemplo para el paquete de pruebas principal de pruebas de análisis de C/C++:

name: codeql/cpp-tests
dependencies:
  codeql/cpp-all: "*"
  codeql/cpp-queries: "*"
extractor: cpp
tests: .

Notas adicionales sobre las propiedades siguientes:

• dependencies: este paquete depende de los paquetes de consulta y biblioteca principales CodeQL para C++.

• extractor: especifica que todas las pruebas usarán el mismo extractor de C++ para crear la base de datos para las pruebas.

• tests: especifica la ubicación de las pruebas. En este caso, las pruebas se encuentran en la carpeta raíz (y todas las subcarpetas) del paquete.

• version: no hay ninguna propiedad version para el paquete de pruebas. Esto impide que los paquetes de pruebas se publiquen accidentalmente.