Общая информация

Утилита rtadmin – это консольное приложение для автоматизации операций форматирования и администрирования устройств Рутокен.

Функциональные возможности:

Язык интерфейса утилиты – английский.

Режимы работы утилиты:

По умолчанию утилита работает в одиночном режиме.

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

Поддерживаемые устройства

Утилита предназначена для работы только с устройствами Рутокен производства Компании "Актив-софт".

Утилита не поддерживает работу с устройствами Рутокен S и Рутокен TLS.

Поддерживаемые платформы

Утилита не предназначена для работы на виртуальных машинах.

Команды и параметры утилиты

Утилита поддерживает только однократное выполнение команды (команда автоматически завершается после выполнения).

КомандаОписание командыПараметрОписание параметра Значение параметра по умолчанию
Общие (глобальные) параметры


[command] -h

или 

[command] --help

Получить описание и параметры команды, указанной вместо [command]-


--parallelОдновременное выполнение команды на всех подключенных устройствах Рутокен (параллельный режим работы)-
Параметры фильтрации


-e arg

или 

--exclude arg

Исключить из настройки устройства Рутокен с указанными серийными номерами.

Серийный номер указывается в формате DEC

-


-s arg

или 

--serial arg

Выбор одного определенного устройства Рутокен для настройки по его серийному номеру.

Серийный номер указывается в формате DEC

-
Параметры логирования


--log-file argЗаписывать процесс выполнения команды в указанный файл


--no-logНе записывать процесс выполнения команды
Информационные команды
helpПолучить перечень команд и параметров для настройки устройства Рутокен---
info

Получить информацию об устройстве Рутокен, подключенном к компьютеру.

По умолчанию утилита отображает информацию только об одном устройстве Рутокен.

Если к компьютеру подключено несколько устройств Рутокен, необходимо использовать параметры фильтрации -s, -e или глобальный параметр --parallel, иначе выводится ошибка

---
list-tokens
Получить список устройств Рутокен, подключенных к компьютеру ---
version
Получить информацию о версии утилиты---
Команды для управления PIN-кодами
create-local-pin




Создать PIN-код локального пользователя






-P arg
или
--auth-pin-input arg

Способ ввода PIN-кода Пользователя устройства Рутокен для авторизации. 

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Пользователя для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
-N arg
или
--new-pin-input arg

Способ ввода PIN-кода локального пользователя.

Доступные значения:

  • console – из консоли по приглашению;
  • options – как параметр;
  • generate – сгенерировать внутри утилиты в соответствии с установленными ограничениями
options
-n arg
или
--new-pin arg

Значение PIN-кода локального пользователя.

Параметр используется в случае, если выбран способ ввода options

-
-i arg
или
--local-id arg

ID локального пользователя, для которого создается PIN-код. 

Представляет собой натуральное число.

Минимальное значение идентификатора – 3

-
force-pin-change


Заблокировать возможность использования и настройки устройства Рутокен пользователем  до момента смены его PIN-кода


-P arg
или
--auth-pin-input arg

Способ ввода PIN-кода Администратора для авторизации на устройстве Рутокен. 

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Администратора для авторизации на устройстве Рутокен.

Параметр используется в случае, если выбран способ ввода options

-
set-local-pin

Изменить PIN-код локального пользователя





-P arg
или
--auth-pin-input arg

Способ ввода текущего значения PIN-кода локального пользователя.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение текущего PIN-кода локального пользователя. 

Параметр используется в случае, если выбран способ ввода options

-
-N arg
или
--new-pin-input arg

Способ ввода нового значения PIN-кода локального пользователя.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр;
  • generate – сгенерировать внутри утилиты в соответствии с установленными ограничениями
options
-n arg
или
--new-pin arg

Новое значение PIN-кода локального пользователя.

Параметр используется в случае, если выбран способ ввода options

-

-i arg
или

--local-id arg

ID локального пользователя, PIN-код которого изменяется.

Представляет собой натуральное число.

Минимальное значение идентификатора – 3

