include/openssl/ui.h

   1 /*
   2  * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_UI_H
  11 # define HEADER_UI_H
  12
  13 # include <openssl/opensslconf.h>
  14
  15 # ifndef OPENSSL_NO_UI
  16
  17 #  if OPENSSL_API_COMPAT < 0x10100000L
  18 #   include <openssl/crypto.h>
  19 #  endif
  20 #  include <openssl/safestack.h>
  21 #  include <openssl/pem.h>
  22 #  include <openssl/ossl_typ.h>
  23
  24 #ifdef  __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /*
  29  * All the following functions return -1 or NULL on error and in some cases
  30  * (UI_process()) -2 if interrupted or in some other way cancelled. When
  31  * everything is fine, they return 0, a positive value or a non-NULL pointer,
  32  * all depending on their purpose.
  33  */
  34
  35 /* Creators and destructor.   */
  36 UI *UI_new(void);
  37 UI *UI_new_method(const UI_METHOD *method);
  38 void UI_free(UI *ui);
  39
  40 /*-
  41    The following functions are used to add strings to be printed and prompt
  42    strings to prompt for data.  The names are UI_{add,dup}_<function>_string
  43    and UI_{add,dup}_input_boolean.
  44
  45    UI_{add,dup}_<function>_string have the following meanings:
  46         add     add a text or prompt string.  The pointers given to these
  47                 functions are used verbatim, no copying is done.
  48         dup     make a copy of the text or prompt string, then add the copy
  49                 to the collection of strings in the user interface.
  50         <function>
  51                 The function is a name for the functionality that the given
  52                 string shall be used for.  It can be one of:
  53                         input   use the string as data prompt.
  54                         verify  use the string as verification prompt.  This
  55                                 is used to verify a previous input.
  56                         info    use the string for informational output.
  57                         error   use the string for error output.
  58    Honestly, there's currently no difference between info and error for the
  59    moment.
  60
  61    UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
  62    and are typically used when one wants to prompt for a yes/no response.
  63
  64    All of the functions in this group take a UI and a prompt string.
  65    The string input and verify addition functions also take a flag argument,
  66    a buffer for the result to end up with, a minimum input size and a maximum
  67    input size (the result buffer MUST be large enough to be able to contain
  68    the maximum number of characters).  Additionally, the verify addition
  69    functions takes another buffer to compare the result against.
  70    The boolean input functions take an action description string (which should
  71    be safe to ignore if the expected user action is obvious, for example with
  72    a dialog box with an OK button and a Cancel button), a string of acceptable
  73    characters to mean OK and to mean Cancel.  The two last strings are checked
  74    to make sure they don't have common characters.  Additionally, the same
  75    flag argument as for the string input is taken, as well as a result buffer.
  76    The result buffer is required to be at least one byte long.  Depending on
  77    the answer, the first character from the OK or the Cancel character strings
  78    will be stored in the first byte of the result buffer.  No NUL will be
  79    added, so the result is *not* a string.
  80
  81    On success, the all return an index of the added information.  That index
  82    is useful when retrieving results with UI_get0_result(). */
  83 int UI_add_input_string(UI *ui, const char *prompt, int flags,
  84                         char *result_buf, int minsize, int maxsize);
  85 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
  86                         char *result_buf, int minsize, int maxsize);
  87 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
  88                          char *result_buf, int minsize, int maxsize,
  89                          const char *test_buf);
  90 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
  91                          char *result_buf, int minsize, int maxsize,
  92                          const char *test_buf);
  93 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  94                          const char *ok_chars, const char *cancel_chars,
  95                          int flags, char *result_buf);
  96 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  97                          const char *ok_chars, const char *cancel_chars,
  98                          int flags, char *result_buf);
  99 int UI_add_info_string(UI *ui, const char *text);
 100 int UI_dup_info_string(UI *ui, const char *text);
 101 int UI_add_error_string(UI *ui, const char *text);
 102 int UI_dup_error_string(UI *ui, const char *text);
 103
 104 /* These are the possible flags.  They can be or'ed together. */
 105 /* Use to have echoing of input */
 106 # define UI_INPUT_FLAG_ECHO              0x01
 107 /*
 108  * Use a default password.  Where that password is found is completely up to
 109  * the application, it might for example be in the user data set with
 110  * UI_add_user_data().  It is not recommended to have more than one input in
 111  * each UI being marked with this flag, or the application might get
 112  * confused.
 113  */
 114 #  define UI_INPUT_FLAG_DEFAULT_PWD       0x02
 115
 116 /*-
 117  * The user of these routines may want to define flags of their own.  The core
 118  * UI won't look at those, but will pass them on to the method routines.  They
 119  * must use higher bits so they don't get confused with the UI bits above.
 120  * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use.  A good
 121  * example of use is this:
 122  *
 123  *    #define MY_UI_FLAG1       (0x01 << UI_INPUT_FLAG_USER_BASE)
 124  *
 125 */
 126 #  define UI_INPUT_FLAG_USER_BASE 16
 127
 128 /*-
 129  * The following function helps construct a prompt.  object_desc is a
 130  * textual short description of the object, for example "pass phrase",
 131  * and object_name is the name of the object (might be a card name or
 132  * a file name.
 133  * The returned string shall always be allocated on the heap with
 134  * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
 135  *
 136  * If the ui_method doesn't contain a pointer to a user-defined prompt
 137  * constructor, a default string is built, looking like this:
 138  *
 139  *       "Enter {object_desc} for {object_name}:"
 140  *
 141  * So, if object_desc has the value "pass phrase" and object_name has
 142  * the value "foo.key", the resulting string is:
 143  *
 144  *       "Enter pass phrase for foo.key:"
 145 */
 146 char *UI_construct_prompt(UI *ui_method,
 147                           const char *object_desc, const char *object_name);
 148
 149 /*
 150  * The following function is used to store a pointer to user-specific data.
 151  * Any previous such pointer will be returned and replaced.
 152  *
 153  * For callback purposes, this function makes a lot more sense than using
 154  * ex_data, since the latter requires that different parts of OpenSSL or
 155  * applications share the same ex_data index.
 156  *
 157  * Note that the UI_OpenSSL() method completely ignores the user data. Other
 158  * methods may not, however.
 159  */
 160 void *UI_add_user_data(UI *ui, void *user_data);
 161 /* We need a user data retrieving function as well.  */
 162 void *UI_get0_user_data(UI *ui);
 163
 164 /* Return the result associated with a prompt given with the index i. */
 165 const char *UI_get0_result(UI *ui, int i);
 166
 167 /* When all strings have been added, process the whole thing. */
 168 int UI_process(UI *ui);
 169
 170 /*
 171  * Give a user interface parametrised control commands.  This can be used to
 172  * send down an integer, a data pointer or a function pointer, as well as be
 173  * used to get information from a UI.
 174  */
 175 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void));
 176
 177 /* The commands */
 178 /*
 179  * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
 180  * OpenSSL error stack before printing any info or added error messages and
 181  * before any prompting.
 182  */
 183 #  define UI_CTRL_PRINT_ERRORS            1
 184 /*
 185  * Check if a UI_process() is possible to do again with the same instance of
 186  * a user interface.  This makes UI_ctrl() return 1 if it is redoable, and 0
 187  * if not.
 188  */
 189 # define UI_CTRL_IS_REDOABLE             2
 190
 191 /* Some methods may use extra data */
 192 # define UI_set_app_data(s,arg)         UI_set_ex_data(s,0,arg)
 193 # define UI_get_app_data(s)             UI_get_ex_data(s,0)
 194
 195 #define UI_get_ex_new_index(l, p, newf, dupf, freef) \
 196     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, l, p, newf, dupf, freef)
 197 int UI_set_ex_data(UI *r, int idx, void *arg);
 198 void *UI_get_ex_data(UI *r, int idx);
 199
 200 /* Use specific methods instead of the built-in one */
 201 void UI_set_default_method(const UI_METHOD *meth);
 202 const UI_METHOD *UI_get_default_method(void);
 203 const UI_METHOD *UI_get_method(UI *ui);
 204 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
 205
 206 /* The method with all the built-in thingies */
 207 UI_METHOD *UI_OpenSSL(void);
 208
 209 /*
 210  * NULL method.  Literarily does nothing, but may serve as a placeholder
 211  * to avoid internal default.
 212  */
 213 const UI_METHOD *UI_null(void);
 214
 215 /* ---------- For method writers ---------- */
 216 /*-
 217    A method contains a number of functions that implement the low level
 218    of the User Interface.  The functions are:
 219
 220         an opener       This function starts a session, maybe by opening
 221                         a channel to a tty, or by opening a window.
 222         a writer        This function is called to write a given string,
 223                         maybe to the tty, maybe as a field label in a
 224                         window.
 225         a flusher       This function is called to flush everything that
 226                         has been output so far.  It can be used to actually
 227                         display a dialog box after it has been built.
 228         a reader        This function is called to read a given prompt,
 229                         maybe from the tty, maybe from a field in a
 230                         window.  Note that it's called with all string
 231                         structures, not only the prompt ones, so it must
 232                         check such things itself.
 233         a closer        This function closes the session, maybe by closing
 234                         the channel to the tty, or closing the window.
 235
 236    All these functions are expected to return:
 237
 238         0       on error.
 239         1       on success.
 240         -1      on out-of-band events, for example if some prompting has
 241                 been canceled (by pressing Ctrl-C, for example).  This is
 242                 only checked when returned by the flusher or the reader.
 243
 244    The way this is used, the opener is first called, then the writer for all
 245    strings, then the flusher, then the reader for all strings and finally the
 246    closer.  Note that if you want to prompt from a terminal or other command
 247    line interface, the best is to have the reader also write the prompts
 248    instead of having the writer do it.  If you want to prompt from a dialog
 249    box, the writer can be used to build up the contents of the box, and the
 250    flusher to actually display the box and run the event loop until all data
 251    has been given, after which the reader only grabs the given data and puts
 252    them back into the UI strings.
 253
 254    All method functions take a UI as argument.  Additionally, the writer and
 255    the reader take a UI_STRING.
 256 */
 257
 258 /*
 259  * The UI_STRING type is the data structure that contains all the needed info
 260  * about a string or a prompt, including test data for a verification prompt.
 261  */
 262 typedef struct ui_string_st UI_STRING;
 263 DEFINE_STACK_OF(UI_STRING)
 264
 265 /*
 266  * The different types of strings that are currently supported. This is only
 267  * needed by method authors.
 268  */
 269 enum UI_string_types {
 270     UIT_NONE = 0,
 271     UIT_PROMPT,                 /* Prompt for a string */
 272     UIT_VERIFY,                 /* Prompt for a string and verify */
 273     UIT_BOOLEAN,                /* Prompt for a yes/no response */
 274     UIT_INFO,                   /* Send info to the user */
 275     UIT_ERROR                   /* Send an error message to the user */
 276 };
 277
 278 /* Create and manipulate methods */
 279 UI_METHOD *UI_create_method(const char *name);
 280 void UI_destroy_method(UI_METHOD *ui_method);
 281 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui));
 282 int UI_method_set_writer(UI_METHOD *method,
 283                          int (*writer) (UI *ui, UI_STRING *uis));
 284 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui));
 285 int UI_method_set_reader(UI_METHOD *method,
 286                          int (*reader) (UI *ui, UI_STRING *uis));
 287 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui));
 288 int UI_method_set_prompt_constructor(UI_METHOD *method,
 289                                      char *(*prompt_constructor) (UI *ui,
 290                                                                   const char
 291                                                                   *object_desc,
 292                                                                   const char
 293                                                                   *object_name));
 294 int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data);
 295 int (*UI_method_get_opener(const UI_METHOD *method)) (UI *);
 296 int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *);
 297 int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *);
 298 int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *);
 299 int (*UI_method_get_closer(const UI_METHOD *method)) (UI *);
 300 char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
 301     (UI *, const char *, const char *);
 302 const void *UI_method_get_ex_data(const UI_METHOD *method, int idx);
 303
 304 /*
 305  * The following functions are helpers for method writers to access relevant
 306  * data from a UI_STRING.
 307  */
 308
 309 /* Return type of the UI_STRING */
 310 enum UI_string_types UI_get_string_type(UI_STRING *uis);
 311 /* Return input flags of the UI_STRING */
 312 int UI_get_input_flags(UI_STRING *uis);
 313 /* Return the actual string to output (the prompt, info or error) */
 314 const char *UI_get0_output_string(UI_STRING *uis);
 315 /*
 316  * Return the optional action string to output (the boolean prompt
 317  * instruction)
 318  */
 319 const char *UI_get0_action_string(UI_STRING *uis);
 320 /* Return the result of a prompt */
 321 const char *UI_get0_result_string(UI_STRING *uis);
 322 /*
 323  * Return the string to test the result against.  Only useful with verifies.
 324  */
 325 const char *UI_get0_test_string(UI_STRING *uis);
 326 /* Return the required minimum size of the result */
 327 int UI_get_result_minsize(UI_STRING *uis);
 328 /* Return the required maximum size of the result */
 329 int UI_get_result_maxsize(UI_STRING *uis);
 330 /* Set the result of a UI_STRING. */
 331 int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
 332
 333 /* A couple of popular utility functions */
 334 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
 335                            int verify);
 336 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
 337                     int verify);
 338     UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag);
 339
 340 /* BEGIN ERROR CODES */
 341 /*
 342  * The following lines are auto generated by the script mkerr.pl. Any changes
 343  * made after this point may be overwritten when the script is next run.
 344  */
 345
 346 int ERR_load_UI_strings(void);
 347
 348 /* Error codes for the UI functions. */
 349
 350 /* Function codes. */
 351 # define UI_F_CLOSE_CONSOLE                               115
 352 # define UI_F_ECHO_CONSOLE                                116
 353 # define UI_F_GENERAL_ALLOCATE_BOOLEAN                    108
 354 # define UI_F_GENERAL_ALLOCATE_PROMPT                     109
 355 # define UI_F_NOECHO_CONSOLE                              117
 356 # define UI_F_OPEN_CONSOLE                                114
 357 # define UI_F_UI_CREATE_METHOD                            112
 358 # define UI_F_UI_CTRL                                     111
 359 # define UI_F_UI_DUP_ERROR_STRING                         101
 360 # define UI_F_UI_DUP_INFO_STRING                          102
 361 # define UI_F_UI_DUP_INPUT_BOOLEAN                        110
 362 # define UI_F_UI_DUP_INPUT_STRING                         103
 363 # define UI_F_UI_DUP_VERIFY_STRING                        106
 364 # define UI_F_UI_GET0_RESULT                              107
 365 # define UI_F_UI_NEW_METHOD                               104
 366 # define UI_F_UI_PROCESS                                  113
 367 # define UI_F_UI_SET_RESULT                               105
 368
 369 /* Reason codes. */
 370 # define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS             104
 371 # define UI_R_INDEX_TOO_LARGE                             102
 372 # define UI_R_INDEX_TOO_SMALL                             103
 373 # define UI_R_NO_RESULT_BUFFER                            105
 374 # define UI_R_PROCESSING_ERROR                            107
 375 # define UI_R_RESULT_TOO_LARGE                            100
 376 # define UI_R_RESULT_TOO_SMALL                            101
 377 # define UI_R_SYSASSIGN_ERROR                             109
 378 # define UI_R_SYSDASSGN_ERROR                             110
 379 # define UI_R_SYSQIOW_ERROR                               111
 380 # define UI_R_UNKNOWN_CONTROL_COMMAND                     106
 381 # define UI_R_UNKNOWN_TTYGET_ERRNO_VALUE                  108
 382
 383 #  ifdef  __cplusplus
 384 }
 385 #  endif
 386 # endif
 387 #endif