     [file version.texi not included]

В этом файле описано использование и устройство PINENTRY.

Это редакция EDITION (UPDATED) Руководства по
pinentry для версии VERSION.

Опубликовано g10 Code GmbH
 Hüttenstr. 61
 40699 Erkrath, Германия

Copyright © 2002, 2005, 2015 g10 Code GmbH

Copyright © 2016 Ineiev <ineiev@gnu.org> (translation)

Разрешается копировать, распространять и модифицировать этот документ на
условиях Стандартной общественной лицензии GNU в том виде, в каком она
опубликована Фондом свободного программного обеспечения; либо версии 3 этой
лицензии, либо (по вашему выбору) любой более поздней версии. Текст лицензии
находится в разделе, озаглавленном «Copying».

Введение
********

В этом руководстве описано пользование программой PINENTRY и ее протокол.

Программа PINENTRY представляет небольшое интерактивное приложение для ввода PIN или фраз-паролей. Обычно оно вызывается программой GPG-AGENT (see Вызов gpg-agent (Руководство по Охране приватности GNU)).

Есть несколько вариантов PINENTRY, которые отличаются внешним видом в зависимости от библиотеки пользовательского интерфейса: pinentry-gtk (на базе GTK+), pinentry-qt (на базе QT), а также два текстовых, pinentry-curses (на базе curses) и pinentry-tty, который не требует ничего, кроме простого терминала. Некоторые из них у вас могут быть не установлены. Если в вашей системе поддерживается библиотека curses, графические варианты используют ее как запасной вариант, когда переменная DISPLAY не установлена.

Как пользоваться PINENTRY
*************************

Программу PINENTRY можно запустить прямо из командной строки и выполнять команды по протоколу Assuan через стандартные потоки ввода и вывода.

Вот список параметров, которые поддерживают все варианты PINENTRY:

--version
     Вывести версию программы и лицензионные сведения.

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

--debug
-d
     Включить некоторый отладочный вывод. Полезно в основном для разработчиков. Обратите внимание, что это может раскрывать такие важные данные, как фраза-пароль.

--no-global-grab
-g
     Перехватывать клавиатуру, только когда окно активно. Этот параметр предназначен для отладки программ, пользующихся PINENTRY; без него у вас не будет доступа к сеансу X (если у вас нет других средств подключиться к машине, чтобы снять PINENTRY с выполнения).

--parent-wid N
     Пользоваться окном с данным идентификатором как порождающим окном для размещения окна. Обратите внимание, что это полностью поддерживается не во всех вариантах PINENTRY.

--timeout СЕКУНДЫ
     Прекратить ожидание ввода от пользователя после указанного числа секунд, возвратив ошибку. Возвращается та же ошибка, как при нажатии кнопки отмены. Чтобы программа ожидала ввода неопределенно долго, задайте в качестве аргумента 0 (что является исходным значением).

--display СТРОКА
--ttyname СТРОКА
--ttytype СТРОКА
--lc-ctype СТРОКА
--lc-messages СТРОКА
     Эти параметры предназначены для передачи в PINENTRY сведений о локализации. Они необходимы, поскольку PINENTRY обычно вызывается каким-то фоновым процессом, в котором нет никакой информации о языке и терминале, которые будут использоваться. Эти параметры можно передать также с помощью параметров протокола Assuan.

Пользовательские оболочки
*************************

Есть несколько разных вариантов PINENTRY, а именно, варианты Gtk+2, Qt 4, Gnome 3, Emacs, curses и tty. Эти различные реализации обеспечивают интеграцию с конкретной средой на более высоком уровне. Например, вариант Gnome 3 отображает запросы с помощью элементов Gnome 3. Для пользователей Gnome 3 этот повышенный уровень интеграции обеспечивает эстетически цельную среду. Однако есть и недостатки. Такое большое количество компонентов в PINENTRY снижает надежность. В частности, больше возможностей того, что фраза-пароль будет сохранена в памяти, которая станет доступна для злоумышенника (ср. уязвимость Heartbeet в OpenSSL).