-
set-so-pin
Изменить PIN-код Администратора устройства Рутокен
-P arg
или
--auth-pin-input arg

Способ ввода текущего значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options

-p arg
или
--auth-pin arg

Текущее значение PIN-кода Администратора для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
-N arg
или
--new-pin-input arg

Способ ввода нового значения PIN-кода Администратора устройства Рутокен:

  • console – из консоли по приглашению;
  • options – как параметр;
  • generate – сгенерировать внутри утилиты в соответствии с установленными ограничениями
options
-n arg
или
--new-pin arg

Новое значение PIN-кода Администратора.

Параметр используется в случае, если выбран способ ввода options

-
set-user-pin




Изменить PIN-код Пользователя устройства Рутокен






-P arg
или
--auth-pin-input arg

Способ ввода текущего значения PIN-кода владельца устройства Рутокен, который может менять PIN-код Пользователя, для авторизации.

Доступные значения:

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Текущее значение PIN-кода владельца устройства Рутокен для авторизации.

Параметр используется в случае, если выбран способ ввода options

-
-N arg
или
--new-pin-input arg

Способ ввода нового значения PIN-кода Пользователя устройства Рутокен.

Доступные значения:

  • console – из консоли по приглашению;
  • options – как параметр;
  • generate – сгенерировать внутри утилиты в соответствии с установленными политиками качества PIN-кода
options
-n arg
или
--new-pin arg

Новое значение PIN-кода Пользователя.

Параметр используется в случае, если выбран способ ввода options

-
--auth-as arg

Тип владельца устройства Рутокен, который изменяет PIN-код Пользователя.

Доступные значения:

  • user – пользователь;
  • so – администратор
-
Команды для управления Рутокеном
format




Форматировать устройство Рутокен



-P arg
или
--auth-pin-input arg

Способ ввода текущего значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Текущее значение PIN-кода Администратора для авторизации на устройстве Рутокен.

Параметр используется в случае, если выбран способ ввода options

-
--new-user-pin-input arg

Способ ввода нового значения PIN-кода Пользователя устройства Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр.

Если способ ввода и новое значение PIN-кода Пользователя не указаны, будет установлен PIN-код по умолчанию: 12345678

options

--new-user-pin arg

Новое значение PIN-кода Пользователя.

Параметр используется в случае, если выбран способ ввода options

-
--new-so-pin-input arg

Способ ввода нового значения PIN-кода Администратора устройства Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр.

Если способ ввода и новое значение PIN-кода Администратора не указаны, будет установлен PIN-код по умолчанию: 87654321

options
--new-so-pin arg

Новое значение PIN-кода Администратора.

Параметр используется в случае, если выбран способ ввода options

-
-l arg
или
--label arg		Значение метки устройства Рутокен.
Если параметр отсутствует, устанавливается метка по умолчанию:  "модель устройства Рутокен" <no label>		-
--min-so-pin arg

Минимальная длина PIN-кода Администратора (в байтах)

6
--min-user-pin arg

Минимальная длина PIN-кода Пользователя (в байтах)

6
--max-so-pin-retry-count arg

Максимальное количество попыток ввода неверного PIN-кода Администратора устройства Рутокен

10
--max-user-pin-retry-count arg

Максимальное количество попыток ввода неверного PIN-кода Пользователя устройства Рутокен

10
-r 
или
--repair

Форматирование в режиме без предъявления PIN-кода Администратора.

Параметр опциональный (не является обязательным).

При его использовании параметры -P (--auth-pin-input) и 
-p (--auth-pin) в команде не указываются

-
--pin-change-policy arg

Политика смены PIN-кода Пользователя.

Доступные значения: 

  • so – PIN-код Пользователя может менять только администратор устройства Рутокен;
  • user – PIN-код Пользователя может менять только пользователь устройства Рутокен;
  • both – PIN-код Пользователя могут менять и пользователь, и администратор устройства Рутокен
user
format-drive


Форматировать Flash-память устройства Рутокен

-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Администратора для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
--volume arg

