summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDr. David von Oheimb <David.von.Oheimb@siemens.com>2020-05-11 15:31:53 +0200
committerDr. David von Oheimb <David.von.Oheimb@siemens.com>2020-09-10 22:01:07 +0200
commitd3dbc9b50043fd1b4464b3f2b0ab8c54075099d6 (patch)
treedd14564465fa9c3533407049553a0f76a82ab3ae /doc
parentapps_ui.c: Correct handling of empty password from -passin (diff)
downloadopenssl-d3dbc9b50043fd1b4464b3f2b0ab8c54075099d6.tar.xz
openssl-d3dbc9b50043fd1b4464b3f2b0ab8c54075099d6.zip
apps_ui.c: Correct password prompt for ui_method
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/12493)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/UI_new.pod10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man3/UI_new.pod b/doc/man3/UI_new.pod
index 0615e2766c..c3852587eb 100644
--- a/doc/man3/UI_new.pod
+++ b/doc/man3/UI_new.pod
@@ -44,7 +44,7 @@ UI_get_method, UI_set_method, UI_OpenSSL, UI_null - user interface
int UI_dup_error_string(UI *ui, const char *text);
char *UI_construct_prompt(UI *ui_method,
- const char *object_desc, const char *object_name);
+ const char *phrase_desc, const char *object_name);
void *UI_add_user_data(UI *ui, void *user_data);
int UI_dup_user_data(UI *ui, void *user_data);
@@ -149,10 +149,12 @@ as their UI_add counterparts, except that they make their own copies
of all strings.
UI_construct_prompt() is a helper function that can be used to create
-a prompt from two pieces of information: an description and a name.
+a prompt from two pieces of information: a phrase description I<phrase_desc>
+and an object name I<object_name>, where the latter may be NULL.
The default constructor (if there is none provided by the method used)
-creates a string "Enter I<description> for I<name>:". With the
-description "pass phrase" and the filename "foo.key", that becomes
+creates a string "Enter I<phrase_desc> for I<object_name>:"
+where the " for I<object_name>" part is left out if I<object_name> is NULL.
+With the description "pass phrase" and the filename "foo.key", that becomes
"Enter pass phrase for foo.key:". Other methods may create whatever
string and may include encodings that will be processed by the other
method functions.