Начало работы с интерфейсом командной строки Checks

Интерфейс командной строки Checks CLI интегрирует функциональность Checks в ваш рабочий процесс разработки. Вы можете запускать CLI локально, в конвейере CI/CD или с помощью других типов скриптов и автоматизации.

Для настройки и использования интерфейса командной строки Checks необходимо выполнить следующие шаги:

  1. Установите Checks CLI.
  2. Аутентифицируйте свой компьютер.
  3. Интегрируйте и используйте Checks CLI, выполняя команды из командной строки или интегрируя Checks CLI в вашу среду CI/CD .

Настройка интерфейса командной строки для проверок

Установить или обновить Checks CLI можно с помощью автономных исполняемых файлов, указанных в таблицах, как для Linux, так и для macOS.

После установки Checks CLI необходимо пройти аутентификацию. Затем вы можете приступить к тестированию и устранению уязвимостей, начиная с проверки вашей установки.

Установка с помощью автономных исполняемых файлов.

Checks предоставляет ссылки для загрузки автономных исполняемых файлов последней версии и для конкретных версий. Например, следующие ссылки предназначены для macOS и Linux:

Например, чтобы загрузить и запустить последнюю версию Checks CLI на macOS, выполните следующую команду:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Убедитесь, что вы установили менеджер пакетов и все необходимые сторонние инструменты.
  2. Загрузите исполняемый файл Checks CLI для вашей платформы:

Linux

Платформа

Упаковка

Размер

Контрольная сумма SHA256

Linux

checks-linux

35,1 МБ

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Сделайте исполняемый файл исполняемым, выполнив команду chmod +x ./checks . ( Необязательно ) Переместите исполняемый файл в место, где вы сможете запускать его глобально: mv ./checks /usr/local/bin/

macOS

Платформа

Упаковка

Размер

Контрольная сумма SHA256

macOS

checks-macos

29,4 МБ

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Сделайте исполняемый файл исполняемым, выполнив команду chmod +x ./checks ( необязательно ). Переместите исполняемый файл в место, где вы сможете запускать его глобально: mv ./checks /usr/local/bin/

Windows

Платформа

Упаковка

Размер

Контрольная сумма SHA256

Windows 8.1 и более поздние версии, а также Windows Server 2012 и более поздние версии.

checks-win.exe

29,5 МБ

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

( Необязательно ) Переименуйте файл в checks.exe , чтобы вы могли запускать команды проверки в соответствии с документацией, например, с checks help .

Обновите CLI до последней версии.

Чтобы убедиться, что вы получаете самые новые функции и исправления ошибок, мы рекомендуем регулярно проверять наличие обновлений для интерфейса командной строки.

Вы можете загрузить новую версию из предыдущих таблиц, а затем заменить ею предыдущую версию в вашей системе.

Проверьте установку.

После аутентификации вы можете проверить установку. Для быстрой проверки запустите checks --help .

Дополнительная информация

Выполните checks --help или просмотрите сводку команд и параметров командной строки.

Получение поддержки

Отправляйте электронные письма по адресу checks-support@google.com, если вам нужна помощь с интерфейсом командной строки Checks или с Checks в целом.

Аутентификация CLI

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

Сервисный аккаунт — это аккаунт Google Cloud, связанный с вашим проектом Google Cloud, а не с конкретным пользователем. Сервисные аккаунты полезны для настройки проверок в среде непрерывной интеграции (CI).

Пользовательская учетная запись — это учетная запись Google, которая имеет доступ к вашей учетной записи Checks. Это лучший вариант для использования интерфейса командной строки Checks из командной строки.

Аутентификация с использованием служебной учетной записи.

  1. Откройте консоль Google Cloud и выберите свой проект.
  2. В библиотеке API включите API проверок .
  3. Для создания сервисной учетной записи для вашего проекта перейдите на страницу «Сервисные учетные записи IAM» в консоли Google Cloud. Нажмите «Создать сервисную учетную запись» и введите данные сервисной учетной записи.
    1. Создайте закрытый JSON-ключ для вашей новой учетной записи службы и переместите его в место, доступное для вашей среды сборки. Обязательно храните этот файл в безопасном месте , поскольку он предоставляет администраторский доступ к проверкам.
    2. При использовании CLI установите переменную среды CHECKS_CREDENTIALS указав путь к JSON-файлу вашего закрытого ключа. Если вы используете плагин Checks CI/CD, обратитесь к документации плагина, чтобы узнать, как указать учетные данные.
  4. Чтобы предоставить учетной записи службы доступ к вашей учетной записи Checks, добавьте адрес электронной почты и назначьте ей роль « Владелец» на странице настроек консоли Checks. Дополнительную информацию о приглашении пользователей в вашу учетную запись Checks см. в разделе «Управление доступом команды» .

Аутентификация с помощью учетной записи пользователя.

Важно: если вы подключаетесь через SSH, перенаправьте порт 9005.

  1. Войдите в Checks CLI, используя свою учетную запись Google, с помощью следующей команды: checks login

    Эта команда подключает ваш локальный компьютер к Checks и предоставляет вам доступ к вашим счетам в Checks.

    • Используйте checks login --reauth если вы уже входили в систему, но хотите переключиться на другую учетную запись Google.
    • Используйте checks logout , чтобы выйти из системы.

  2. Откройте сгенерированный URL-адрес аутентификации в браузере.

  3. Войдите в свой аккаунт Google.

  4. Предоставьте компании Checks разрешение на доступ к вашему счету Checks.