Чтобы понять, сколько компонентов работает с фразой-паролем, рассмотрим ту же реализацию Gnome 3. Когда пользователь нажимает на клавишу, ее код передается из ядра через сервер XWindow в библиотеку (Gtk+) и в само поле ввода текста. По пути код клавиши обрабатывается и сохраняется в памяти. В действительности нажатия на клавиши, вероятно, считываются с помощью функций стандартной библиотеки Си, которая буферирует вводимые символы. Никакие из этих процедур не заботятся о том, чтобы не произошло утечки содержимого памяти; они не сохраняют данные в защищенной от записи на диск памяти и не обнуляют память перед освобождением. Однако даже если бы они это делали, остается проблема с переходом компьютера в спящий режим, когда система все равно записывает защищенные страницы памяти на диск. Далее, многие системы работают в виртуальной среде (например, под Xen) и практически не контролируют свои ресурсы.

Вариант curses пользуется гораздо меньшим наслоением программ, а вариант tty — еще меньшим. Однако если они работают в терминале XWindow, то фразу-пароль обрабатывают примерно столько же компонент, как в случае Gnome 3! Таким образом, для наибольшей безопасности вам нужно направить GPG Agent на пользование фиксированной виртуальной консолью. Поскольку для того, чтобы GPG Agent пользовался этой консолью, вам нужно оставаться в системе, вам нужно работать там, причем screen или tmux должны захватывать tty.

Реализация pinentry на базе Emacs взаимодействует с работающим экземпляром Emacs и дает ему указание отобразить запрос фразы-пароля. Поскольку это не очень-то работает, когда никакой экземпляр Emacs не выполняется, обобщенная механика PINENTRY проверяет, должен ли вызываться Emacs с поддержкой PINENTRY. А именно, проверяется, установлена ли переменная INSIDE_EMACS, а затем предпринимается попытка установить связь по указанному адресу. В этом случае вместо, напр., запуска pinentry-gtk2, вводящего пароль через Gtk+2, программа взаимодействует с сеансом Emacs. Эту функцию можно явным образом выключить с помощью параметра --disable-inside-emacs при запуске configure перед сборкой PINENTRY.

Вводить фразы-пароли с помощью Emacs удобно, однако это сопряжено со значительным риском. Emacs сохраняет в буфере все нажатия на клавиши. (Последние нажатия можно увидеть с помощь комбинации C-h l (view-lossage).) Однако Emacs — огромная программа, она не обеспечивает серьезной изоляции процесса. Таким образом обработка фраз-паролей в Emacs добавляет огромный массив программ, которым пользователю приходится доверять. По этой причине в Emacs это по умолчанию выключено (пользователю нужно явным образом выполнить (pinentry-start), напр., в своем файле .emacs).

Подобно проверке, связанной с Emacs, пользовательские оболочки PINENTRY проверяют, установлена ли переменная DISPLAY и есть ли работающий сервер X. Если это не так, они вызывают как запасной вариант оболочку на базе curses. Это тоже можно отключить во время сборки параметром --disable-fallback-curses при запуске configure.

Протокол Assuan PINENTRY
************************

Программа PINENTRY никогда не должна обслуживать более одного соединения одновременно. Разумно выполнять exec PINENTRY перед запросом.

Программе PINENTRY не обязательно оставаться в памяти, потому что GPG-AGENT способен запоминать фразы-пароли. Обычно c PINENTRY работают, организовывая канал (не сокет) с последующим выполнением fork/exec PINENTRY. Затем средствами описанного здесь протокола осуществляется связь, пока клиент не получает удовлетворительный результат.

Хотя программа называется PINENTRY, она позволяет вводить достаточно длинные строки (все варианты поддерживают строки длиной до 2048 символов). Программа-клиент, пользующаяся PINENTRY, должна проверять корректность.

