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