BearPass

Appearance

BearPass Command Line Interface (CLI) ​

Важно

Доступно только для платных тарифов

Интерфейс командной строки BearPass (CLI) - это инструмент, который позволяет вам взаимодействовать с данными паролей напрямую из терминала. Данная CLI-утилита упрощает получение данных в автоматизациях и скриптах, и особенно полезна для DevOps-инженеров.

CLI поддерживает два способа аутентификации: через API-ключ и через JWT-токен от внешнего OIDC-провайдера. Подробнее о настройке доверенных провайдеров и создании JWT-привязок — в разделе «Аутентификация с использованием JWT-токенов внешних провайдеров».

Узнать о всех возможностях CLI-клиента можно с помощью аргумента --help

shell
Bearpass CLI client

Usage: bearpass <command> [args]

Available commands:
   config    Configure main settings
   get       Get password data

Скачивание и установка ​

Для amd64:

shell
wget https://services.bearpass.ru/downloads/bearpass-amd64.zip
unzip bearpass-amd64.zip
chmod +x bearpass

Для arm64:

shell
wget https://services.bearpass.ru/downloads/bearpass-arm64.zip
unzip bearpass-arm64.zip
chmod +x bearpass

Начало работы ​

Перед началом работы с cli клиентом, его необходимо сконфигурировать.

Это можно сделать с помощью:

  1. Переменных окружения
  2. Запуска команды config

Переменные окружения ​

Установите переменные окружения

  • BEARPASS_API_URL - URL сервера BearPass в формате https://bearpass.company.com/
  • BEARPASS_API_KEY - Ключ API пользователя, через которого будет производиться работа с CLI клиентом
  • BEARPASS_JWT_TOKEN - JWT-токен от внешнего OIDC-провайдера (передается в BearPass для аутентификации)

Запуск команды config ​

Для интерактивной настройки запустите команду ./bearpass config

Процесс конфигурации:

  1. Введите URL сервера BearPass (например, https://bearpass.company.com/).
  2. Выберите метод аутентификации:
  • Введите jwt для использования JWT-токена
  • Нажмите Enter для выбора API-ключа (значение по умолчанию)
  1. Введите учетные данные:
  • Для API-ключа: введите ключ
  • Для JWT: вставьте JWT-токен от внешнего провайдера

Данные будут сохранены в файл ~/.bearpass/config

Важно: При использовании JWT-токена CLI не проверяет его на этапе конфигурации. Проверка произойдет при первом запросе к API.

Для этого запустите команду ./bearpass config Укажите 2 параметра:

  1. URL сервера BearPass в формате https://bearpass.company.com/
  2. Ключ API пользователя, через которого будет производиться работа с CLI клиентом

Данные будут сохранены в файл ~/.bearpass/config

Доступные команды ​

get ​

Получение данных пароля по id

shell
./bearpass get --help

Usage: bearpass get <id> [args]

<id> - Password id as number

Available arguments:
        --field="<string>"      Specify the field to get from BearPass password. Available fields: name, parent_id, type, comment, quality_percent, actual_percent, compromised_count, archived, personal, created_at, version, url, login. For additional fields use syntax: additional_field[field name]. Example: --field="additional_field[port]"

Для получения всех данных пароля необходимо запустить команду в формате bearpass get <id>, например: bearpass get 1.

Стандартный формат ответа - json.

Для получения данных отдельного поля необходимо указать флаг --field=<fieldName>
Все доступные поля: name, parent_id, type, comment, quality_percent, actual_percent, compromised_count, archived, personal, created_at, version, url, login
Для получения данных дополнительного поля необходимо указать additional_field и название поля в кавычках, например --field="additional_field[ip address]"

Примеры:

shell
./bearpass get 2 --field=password
9!2%P0jw^Ns38gW
shell
./bearpass get 2 --field="additional_field[ip address]"
8.8.8.8

config ​

Конфигурация CLI клиента

Особенности работы с JWT-аутентификацией ​

Обновление последнего использования: При каждом успешном запросе (например, bearpass get) в веб-интерфейсе на вкладке JWT-авторизация обновляется дата в колонке «Последнее использование» для соответствующей привязки.

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