sl@0: /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */ sl@0: /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL sl@0: * project 2001. sl@0: */ sl@0: /* ==================================================================== sl@0: * Copyright (c) 2001 The OpenSSL Project. All rights reserved. sl@0: * sl@0: * Redistribution and use in source and binary forms, with or without sl@0: * modification, are permitted provided that the following conditions sl@0: * are met: sl@0: * sl@0: * 1. Redistributions of source code must retain the above copyright sl@0: * notice, this list of conditions and the following disclaimer. sl@0: * sl@0: * 2. Redistributions in binary form must reproduce the above copyright sl@0: * notice, this list of conditions and the following disclaimer in sl@0: * the documentation and/or other materials provided with the sl@0: * distribution. sl@0: * sl@0: * 3. All advertising materials mentioning features or use of this sl@0: * software must display the following acknowledgment: sl@0: * "This product includes software developed by the OpenSSL Project sl@0: * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" sl@0: * sl@0: * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to sl@0: * endorse or promote products derived from this software without sl@0: * prior written permission. For written permission, please contact sl@0: * openssl-core@openssl.org. sl@0: * sl@0: * 5. Products derived from this software may not be called "OpenSSL" sl@0: * nor may "OpenSSL" appear in their names without prior written sl@0: * permission of the OpenSSL Project. sl@0: * sl@0: * 6. Redistributions of any form whatsoever must retain the following sl@0: * acknowledgment: sl@0: * "This product includes software developed by the OpenSSL Project sl@0: * for use in the OpenSSL Toolkit (http://www.openssl.org/)" sl@0: * sl@0: * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY sl@0: * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE sl@0: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR sl@0: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR sl@0: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, sl@0: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT sl@0: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; sl@0: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) sl@0: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, sl@0: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) sl@0: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED sl@0: * OF THE POSSIBILITY OF SUCH DAMAGE. sl@0: * ==================================================================== sl@0: * sl@0: * This product includes cryptographic software written by Eric Young sl@0: * (eay@cryptsoft.com). This product includes software written by Tim sl@0: * Hudson (tjh@cryptsoft.com). sl@0: * sl@0: */ sl@0: /* sl@0: © Portions copyright (c) 2006 Nokia Corporation. All rights reserved. sl@0: */ sl@0: sl@0: #ifndef HEADER_UI_H sl@0: #define HEADER_UI_H sl@0: #ifdef SYMBIAN sl@0: #include sl@0: #endif sl@0: #ifndef OPENSSL_NO_DEPRECATED sl@0: #include sl@0: #endif sl@0: #include sl@0: #include sl@0: sl@0: #ifdef __cplusplus sl@0: extern "C" { sl@0: #endif sl@0: sl@0: /* Declared already in ossl_typ.h */ sl@0: /* typedef struct ui_st UI; */ sl@0: /* typedef struct ui_method_st UI_METHOD; */ sl@0: sl@0: sl@0: /* All the following functions return -1 or NULL on error and in some cases sl@0: (UI_process()) -2 if interrupted or in some other way cancelled. sl@0: When everything is fine, they return 0, a positive value or a non-NULL sl@0: pointer, all depending on their purpose. */ sl@0: sl@0: /* Creators and destructor. */ sl@0: IMPORT_C UI *UI_new(void); sl@0: IMPORT_C UI *UI_new_method(const UI_METHOD *method); sl@0: IMPORT_C void UI_free(UI *ui); sl@0: sl@0: /* The following functions are used to add strings to be printed and prompt sl@0: strings to prompt for data. The names are UI_{add,dup}__string sl@0: and UI_{add,dup}_input_boolean. sl@0: sl@0: UI_{add,dup}__string have the following meanings: sl@0: add add a text or prompt string. The pointers given to these sl@0: functions are used verbatim, no copying is done. sl@0: dup make a copy of the text or prompt string, then add the copy sl@0: to the collection of strings in the user interface. sl@0: sl@0: The function is a name for the functionality that the given sl@0: string shall be used for. It can be one of: sl@0: input use the string as data prompt. sl@0: verify use the string as verification prompt. This sl@0: is used to verify a previous input. sl@0: info use the string for informational output. sl@0: error use the string for error output. sl@0: Honestly, there's currently no difference between info and error for the sl@0: moment. sl@0: sl@0: UI_{add,dup}_input_boolean have the same semantics for "add" and "dup", sl@0: and are typically used when one wants to prompt for a yes/no response. sl@0: sl@0: sl@0: All of the functions in this group take a UI and a prompt string. sl@0: The string input and verify addition functions also take a flag argument, sl@0: a buffer for the result to end up with, a minimum input size and a maximum sl@0: input size (the result buffer MUST be large enough to be able to contain sl@0: the maximum number of characters). Additionally, the verify addition sl@0: functions takes another buffer to compare the result against. sl@0: The boolean input functions take an action description string (which should sl@0: be safe to ignore if the expected user action is obvious, for example with sl@0: a dialog box with an OK button and a Cancel button), a string of acceptable sl@0: characters to mean OK and to mean Cancel. The two last strings are checked sl@0: to make sure they don't have common characters. Additionally, the same sl@0: flag argument as for the string input is taken, as well as a result buffer. sl@0: The result buffer is required to be at least one byte long. Depending on sl@0: the answer, the first character from the OK or the Cancel character strings sl@0: will be stored in the first byte of the result buffer. No NUL will be sl@0: added, so the result is *not* a string. sl@0: sl@0: On success, the all return an index of the added information. That index sl@0: is usefull when retrieving results with UI_get0_result(). */ sl@0: IMPORT_C int UI_add_input_string(UI *ui, const char *prompt, int flags, sl@0: char *result_buf, int minsize, int maxsize); sl@0: IMPORT_C int UI_dup_input_string(UI *ui, const char *prompt, int flags, sl@0: char *result_buf, int minsize, int maxsize); sl@0: IMPORT_C int UI_add_verify_string(UI *ui, const char *prompt, int flags, sl@0: char *result_buf, int minsize, int maxsize, const char *test_buf); sl@0: IMPORT_C int UI_dup_verify_string(UI *ui, const char *prompt, int flags, sl@0: char *result_buf, int minsize, int maxsize, const char *test_buf); sl@0: IMPORT_C int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, sl@0: const char *ok_chars, const char *cancel_chars, sl@0: int flags, char *result_buf); sl@0: IMPORT_C int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, sl@0: const char *ok_chars, const char *cancel_chars, sl@0: int flags, char *result_buf); sl@0: IMPORT_C int UI_add_info_string(UI *ui, const char *text); sl@0: IMPORT_C int UI_dup_info_string(UI *ui, const char *text); sl@0: IMPORT_C int UI_add_error_string(UI *ui, const char *text); sl@0: IMPORT_C int UI_dup_error_string(UI *ui, const char *text); sl@0: sl@0: /* These are the possible flags. They can be or'ed together. */ sl@0: /* Use to have echoing of input */ sl@0: #define UI_INPUT_FLAG_ECHO 0x01 sl@0: /* Use a default password. Where that password is found is completely sl@0: up to the application, it might for example be in the user data set sl@0: with UI_add_user_data(). It is not recommended to have more than sl@0: one input in each UI being marked with this flag, or the application sl@0: might get confused. */ sl@0: #define UI_INPUT_FLAG_DEFAULT_PWD 0x02 sl@0: sl@0: /* The user of these routines may want to define flags of their own. The core sl@0: UI won't look at those, but will pass them on to the method routines. They sl@0: must use higher bits so they don't get confused with the UI bits above. sl@0: UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good sl@0: example of use is this: sl@0: sl@0: #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE) sl@0: sl@0: */ sl@0: #define UI_INPUT_FLAG_USER_BASE 16 sl@0: sl@0: sl@0: /* The following function helps construct a prompt. object_desc is a sl@0: textual short description of the object, for example "pass phrase", sl@0: and object_name is the name of the object (might be a card name or sl@0: a file name. sl@0: The returned string shall always be allocated on the heap with sl@0: OPENSSL_malloc(), and need to be free'd with OPENSSL_free(). sl@0: sl@0: If the ui_method doesn't contain a pointer to a user-defined prompt sl@0: constructor, a default string is built, looking like this: sl@0: sl@0: "Enter {object_desc} for {object_name}:" sl@0: sl@0: So, if object_desc has the value "pass phrase" and object_name has sl@0: the value "foo.key", the resulting string is: sl@0: sl@0: "Enter pass phrase for foo.key:" sl@0: */ sl@0: IMPORT_C char *UI_construct_prompt(UI *ui_method, sl@0: const char *object_desc, const char *object_name); sl@0: sl@0: sl@0: /* The following function is used to store a pointer to user-specific data. sl@0: Any previous such pointer will be returned and replaced. sl@0: sl@0: For callback purposes, this function makes a lot more sense than using sl@0: ex_data, since the latter requires that different parts of OpenSSL or sl@0: applications share the same ex_data index. sl@0: sl@0: Note that the UI_OpenSSL() method completely ignores the user data. sl@0: Other methods may not, however. */ sl@0: IMPORT_C void *UI_add_user_data(UI *ui, void *user_data); sl@0: /* We need a user data retrieving function as well. */ sl@0: IMPORT_C void *UI_get0_user_data(UI *ui); sl@0: sl@0: /* Return the result associated with a prompt given with the index i. */ sl@0: IMPORT_C const char *UI_get0_result(UI *ui, int i); sl@0: sl@0: /* When all strings have been added, process the whole thing. */ sl@0: IMPORT_C int UI_process(UI *ui); sl@0: sl@0: /* Give a user interface parametrised control commands. This can be used to sl@0: send down an integer, a data pointer or a function pointer, as well as sl@0: be used to get information from a UI. */ sl@0: IMPORT_C int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)(void)); sl@0: sl@0: /* The commands */ sl@0: /* Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the sl@0: OpenSSL error stack before printing any info or added error messages and sl@0: before any prompting. */ sl@0: #define UI_CTRL_PRINT_ERRORS 1 sl@0: /* Check if a UI_process() is possible to do again with the same instance of sl@0: a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0 sl@0: if not. */ sl@0: #define UI_CTRL_IS_REDOABLE 2 sl@0: sl@0: sl@0: /* Some methods may use extra data */ sl@0: #define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg) sl@0: #define UI_get_app_data(s) UI_get_ex_data(s,0) sl@0: IMPORT_C int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, sl@0: CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); sl@0: IMPORT_C int UI_set_ex_data(UI *r,int idx,void *arg); sl@0: IMPORT_C void *UI_get_ex_data(UI *r, int idx); sl@0: sl@0: /* Use specific methods instead of the built-in one */ sl@0: IMPORT_C void UI_set_default_method(const UI_METHOD *meth); sl@0: IMPORT_C const UI_METHOD *UI_get_default_method(void); sl@0: IMPORT_C const UI_METHOD *UI_get_method(UI *ui); sl@0: IMPORT_C const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); sl@0: sl@0: /* The method with all the built-in thingies */ sl@0: IMPORT_C UI_METHOD *UI_OpenSSL(void); sl@0: sl@0: sl@0: /* ---------- For method writers ---------- */ sl@0: /* A method contains a number of functions that implement the low level sl@0: of the User Interface. The functions are: sl@0: sl@0: an opener This function starts a session, maybe by opening sl@0: a channel to a tty, or by opening a window. sl@0: a writer This function is called to write a given string, sl@0: maybe to the tty, maybe as a field label in a sl@0: window. sl@0: a flusher This function is called to flush everything that sl@0: has been output so far. It can be used to actually sl@0: display a dialog box after it has been built. sl@0: a reader This function is called to read a given prompt, sl@0: maybe from the tty, maybe from a field in a sl@0: window. Note that it's called wth all string sl@0: structures, not only the prompt ones, so it must sl@0: check such things itself. sl@0: a closer This function closes the session, maybe by closing sl@0: the channel to the tty, or closing the window. sl@0: sl@0: All these functions are expected to return: sl@0: sl@0: 0 on error. sl@0: 1 on success. sl@0: -1 on out-of-band events, for example if some prompting has sl@0: been canceled (by pressing Ctrl-C, for example). This is sl@0: only checked when returned by the flusher or the reader. sl@0: sl@0: The way this is used, the opener is first called, then the writer for all sl@0: strings, then the flusher, then the reader for all strings and finally the sl@0: closer. Note that if you want to prompt from a terminal or other command sl@0: line interface, the best is to have the reader also write the prompts sl@0: instead of having the writer do it. If you want to prompt from a dialog sl@0: box, the writer can be used to build up the contents of the box, and the sl@0: flusher to actually display the box and run the event loop until all data sl@0: has been given, after which the reader only grabs the given data and puts sl@0: them back into the UI strings. sl@0: sl@0: All method functions take a UI as argument. Additionally, the writer and sl@0: the reader take a UI_STRING. sl@0: */ sl@0: sl@0: /* The UI_STRING type is the data structure that contains all the needed info sl@0: about a string or a prompt, including test data for a verification prompt. sl@0: */ sl@0: DECLARE_STACK_OF(UI_STRING) sl@0: typedef struct ui_string_st UI_STRING; sl@0: sl@0: /* The different types of strings that are currently supported. sl@0: This is only needed by method authors. */ sl@0: enum UI_string_types sl@0: { sl@0: UIT_NONE=0, sl@0: UIT_PROMPT, /* Prompt for a string */ sl@0: UIT_VERIFY, /* Prompt for a string and verify */ sl@0: UIT_BOOLEAN, /* Prompt for a yes/no response */ sl@0: UIT_INFO, /* Send info to the user */ sl@0: UIT_ERROR /* Send an error message to the user */ sl@0: }; sl@0: sl@0: /* Create and manipulate methods */ sl@0: IMPORT_C UI_METHOD *UI_create_method(char *name); sl@0: IMPORT_C void UI_destroy_method(UI_METHOD *ui_method); sl@0: IMPORT_C int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui)); sl@0: IMPORT_C int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis)); sl@0: IMPORT_C int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui)); sl@0: IMPORT_C int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis)); sl@0: IMPORT_C int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui)); sl@0: IMPORT_C int (*UI_method_get_opener(UI_METHOD *method))(UI*); sl@0: IMPORT_C int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*); sl@0: IMPORT_C int (*UI_method_get_flusher(UI_METHOD *method))(UI*); sl@0: IMPORT_C int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*); sl@0: IMPORT_C int (*UI_method_get_closer(UI_METHOD *method))(UI*); sl@0: sl@0: /* The following functions are helpers for method writers to access relevant sl@0: data from a UI_STRING. */ sl@0: sl@0: /* Return type of the UI_STRING */ sl@0: IMPORT_C enum UI_string_types UI_get_string_type(UI_STRING *uis); sl@0: /* Return input flags of the UI_STRING */ sl@0: IMPORT_C int UI_get_input_flags(UI_STRING *uis); sl@0: /* Return the actual string to output (the prompt, info or error) */ sl@0: IMPORT_C const char *UI_get0_output_string(UI_STRING *uis); sl@0: /* Return the optional action string to output (the boolean promtp instruction) */ sl@0: IMPORT_C const char *UI_get0_action_string(UI_STRING *uis); sl@0: /* Return the result of a prompt */ sl@0: IMPORT_C const char *UI_get0_result_string(UI_STRING *uis); sl@0: /* Return the string to test the result against. Only useful with verifies. */ sl@0: IMPORT_C const char *UI_get0_test_string(UI_STRING *uis); sl@0: /* Return the required minimum size of the result */ sl@0: IMPORT_C int UI_get_result_minsize(UI_STRING *uis); sl@0: /* Return the required maximum size of the result */ sl@0: IMPORT_C int UI_get_result_maxsize(UI_STRING *uis); sl@0: /* Set the result of a UI_STRING. */ sl@0: IMPORT_C int UI_set_result(UI *ui, UI_STRING *uis, const char *result); sl@0: sl@0: sl@0: /* A couple of popular utility functions */ sl@0: IMPORT_C int UI_UTIL_read_pw_string(char *buf,int length,const char *prompt,int verify); sl@0: IMPORT_C int UI_UTIL_read_pw(char *buf,char *buff,int size,const char *prompt,int verify); sl@0: sl@0: sl@0: /* BEGIN ERROR CODES */ sl@0: /* The following lines are auto generated by the script mkerr.pl. Any changes sl@0: * made after this point may be overwritten when the script is next run. sl@0: */ sl@0: IMPORT_C void ERR_load_UI_strings(void); sl@0: sl@0: /* Error codes for the UI functions. */ sl@0: sl@0: /* Function codes. */ sl@0: #define UI_F_GENERAL_ALLOCATE_BOOLEAN 108 sl@0: #define UI_F_GENERAL_ALLOCATE_PROMPT 109 sl@0: #define UI_F_GENERAL_ALLOCATE_STRING 100 sl@0: #define UI_F_UI_CTRL 111 sl@0: #define UI_F_UI_DUP_ERROR_STRING 101 sl@0: #define UI_F_UI_DUP_INFO_STRING 102 sl@0: #define UI_F_UI_DUP_INPUT_BOOLEAN 110 sl@0: #define UI_F_UI_DUP_INPUT_STRING 103 sl@0: #define UI_F_UI_DUP_VERIFY_STRING 106 sl@0: #define UI_F_UI_GET0_RESULT 107 sl@0: #define UI_F_UI_NEW_METHOD 104 sl@0: #define UI_F_UI_SET_RESULT 105 sl@0: sl@0: /* Reason codes. */ sl@0: #define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS 104 sl@0: #define UI_R_INDEX_TOO_LARGE 102 sl@0: #define UI_R_INDEX_TOO_SMALL 103 sl@0: #define UI_R_NO_RESULT_BUFFER 105 sl@0: #define UI_R_RESULT_TOO_LARGE 100 sl@0: #define UI_R_RESULT_TOO_SMALL 101 sl@0: #define UI_R_UNKNOWN_CONTROL_COMMAND 106 sl@0: sl@0: #ifdef __cplusplus sl@0: } sl@0: #endif sl@0: #endif