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