Configuración de un área de trabajo de CodeQL

Cuando trabajas con CodeQL, necesitas tener acceso a las bibliotecas y consultas estándar.

Configuración de una CodeQL área de trabajo

Hay varias maneras diferentes de conceder a la extensión acceso a las bibliotecas y consultas estándar desde el repositorio github/codeql:

  • Use el CodeQL área de trabajo de inicio, que contiene una serie de directorios denominados con el formato codeql-custom-queries-LANGUAGE. Estos están listos para empezar a desarrollar sus propias consultas personalizadas para cada lenguaje, mediante las bibliotecas estándar. También hay algunas consultas de ejemplo para empezar. Esta método es el recomendado.

  • Actualice un área de trabajo existente para CodeQL. Este método se recomienda para usuarios avanzados.

  •         CodeQL CLI los usuarios pueden abrir el directorio que contiene su archivo extraído CodeQL CLI .

Nota:

El CodeQL repositorio se incluye como un submódulo en el área de trabajo de inicio. Debe usar git submodule update --remote periódicamente para mantener actualizados los submódulos y asegurarse de que siguen siendo compatibles con las versiones más recientes de la VS Code extensión y CodeQL CLI.

  1. Clona el repositorio vscode-codeql-starter en tu equipo. Asegúrese de incluir los submódulos, ya sea mediante git clone --recursive, o mediante git submodule update --init --remote después de la clonación.

  2. En VS Code, haga clic en Archivo y, a continuación, en Abrir área de trabajo desde archivo... para abrir el archivo desde la vscode-codeql-starter.code-workspace finalización de la compra del repositorio del área de trabajo.

Opción 2: Actualización de un área de trabajo existente para CodeQL (avanzado)

  1. En VS Code, seleccione Archivo y luego Agregar carpeta al espacio de trabajo..., y busque la extracción local del CodeQL repositorio.

  2. Cree un nuevo directorio por idioma de destino para contener consultas y bibliotecas personalizadas, mediante las opciones Nueva carpeta o Agregar carpeta al área de trabajo....

  3. Cree un archivo qlpack.yml en cada directorio de idioma de destino (la rama main de github/codeql ya tiene estos archivos). Esto especifica al CodeQL CLI el idioma objetivo de ese directorio y sus dependencias. CodeQL buscará las dependencias en todos los directorios de área de trabajo abiertos o en la ruta de búsqueda del usuario.

    Por ejemplo, para que un directorio personalizado CodeQL llamado my-custom-cpp-pack dependa de la CodeQL biblioteca estándar para C++, cree un qlpack.yml archivo con el siguiente contenido:

    name: my-custom-cpp-pack
version: 0.0.0
libraryPathDependencies: codeql/cpp-all

    Para obtener más información sobre por qué necesita agregar un archivo qlpack.yml, consulta Personalización del análisis con paquetes de CodeQL.

Opción 3: Abrir el directorio que contiene el archivo extraído CodeQL CLI

Nota:

Para esta opción, debe configurar el CodeQL CLI. Para obtener más información, vea Configuración de la CLI de CodeQL.

En VS Code, abra el directorio donde extrajo el archivo .zip CodeQL CLI para crear el directorio CodeQL (por ejemplo codeql-home).