1 /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte (levitte@stacken.kth.se) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * openssl-core@openssl.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/crypto.h>
63 #include <openssl/safestack.h>
69 /* The UI type is a holder for a specific user interface session. It can
70 contain an illimited number of informational or error strings as well
71 as things to prompt for, both passwords (noecho mode) and others (echo
72 mode), and verification of the same. All of these are called strings,
73 and are further described below. */
74 typedef struct ui_st UI;
76 /* All instances of UI have a reference to a method structure, which is a
77 ordered vector of functions that implement the lower level things to do.
78 There is an instruction on the implementation further down, in the section
79 for method implementors. */
80 typedef struct ui_method_st UI_METHOD;
83 /* All the following functions return -1 or NULL on error and in some cases
84 (UI_process()) -2 if interrupted or in some other way cancelled.
85 When everything is fine, they return 0, a positive value or a non-NULL
86 pointer, all depending on their purpose. */
88 /* Creators and destructor. */
90 UI *UI_new_method(const UI_METHOD *method);
93 /* The following functions are used to add strings to be printed and prompt
94 strings to prompt for data. The names are UI_{add,dup}_<function>_string,
95 with the following meanings:
96 add add a text or prompt string. The pointers given to these
97 functions are used verbatim, no copying is done.
98 dup make a copy of the text or prompt string, then add the copy
99 to the collection of strings in the user interface.
101 The function is a name for the functionality that the given
102 string shall be used for. It can be one of:
103 input use the string as data prompt.
104 verify use the string as verification prompt. This
105 is used to verify a previous input.
106 info use the string for informational output.
107 error use the string for error output.
108 Honestly, there's currently no difference between info and error for the
111 All of the functions in this group take a UI and a string. The input and
112 verify addition functions also take a flag argument, a buffer for the result
113 to end up with, a minimum input size and a maximum input size (the result
114 buffer MUST be large enough to be able to contain the maximum number of
115 characters). Additionally, the verify addition functions takes another
116 buffer to compare the result against.
118 On success, the all return an index of the added information. That index
119 is usefull when retrieving results with UI_get0_result(). */
120 int UI_add_input_string(UI *ui, const char *prompt, int flags,
121 char *result_buf, int minsize, int maxsize);
122 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
123 char *result_buf, int minsize, int maxsize);
124 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
125 char *result_buf, int minsize, int maxsize, const char *test_buf);
126 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
127 char *result_buf, int minsize, int maxsize, const char *test_buf);
128 int UI_add_info_string(UI *ui, const char *text);
129 int UI_dup_info_string(UI *ui, const char *text);
130 int UI_add_error_string(UI *ui, const char *text);
131 int UI_dup_error_string(UI *ui, const char *text);
133 /* These are the possible flags. They can be or'ed together. */
134 /* Use to have echoing of input */
135 #define UI_INPUT_FLAG_ECHO 0x01
136 /* Use a default answer. Where that answer is found is completely up
137 to the application, it might for example be in the user data set
138 with UI_add_user_data(). It is not recommended to have more than
139 one input in each UI being marked with this flag, or the application
140 might get confused. */
141 #define UI_INPUT_FLAG_DEFAULT 0x02
143 /* The user of these routines may want to define flags of their own. The core
144 UI won't look at those, but will pass them on to the method routines. They
145 must use higher bits so they don't get confused with the UI bits above.
146 UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good
147 example of use is this:
149 #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE)
152 #define UI_INPUT_FLAG_USER_BASE 16
155 /* The following function helps construct a prompt. object_desc is a
156 textual short description of the object, for example "pass phrase",
157 and object_name is the name of the object (might be a card name or
159 The returned string shall always be allocated on the heap with
160 OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
162 If the ui_method doesn't contain a pointer to a user-defined prompt
163 constructor, a default string is built, looking like this:
165 "Enter {object_desc} for {object_name}:"
167 So, if object_desc has the value "pass phrase" and object_name has
168 the value "foo.key", the resulting string is:
170 "Enter pass phrase for foo.key:"
172 char *UI_construct_prompt(UI *ui_method,
173 const char *object_desc, const char *object_name);
176 /* The following function is used to store a pointer to user-specific data.
177 Any previous such pointer will be returned and replaced.
179 For callback purposes, this function makes a lot more sense than using
180 ex_data, since the latter requires that different parts of OpenSSL or
181 applications share the same ex_data index.
183 Note that the UI_OpenSSL() method completely ignores the user data.
184 Other methods may not, however. */
185 void *UI_add_user_data(UI *ui, void *user_data);
186 /* We need a user data retrieving function as well. */
187 void *UI_get0_user_data(UI *ui);
189 /* Return the result associated with a prompt given with the index i. */
190 const char *UI_get0_result(UI *ui, int i);
192 /* When all strings have been added, process the whole thing. */
193 int UI_process(UI *ui);
195 /* Some methods may use extra data */
196 #define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg)
197 #define UI_get_app_data(s) UI_get_ex_data(s,0)
198 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
199 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
200 int UI_set_ex_data(UI *r,int idx,void *arg);
201 void *UI_get_ex_data(UI *r, int idx);
203 /* Use specific methods instead of the built-in one */
204 void UI_set_default_method(const UI_METHOD *meth);
205 const UI_METHOD *UI_get_default_method(void);
206 const UI_METHOD *UI_get_method(UI *ui);
207 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
209 /* The method with all the built-in thingies */
210 UI_METHOD *UI_OpenSSL(void);
213 /* ---------- For method writers ---------- */
214 /* A method contains a number of functions that implement the low level
215 of the User Interface. The functions are:
217 an opener This function starts a session, maybe by opening
218 a channel to a tty, or by opening a window.
219 a writer This function is called to write a given string,
220 maybe to the tty, maybe as a field label in a
222 a flusher This function is called to flush everything that
223 has been output so far. It can be used to actually
224 display a dialog box after it has been built.
225 a reader This function is called to read a given prompt,
226 maybe from the tty, maybe from a field in a
227 window. Note that it's called wth all string
228 structures, not only the prompt ones, so it must
229 check such things itself.
230 a closer This function closes the session, maybe by closing
231 the channel to the tty, or closing the window.
233 All these functions are expected to return:
237 -1 on out-of-band events, for example if some prompting has
238 been canceled (by pressing Ctrl-C, for example). This is
239 only checked when returned by the flusher or the reader.
241 The way this is used, the opener is first called, then the writer for all
242 strings, then the flusher, then the reader for all strings and finally the
243 closer. Note that if you want to prompt from a terminal or other command
244 line interface, the best is to have the reader also write the prompts
245 instead of having the writer do it. If you want to prompt from a dialog
246 box, the writer can be used to build up the contents of the box, and the
247 flusher to actually display the box and run the event loop until all data
248 has been given, after which the reader only grabs the given data and puts
249 them back into the UI strings.
251 All method functions take a UI as argument. Additionally, the writer and
252 the reader take a UI_STRING.
255 /* The UI_STRING type is the data structure that contains all the needed info
256 about a string or a prompt, including test data for a verification prompt.
258 DECLARE_STACK_OF(UI_STRING)
259 typedef struct ui_string_st UI_STRING;
261 /* The different types of strings that are currently supported.
262 This is only needed by method authors. */
266 UIT_PROMPT, /* Prompt for a string */
267 UIT_VERIFY, /* Prompt for a string and verify */
268 UIT_INFO, /* Send info to the user */
269 UIT_ERROR /* Send an error message to the user */
272 /* Create and manipulate methods */
273 UI_METHOD *UI_create_method(char *name);
274 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui));
275 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis));
276 int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui));
277 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis));
278 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui));
279 int (*UI_method_get_opener(UI_METHOD *method))(UI*);
280 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*);
281 int (*UI_method_get_flusher(UI_METHOD *method))(UI*);
282 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*);
283 int (*UI_method_get_closer(UI_METHOD *method))(UI*);
285 /* The following functions are helpers for method writers to access relevant
286 data from a UI_STRING. */
288 /* Return type of the UI_STRING */
289 enum UI_string_types UI_get_string_type(UI_STRING *uis);
290 /* Return input flags of the UI_STRING */
291 int UI_get_input_flags(UI_STRING *uis);
292 /* Return the actual string to output (the prompt, info or error) */
293 const char *UI_get0_output_string(UI_STRING *uis);
294 /* Return the result of a prompt */
295 const char *UI_get0_result_string(UI_STRING *uis);
296 /* Return the string to test the result against. Only useful with verifies. */
297 const char *UI_get0_test_string(UI_STRING *uis);
298 /* Return the required minimum size of the result */
299 int UI_get_result_minsize(UI_STRING *uis);
300 /* Return the required maximum size of the result */
301 int UI_get_result_maxsize(UI_STRING *uis);
302 /* Set the result of a UI_STRING. */
303 int UI_set_result(UI_STRING *uis, const char *result);
306 /* BEGIN ERROR CODES */
307 /* The following lines are auto generated by the script mkerr.pl. Any changes
308 * made after this point may be overwritten when the script is next run.
310 void ERR_load_UI_strings(void);
312 /* Error codes for the UI functions. */
314 /* Function codes. */
315 #define UI_F_GENERAL_ALLOCATE_STRING 100
316 #define UI_F_UI_DUP_ERROR_STRING 101
317 #define UI_F_UI_DUP_INFO_STRING 102
318 #define UI_F_UI_DUP_INPUT_STRING 103
319 #define UI_F_UI_DUP_VERIFY_STRING 106
320 #define UI_F_UI_GET0_RESULT 107
321 #define UI_F_UI_NEW_METHOD 104
322 #define UI_F_UI_SET_RESULT 105
325 #define UI_R_INDEX_TOO_LARGE 102
326 #define UI_R_INDEX_TOO_SMALL 103
327 #define UI_R_RESULT_TOO_LARGE 100
328 #define UI_R_RESULT_TOO_SMALL 101