Настройка интерфейса командной строки CodeQL

Настройка CodeQL CLI

Для выполнения команд CodeQL необходимо настроить интерфейс командной строки, чтобы он смог получить доступ к средствам, запросам и библиотекам, необходимым для создания и анализа баз данных.

Можно настроить CodeQL CLI для поддержки различных вариантов использования и структур каталогов. Чтобы быстро приступить к работе, рекомендуется применить относительно простую настройку, как описано в приведенных ниже шагах.

Если вы планируете использовать CodeQL CLI для исследования безопасности или тестирования или участия в запросах, может потребоваться более расширенная настройка CodeQL CLI. Дополнительные сведения см. в разделе Расширенная настройка интерфейса командной строки CodeQL.

Если вы настраиваете CodeQL CLI в системе CI, необходимо сделать полное содержимое пакета CodeQL CLI для каждого сервера CI, для которого требуется выполнить анализ CodeQL code scanning. Например, можно настроить каждый сервер для копирования пакета из центрального внутреннего расположения и извлечения его. Кроме того, можно использовать REST API для получения пакета непосредственно из GitHub, чтобы использовать преимущества последних улучшений запросов. Дополнительные сведения см . в статье AUTOTITLE в документации по REST API.

Если вы используете macOS в Apple Silicon (например, Apple M1), убедитесь, что установлены средства разработчика командной строки Xcode и Rosetta 2 .

1. Скачайте архив tar CodeQL CLI

Пакет скачивания CodeQL CLI — это архив tar, содержащий средства, скрипты и различные файлы данных CodeQL. Если у вас нет лицензии GitHub Enterprise , скачав этот архив, вы согласны с GitHub CodeQL условий.

Загрузите пакет CodeQL из https://github.com/github/codeql-action/releases. Содержимое пакета:

• Продукт CodeQL CLI
• совместимая версия запросов и библиотек из https://github.com/github/codeql;
• предварительно скомпилированные версии всех запросов, включенных в пакет.

Всегда следует использовать пакет CodeQL . Это обеспечивает совместимость и обеспечивает гораздо более высокую производительность, чем отдельная загрузка запросов CodeQL CLI и извлечении запросов CodeQL. Если вы будете запускать CLI только на одной конкретной платформе, скачайте соответствующий файл codeql-bundle-PLATFORM.tar.zst. Кроме того, можно скачать файл codeql-bundle.tar.zst, содержащий CLI для всех поддерживаемых платформ.

Существуют также tar.gz варианты пакета, которые идентичны tar.zst вариантам, кроме сжатых с помощью менее эффективного алгоритма gzip. Единственной причиной скачивания tar.gz вариантов является использование старых средств декомпрессии, которые не поддерживают алгоритм сжатия Zstandard.

2. Извлечение архива tar CodeQL CLI

Извлеките архив данных CodeQL CLI tar в каталог выбранного вами каталога.

3. Запуск codeql

После извлечения можно выполнить процессы CodeQL путем выполнения codeql исполняемого файла несколькими способами:

• Выполнив выполнение <extraction-root>/codeql/codeql, где <extraction-root> находится папка, в которой извлечен пакет CodeQL CLI.
• Добавив <extraction-root>/codeql в PATH, чтобы можно было запустить исполняемый файл просто как codeql.

На этом этапе можно выполнить команды CodeQL. Полный список команд CodeQL CLI см. в разделе "Команды CLI CodeQL вручную".

Тестирование конфигурации CodeQL CLI

После извлечения пакета CodeQL CLI можно выполнить следующую команду, чтобы убедиться, что интерфейс командной строки настроен для создания и анализа баз данных:

• codeql resolve packs, если /<extraction root>/codeql находится в PATH.
• В противном случае — значение /<extraction root>/codeql/codeql resolve packs.

При успешном выполнении вы увидите выходные данные, аналогичные следующему извлечению:

Searching directories specified by `--additional-packs`. All directories have equal priority.
  Searching in:
    No packs were found at this location.
Searching directories specified by `--search-path`. Directories are searched in order.
Searching the root of the CodeQL distribution.
  Searching in:
      <extraction root>
    The following packs were found:
      codeql/java-all@<version>: (library) <extraction root>/qlpacks/codeql/javat-all/<version>/qlpack.yml
      codeql/java-queries@<version>: (query) <extraction root>/qlpacks/codeql/java-queries/<version>/qlpack.yml
      codeql/javascript-all@<version>: (library) <extraction root>/qlpacks/codeql/javascript-all/<version>/qlpack.yml
      codeql/javascript-queries@<version>: (query) <extraction root>/qlpacks/codeql/javascript-queries/<version>/qlpack.yml
      codeql/swift-all@<version>: (library) <extraction root>/qlpacks/codeql/swift-all/<version>/qlpack.yml
      codeql/swift-queries@<version>: (query) <extraction root>/qlpacks/codeql/swift-queries/<version>/qlpack.yml
...

Результаты усечены для краткости. Фактические результаты будут более длинными и более подробными.

Убедитесь, что выходные данные содержат ожидаемые языки, а расположение каталога для файлов qlpack указано верно. Расположение должно находиться в извлеченном пакете CodeQL CLI, показанном в предыдущем примере как <extraction root>. Если CodeQL CLI не удается найти qlpacks для ожидаемых языков, убедитесь, что скачали пакет CodeQL, а не отдельную копию CodeQL CLI.

Можно также запустить codeql resolve languages , чтобы показать, какие языки доступны для создания базы данных. В этом списке перечислены языки, поддерживаемые по умолчанию в пакете CodeQL CLI.

При необходимости можно скачать некоторые пакеты CodeQL, содержащие предварительно скомпилированные запросы, которые вы хотите запустить. Дополнительные сведения см. в разделе Настройка анализа с помощью пакетов CodeQL.

Команда codeql resolve packs полезна для диагностики проблем, когда CodeQL CLI не удается найти пакеты запросов, которые вы ожидаете получить для анализа.

Следующие шаги

Сведения о подготовке кода для анализа с помощью CodeQL CLIсм. в разделе Подготовка кода для анализа CodeQL.