Параметры создаваемых разделов.

Указываются в виде:

<Size>:<Access mode>:<Owner>

где:

Size – размер раздела (в Мб);

Access mode – режим доступа к разделу.
Доступные значения:

  • h – скрытый раздел;
  • r – раздел только для чтения;
  • rw – раздел для чтения и записи;
  • cd – эмулятор CD-ROM.

Owner – владелец раздела.
Доступные значения:

  • so – администратор устройства Рутокен;
  • user – глобальный пользователь устройства Рутокен;
  • local-X – локальный пользователь устройства Рутокен
    (X – идентификационный номер локального пользователя)
-
set-label


Установить метку Рутокена


-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода Пользователя для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Пользователя для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
-l arg
или
--label arg
Новое значение метки-
set-pin-policy











Установить политики качества PIN-кода Пользователя










-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Администратора для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
--min-length arg

Минимальная длина PIN-кода Пользователя (в символах)

-
--history-depth arg

Глубина истории устанавливаемых PIN-кодов.

Применяется  для запрета установки PIN-кода, совпадающего с одним из ранее использовавшихся. 

Глубина измеряется в количестве PIN-кодов и не должна превышать 10

-
--allow-default arg

Разрешить использовать PIN-код по умолчанию.

Доступные значения:

  • true или 1;
  • false или 0
-
--digit-required arg

PIN-код должен содержать хотя бы одну цифру.

Доступные значения:

  • true или 1;
  • false или 0

-

--uppercase-required arg

PIN-код должен содержать хотя бы одну заглавную букву.

Доступные значения:

  • true или 1;
  • false или 0

-

--lowercase-required arg

PIN-код должен содержать хотя бы одну строчную букву.

Доступные значения:

  • true или 1;
  • false или 0

-

--spec-char-required arg

PIN-код должен содержать хотя бы один специальный символ.

Доступные значения:

  • true или 1;
  • false или 0

-

--diff-chars-required arg

Запрещать устанавливать PIN-код, состоящий из одного повторяющегося символа.

Доступные значения:

  • true или 1;
  • false или 0

-

--allow-change-policy arg

Разрешить изменение политик качества PIN-кода Пользователя.

Доступные значения:

  • true или 1;
  • false или 0
true
--remove-on-format arg

Удалить политики качества PIN-кода Пользователя после форматирования устройства Рутокен.

Доступные значения:

  • true или 1;
  • false или 0
true
set-touch-settings



Настроить сенсорную кнопку устройства Рутокен



-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Администратора для авторизации на устройстве Рутокен. 

Параметр используется в случае, если выбран способ ввода options

-
--mode arg

Способ подтверждения двух и более последовательных операций подписи.

Доступные значения: 

  • discrete – отдельное нажатие сенсорной кнопки для каждой подписи;
  • continuous – длительное нажатие сенсорной кнопки для всех подписей
-
--present-time-limit arg

Время после нажатия на сенсорную кнопку, в течение которого подтверждается операция подписи (в секундах). 

Временной диапазон от 0 до 5 секунд, где:

  • 0 – прекращение подтверждения операций подписи сразу после прекращения нажатия на кнопку;
  • 5 – подтверждение операций подписи прекращается через 5 секунд после прекращения нажатия на кнопку
-
--action-timeout arg

Время ожидания нажатия на сенсорную кнопку для подтверждения операции подписи (в секундах).

Временной диапазон от 5 до 30 секунд

-
set-volume-access-mode
Изменить доступ к разделу

-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода владельца раздела для авторизации.

Доступные значения: 

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода владельца раздела для авторизации.

Параметр используется в случае, если выбран способ ввода options

-
--volume-id argИдентификатор раздела-
--new-mode arg

Новый режим доступа к разделу.
Доступные значения:

  • h – скрытый раздел;
  • r – раздел только для чтения;
  • rw – раздел для чтения и записи;
  • cd – эмулятор CD-ROM
-
--temp

Параметр опциональный (не является обязательным). 

