jpayne@69: /*
jpayne@69:  * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
jpayne@69:  *
jpayne@69:  * Licensed under the OpenSSL license (the "License").  You may not use
jpayne@69:  * this file except in compliance with the License.  You can obtain a copy
jpayne@69:  * in the file LICENSE in the source distribution or at
jpayne@69:  * https://www.openssl.org/source/license.html
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef HEADER_UI_H
jpayne@69: # define HEADER_UI_H
jpayne@69: 
jpayne@69: # include <openssl/opensslconf.h>
jpayne@69: 
jpayne@69: # if OPENSSL_API_COMPAT < 0x10100000L
jpayne@69: #  include <openssl/crypto.h>
jpayne@69: # endif
jpayne@69: # include <openssl/safestack.h>
jpayne@69: # include <openssl/pem.h>
jpayne@69: # include <openssl/ossl_typ.h>
jpayne@69: # include <openssl/uierr.h>
jpayne@69: 
jpayne@69: /* For compatibility reasons, the macro OPENSSL_NO_UI is currently retained */
jpayne@69: # if OPENSSL_API_COMPAT < 0x10200000L
jpayne@69: #  ifdef OPENSSL_NO_UI_CONSOLE
jpayne@69: #   define OPENSSL_NO_UI
jpayne@69: #  endif
jpayne@69: # endif
jpayne@69: 
jpayne@69: # ifdef  __cplusplus
jpayne@69: extern "C" {
jpayne@69: # endif
jpayne@69: 
jpayne@69: /*
jpayne@69:  * All the following functions return -1 or NULL on error and in some cases
jpayne@69:  * (UI_process()) -2 if interrupted or in some other way cancelled. When
jpayne@69:  * everything is fine, they return 0, a positive value or a non-NULL pointer,
jpayne@69:  * all depending on their purpose.
jpayne@69:  */
jpayne@69: 
jpayne@69: /* Creators and destructor.   */
jpayne@69: UI *UI_new(void);
jpayne@69: UI *UI_new_method(const UI_METHOD *method);
jpayne@69: void UI_free(UI *ui);
jpayne@69: 
jpayne@69: /*-
jpayne@69:    The following functions are used to add strings to be printed and prompt
jpayne@69:    strings to prompt for data.  The names are UI_{add,dup}_<function>_string
jpayne@69:    and UI_{add,dup}_input_boolean.
jpayne@69: 
jpayne@69:    UI_{add,dup}_<function>_string have the following meanings:
jpayne@69:         add     add a text or prompt string.  The pointers given to these
jpayne@69:                 functions are used verbatim, no copying is done.
jpayne@69:         dup     make a copy of the text or prompt string, then add the copy
jpayne@69:                 to the collection of strings in the user interface.
jpayne@69:         <function>
jpayne@69:                 The function is a name for the functionality that the given
jpayne@69:                 string shall be used for.  It can be one of:
jpayne@69:                         input   use the string as data prompt.
jpayne@69:                         verify  use the string as verification prompt.  This
jpayne@69:                                 is used to verify a previous input.
jpayne@69:                         info    use the string for informational output.
jpayne@69:                         error   use the string for error output.
jpayne@69:    Honestly, there's currently no difference between info and error for the
jpayne@69:    moment.
jpayne@69: 
jpayne@69:    UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
jpayne@69:    and are typically used when one wants to prompt for a yes/no response.
jpayne@69: 
jpayne@69:    All of the functions in this group take a UI and a prompt string.
jpayne@69:    The string input and verify addition functions also take a flag argument,
jpayne@69:    a buffer for the result to end up with, a minimum input size and a maximum
jpayne@69:    input size (the result buffer MUST be large enough to be able to contain
jpayne@69:    the maximum number of characters).  Additionally, the verify addition
jpayne@69:    functions takes another buffer to compare the result against.
jpayne@69:    The boolean input functions take an action description string (which should
jpayne@69:    be safe to ignore if the expected user action is obvious, for example with
jpayne@69:    a dialog box with an OK button and a Cancel button), a string of acceptable
jpayne@69:    characters to mean OK and to mean Cancel.  The two last strings are checked
jpayne@69:    to make sure they don't have common characters.  Additionally, the same
jpayne@69:    flag argument as for the string input is taken, as well as a result buffer.
jpayne@69:    The result buffer is required to be at least one byte long.  Depending on
jpayne@69:    the answer, the first character from the OK or the Cancel character strings
jpayne@69:    will be stored in the first byte of the result buffer.  No NUL will be
jpayne@69:    added, so the result is *not* a string.
jpayne@69: 
jpayne@69:    On success, the all return an index of the added information.  That index
jpayne@69:    is useful when retrieving results with UI_get0_result(). */
jpayne@69: int UI_add_input_string(UI *ui, const char *prompt, int flags,
jpayne@69:                         char *result_buf, int minsize, int maxsize);
jpayne@69: int UI_dup_input_string(UI *ui, const char *prompt, int flags,
jpayne@69:                         char *result_buf, int minsize, int maxsize);
jpayne@69: int UI_add_verify_string(UI *ui, const char *prompt, int flags,
jpayne@69:                          char *result_buf, int minsize, int maxsize,
jpayne@69:                          const char *test_buf);
jpayne@69: int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
jpayne@69:                          char *result_buf, int minsize, int maxsize,
jpayne@69:                          const char *test_buf);
jpayne@69: int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
jpayne@69:                          const char *ok_chars, const char *cancel_chars,
jpayne@69:                          int flags, char *result_buf);
jpayne@69: int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
jpayne@69:                          const char *ok_chars, const char *cancel_chars,
jpayne@69:                          int flags, char *result_buf);
jpayne@69: int UI_add_info_string(UI *ui, const char *text);
jpayne@69: int UI_dup_info_string(UI *ui, const char *text);
jpayne@69: int UI_add_error_string(UI *ui, const char *text);
jpayne@69: int UI_dup_error_string(UI *ui, const char *text);
jpayne@69: 
jpayne@69: /* These are the possible flags.  They can be or'ed together. */
jpayne@69: /* Use to have echoing of input */
jpayne@69: # define UI_INPUT_FLAG_ECHO              0x01
jpayne@69: /*
jpayne@69:  * Use a default password.  Where that password is found is completely up to
jpayne@69:  * the application, it might for example be in the user data set with
jpayne@69:  * UI_add_user_data().  It is not recommended to have more than one input in
jpayne@69:  * each UI being marked with this flag, or the application might get
jpayne@69:  * confused.
jpayne@69:  */
jpayne@69: # define UI_INPUT_FLAG_DEFAULT_PWD       0x02
jpayne@69: 
jpayne@69: /*-
jpayne@69:  * The user of these routines may want to define flags of their own.  The core
jpayne@69:  * UI won't look at those, but will pass them on to the method routines.  They
jpayne@69:  * must use higher bits so they don't get confused with the UI bits above.
jpayne@69:  * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use.  A good
jpayne@69:  * example of use is this:
jpayne@69:  *
jpayne@69:  *    #define MY_UI_FLAG1       (0x01 << UI_INPUT_FLAG_USER_BASE)
jpayne@69:  *
jpayne@69: */
jpayne@69: # define UI_INPUT_FLAG_USER_BASE 16
jpayne@69: 
jpayne@69: /*-
jpayne@69:  * The following function helps construct a prompt.  object_desc is a
jpayne@69:  * textual short description of the object, for example "pass phrase",
jpayne@69:  * and object_name is the name of the object (might be a card name or
jpayne@69:  * a file name.
jpayne@69:  * The returned string shall always be allocated on the heap with
jpayne@69:  * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
jpayne@69:  *
jpayne@69:  * If the ui_method doesn't contain a pointer to a user-defined prompt
jpayne@69:  * constructor, a default string is built, looking like this:
jpayne@69:  *
jpayne@69:  *       "Enter {object_desc} for {object_name}:"
jpayne@69:  *
jpayne@69:  * So, if object_desc has the value "pass phrase" and object_name has
jpayne@69:  * the value "foo.key", the resulting string is:
jpayne@69:  *
jpayne@69:  *       "Enter pass phrase for foo.key:"
jpayne@69: */
jpayne@69: char *UI_construct_prompt(UI *ui_method,
jpayne@69:                           const char *object_desc, const char *object_name);
jpayne@69: 
jpayne@69: /*
jpayne@69:  * The following function is used to store a pointer to user-specific data.
jpayne@69:  * Any previous such pointer will be returned and replaced.
jpayne@69:  *
jpayne@69:  * For callback purposes, this function makes a lot more sense than using
jpayne@69:  * ex_data, since the latter requires that different parts of OpenSSL or
jpayne@69:  * applications share the same ex_data index.
jpayne@69:  *
jpayne@69:  * Note that the UI_OpenSSL() method completely ignores the user data. Other
jpayne@69:  * methods may not, however.
jpayne@69:  */
jpayne@69: void *UI_add_user_data(UI *ui, void *user_data);
jpayne@69: /*
jpayne@69:  * Alternatively, this function is used to duplicate the user data.
jpayne@69:  * This uses the duplicator method function.  The destroy function will
jpayne@69:  * be used to free the user data in this case.
jpayne@69:  */
jpayne@69: int UI_dup_user_data(UI *ui, void *user_data);
jpayne@69: /* We need a user data retrieving function as well.  */
jpayne@69: void *UI_get0_user_data(UI *ui);
jpayne@69: 
jpayne@69: /* Return the result associated with a prompt given with the index i. */
jpayne@69: const char *UI_get0_result(UI *ui, int i);
jpayne@69: int UI_get_result_length(UI *ui, int i);
jpayne@69: 
jpayne@69: /* When all strings have been added, process the whole thing. */
jpayne@69: int UI_process(UI *ui);
jpayne@69: 
jpayne@69: /*
jpayne@69:  * Give a user interface parameterised control commands.  This can be used to
jpayne@69:  * send down an integer, a data pointer or a function pointer, as well as be
jpayne@69:  * used to get information from a UI.
jpayne@69:  */
jpayne@69: int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void));
jpayne@69: 
jpayne@69: /* The commands */
jpayne@69: /*
jpayne@69:  * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
jpayne@69:  * OpenSSL error stack before printing any info or added error messages and
jpayne@69:  * before any prompting.
jpayne@69:  */
jpayne@69: # define UI_CTRL_PRINT_ERRORS            1
jpayne@69: /*
jpayne@69:  * Check if a UI_process() is possible to do again with the same instance of
jpayne@69:  * a user interface.  This makes UI_ctrl() return 1 if it is redoable, and 0
jpayne@69:  * if not.
jpayne@69:  */
jpayne@69: # define UI_CTRL_IS_REDOABLE             2
jpayne@69: 
jpayne@69: /* Some methods may use extra data */
jpayne@69: # define UI_set_app_data(s,arg)         UI_set_ex_data(s,0,arg)
jpayne@69: # define UI_get_app_data(s)             UI_get_ex_data(s,0)
jpayne@69: 
jpayne@69: # define UI_get_ex_new_index(l, p, newf, dupf, freef) \
jpayne@69:     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, l, p, newf, dupf, freef)
jpayne@69: int UI_set_ex_data(UI *r, int idx, void *arg);
jpayne@69: void *UI_get_ex_data(UI *r, int idx);
jpayne@69: 
jpayne@69: /* Use specific methods instead of the built-in one */
jpayne@69: void UI_set_default_method(const UI_METHOD *meth);
jpayne@69: const UI_METHOD *UI_get_default_method(void);
jpayne@69: const UI_METHOD *UI_get_method(UI *ui);
jpayne@69: const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
jpayne@69: 
jpayne@69: # ifndef OPENSSL_NO_UI_CONSOLE
jpayne@69: 
jpayne@69: /* The method with all the built-in thingies */
jpayne@69: UI_METHOD *UI_OpenSSL(void);
jpayne@69: 
jpayne@69: # endif
jpayne@69: 
jpayne@69: /*
jpayne@69:  * NULL method.  Literally does nothing, but may serve as a placeholder
jpayne@69:  * to avoid internal default.
jpayne@69:  */
jpayne@69: const UI_METHOD *UI_null(void);
jpayne@69: 
jpayne@69: /* ---------- For method writers ---------- */
jpayne@69: /*-
jpayne@69:    A method contains a number of functions that implement the low level
jpayne@69:    of the User Interface.  The functions are:
jpayne@69: 
jpayne@69:         an opener       This function starts a session, maybe by opening
jpayne@69:                         a channel to a tty, or by opening a window.
jpayne@69:         a writer        This function is called to write a given string,
jpayne@69:                         maybe to the tty, maybe as a field label in a
jpayne@69:                         window.
jpayne@69:         a flusher       This function is called to flush everything that
jpayne@69:                         has been output so far.  It can be used to actually
jpayne@69:                         display a dialog box after it has been built.
jpayne@69:         a reader        This function is called to read a given prompt,
jpayne@69:                         maybe from the tty, maybe from a field in a
jpayne@69:                         window.  Note that it's called with all string
jpayne@69:                         structures, not only the prompt ones, so it must
jpayne@69:                         check such things itself.
jpayne@69:         a closer        This function closes the session, maybe by closing
jpayne@69:                         the channel to the tty, or closing the window.
jpayne@69: 
jpayne@69:    All these functions are expected to return:
jpayne@69: 
jpayne@69:         0       on error.
jpayne@69:         1       on success.
jpayne@69:         -1      on out-of-band events, for example if some prompting has
jpayne@69:                 been canceled (by pressing Ctrl-C, for example).  This is
jpayne@69:                 only checked when returned by the flusher or the reader.
jpayne@69: 
jpayne@69:    The way this is used, the opener is first called, then the writer for all
jpayne@69:    strings, then the flusher, then the reader for all strings and finally the
jpayne@69:    closer.  Note that if you want to prompt from a terminal or other command
jpayne@69:    line interface, the best is to have the reader also write the prompts
jpayne@69:    instead of having the writer do it.  If you want to prompt from a dialog
jpayne@69:    box, the writer can be used to build up the contents of the box, and the
jpayne@69:    flusher to actually display the box and run the event loop until all data
jpayne@69:    has been given, after which the reader only grabs the given data and puts
jpayne@69:    them back into the UI strings.
jpayne@69: 
jpayne@69:    All method functions take a UI as argument.  Additionally, the writer and
jpayne@69:    the reader take a UI_STRING.
jpayne@69: */
jpayne@69: 
jpayne@69: /*
jpayne@69:  * The UI_STRING type is the data structure that contains all the needed info
jpayne@69:  * about a string or a prompt, including test data for a verification prompt.
jpayne@69:  */
jpayne@69: typedef struct ui_string_st UI_STRING;
jpayne@69: DEFINE_STACK_OF(UI_STRING)
jpayne@69: 
jpayne@69: /*
jpayne@69:  * The different types of strings that are currently supported. This is only
jpayne@69:  * needed by method authors.
jpayne@69:  */
jpayne@69: enum UI_string_types {
jpayne@69:     UIT_NONE = 0,
jpayne@69:     UIT_PROMPT,                 /* Prompt for a string */
jpayne@69:     UIT_VERIFY,                 /* Prompt for a string and verify */
jpayne@69:     UIT_BOOLEAN,                /* Prompt for a yes/no response */
jpayne@69:     UIT_INFO,                   /* Send info to the user */
jpayne@69:     UIT_ERROR                   /* Send an error message to the user */
jpayne@69: };
jpayne@69: 
jpayne@69: /* Create and manipulate methods */
jpayne@69: UI_METHOD *UI_create_method(const char *name);
jpayne@69: void UI_destroy_method(UI_METHOD *ui_method);
jpayne@69: int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui));
jpayne@69: int UI_method_set_writer(UI_METHOD *method,
jpayne@69:                          int (*writer) (UI *ui, UI_STRING *uis));
jpayne@69: int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui));
jpayne@69: int UI_method_set_reader(UI_METHOD *method,
jpayne@69:                          int (*reader) (UI *ui, UI_STRING *uis));
jpayne@69: int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui));
jpayne@69: int UI_method_set_data_duplicator(UI_METHOD *method,
jpayne@69:                                   void *(*duplicator) (UI *ui, void *ui_data),
jpayne@69:                                   void (*destructor)(UI *ui, void *ui_data));
jpayne@69: int UI_method_set_prompt_constructor(UI_METHOD *method,
jpayne@69:                                      char *(*prompt_constructor) (UI *ui,
jpayne@69:                                                                   const char
jpayne@69:                                                                   *object_desc,
jpayne@69:                                                                   const char
jpayne@69:                                                                   *object_name));
jpayne@69: int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data);
jpayne@69: int (*UI_method_get_opener(const UI_METHOD *method)) (UI *);
jpayne@69: int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *);
jpayne@69: int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *);
jpayne@69: int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *);
jpayne@69: int (*UI_method_get_closer(const UI_METHOD *method)) (UI *);
jpayne@69: char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
jpayne@69:     (UI *, const char *, const char *);
jpayne@69: void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *);
jpayne@69: void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *);
jpayne@69: const void *UI_method_get_ex_data(const UI_METHOD *method, int idx);
jpayne@69: 
jpayne@69: /*
jpayne@69:  * The following functions are helpers for method writers to access relevant
jpayne@69:  * data from a UI_STRING.
jpayne@69:  */
jpayne@69: 
jpayne@69: /* Return type of the UI_STRING */
jpayne@69: enum UI_string_types UI_get_string_type(UI_STRING *uis);
jpayne@69: /* Return input flags of the UI_STRING */
jpayne@69: int UI_get_input_flags(UI_STRING *uis);
jpayne@69: /* Return the actual string to output (the prompt, info or error) */
jpayne@69: const char *UI_get0_output_string(UI_STRING *uis);
jpayne@69: /*
jpayne@69:  * Return the optional action string to output (the boolean prompt
jpayne@69:  * instruction)
jpayne@69:  */
jpayne@69: const char *UI_get0_action_string(UI_STRING *uis);
jpayne@69: /* Return the result of a prompt */
jpayne@69: const char *UI_get0_result_string(UI_STRING *uis);
jpayne@69: int UI_get_result_string_length(UI_STRING *uis);
jpayne@69: /*
jpayne@69:  * Return the string to test the result against.  Only useful with verifies.
jpayne@69:  */
jpayne@69: const char *UI_get0_test_string(UI_STRING *uis);
jpayne@69: /* Return the required minimum size of the result */
jpayne@69: int UI_get_result_minsize(UI_STRING *uis);
jpayne@69: /* Return the required maximum size of the result */
jpayne@69: int UI_get_result_maxsize(UI_STRING *uis);
jpayne@69: /* Set the result of a UI_STRING. */
jpayne@69: int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
jpayne@69: int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len);
jpayne@69: 
jpayne@69: /* A couple of popular utility functions */
jpayne@69: int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
jpayne@69:                            int verify);
jpayne@69: int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
jpayne@69:                     int verify);
jpayne@69: UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag);
jpayne@69: 
jpayne@69: 
jpayne@69: # ifdef  __cplusplus
jpayne@69: }
jpayne@69: # endif
jpayne@69: #endif