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