Обратите внимание, что все строки ожидаются в кодировке UTF-8; PINENTRY преобразует их в местную кодировку. Чтобы вводить символы перевода строки и другие специальные символы, вы можете экранировать их процентом (напр., перевод строки кодируется как %0A, сам знак процента кодируется как %25 и т.д.

Далее приводится список поддерживаемых команд.

Задать время ожидания перед возвратом ошибки

            C: SETTIMEOUT 30
            S: OK

Задать пояснительный текст для отображения

            C: SETDESC Введите PIN Леонида Брежнева <nobody@ussr.gov>
            S: OK

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

            C: SETPROMPT PIN:
            S: OK

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

Задать заголовок окна
     Этой командой можно изменить исходный заголовок окна. При этом нужно позаботиться о том, чтобы можно было понять, что окно относится к PINENTRY.

            C: SETTITLE Камера звукозаписи
            S: OK

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

     Установить текст кнопки, сигнализирующей подтверждение (в UTF-8). Клавиша быстрого доступа устанавливается, как в SETPROMPT.

            C: SETOK Так точно
            S: OK

     Установить текст кнопки, сигнализирующей отмену или несогласие (в UTF-8). Клавиша быстрого доступа устанавливается, как в SETPROMPT.

            C: SETCANCEL Отставить
            S: OK

     Когда требуется три кнопки, следующая команда устанавливает текст (в UTF-8) для неподтверждающей кнопки. Текст для подтверждающей кнопки по-прежнему устанавливается с помощью SETOK, а текст кнопки отмены устанавливается с помощью SETCANCEL. Клавиша быстрого доступа устанавливается, как в SETPROMPT.

            C: SETNOTOK Никак нет
            S: OK

Задать текст ошибки
     С помощью этой команда программа-клиент отображает сообщение об ошибке. В отличие от других команд, сообщение об ошибке автоматически сбрасывается командами GETPIN и CONFIRM и показывается только при запросе PIN.

            C: SETERROR Введен неверный PIN - попробуйте еще раз
            S: OK

Включить индикатор качества фразы-пароля
     Добавить в окно GETPIN индикатор качества. Этот индикатор обновляется в процессе ввода фразы-пароля. Программы-клиенты должны реализовать ответ на запрос «QUALITY», в котором они получают текущую фразу-пароль (экранированную процентом и плюсом) и должны высылать в ответ одно численное значение в диапазоне от -100 до 100. Отрицательные значения будут отображаться красным цветом.

            C: SETQUALITYBAR
            S: OK

     Если для индикатора качества нужна особая метка, добавьте ее текст в качестве аргумента в виде строки, экранированной процентом. Это понадобится для перевода метки, потому что в PINENTRY gettext не используется, кроме строк из библиотеки пользовательского интерфейса.

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

            C: SETQUALITYBAR_TT строка
            S: OK

     Где аргумент — экранированная процентом строка, которая выводится в качестве всплывающей подсказки.

Запрос PIN
     Главное в этой программе — запрос фразы-пароля или PIN, это делается командой:

            C: GETPIN
            S: D баста, карапузики
            S: OK

     Обратите внимание, что фраза-пароль передается открытым текстом с помощью стандартных пакетов с данными. Данные будут в UTF-8.

Запросить подтверждение
     Для запроса подтверждения (да или нет) можно воспользоваться командой:

            C: CONFIRM
            S: OK

     Перед тем как подать эту команду, программа-клиент должна задать соответствующий текст с помощью команды SETDESC; можно также задать тексты кнопок с помощью SETPROMPT. В случае положительного ответа возвращается OK, в других случаях возвращается код ошибки ASSUAN_Not_Confirmed.

Вывести сообщение
     Для вывода сообщения можно воспользоваться командой:

            C: MESSAGE
            S: OK

     Как вариант, можно добавить кнопку для подтверждения:

            C: CONFIRM --one-button
            S: OK

     Перед тем как подать эту команду, программа-клиент должна задать соответствующий текст с помощью команды SETDESC; можно также задать текст кнопки с помощью SETOK. В случае положительного ответа возвращается OK, в других случаях возвращается код ошибки ASSUAN_Not_Confirmed.

Задать устройство вывода
     При пользовании X программу PINENTRY надо вызывать с соответствующей переменной среды DISPLAY или параметром --display.

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

            C: OPTION ttyname=/dev/tty3
            S: OK
            C: OPTION ttytype=vt100
            S: OK
            C: OPTION lc-ctype=de_DE.UTF-8
            S: OK

     Программа-клиент должна пользоваться параметром ttyname, чтобы задать имя выходного файла TTY, параметром ttytype, чтобы задать переменную TERM, соответствующую этому tty, и lc-ctype, чтобы задать параметры локализации, которые определяют кодировку терминала.

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

            C: OPTION default-ok=_Правильно
            S: OK
            C: OPTION default-cancel=Отбой
            S: OK
            C: OPTION default-prompt=Введите PIN:
            S: OK

     В этих строках клавиши быстрого доступа отмечаются, как в SETPROMPT.

Запоминание фраз-паролей

     В некоторых средах, таких как GNOME, пароли запоминаются в буфере. Если задан параметр allow-external-password-cache, а также идентификатор ключа (с помощью SETKEYINFO), PINENTRY пользуется только внешним буфером. В этом случае, если фраза-пароль считывается из буфера, PINENTRY высылает сообщение о состоянии PASSWORD_FROM_CACHE перед тем, как выдать фразу-пароль. Это указывает программе GPG-Agent, что увеличивать счетчик попыток ввода фразы-пароля не нужно.

            C: OPTION allow-external-password-cache
            S: OK
            C: SETKEYINFO код ключа
            S: OK
            C: getpin
            S: S PASSWORD_FROM_CACHE
            S: D 1234
            C: OK

     Замечание: если не задан allow-external-password-cache, внешний буфер паролей использоваться не должен: это может привести к трудноуловимым ошибкам. В частности, если этот параметр не задан, GPG-Agent не учитывает сообщение о состоянии PASSWORD_FROM_CACHE и увеличивает счетчик попыток при пользовании паролем из буфера. Если счетчик попыток равен 1, у пользователя не будет возможности исправить пароль в буфере.

     Замечание: настоятельно рекомендуется, чтобы программа ввода пароля, которая поддерживает эту возможность, предоставляла пользователю возможность ручного включения ее. То есть сохранение фразы-пароля во внешнем диспетчере паролей должно производиться по явному требованию.

     Формат идентификатора ключа, который выдает SETKEYINFO, следует считать недокументированным, в будущем он может изменяться. В настоящее время он принимает вид X/HEXSTRING, где X равен n, s или u. В двух первых случаях HEXSTRING соответствует коду ключа. Код ключа отличается от идентификатора ключа OpenPGP, но соответствие можно установить, выполнив

            # gpg2 --with-keygrip --list-secret-keys

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

Подробности реализации
**********************

Исходный текст программы ввода пароля можно разделить на три части. Есть рабочий модуль, он находится в pinentry/, есть служебные функции, например, в secmem/, и есть различные пользовательские оболочки.

Вся низкоуровневая логика живет в рабочем модуле. Это от необходимости реализовывать, например, протокол Assuan в пользовательских оболочках. Когда рабочий модуль получает параметр, он обновляет состояние в структуре pinentry_t. Пользовательская оболочка вызывается, когда программа-клиент запрашивает GETPIN, CONFIRM или MESSAGE. В этих случаях рабочий модуль задействует функцию pinentry_cmd_handler, в которую передается структура pinentry_t.

Когда задействуется функция обратного вызова, пользовательская оболочка должна создать окно, соответствующее состоянию структуры pinentry_t. Например, заголовок окна (если он есть) хранится в поле title. Если это поле содержит NULL, оболочка должна выбрать подходящее значение. (Исходное значение задается не всегда, потому что для разных инструментариев и сред подходят разные значения.)

Окно должно поддерживать определенное количество различных видов взаимодействия с пользователем. Ниже описано каждый из них.

Подтверждение фразы-пароля

     При создании ключа фразу-пароль нужно ввести дважды. Программа-клиент (обычно это GPG-Agent) информирует PINENTRY об этом с помощью SETREPEAT. В этом случае рабочий модуль записывает в поле repeat_passphrase копию переданной строки. Величина в этом поле должна использоваться в качестве метки для поля повторного ввода.

     Проверять, сходятся ли пароли, должна пользовательская оболочка. Если они не сходятся, оболочка должна отобразить сообщение об ошибке и продолжить запросы к пользователю.

     Если пароли сходятся и пользователь нажал кнопку подтверждения, в поле repeat_okay должно быть занесена величина 1 (в результате рабочий модуль выдает сообщение о состоянии S PIN_REPEATED).

Окно сообщения

     Иногда программе GPG-Agent нужно отобразить сообщение. В этом случае переменная pin равна NULL.

     На уровне Assuan этот режим выбирается с помощью команды MESSAGE или CONFIRM вместо команды GETPIN. Команда MESSAGE не показывает никаких кнопок. То же самое верно для CONFIRM, если задан параметр --one-button. Если в команде CONFIRM этого параметра нет, в соответствующем окне будут кнопки OK, CANCEL, и (не обязательно) NOTOK. Пользовательская оболочка может определить, должна ли быть в окне одна кнопка, анализируя переменную one_button.

Ввод фразы-пароля

     В противном случае GPG-Agent просто запрашивает фразу-пароль. В этом случае нужно показывать кнопки OK и CANCEL.

Во всех трех вариантах вид окна примерно одинаков. Вот элементы, которые определяют вид окна:

title
     Заголовок окна.

description
     Цель вывода окна. При запросе фразы-пароля описывает ключ. При выводе окна сообщения поле содержит текст этого сообщения.

error
     Если GPG-Agent определяет, что фраза-пароль неверна, он снова вызывает GETPIN (настраиваемое число раз) для повторного запроса к пользователю. В этом случае эта переменная содержит описание ошибки. Этот текст обычно нужно выделить тем или иным образом.

prompt, default-prompt
     Строка, связанная с полем ввода фразы-пароля.

     Между prompt и default-prompt есть небольшое различие. default-prompt означает, что можно использовать стилизованный запрос (например, в виде пиктограммы). prompt означает, что запрос несовместим с такой стилизацией, таким образом, пиктограммы применяться не должны.

     Если установлены обе переменные, prompt имеет приоритет.

repeat_passphrase
     Строка, связанная с полем повторного ввода фразы-пароля. Поле повторного ввода нужно показывать, только если она не равна NULL.

ok, default-ok
     Строка, которую нужно написать на кнопке OK.

     Если в строке есть символы _, следующий символ нужно использовать в качестве клавиши быстрого доступа (двойной символ подчеркивания означает, что просто должен быть показан символ подчеркивания). Если пользовательская оболочка не поддерживает клавиши быстрого доступа, то символы подчеркивания следует удалять вручную.

     Между ok и default-ok есть небольшое различие. default-ok означает, что нужно использовать стилизованную кнопку. Например, на ней может быть знак галочки. ok означает, что назначение кнопки не соответствует такой пиктограмме, таким образом, пиктограмма применяться не должна. Таким образом, если на кнопке ok должен быть текст «Пароль не требуется», нужно пользоваться вариантом ok, потому что пиктограмма с галочкой не имеет смысла.

     Если эта переменная равна NULL, пользовательская оболочка должна выбрать подходящее исходное значение.

     Если установлены обе переменные, ok имеет приоритет.

cancel, default-cancel
     Как ok и default-ok, но строки используются для кнопки cancel.

     Если установлен признак one_button, эта кнопка должна отсутствовать.

default-notok
     Как default-ok, но для второй кнопки.

     Эта кнопка должна отображаться только в окне сообщения. Если эти переменные равны NULL или установлен признак one_button, эта кнопка должна отсутствовать.

quality_bar
     Если задано, нужен индикатор качества пароля. Значение этого поля представляет метку для индикатора.

     Замечание: для обновления индикатора при каждом изменении пароля вызывайте функцию pinentry_inq_quality, обновляя соответствующим образом показания индикатора.

quality_bar_tt
     Всплывающая подсказка для индикатора качества.

default_pwmngr
     Если установлены may_cache_password и keyinfo и пользователь выражает согласие, PINENTRY может запоминать пароли во внешнем диспетчере. Замечание: получать согласие пользователя важно, потому что диспетчеры паролей нередко обеспечивают другой уровень безопасности. Если вышеозначенное условие выполняется, а признак tried_password_cache сброшен, то нужно показывать элемент управления-флажок с указанной строкой. В исходном состоянии флажок должен быть сброшен.

default-cf-visi
     Строка, которая выводится с вопросом о том, хотите ли вы подтвердить, что пользователь желает сделать пароль видимым или невидимым.

default-tt-visi
     Всплывающая подсказка для действия, которое открыло бы вводимый пароль.

default-tt-hide
     Всплывающая подсказка для действия, которое скрыло бы пароль, открытый действием default-tt-visi.

После обработки запроса программа по мере необходимости должна сохранить фразу-пароль в pin. Эта переменная размещается в безопасной памяти. Для изменения размера буфера пользуйтесь функцией pinentry_setbufferlen.

Возвращаемый код выхода зависит от того, находится ли окно в режиме вывода сообщения или в режиме ввода фразы-пароля.

В режиме вывода сообщения возвращается 1, когда пользователь нажимает ok; в противном случае возвращается 0. В случае ошибки specific_err или setting locale_err устанавливается в 1 (для ошибок, связанных с локализацией). Если нажата кнопка cancel, переменной canceled присваивается 1. Если нажата кнопка notok, никаких других действий не производится.

В режиме ввода фразы-пароля возвращается 1, если пользователь ввел пароль и нажал ok. В случае ошибки возвращается -1 и устанавливаются specific_err или setting locale_err, как Если нажата кнопка cancel, возвращается -1.

Если окно закрывается, обработчик должен установить переменную close_button, а в остальном действовать, как если бы была нажата кнопка cancel.

     [file gpl.texi not included]