LTKCPP-- LLRP Toolkit C Plus Plus Library
|
00001 /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */ 00002 /* 00003 * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project 00004 * 2001. 00005 */ 00006 /* ==================================================================== 00007 * Copyright (c) 2001 The OpenSSL Project. All rights reserved. 00008 * 00009 * Redistribution and use in source and binary forms, with or without 00010 * modification, are permitted provided that the following conditions 00011 * are met: 00012 * 00013 * 1. Redistributions of source code must retain the above copyright 00014 * notice, this list of conditions and the following disclaimer. 00015 * 00016 * 2. Redistributions in binary form must reproduce the above copyright 00017 * notice, this list of conditions and the following disclaimer in 00018 * the documentation and/or other materials provided with the 00019 * distribution. 00020 * 00021 * 3. All advertising materials mentioning features or use of this 00022 * software must display the following acknowledgment: 00023 * "This product includes software developed by the OpenSSL Project 00024 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 00025 * 00026 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 00027 * endorse or promote products derived from this software without 00028 * prior written permission. For written permission, please contact 00029 * openssl-core@openssl.org. 00030 * 00031 * 5. Products derived from this software may not be called "OpenSSL" 00032 * nor may "OpenSSL" appear in their names without prior written 00033 * permission of the OpenSSL Project. 00034 * 00035 * 6. Redistributions of any form whatsoever must retain the following 00036 * acknowledgment: 00037 * "This product includes software developed by the OpenSSL Project 00038 * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 00039 * 00040 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 00041 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00042 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00043 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 00044 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00045 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 00046 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00047 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00048 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 00049 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00050 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 00051 * OF THE POSSIBILITY OF SUCH DAMAGE. 00052 * ==================================================================== 00053 * 00054 * This product includes cryptographic software written by Eric Young 00055 * (eay@cryptsoft.com). This product includes software written by Tim 00056 * Hudson (tjh@cryptsoft.com). 00057 * 00058 */ 00059 00060 #ifndef HEADER_UI_H 00061 # define HEADER_UI_H 00062 00063 # ifndef OPENSSL_NO_DEPRECATED 00064 # include <openssl/crypto.h> 00065 # endif 00066 # include <openssl/safestack.h> 00067 # include <openssl/ossl_typ.h> 00068 00069 #ifdef __cplusplus 00070 extern "C" { 00071 #endif 00072 00073 /* Declared already in ossl_typ.h */ 00074 /* typedef struct ui_st UI; */ 00075 /* typedef struct ui_method_st UI_METHOD; */ 00076 00077 /* 00078 * All the following functions return -1 or NULL on error and in some cases 00079 * (UI_process()) -2 if interrupted or in some other way cancelled. When 00080 * everything is fine, they return 0, a positive value or a non-NULL pointer, 00081 * all depending on their purpose. 00082 */ 00083 00084 /* Creators and destructor. */ 00085 UI *UI_new(void); 00086 UI *UI_new_method(const UI_METHOD *method); 00087 void UI_free(UI *ui); 00088 00089 /*- 00090 The following functions are used to add strings to be printed and prompt 00091 strings to prompt for data. The names are UI_{add,dup}_<function>_string 00092 and UI_{add,dup}_input_boolean. 00093 00094 UI_{add,dup}_<function>_string have the following meanings: 00095 add add a text or prompt string. The pointers given to these 00096 functions are used verbatim, no copying is done. 00097 dup make a copy of the text or prompt string, then add the copy 00098 to the collection of strings in the user interface. 00099 <function> 00100 The function is a name for the functionality that the given 00101 string shall be used for. It can be one of: 00102 input use the string as data prompt. 00103 verify use the string as verification prompt. This 00104 is used to verify a previous input. 00105 info use the string for informational output. 00106 error use the string for error output. 00107 Honestly, there's currently no difference between info and error for the 00108 moment. 00109 00110 UI_{add,dup}_input_boolean have the same semantics for "add" and "dup", 00111 and are typically used when one wants to prompt for a yes/no response. 00112 00113 All of the functions in this group take a UI and a prompt string. 00114 The string input and verify addition functions also take a flag argument, 00115 a buffer for the result to end up with, a minimum input size and a maximum 00116 input size (the result buffer MUST be large enough to be able to contain 00117 the maximum number of characters). Additionally, the verify addition 00118 functions takes another buffer to compare the result against. 00119 The boolean input functions take an action description string (which should 00120 be safe to ignore if the expected user action is obvious, for example with 00121 a dialog box with an OK button and a Cancel button), a string of acceptable 00122 characters to mean OK and to mean Cancel. The two last strings are checked 00123 to make sure they don't have common characters. Additionally, the same 00124 flag argument as for the string input is taken, as well as a result buffer. 00125 The result buffer is required to be at least one byte long. Depending on 00126 the answer, the first character from the OK or the Cancel character strings 00127 will be stored in the first byte of the result buffer. No NUL will be 00128 added, so the result is *not* a string. 00129 00130 On success, the all return an index of the added information. That index 00131 is usefull when retrieving results with UI_get0_result(). */ 00132 int UI_add_input_string(UI *ui, const char *prompt, int flags, 00133 char *result_buf, int minsize, int maxsize); 00134 int UI_dup_input_string(UI *ui, const char *prompt, int flags, 00135 char *result_buf, int minsize, int maxsize); 00136 int UI_add_verify_string(UI *ui, const char *prompt, int flags, 00137 char *result_buf, int minsize, int maxsize, 00138 const char *test_buf); 00139 int UI_dup_verify_string(UI *ui, const char *prompt, int flags, 00140 char *result_buf, int minsize, int maxsize, 00141 const char *test_buf); 00142 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, 00143 const char *ok_chars, const char *cancel_chars, 00144 int flags, char *result_buf); 00145 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, 00146 const char *ok_chars, const char *cancel_chars, 00147 int flags, char *result_buf); 00148 int UI_add_info_string(UI *ui, const char *text); 00149 int UI_dup_info_string(UI *ui, const char *text); 00150 int UI_add_error_string(UI *ui, const char *text); 00151 int UI_dup_error_string(UI *ui, const char *text); 00152 00153 /* These are the possible flags. They can be or'ed together. */ 00154 /* Use to have echoing of input */ 00155 # define UI_INPUT_FLAG_ECHO 0x01 00156 /* 00157 * Use a default password. Where that password is found is completely up to 00158 * the application, it might for example be in the user data set with 00159 * UI_add_user_data(). It is not recommended to have more than one input in 00160 * each UI being marked with this flag, or the application might get 00161 * confused. 00162 */ 00163 # define UI_INPUT_FLAG_DEFAULT_PWD 0x02 00164 00165 /*- 00166 * The user of these routines may want to define flags of their own. The core 00167 * UI won't look at those, but will pass them on to the method routines. They 00168 * must use higher bits so they don't get confused with the UI bits above. 00169 * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good 00170 * example of use is this: 00171 * 00172 * #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE) 00173 * 00174 */ 00175 # define UI_INPUT_FLAG_USER_BASE 16 00176 00177 /*- 00178 * The following function helps construct a prompt. object_desc is a 00179 * textual short description of the object, for example "pass phrase", 00180 * and object_name is the name of the object (might be a card name or 00181 * a file name. 00182 * The returned string shall always be allocated on the heap with 00183 * OPENSSL_malloc(), and need to be free'd with OPENSSL_free(). 00184 * 00185 * If the ui_method doesn't contain a pointer to a user-defined prompt 00186 * constructor, a default string is built, looking like this: 00187 * 00188 * "Enter {object_desc} for {object_name}:" 00189 * 00190 * So, if object_desc has the value "pass phrase" and object_name has 00191 * the value "foo.key", the resulting string is: 00192 * 00193 * "Enter pass phrase for foo.key:" 00194 */ 00195 char *UI_construct_prompt(UI *ui_method, 00196 const char *object_desc, const char *object_name); 00197 00198 /* 00199 * The following function is used to store a pointer to user-specific data. 00200 * Any previous such pointer will be returned and replaced. 00201 * 00202 * For callback purposes, this function makes a lot more sense than using 00203 * ex_data, since the latter requires that different parts of OpenSSL or 00204 * applications share the same ex_data index. 00205 * 00206 * Note that the UI_OpenSSL() method completely ignores the user data. Other 00207 * methods may not, however. 00208 */ 00209 void *UI_add_user_data(UI *ui, void *user_data); 00210 /* We need a user data retrieving function as well. */ 00211 void *UI_get0_user_data(UI *ui); 00212 00213 /* Return the result associated with a prompt given with the index i. */ 00214 const char *UI_get0_result(UI *ui, int i); 00215 00216 /* When all strings have been added, process the whole thing. */ 00217 int UI_process(UI *ui); 00218 00219 /* 00220 * Give a user interface parametrised control commands. This can be used to 00221 * send down an integer, a data pointer or a function pointer, as well as be 00222 * used to get information from a UI. 00223 */ 00224 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void)); 00225 00226 /* The commands */ 00227 /* 00228 * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the 00229 * OpenSSL error stack before printing any info or added error messages and 00230 * before any prompting. 00231 */ 00232 # define UI_CTRL_PRINT_ERRORS 1 00233 /* 00234 * Check if a UI_process() is possible to do again with the same instance of 00235 * a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0 00236 * if not. 00237 */ 00238 # define UI_CTRL_IS_REDOABLE 2 00239 00240 /* Some methods may use extra data */ 00241 # define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg) 00242 # define UI_get_app_data(s) UI_get_ex_data(s,0) 00243 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 00244 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 00245 int UI_set_ex_data(UI *r, int idx, void *arg); 00246 void *UI_get_ex_data(UI *r, int idx); 00247 00248 /* Use specific methods instead of the built-in one */ 00249 void UI_set_default_method(const UI_METHOD *meth); 00250 const UI_METHOD *UI_get_default_method(void); 00251 const UI_METHOD *UI_get_method(UI *ui); 00252 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); 00253 00254 /* The method with all the built-in thingies */ 00255 UI_METHOD *UI_OpenSSL(void); 00256 00257 /* ---------- For method writers ---------- */ 00258 /*- 00259 A method contains a number of functions that implement the low level 00260 of the User Interface. The functions are: 00261 00262 an opener This function starts a session, maybe by opening 00263 a channel to a tty, or by opening a window. 00264 a writer This function is called to write a given string, 00265 maybe to the tty, maybe as a field label in a 00266 window. 00267 a flusher This function is called to flush everything that 00268 has been output so far. It can be used to actually 00269 display a dialog box after it has been built. 00270 a reader This function is called to read a given prompt, 00271 maybe from the tty, maybe from a field in a 00272 window. Note that it's called wth all string 00273 structures, not only the prompt ones, so it must 00274 check such things itself. 00275 a closer This function closes the session, maybe by closing 00276 the channel to the tty, or closing the window. 00277 00278 All these functions are expected to return: 00279 00280 0 on error. 00281 1 on success. 00282 -1 on out-of-band events, for example if some prompting has 00283 been canceled (by pressing Ctrl-C, for example). This is 00284 only checked when returned by the flusher or the reader. 00285 00286 The way this is used, the opener is first called, then the writer for all 00287 strings, then the flusher, then the reader for all strings and finally the 00288 closer. Note that if you want to prompt from a terminal or other command 00289 line interface, the best is to have the reader also write the prompts 00290 instead of having the writer do it. If you want to prompt from a dialog 00291 box, the writer can be used to build up the contents of the box, and the 00292 flusher to actually display the box and run the event loop until all data 00293 has been given, after which the reader only grabs the given data and puts 00294 them back into the UI strings. 00295 00296 All method functions take a UI as argument. Additionally, the writer and 00297 the reader take a UI_STRING. 00298 */ 00299 00300 /* 00301 * The UI_STRING type is the data structure that contains all the needed info 00302 * about a string or a prompt, including test data for a verification prompt. 00303 */ 00304 typedef struct ui_string_st UI_STRING; 00305 DECLARE_STACK_OF(UI_STRING) 00306 00307 /* 00308 * The different types of strings that are currently supported. This is only 00309 * needed by method authors. 00310 */ 00311 enum UI_string_types { 00312 UIT_NONE = 0, 00313 UIT_PROMPT, /* Prompt for a string */ 00314 UIT_VERIFY, /* Prompt for a string and verify */ 00315 UIT_BOOLEAN, /* Prompt for a yes/no response */ 00316 UIT_INFO, /* Send info to the user */ 00317 UIT_ERROR /* Send an error message to the user */ 00318 }; 00319 00320 /* Create and manipulate methods */ 00321 UI_METHOD *UI_create_method(char *name); 00322 void UI_destroy_method(UI_METHOD *ui_method); 00323 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui)); 00324 int UI_method_set_writer(UI_METHOD *method, 00325 int (*writer) (UI *ui, UI_STRING *uis)); 00326 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui)); 00327 int UI_method_set_reader(UI_METHOD *method, 00328 int (*reader) (UI *ui, UI_STRING *uis)); 00329 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui)); 00330 int UI_method_set_prompt_constructor(UI_METHOD *method, 00331 char *(*prompt_constructor) (UI *ui, 00332 const char 00333 *object_desc, 00334 const char 00335 *object_name)); 00336 int (*UI_method_get_opener(UI_METHOD *method)) (UI *); 00337 int (*UI_method_get_writer(UI_METHOD *method)) (UI *, UI_STRING *); 00338 int (*UI_method_get_flusher(UI_METHOD *method)) (UI *); 00339 int (*UI_method_get_reader(UI_METHOD *method)) (UI *, UI_STRING *); 00340 int (*UI_method_get_closer(UI_METHOD *method)) (UI *); 00341 char *(*UI_method_get_prompt_constructor(UI_METHOD *method)) (UI *, 00342 const char *, 00343 const char *); 00344 00345 /* 00346 * The following functions are helpers for method writers to access relevant 00347 * data from a UI_STRING. 00348 */ 00349 00350 /* Return type of the UI_STRING */ 00351 enum UI_string_types UI_get_string_type(UI_STRING *uis); 00352 /* Return input flags of the UI_STRING */ 00353 int UI_get_input_flags(UI_STRING *uis); 00354 /* Return the actual string to output (the prompt, info or error) */ 00355 const char *UI_get0_output_string(UI_STRING *uis); 00356 /* 00357 * Return the optional action string to output (the boolean promtp 00358 * instruction) 00359 */ 00360 const char *UI_get0_action_string(UI_STRING *uis); 00361 /* Return the result of a prompt */ 00362 const char *UI_get0_result_string(UI_STRING *uis); 00363 /* 00364 * Return the string to test the result against. Only useful with verifies. 00365 */ 00366 const char *UI_get0_test_string(UI_STRING *uis); 00367 /* Return the required minimum size of the result */ 00368 int UI_get_result_minsize(UI_STRING *uis); 00369 /* Return the required maximum size of the result */ 00370 int UI_get_result_maxsize(UI_STRING *uis); 00371 /* Set the result of a UI_STRING. */ 00372 int UI_set_result(UI *ui, UI_STRING *uis, const char *result); 00373 00374 /* A couple of popular utility functions */ 00375 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt, 00376 int verify); 00377 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt, 00378 int verify); 00379 00380 /* BEGIN ERROR CODES */ 00381 /* 00382 * The following lines are auto generated by the script mkerr.pl. Any changes 00383 * made after this point may be overwritten when the script is next run. 00384 */ 00385 void ERR_load_UI_strings(void); 00386 00387 /* Error codes for the UI functions. */ 00388 00389 /* Function codes. */ 00390 # define UI_F_GENERAL_ALLOCATE_BOOLEAN 108 00391 # define UI_F_GENERAL_ALLOCATE_PROMPT 109 00392 # define UI_F_GENERAL_ALLOCATE_STRING 100 00393 # define UI_F_UI_CTRL 111 00394 # define UI_F_UI_DUP_ERROR_STRING 101 00395 # define UI_F_UI_DUP_INFO_STRING 102 00396 # define UI_F_UI_DUP_INPUT_BOOLEAN 110 00397 # define UI_F_UI_DUP_INPUT_STRING 103 00398 # define UI_F_UI_DUP_VERIFY_STRING 106 00399 # define UI_F_UI_GET0_RESULT 107 00400 # define UI_F_UI_NEW_METHOD 104 00401 # define UI_F_UI_SET_RESULT 105 00402 00403 /* Reason codes. */ 00404 # define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS 104 00405 # define UI_R_INDEX_TOO_LARGE 102 00406 # define UI_R_INDEX_TOO_SMALL 103 00407 # define UI_R_NO_RESULT_BUFFER 105 00408 # define UI_R_RESULT_TOO_LARGE 100 00409 # define UI_R_RESULT_TOO_SMALL 101 00410 # define UI_R_UNKNOWN_CONTROL_COMMAND 106 00411 00412 #ifdef __cplusplus 00413 } 00414 #endif 00415 #endif