doc/crypto/UI_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 UI,
   6 UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string,
   7 UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean,
   8 UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string,
   9 UI_add_error_string, UI_dup_error_string, UI_construct_prompt,
  10 UI_add_user_data, UI_get0_user_data, UI_get0_result, UI_process,
  11 UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method,
  12 UI_set_method, UI_OpenSSL, UI_null - user interface
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/ui.h>
  17
  18  typedef struct ui_st UI;
  19
  20  UI *UI_new(void);
  21  UI *UI_new_method(const UI_METHOD *method);
  22  void UI_free(UI *ui);
  23
  24  int UI_add_input_string(UI *ui, const char *prompt, int flags,
  25         char *result_buf, int minsize, int maxsize);
  26  int UI_dup_input_string(UI *ui, const char *prompt, int flags,
  27         char *result_buf, int minsize, int maxsize);
  28  int UI_add_verify_string(UI *ui, const char *prompt, int flags,
  29         char *result_buf, int minsize, int maxsize, const char *test_buf);
  30  int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
  31         char *result_buf, int minsize, int maxsize, const char *test_buf);
  32  int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  33         const char *ok_chars, const char *cancel_chars,
  34         int flags, char *result_buf);
  35  int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  36         const char *ok_chars, const char *cancel_chars,
  37         int flags, char *result_buf);
  38  int UI_add_info_string(UI *ui, const char *text);
  39  int UI_dup_info_string(UI *ui, const char *text);
  40  int UI_add_error_string(UI *ui, const char *text);
  41  int UI_dup_error_string(UI *ui, const char *text);
  42
  43  char *UI_construct_prompt(UI *ui_method,
  44         const char *object_desc, const char *object_name);
  45
  46  void *UI_add_user_data(UI *ui, void *user_data);
  47  void *UI_get0_user_data(UI *ui);
  48
  49  const char *UI_get0_result(UI *ui, int i);
  50
  51  int UI_process(UI *ui);
  52
  53  int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
  54
  55  void UI_set_default_method(const UI_METHOD *meth);
  56  const UI_METHOD *UI_get_default_method(void);
  57  const UI_METHOD *UI_get_method(UI *ui);
  58  const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
  59
  60  UI_METHOD *UI_OpenSSL(void);
  61  const UI_METHOD *UI_null(void);
  62
  63 =head1 DESCRIPTION
  64
  65 UI stands for User Interface, and is general purpose set of routines to
  66 prompt the user for text-based information.  Through user-written methods
  67 (see L<UI_create_method(3)>), prompting can be done in any way
  68 imaginable, be it plain text prompting, through dialog boxes or from a
  69 cell phone.
  70
  71 All the functions work through a context of the type UI.  This context
  72 contains all the information needed to prompt correctly as well as a
  73 reference to a UI_METHOD, which is an ordered vector of functions that
  74 carry out the actual prompting.
  75
  76 The first thing to do is to create a UI with UI_new() or UI_new_method(),
  77 then add information to it with the UI_add or UI_dup functions.  Also,
  78 user-defined random data can be passed down to the underlying method
  79 through calls to UI_add_user_data.  The default UI method doesn't care
  80 about these data, but other methods might.  Finally, use UI_process()
  81 to actually perform the prompting and UI_get0_result() to find the result
  82 to the prompt.
  83
  84 A UI can contain more than one prompt, which are performed in the given
  85 sequence.  Each prompt gets an index number which is returned by the
  86 UI_add and UI_dup functions, and has to be used to get the corresponding
  87 result with UI_get0_result().
  88
  89 The functions are as follows:
  90
  91 UI_new() creates a new UI using the default UI method.  When done with
  92 this UI, it should be freed using UI_free().
  93
  94 UI_new_method() creates a new UI using the given UI method.  When done with
  95 this UI, it should be freed using UI_free().
  96
  97 UI_OpenSSL() returns the built-in UI method (note: not necessarely the
  98 default one, since the default can be changed.  See further on).  This
  99 method is the most machine/OS dependent part of OpenSSL and normally
 100 generates the most problems when porting.
 101
 102 UI_null() returns a UI method that does nothing.  Its use is to avoid
 103 getting internal defaults for passed UI_METHOD pointers.
 104
 105 UI_free() removes a UI from memory, along with all other pieces of memory
 106 that's connected to it, like duplicated input strings, results and others.
 107 If B<ui> is NULL nothing is done.
 108
 109 UI_add_input_string() and UI_add_verify_string() add a prompt to the UI,
 110 as well as flags and a result buffer and the desired minimum and maximum
 111 sizes of the result, not counting the final NUL character.  The given
 112 information is used to prompt for information, for example a password,
 113 and to verify a password (i.e. having the user enter it twice and check
 114 that the same string was entered twice).  UI_add_verify_string() takes
 115 and extra argument that should be a pointer to the result buffer of the
 116 input string that it's supposed to verify, or verification will fail.
 117
 118 UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered
 119 in a boolean way, with a single character for yes and a different character
 120 for no.  A set of characters that can be used to cancel the prompt is given
 121 as well.  The prompt itself is divided in two, one part being the
 122 descriptive text (given through the I<prompt> argument) and one describing
 123 the possible answers (given through the I<action_desc> argument).
 124
 125 UI_add_info_string() and UI_add_error_string() add strings that are shown at
 126 the same time as the prompt for extra information or to show an error string.
 127 The difference between the two is only conceptual.  With the builtin method,
 128 there's no technical difference between them.  Other methods may make a
 129 difference between them, however.
 130
 131 The flags currently supported are B<UI_INPUT_FLAG_ECHO>, which is relevant for
 132 UI_add_input_string() and will have the users response be echoed (when
 133 prompting for a password, this flag should obviously not be used, and
 134 B<UI_INPUT_FLAG_DEFAULT_PWD>, which means that a default password of some
 135 sort will be used (completely depending on the application and the UI
 136 method).
 137
 138 UI_dup_input_string(), UI_dup_verify_string(), UI_dup_input_boolean(),
 139 UI_dup_info_string() and UI_dup_error_string() are basically the same
 140 as their UI_add counterparts, except that they make their own copies
 141 of all strings.
 142
 143 UI_construct_prompt() is a helper function that can be used to create
 144 a prompt from two pieces of information: an description and a name.
 145 The default constructor (if there is none provided by the method used)
 146 creates a string "Enter I<description> for I<name>:".  With the
 147 description "pass phrase" and the file name "foo.key", that becomes
 148 "Enter pass phrase for foo.key:".  Other methods may create whatever
 149 string and may include encodings that will be processed by the other
 150 method functions.
 151
 152 UI_add_user_data() adds a piece of memory for the method to use at any
 153 time.  The builtin UI method doesn't care about this info.  Note that several
 154 calls to this function doesn't add data, it replaces the previous blob
 155 with the one given as argument.
 156
 157 UI_get0_user_data() retrieves the data that has last been given to the
 158 UI with UI_add_user_data().
 159
 160 UI_get0_result() returns a pointer to the result buffer associated with
 161 the information indexed by I<i>.
 162
 163 UI_process() goes through the information given so far, does all the printing
 164 and prompting and returns the final status, which is -2 on out-of-band events
 165 (Interrupt, Cancel, ...), -1 on error and 0 on success.
 166
 167 UI_ctrl() adds extra control for the application author.  For now, it
 168 understands two commands: B<UI_CTRL_PRINT_ERRORS>, which makes UI_process()
 169 print the OpenSSL error stack as part of processing the UI, and
 170 B<UI_CTRL_IS_REDOABLE>, which returns a flag saying if the used UI can
 171 be used again or not.
 172
 173 UI_set_default_method() changes the default UI method to the one given.
 174 This function is not thread-safe and should not be called at the same time
 175 as other OpenSSL functions.
 176
 177 UI_get_default_method() returns a pointer to the current default UI method.
 178
 179 UI_get_method() returns the UI method associated with a given UI.
 180
 181 UI_set_method() changes the UI method associated with a given UI.
 182
 183 =head1 NOTES
 184
 185 The resulting strings that the built in method UI_OpenSSL() generate
 186 are assumed to be encoded according to the current locale or (for
 187 Windows) code page.
 188 For applications having different demands, these strings need to be
 189 converted appropriately by the caller.
 190 For Windows, if the OPENSSL_WIN32_UTF8 environment variable is set,
 191 the built-in method UI_OpenSSL() will produce UTF-8 encoded strings
 192 instead.
 193
 194 =head1 COPYRIGHT
 195
 196 Copyright 2001-2017 The OpenSSL Project Authors. All Rights Reserved.
 197
 198 Licensed under the OpenSSL license (the "License").  You may not use
 199 this file except in compliance with the License.  You can obtain a copy
 200 in the file LICENSE in the source distribution or at
 201 L<https://www.openssl.org/source/license.html>.
 202
 203 =cut