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