2.6.7 Запросить фразу-пароль

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

  GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] \
                 [--qualitybar] идентификатор буфера    \
                 [сообщение об ошибке приглашение описание]

В аргументе идентификатор буфера передается строка, указывающая на сохраненную фразу-пароль. Чтобы не пользоваться буфером, задайте X. Без других аргументов gpg-agent выдает сохраненную фразу-пароль или ошибку. По соглашению в качестве идентификатора используется либо шестнадцатеричный отпечаток ключа, либо произвольная строка, в начале которой стоит имя вызывающего приложения с двоеточием, например, gpg:что-то-там.

Аргумент сообщение об ошибке представляет либо один X, если сообщения нет, либо сообщение, которое нужно показать при ошибке (напр., «неверная фраза-пароль»). Пробелы должны быть экранированы процентом или заменяться на +.

Аргумент приглашение представляет либо один X, если исходное приглашение не заменяется, либо текст, который показывается в качестве приглашения. Пробелы должны быть экранированы процентом или заменяться на +.

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

Агент отвечает сообщением об ошибке либо «OK» с последующей фразой-паролем в шестнадцатеричном виде. Обратите внимание, что длина строк неявно ограничивается максимальной длиной команды. Если задан параметр --data, фраза-пароль возвращается не в строке с «OK», а в обычных строках данных; этот метод предпочтителен.

Если задан параметр --check, проверяются обычные ограничения на фразу-пароль. Проверка не проводится, если фраза-пароль найдена в буфере.

Если задан параметр --no-ask, а фраза-пароль не находится в буфере, фраза-пароль у пользователя запрашиваться не будет; вместо этого будет возвращаться GPG_ERR_NO_DATA.

Если задан параметр --qualitybar и установлена минимальная длина фразы-пароля, то показывается визуальный индикатор качества вводимой фразы-пароля.

  CLEAR_PASSPHRASE идентификатор буфера

Сбросить фразу-пароль в буфере. Функция возвращает «OK», даже когда такой фразы-пароля нет.