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