include/openssl/ui.h

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