doc/crypto/UI_new.pod

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