doc/crypto/UI_new.pod

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