2 * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
13 # include <openssl/opensslconf.h>
15 # ifndef OPENSSL_NO_UI
17 # if OPENSSL_API_COMPAT < 0x10100000L
18 # include <openssl/crypto.h>
20 # include <openssl/safestack.h>
21 # include <openssl/pem.h>
22 # include <openssl/ossl_typ.h>
23 # include <openssl/uierr.h>
30 * All the following functions return -1 or NULL on error and in some cases
31 * (UI_process()) -2 if interrupted or in some other way cancelled. When
32 * everything is fine, they return 0, a positive value or a non-NULL pointer,
33 * all depending on their purpose.
36 /* Creators and destructor. */
38 UI *UI_new_method(const UI_METHOD *method);
42 The following functions are used to add strings to be printed and prompt
43 strings to prompt for data. The names are UI_{add,dup}_<function>_string
44 and UI_{add,dup}_input_boolean.
46 UI_{add,dup}_<function>_string have the following meanings:
47 add add a text or prompt string. The pointers given to these
48 functions are used verbatim, no copying is done.
49 dup make a copy of the text or prompt string, then add the copy
50 to the collection of strings in the user interface.
52 The function is a name for the functionality that the given
53 string shall be used for. It can be one of:
54 input use the string as data prompt.
55 verify use the string as verification prompt. This
56 is used to verify a previous input.
57 info use the string for informational output.
58 error use the string for error output.
59 Honestly, there's currently no difference between info and error for the
62 UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
63 and are typically used when one wants to prompt for a yes/no response.
65 All of the functions in this group take a UI and a prompt string.
66 The string input and verify addition functions also take a flag argument,
67 a buffer for the result to end up with, a minimum input size and a maximum
68 input size (the result buffer MUST be large enough to be able to contain
69 the maximum number of characters). Additionally, the verify addition
70 functions takes another buffer to compare the result against.
71 The boolean input functions take an action description string (which should
72 be safe to ignore if the expected user action is obvious, for example with
73 a dialog box with an OK button and a Cancel button), a string of acceptable
74 characters to mean OK and to mean Cancel. The two last strings are checked
75 to make sure they don't have common characters. Additionally, the same
76 flag argument as for the string input is taken, as well as a result buffer.
77 The result buffer is required to be at least one byte long. Depending on
78 the answer, the first character from the OK or the Cancel character strings
79 will be stored in the first byte of the result buffer. No NUL will be
80 added, so the result is *not* a string.
82 On success, the all return an index of the added information. That index
83 is useful when retrieving results with UI_get0_result(). */
84 int UI_add_input_string(UI *ui, const char *prompt, int flags,
85 char *result_buf, int minsize, int maxsize);
86 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
87 char *result_buf, int minsize, int maxsize);
88 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
89 char *result_buf, int minsize, int maxsize,
90 const char *test_buf);
91 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
92 char *result_buf, int minsize, int maxsize,
93 const char *test_buf);
94 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
95 const char *ok_chars, const char *cancel_chars,
96 int flags, char *result_buf);
97 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
98 const char *ok_chars, const char *cancel_chars,
99 int flags, char *result_buf);
100 int UI_add_info_string(UI *ui, const char *text);
101 int UI_dup_info_string(UI *ui, const char *text);
102 int UI_add_error_string(UI *ui, const char *text);
103 int UI_dup_error_string(UI *ui, const char *text);
105 /* These are the possible flags. They can be or'ed together. */
106 /* Use to have echoing of input */
107 # define UI_INPUT_FLAG_ECHO 0x01
109 * Use a default password. Where that password is found is completely up to
110 * the application, it might for example be in the user data set with
111 * UI_add_user_data(). It is not recommended to have more than one input in
112 * each UI being marked with this flag, or the application might get
115 # define UI_INPUT_FLAG_DEFAULT_PWD 0x02
118 * The user of these routines may want to define flags of their own. The core
119 * UI won't look at those, but will pass them on to the method routines. They
120 * must use higher bits so they don't get confused with the UI bits above.
121 * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good
122 * example of use is this:
124 * #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE)
127 # define UI_INPUT_FLAG_USER_BASE 16
130 * The following function helps construct a prompt. object_desc is a
131 * textual short description of the object, for example "pass phrase",
132 * and object_name is the name of the object (might be a card name or
134 * The returned string shall always be allocated on the heap with
135 * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
137 * If the ui_method doesn't contain a pointer to a user-defined prompt
138 * constructor, a default string is built, looking like this:
140 * "Enter {object_desc} for {object_name}:"
142 * So, if object_desc has the value "pass phrase" and object_name has
143 * the value "foo.key", the resulting string is:
145 * "Enter pass phrase for foo.key:"
147 char *UI_construct_prompt(UI *ui_method,
148 const char *object_desc, const char *object_name);
151 * The following function is used to store a pointer to user-specific data.
152 * Any previous such pointer will be returned and replaced.
154 * For callback purposes, this function makes a lot more sense than using
155 * ex_data, since the latter requires that different parts of OpenSSL or
156 * applications share the same ex_data index.
158 * Note that the UI_OpenSSL() method completely ignores the user data. Other
159 * methods may not, however.
161 void *UI_add_user_data(UI *ui, void *user_data);
163 * Alternatively, this function is used to duplicate the user data.
164 * This uses the duplicator method function. The destroy function will
165 * be used to free the user data in this case.
167 int UI_dup_user_data(UI *ui, void *user_data);
168 /* We need a user data retrieving function as well. */
169 void *UI_get0_user_data(UI *ui);
171 /* Return the result associated with a prompt given with the index i. */
172 const char *UI_get0_result(UI *ui, int i);
174 /* When all strings have been added, process the whole thing. */
175 int UI_process(UI *ui);
178 * Give a user interface parametrised control commands. This can be used to
179 * send down an integer, a data pointer or a function pointer, as well as be
180 * used to get information from a UI.
182 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void));
186 * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
187 * OpenSSL error stack before printing any info or added error messages and
188 * before any prompting.
190 # define UI_CTRL_PRINT_ERRORS 1
192 * Check if a UI_process() is possible to do again with the same instance of
193 * a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0
196 # define UI_CTRL_IS_REDOABLE 2
198 /* Some methods may use extra data */
199 # define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg)
200 # define UI_get_app_data(s) UI_get_ex_data(s,0)
202 #define UI_get_ex_new_index(l, p, newf, dupf, freef) \
203 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, l, p, newf, dupf, freef)
204 int UI_set_ex_data(UI *r, int idx, void *arg);
205 void *UI_get_ex_data(UI *r, int idx);
207 /* Use specific methods instead of the built-in one */
208 void UI_set_default_method(const UI_METHOD *meth);
209 const UI_METHOD *UI_get_default_method(void);
210 const UI_METHOD *UI_get_method(UI *ui);
211 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
213 /* The method with all the built-in thingies */
214 UI_METHOD *UI_OpenSSL(void);
217 * NULL method. Literally does nothing, but may serve as a placeholder
218 * to avoid internal default.
220 const UI_METHOD *UI_null(void);
222 /* ---------- For method writers ---------- */
224 A method contains a number of functions that implement the low level
225 of the User Interface. The functions are:
227 an opener This function starts a session, maybe by opening
228 a channel to a tty, or by opening a window.
229 a writer This function is called to write a given string,
230 maybe to the tty, maybe as a field label in a
232 a flusher This function is called to flush everything that
233 has been output so far. It can be used to actually
234 display a dialog box after it has been built.
235 a reader This function is called to read a given prompt,
236 maybe from the tty, maybe from a field in a
237 window. Note that it's called with all string
238 structures, not only the prompt ones, so it must
239 check such things itself.
240 a closer This function closes the session, maybe by closing
241 the channel to the tty, or closing the window.
243 All these functions are expected to return:
247 -1 on out-of-band events, for example if some prompting has
248 been canceled (by pressing Ctrl-C, for example). This is
249 only checked when returned by the flusher or the reader.
251 The way this is used, the opener is first called, then the writer for all
252 strings, then the flusher, then the reader for all strings and finally the
253 closer. Note that if you want to prompt from a terminal or other command
254 line interface, the best is to have the reader also write the prompts
255 instead of having the writer do it. If you want to prompt from a dialog
256 box, the writer can be used to build up the contents of the box, and the
257 flusher to actually display the box and run the event loop until all data
258 has been given, after which the reader only grabs the given data and puts
259 them back into the UI strings.
261 All method functions take a UI as argument. Additionally, the writer and
262 the reader take a UI_STRING.
266 * The UI_STRING type is the data structure that contains all the needed info
267 * about a string or a prompt, including test data for a verification prompt.
269 typedef struct ui_string_st UI_STRING;
270 DEFINE_STACK_OF(UI_STRING)
273 * The different types of strings that are currently supported. This is only
274 * needed by method authors.
276 enum UI_string_types {
278 UIT_PROMPT, /* Prompt for a string */
279 UIT_VERIFY, /* Prompt for a string and verify */
280 UIT_BOOLEAN, /* Prompt for a yes/no response */
281 UIT_INFO, /* Send info to the user */
282 UIT_ERROR /* Send an error message to the user */
285 /* Create and manipulate methods */
286 UI_METHOD *UI_create_method(const char *name);
287 void UI_destroy_method(UI_METHOD *ui_method);
288 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui));
289 int UI_method_set_writer(UI_METHOD *method,
290 int (*writer) (UI *ui, UI_STRING *uis));
291 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui));
292 int UI_method_set_reader(UI_METHOD *method,
293 int (*reader) (UI *ui, UI_STRING *uis));
294 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui));
295 int UI_method_set_data_duplicator(UI_METHOD *method,
296 void *(*duplicator) (UI *ui, void *ui_data),
297 void (*destructor)(UI *ui, void *ui_data));
298 int UI_method_set_prompt_constructor(UI_METHOD *method,
299 char *(*prompt_constructor) (UI *ui,
304 int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data);
305 int (*UI_method_get_opener(const UI_METHOD *method)) (UI *);
306 int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *);
307 int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *);
308 int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *);
309 int (*UI_method_get_closer(const UI_METHOD *method)) (UI *);
310 char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
311 (UI *, const char *, const char *);
312 void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *);
313 void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *);
314 const void *UI_method_get_ex_data(const UI_METHOD *method, int idx);
317 * The following functions are helpers for method writers to access relevant
318 * data from a UI_STRING.
321 /* Return type of the UI_STRING */
322 enum UI_string_types UI_get_string_type(UI_STRING *uis);
323 /* Return input flags of the UI_STRING */
324 int UI_get_input_flags(UI_STRING *uis);
325 /* Return the actual string to output (the prompt, info or error) */
326 const char *UI_get0_output_string(UI_STRING *uis);
328 * Return the optional action string to output (the boolean prompt
331 const char *UI_get0_action_string(UI_STRING *uis);
332 /* Return the result of a prompt */
333 const char *UI_get0_result_string(UI_STRING *uis);
335 * Return the string to test the result against. Only useful with verifies.
337 const char *UI_get0_test_string(UI_STRING *uis);
338 /* Return the required minimum size of the result */
339 int UI_get_result_minsize(UI_STRING *uis);
340 /* Return the required maximum size of the result */
341 int UI_get_result_maxsize(UI_STRING *uis);
342 /* Set the result of a UI_STRING. */
343 int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
345 /* A couple of popular utility functions */
346 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
348 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
350 UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag);
352 int ERR_load_UI_strings(void);