Если он указан, то измененный режим доступа к разделу действует до первого отключения устройства Рутокен от компьютера, после чего возвращается предыдущий режим доступа


unblock-pins
Разблокировать PIN-код Пользователя и все PIN-коды локальных пользователей
-P arg
или
--auth-pin-input arg

Способ ввода значения PIN-кода Администратора для авторизации на устройстве Рутокен.

Доступные значения:

  • console – из консоли по приглашению;
  • options – как параметр
options
-p arg
или
--auth-pin arg

Значение PIN-кода Администратора для авторизации на устройстве Рутокен.

Параметр используется в случае, если выбран способ ввода options

-

Информация об устройстве Рутокен

Утилита передает пользователю следующую информацию об устройстве Рутокен:

Самоидентификация поддерживается у устройств Рутокен с микропрограммой версии 32 и новее.

Форматирование

Утилита поддерживает 3 режима форматирования устройства Рутокен:

Особенности форматирования Рутокен ЭЦП 2.0 Flash

Создание и управление PIN-кодами

Операции с PIN-кодами

В утилите доступны следующие операции с PIN-кодами:

Создание и смена PIN-кода

Утилита поддерживает 2 способа создания и смены PIN-кодов на устройстве Рутокен:

Ручная

При данном способе владелец устройства Рутокен вводит новый PIN-код вручную в консольное окно утилиты.

При этом новый PIN-код необходимо вводить:

Автоматическая

При данном способе утилита генерирует в соответствии с установленными ограничениями новый PIN-код и далее передает его на устройство Рутокен для установки.

Сгенерированный PIN-код отображается в лог-файле в явном виде.

Доступ к разделам Flash-памяти 

Информация в данном разделе актуальна только для устройства Рутокен ЭЦП 2.0 Flash.

Для смены режима доступа к разделу Flash-памяти устройства Рутокен утилита запрашивает только PIN-код владельца раздела. Тип владельца определяется автоматически на основании информации о разделе.

Утилита поддерживает следующие режимы доступа:

Новый режим может действовать на протяжении следующего периода времени:

По умолчанию период действия нового режима доступа – постоянно.

Период действия режима доступа на CD – только постоянно. 

Запрещено временно изменять режим доступа:

  • раздела на CD;
  • CD раздела на другие.

Логирование

Процесс выполнения всех команд, изменяющих состояние устройства Рутокен, записывается в лог-файл.

По умолчанию логирование включено. При этом в консоль выводится информация о:

Для отмены логирования команды используется параметр --no-log. При этом в консоль выводится информация о:

По умолчанию лог-файл хранится в каталоге утилиты, в папке rtadmin-logs. Наименование файла rtadmin_"серийный номер устройства Рутокен".log. При этом для каждого настраиваемого устройства Рутокен создается свой лог-файл.

Для выбора другого лог-файла используется параметр --log-file. При этом логирование настраиваемых устройств Рутокен записывается в один файл.

 Лог-файл представляет собой файл со строками следующего содержания:

Если при создании или смене PIN-кода (локального пользователя, Администратора или Пользователя) новое значение вводится вручную (через консольное окно утилиты), то в лог-файле оно отображается в маскированном виде (***), если генерируется утилитой – в явном виде.

Примеры лог-файлов

  1. Форматирование

    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


  2. Создание 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


  3. Смена метки:

    timestamp: 2024.06.03_17.33.28
serial: 1132293975
model: 65.04.30.02 ECP 3.0
set-label
    label: "ECP"
status: success


Примеры использования утилиты

  1. Отформатировать устройство Рутокен с заданными параметрами:

    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


  2. Отформатировать Flash-память устройства Рутокен:

    rtadmin format-drive -P console --volume 5287:rw:so --volume 3000:rw:user


  3. Создать PIN-код локального пользователя:

    rtadmin create-local-pin --auth-pin 12345678 --new-pin 132456789 --local-id 7


  4. Установить политики качества 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


  5. Выбрать другой лог-файл:

    rtadmin format -r --log-file C:\PerfLogs\log\test.log