Общая информация
Утилита rtadmin – это консольное приложение для автоматизации операций форматирования и администрирования устройств Рутокен.
Функциональные возможности:
- получение списка подключенных к компьютеру устройств Рутокен;
- выбор устройства Рутокен для настройки по его серийному номеру;
- исключение устройства Рутокен из настройки по его серийному номеру;
- получение информации об устройстве Рутокен;
- форматирование устройства Рутокен;
- создание и управление PIN-кодами;
- установка и смена метки устройства Рутокен;
- создание и управление разделами Flash-памяти (для Рутокен ЭЦП 2.0 Flash);
- настройка сенсорной кнопки устройства Рутокен (при ее наличии);
- логирование процесса форматирования и администрирования устройства Рутокен.
Язык интерфейса утилиты – английский.
Режимы работы утилиты:
- одиночный – утилита настраивает только одно подключенное устройство Рутокен. Если подключено несколько устройств Рутокен, необходимо использовать параметры фильтрации, иначе выводится ошибка;
- параллельный – настройка всех подключенных устройств Рутокен осуществляется одновременно.
По умолчанию утилита работает в одиночном режиме.
Для настройки устройств Рутокен в параллельном режиме необходимо указать соответствующий параметр при вызове команды.
Поддерживаемые устройства
- Рутокен Lite;
- Рутокен ЭЦП 2.0;
- Смарт-карты Рутокен ЭЦП 2.0;
- Рутокен ЭЦП 2.0 Flash;
- Рутокен ЭЦП 3.0;
- Рутокен ЭЦП 3.0 NFC;
- Смарт-карты Рутокен ЭЦП 3.0;
- Смарт-карты Рутокен ЭЦП 3.0 NFC;
- устройства Рутокен с сенсорной кнопкой.
Утилита предназначена для работы только с устройствами Рутокен производства компании "Актив-софт".
Утилита не поддерживает работу с устройствами Рутокен S и Рутокен TLS.
Поддерживаемые платформы
- Операционные системы Linux (ARM (64 бит) и х86_64):
- Ubuntu 18.04 и новее;
- Debian 10 и новее;
- CentOS 7 и новее;
- Fedora 36 и новее;
- RHEL 7 и новее;
- Astra Linux 1.6 и новее (включает работу в режиме замкнутой программной среды (ЗПС));
- РОСА "КОБАЛЬТ" ФСТЭК;
- РЕД ОС 7.3 и новее;
- Альт СП 8.4, релиз 10 и новее, Альт 9/10 и новее.
- операционная система macOS 10.15 (ARM (64 бит) и х86_64) и новее;
- операционная система Windows 10 (х86_64) и новее.
Утилита не предназначена для работы на виртуальных машинах.
Команды и параметры утилиты
Утилита поддерживает только однократное выполнение команды (команда автоматически завершается после выполнения).
Команда | Описание команды | Параметр | Описание параметра | Значение параметра по умолчанию |
---|---|---|---|---|
Общие (глобальные) параметры | ||||
| Получить описание и параметры команды, указанной вместо [command] | - | ||
--parallel | Одновременное выполнение команды на всех подключенных устройствах Рутокен (параллельный режим работы) | - | ||
Параметры фильтрации | ||||
| Исключить из настройки устройства Рутокен с указанными серийными номерами. Серийный номер указывается в формате DEC | - | ||
| Выбор одного определенного устройства Рутокен для настройки по его серийному номеру. Серийный номер указывается в формате DEC | - | ||
Параметры логирования | ||||
--log-file arg | Записывать процесс выполнения команды в указанный файл | |||
--no-log | Не записывать процесс выполнения команды | |||
Информационные команды | ||||
help | Получить перечень команд и параметров для настройки устройства Рутокен | - | - | - |
| Получить информацию об устройстве Рутокен, подключенном к компьютеру. По умолчанию утилита отображает информацию только об одном устройстве Рутокен. Если к компьютеру подключено несколько устройств Рутокен, необходимо использовать параметры фильтрации -s, -e или глобальный параметр --parallel, иначе выводится ошибка | - | - | - |
| Получить список устройств Рутокен, подключенных к компьютеру | - | - | - |
| Получить информацию о версии утилиты | - | - | - |
Команды для управления PIN-кодами | ||||
| Создать Локальный PIN-код | |||
| Способ ввода PIN-кода Пользователя устройства Рутокен для авторизации. Доступные значения:
| options | ||
| Значение PIN-кода Пользователя для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового Локального PIN-кода. Доступные значения:
| options | ||
| Значение нового Локального PIN-кода. Параметр используется в случае, если выбран способ ввода options | - | ||
| Идентификатор нового Локального PIN-кода. Представляет собой натуральное число. Минимальное значение идентификатора – 3 | - | ||
| Заблокировать возможность использования и настройки устройства Рутокен Пользователем до момента смены его PIN-кода |
| Способ ввода PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
set-local-pin | Изменить Локальный PIN-код |
| Способ ввода текущего Локального PIN-кода. Доступные значения:
| options |
| Значение текущего Локального PIN-кода. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового значения Локального PIN-кода. Доступные значения:
| options | ||
| Новое значение Локального PIN-кода. Параметр используется в случае, если выбран способ ввода options | - | ||
| Идентификационный номер изменяемого Локального PIN-кода. Представляет собой натуральное число. Минимальное значение идентификатора – 3 | - | ||
| Изменить PIN-код Администратора устройства Рутокен |
| Способ ввода текущего значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Текущее значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового значения PIN-кода Администратора устройства Рутокен:
| options | ||
| Новое значение PIN-кода Администратора. Параметр используется в случае, если выбран способ ввода options | - | ||
| Изменить PIN-код Пользователя устройства Рутокен |
| Способ ввода текущего значения PIN-кода владельца устройства Рутокен, который может менять PIN-код Пользователя, для авторизации. Доступные значения:
| options |
| Текущее значение PIN-кода владельца устройства Рутокен для авторизации. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового значения PIN-кода Пользователя устройства Рутокен. Доступные значения:
| options | ||
| Новое значение PIN-кода Пользователя. Параметр используется в случае, если выбран способ ввода options | - | ||
--auth-as arg | Тип владельца устройства Рутокен, который изменяет PIN-код Пользователя. Доступные значения:
| - | ||
Команды для управления Рутокеном | ||||
| Форматировать устройство Рутокен |
| Способ ввода текущего значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Текущее значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового значения PIN-кода Пользователя устройства Рутокен. Доступные значения:
Если способ ввода и новое значение PIN-кода Пользователя не указаны, будет установлен PIN-код по умолчанию: 12345678 | options | ||
| Новое значение PIN-кода Пользователя. Параметр используется в случае, если выбран способ ввода options | - | ||
| Способ ввода нового значения PIN-кода Администратора устройства Рутокен. Доступные значения:
Если способ ввода и новое значение PIN-кода Администратора не указаны, будет установлен PIN-код по умолчанию: 87654321 | options | ||
| Новое значение PIN-кода Администратора. Параметр используется в случае, если выбран способ ввода options | - | ||
-l arg | Значение метки устройства Рутокен. Если параметр отсутствует, устанавливается метка по умолчанию: "модель устройства Рутокен" <no label> | - | ||
| Минимальная длина PIN-кода Администратора (в байтах) | 6 | ||
| Минимальная длина PIN-кода Пользователя (в байтах) | 6 | ||
| Максимальное количество попыток ввода неверного PIN-кода Администратора устройства Рутокен | 10 | ||
| Максимальное количество попыток ввода неверного PIN-кода Пользователя устройства Рутокен | 10 | ||
| Форматирование в режиме без предъявления PIN-кода Администратора. При его использовании параметры -P (--auth-pin-input) и | - | ||
| Политика смены PIN-кода Пользователя. Доступные значения:
| user | ||
| Форматировать Flash-память устройства Рутокен |
| Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Параметры создаваемых разделов. Указываются в виде: <Size>:<Access mode>:<Owner> где: Size – размер раздела (в Мб); Access mode – режим доступа к разделу.
Owner – владелец раздела.
| - | ||
set-label | Установить метку Рутокена |
| Способ ввода значения PIN-кода Пользователя для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Пользователя для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Новое значение метки | - | ||
| Установить политики качества PIN-кода Пользователя |
| Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
| Минимальная длина PIN-кода Пользователя (в символах) | - | ||
| Глубина истории устанавливаемых PIN-кодов. Применяется для запрета установки PIN-кода, совпадающего с одним из ранее использовавшихся. Глубина измеряется в количестве PIN-кодов и не должна превышать 10 | - | ||
| Разрешить использовать PIN-код по умолчанию. Доступные значения:
| - | ||
| PIN-код должен содержать хотя бы одну цифру. Доступные значения:
| - | ||
| PIN-код должен содержать хотя бы одну заглавную букву. Доступные значения:
| - | ||
| PIN-код должен содержать хотя бы одну строчную букву. Доступные значения:
| - | ||
| PIN-код должен содержать хотя бы один специальный символ. Доступные значения:
| - | ||
| Запрещать устанавливать PIN-код, состоящий из одного повторяющегося символа. Доступные значения:
| - | ||
| Разрешить изменение политик качества PIN-кода Пользователя. Доступные значения:
| true | ||
| Удалить политики качества PIN-кода Пользователя после форматирования устройства Рутокен. Доступные значения:
| true | ||
set-touch-settings | Настроить сенсорную кнопку устройства Рутокен |
| Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - | ||
--mode arg | Способ подтверждения двух и более последовательных операций подписи. Доступные значения:
| - | ||
--present-time-limit arg | Время после нажатия на сенсорную кнопку, в течение которого подтверждается операция подписи (в секундах). Временной диапазон от 0 до 5 секунд, где:
| - | ||
--action-timeout arg | Время ожидания нажатия на сенсорную кнопку для подтверждения операции подписи (в секундах). Временной диапазон от 5 до 30 секунд | - | ||
| Изменить доступ к разделу | -P arg | Способ ввода значения PIN-кода владельца раздела для авторизации. Доступные значения:
| options |
| Значение PIN-кода владельца раздела для авторизации. Параметр используется в случае, если выбран способ ввода options | - | ||
--volume-id arg | Идентификатор раздела | - | ||
--new-mode arg | Новый режим доступа к разделу.
| - | ||
--temp | Параметр опциональный (не является обязательным). Если он указан, то измененный режим доступа к разделу действует до первого отключения устройства Рутокен от компьютера, после чего возвращается предыдущий режим доступа | |||
| Разблокировать PIN-код Пользователя и все Локальные PIN-коды |
| Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен. Доступные значения:
| options |
| Значение PIN-кода Администратора для авторизации на устройстве Рутокен. Параметр используется в случае, если выбран способ ввода options | - |
Информация об устройстве Рутокен
Утилита передает пользователю следующую информацию об устройстве Рутокен:
- метку;
- серийный номер;
- модель с номером – для устройств Рутокен без самоидентификации;
Пример:
11.22.33.44 ECP 2.0 - версию и линейку – для устройств Рутокен с самоидентификацией.
Пример:
Смарт-карта Рутокен ЭЦП 3.0 3100 NFC
- объем свободной и общей памяти (в Кб);
- минимальную и максимальную допустимую длину PIN-кода Пользователя (в байтах);
- минимальную и максимальную допустимую длину PIN-кода Администратора (в байтах);
- количество попыток ввода неверного PIN-кода Пользователя (осталось/всего);
- количество попыток ввода неверного PIN-кода Администратора (осталось/всего);
- политика смены PIN-кода Пользователя;
- аппаратные политики качества PIN-кода Пользователя (для линейки устройств Рутокен ЭЦП 3.0):
- разрешение на изменение политик качества PIN-кода Пользователя;
- разрешение на удаление политик качества PIN-кода Пользователя после форматирования;
- разрешение использовать PIN-код по умолчанию;
- запрет на PIN-код, состоящий из одного повторяющегося символа;
- PIN-код содержит хотя бы одну цифру;
- PIN-код содержит хотя бы одну заглавную букву;
- PIN-код содержит хотя бы одну строчную букву;
- PIN-код содержит хотя бы один специальный символ;
- минимальная длина PIN-кода (в символах);
- глубина истории устанавливаемых PIN-кодов.
- информацию о размере Flash-памяти и атрибутах ее разделов (для устройств Рутокен ЭЦП 2.0 Flash):
- размер Flash-памяти (в Мб);
- размер свободной Flash-памяти (в Мб);
- информация о разделах:
- идентификатор раздела;
- размер раздела (в Мб);
- режим доступа к разделу;
- владелец раздела.
- информацию о настройках сенсорной кнопки:
- способ подтверждения двух и более последовательных операций подписи;
- время после нажатия на сенсорную кнопку, в течение которого подтверждается операция подписи (в секундах);
- время ожидания нажатия на сенсорную кнопку для подтверждения операции подписи (в секундах).
Форматирование
Утилита поддерживает 3 режима форматирования устройства Рутокен:
- с заданными параметрами.
Устанавливаются значения параметров, указанных в команде; с параметрами по умолчанию.
Устанавливаются значения параметров по умолчанию;
- без предъявления PIN-кода Администратора.
Предназначен для форматирования устройства Рутокен в случаях, когда PIN-код Администратора утерян или заблокирован (превышен лимит ввода неверных PIN-кодов).
Утилита блокирует PIN-код Администратора, после чего форматирует устройство Рутокен с установкой заданных параметров или параметров по умолчанию.
Особенности форматирования Рутокен ЭЦП 2.0 Flash
- в режиме без предъявления PIN-кода Администратора форматируется и внутренняя память, и Flash-память устройства;
- в других режимах форматируется только внутренняя память устройства;
- для форматирования только Flash-памяти используется отдельная команда, которая позволяет:
- создавать разделы;
- назначать разделам владельцев;
- назначать режим доступа к разделу.
Создание и управление PIN-кодами
Операции с PIN-кодами
В утилите доступны следующие операции с PIN-кодами:
- создание и смена Локальных PIN-кодов;
- смена PIN-кода Администратора;
- смена PIN-кода Пользователя;
- установка и смена политик качества PIN-кода Пользователя;
- блокировка использования и настройки устройства Рутокен Пользователем до момента смены его PIN-кода;
- установка политик смены PIN-кода Пользователя;
- разблокирование Локальных PIN-кодов и PIN-кода Пользователя при предъявлении PIN-кода Администратора.
Создание и смена PIN-кода
Утилита поддерживает 2 способа создания и смены PIN-кодов на устройстве Рутокен:
- вручную – через консольное окно утилиты;
- автоматическую – PIN-код генерируется утилитой.
Ручная
При данном способе владелец устройства Рутокен вводит новый PIN-код вручную в консольное окно утилиты.
При этом новый PIN-код необходимо вводить:
- однократно.
Если он передается в качестве параметра команды.
Новый PIN-код отображается в консоли в явном виде; - дважды.
Если он вводится по приглашению из консоли.
Первый раз – задание нового PIN-кода, второй – его подтверждение.
Если введенные значения отличаются друг от друга, выводится сообщение об ошибке.
При вводе новый PIN-код отображается в маскированном виде.
Автоматическая
При данном способе утилита генерирует в соответствии с установленными ограничениями новый PIN-код и далее передает его на устройство Рутокен для установки.
Сгенерированный PIN-код отображается в лог-файле в явном виде.
Доступ к разделам Flash-памяти
Для смены режима доступа к разделу Flash-памяти устройства Рутокен утилита запрашивает только PIN-код владельца раздела. Тип владельца определяется автоматически на основании информации о разделе.
Утилита поддерживает следующие режимы доступа:
- скрытый раздел;
- раздел только для чтения;
- раздел для чтения и записи;
- эмулятор CD-ROM.
Новый режим может действовать на протяжении следующего периода времени:
- временно – до первого отключения устройства Рутокен от компьютера, после чего возвращается предыдущий режим;
- постоянно.
По умолчанию период действия нового режима доступа – постоянно.
Период действия режима доступа на CD – только постоянно.
Запрещено временно изменять режим доступа:
- раздела на CD;
- CD раздела на другие.
Логирование
Процесс выполнения всех команд, изменяющих состояние устройства Рутокен, записывается в лог-файл.
По умолчанию логирование включено. При этом в консоль выводится информация о:
- возникшей ошибке;
- статусе выполнения команды.
Для отмены логирования команды используется параметр --no-log. При этом в консоль выводится информация о:
- возникшей ошибке;
- статусе выполнения команды;
- новом PIN-коде (при выполнении команды о смене PIN-кода). PIN-код, сгенерированный утилитой, отображается в явном виде, заданный пользователем – в маскированном (***).
По умолчанию лог-файл хранится в каталоге утилиты, в папке rtadmin-logs. Наименование файла rtadmin_"серийный номер устройства Рутокен".log. При этом для каждого настраиваемого устройства Рутокен создается свой лог-файл.
Для выбора другого лог-файла используется параметр --log-file. При этом логирование настраиваемых устройств Рутокен записывается в один файл.
Лог-файл представляет собой файл со строками следующего содержания:
временная метка выполнения операции в формате ГГГГ.ММ.ДД_ЧЧ.ММ.СС;
- серийный номер устройства Рутокен;
- модель устройства Рутокен;
- название выполненной команды;
- параметры выполненной команды, за исключением способа ввода данных и данных для авторизации на устройстве Рутокен;
Если при создании или смене PIN-кода (Локального, Администратора или Пользователя) новое значение вводится вручную (через консольное окно утилиты), то в лог-файле оно отображается в маскированном виде (***), если генерируется утилитой – в явном виде.
- статус выполнения команды.
Примеры лог-файлов
Форматирование
timestamp: 2024.06.03_17.31.47 serial: 1132293975 model: 65.04.30.02 ECP 3.0 format label: "" min-so-pin: 6 min-user-pin: 6 max-so-pin-retry-count: 10 max-user-pin-retry-count: 10 pin-change-policy: user repair: true new-user-pin: *** new-so-pin: *** status: success
Создание Локального PIN-кода
timestamp: 2024.06.03_17.17.45 serial: 1132293975 model: 65.04.30.02 ECP 3.0 create-local-pin local-id: 6 new-pin: *** status: success
Смена метки
timestamp: 2024.06.03_17.33.28 serial: 1132293975 model: 65.04.30.02 ECP 3.0 set-label label: "ECP" status: success
Примеры использования утилиты
Отформатировать устройство Рутокен с заданными параметрами:
rtadmin format -p 87654321 --new-user-pin 123456789 --new-so-pin 987654321 -l Rutoken_ECP --min-so-pin 8 --min-user-pin 7 --max-so-pin-retry-count 9 --max-user-pin-retry-count 9 --pin-change-policy so
Отформатировать Flash-память устройства Рутокен:
rtadmin format-drive -P console --volume 5287:rw:so --volume 3000:rw:user
Создать Локальный PIN-код:
rtadmin create-local-pin --auth-pin 12345678 --new-pin 132456789 --local-id 7
Установить политики качества PIN-кода Пользователя:
rtadmin set-pin-policy -p 87654321 --min-length 8 --history-depth 9 --allow-default 1 --digit-required true --uppercase-required 0 --lowercase-required false --spec-char-required false --diff-chars-required 1 --allow-change-policy 1 --remove-on-format 1
Выбрать другой лог-файл:
rtadmin format -r --log-file C:\PerfLogs\log\test.log