include/openssl/ui.h

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