doc/man3/UI_new.pod

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