xref: /dragonfly/crypto/libressl/include/openssl/ui.h (revision de0e0e4d)
1 /* $OpenBSD: ui.h,v 1.14 2022/07/12 18:43:56 jsing Exp $ */
2 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
3  * project 2001.
4  */
5 /* ====================================================================
6  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58 
59 #ifndef HEADER_UI_H
60 #define HEADER_UI_H
61 
62 #include <openssl/opensslconf.h>
63 
64 #ifndef OPENSSL_NO_DEPRECATED
65 #include <openssl/crypto.h>
66 #endif
67 #include <openssl/safestack.h>
68 #include <openssl/ossl_typ.h>
69 
70 #ifdef  __cplusplus
71 extern "C" {
72 #endif
73 
74 /* Declared already in ossl_typ.h */
75 /* typedef struct ui_st UI; */
76 /* typedef struct ui_method_st UI_METHOD; */
77 
78 
79 /*
80  * All the following functions return -1 or NULL on error and in some cases
81  * (UI_process()) -2 if interrupted or in some other way cancelled.
82  * When everything is fine, they return 0, a positive value or a non-NULL
83  * pointer, all depending on their purpose.
84  */
85 
86 /* Creators and destructor.   */
87 UI *UI_new(void);
88 UI *UI_new_method(const UI_METHOD *method);
89 void UI_free(UI *ui);
90 
91 /*
92  * The following functions are used to add strings to be printed and prompt
93  * strings to prompt for data.  The names are UI_{add,dup}_<function>_string
94  * and UI_{add,dup}_input_boolean.
95  *
96  * UI_{add,dup}_<function>_string have the following meanings:
97  *	add	add a text or prompt string.  The pointers given to these
98  *		functions are used verbatim, no copying is done.
99  *	dup	make a copy of the text or prompt string, then add the copy
100  *		to the collection of strings in the user interface.
101  *	<function>
102  *		The function is a name for the functionality that the given
103  *		string shall be used for.  It can be one of:
104  *			input	use the string as data prompt.
105  *			verify	use the string as verification prompt.  This
106  *				is used to verify a previous input.
107  *			info	use the string for informational output.
108  *			error	use the string for error output.
109  * Honestly, there's currently no difference between info and error for the
110  * moment.
111  *
112  * UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
113  * and are typically used when one wants to prompt for a yes/no response.
114  *
115  * All of the functions in this group take a UI and a prompt string.
116  * The string input and verify addition functions also take a flag argument,
117  * a buffer for the result to end up in, a minimum input size and a maximum
118  * input size (the result buffer MUST be large enough to be able to contain
119  * the maximum number of characters).  Additionally, the verify addition
120  * functions takes another buffer to compare the result against.
121  * The boolean input functions take an action description string (which should
122  * be safe to ignore if the expected user action is obvious, for example with
123  * a dialog box with an OK button and a Cancel button), a string of acceptable
124  * characters to mean OK and to mean Cancel.  The two last strings are checked
125  * to make sure they don't have common characters.  Additionally, the same
126  * flag argument as for the string input is taken, as well as a result buffer.
127  * The result buffer is required to be at least one byte long.  Depending on
128  * the answer, the first character from the OK or the Cancel character strings
129  * will be stored in the first byte of the result buffer.  No NUL will be
130  * added, so the result is *not* a string.
131  *
132  * On success, the functions all return an index of the added information.
133  * That index is useful when retrieving results with UI_get0_result().
134  */
135 int UI_add_input_string(UI *ui, const char *prompt, int flags,
136     char *result_buf, int minsize, int maxsize);
137 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
138     char *result_buf, int minsize, int maxsize);
139 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
140     char *result_buf, int minsize, int maxsize, const char *test_buf);
141 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
142     char *result_buf, int minsize, int maxsize, const char *test_buf);
143 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
144     const char *ok_chars, const char *cancel_chars,
145     int flags, char *result_buf);
146 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
147     const char *ok_chars, const char *cancel_chars,
148     int flags, char *result_buf);
149 int UI_add_info_string(UI *ui, const char *text);
150 int UI_dup_info_string(UI *ui, const char *text);
151 int UI_add_error_string(UI *ui, const char *text);
152 int UI_dup_error_string(UI *ui, const char *text);
153 
154 /* These are the possible flags.  They can be or'ed together. */
155 /* Use to have echoing of input */
156 #define UI_INPUT_FLAG_ECHO		0x01
157 /*
158  * Use a default password.  Where that password is found is completely
159  * up to the application, it might for example be in the user data set
160  * with UI_add_user_data().  It is not recommended to have more than
161  * one input in each UI being marked with this flag, or the application
162  * might get confused.
163  */
164 #define UI_INPUT_FLAG_DEFAULT_PWD	0x02
165 
166 /*
167  * Users of these routines may want to define flags of their own.  The core
168  * UI won't look at those, but will pass them on to the method routines.  They
169  * must use higher bits so they don't get confused with the UI bits above.
170  * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use.  A good
171  * example of use is this:
172  *
173  *	#define MY_UI_FLAG1	(0x01 << UI_INPUT_FLAG_USER_BASE)
174  */
175 #define UI_INPUT_FLAG_USER_BASE	16
176 
177 
178 /*
179  * The following function helps construct a prompt.  object_desc is a
180  * textual short description of the object, for example "pass phrase",
181  * and object_name is the name of the object (might be a card name or
182  * a file name.
183  * The returned string shall always be allocated on the heap with
184  * malloc(), and need to be free'd with free().
185  *
186  * If the ui_method doesn't contain a pointer to a user-defined prompt
187  * constructor, a default string is built, looking like this:
188  *
189  *	"Enter {object_desc} for {object_name}:"
190  *
191  * So, if object_desc has the value "pass phrase" and object_name has
192  * the value "foo.key", the resulting string is:
193  *
194  *	"Enter pass phrase for foo.key:"
195  */
196 char *UI_construct_prompt(UI *ui_method, const char *object_desc,
197     const char *object_name);
198 
199 
200 /*
201  * The following function is used to store a pointer to user-specific data.
202  * Any previous such pointer will be returned and replaced.
203  *
204  * For callback purposes, this function makes a lot more sense than using
205  * ex_data, since the latter requires that different parts of OpenSSL or
206  * applications share the same ex_data index.
207  *
208  * Note that the UI_OpenSSL() method completely ignores the user data.
209  * Other methods may not, however.
210  */
211 void *UI_add_user_data(UI *ui, void *user_data);
212 /* We need a user data retrieving function as well.  */
213 void *UI_get0_user_data(UI *ui);
214 
215 /* Return the result associated with a prompt given with the index i. */
216 const char *UI_get0_result(UI *ui, int i);
217 
218 /* When all strings have been added, process the whole thing. */
219 int UI_process(UI *ui);
220 
221 /*
222  * Give a user interface parametrised control commands.  This can be used to
223  * send down an integer, a data pointer or a function pointer, as well as
224  * be used to get information from a UI.
225  */
226 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)(void));
227 
228 /* The commands */
229 /*
230  * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
231  * OpenSSL error stack before printing any info or added error messages and
232  * before any prompting.
233  */
234 #define UI_CTRL_PRINT_ERRORS		1
235 /*
236  * Check if a UI_process() is possible to do again with the same instance of
237  * a user interface.  This makes UI_ctrl() return 1 if it is redoable, and 0
238  * if not.
239  */
240 #define UI_CTRL_IS_REDOABLE		2
241 
242 
243 /* Some methods may use extra data */
244 #define UI_set_app_data(s,arg)         UI_set_ex_data(s,0,arg)
245 #define UI_get_app_data(s)             UI_get_ex_data(s,0)
246 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
247     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
248 int UI_set_ex_data(UI *r, int idx, void *arg);
249 void *UI_get_ex_data(UI *r, int idx);
250 
251 /* Use specific methods instead of the built-in one */
252 void UI_set_default_method(const UI_METHOD *meth);
253 const UI_METHOD *UI_get_default_method(void);
254 const UI_METHOD *UI_get_method(UI *ui);
255 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
256 
257 /* The method with all the built-in thingies */
258 UI_METHOD *UI_OpenSSL(void);
259 
260 
261 /*
262  * ---------- For method writers ----------
263  * A method contains a number of functions that implement the low level
264  * of the User Interface.  The functions are:
265  *
266  *	an opener	This function starts a session, maybe by opening
267  *			a channel to a tty, or by opening a window.
268  *	a writer	This function is called to write a given string,
269  *			maybe to the tty, maybe as a field label in a
270  *			window.
271  *	a flusher	This function is called to flush everything that
272  *			has been output so far.  It can be used to actually
273  *			display a dialog box after it has been built.
274  *	a reader	This function is called to read a given prompt,
275  *			maybe from the tty, maybe from a field in a
276  *			window.  Note that it's called wth all string
277  *			structures, not only the prompt ones, so it must
278  *			check such things itself.
279  *	a closer	This function closes the session, maybe by closing
280  *			the channel to the tty, or closing the window.
281  *
282  * All these functions are expected to return:
283  *
284  *	 0	on error.
285  *	 1	on success.
286  *	-1	on out-of-band events, for example if some prompting has
287  *		been canceled (by pressing Ctrl-C, for example).  This is
288  *		only checked when returned by the flusher or the reader.
289  *
290  * The way this is used, the opener is first called, then the writer for all
291  * strings, then the flusher, then the reader for all strings and finally the
292  * closer.  Note that if you want to prompt from a terminal or other command
293  * line interface, the best is to have the reader also write the prompts
294  * instead of having the writer do it.  If you want to prompt from a dialog
295  * box, the writer can be used to build up the contents of the box, and the
296  * flusher to actually display the box and run the event loop until all data
297  * has been given, after which the reader only grabs the given data and puts
298  * them back into the UI strings.
299  *
300  * All method functions take a UI as argument.  Additionally, the writer and
301  * the reader take a UI_STRING.
302  */
303 
304 /*
305  * The UI_STRING type is the data structure that contains all the needed info
306  * about a string or a prompt, including test data for a verification prompt.
307  */
308 typedef struct ui_string_st UI_STRING;
309 DECLARE_STACK_OF(UI_STRING)
310 
311 /*
312  * The different types of strings that are currently supported.
313  * This is only needed by method authors.
314  */
315 enum UI_string_types {
316 	UIT_NONE = 0,
317 	UIT_PROMPT,		/* Prompt for a string */
318 	UIT_VERIFY,		/* Prompt for a string and verify */
319 	UIT_BOOLEAN,		/* Prompt for a yes/no response */
320 	UIT_INFO,		/* Send info to the user */
321 	UIT_ERROR		/* Send an error message to the user */
322 };
323 
324 /* Create and manipulate methods */
325 UI_METHOD *UI_create_method(const char *name);
326 void UI_destroy_method(UI_METHOD *ui_method);
327 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui));
328 int UI_method_set_writer(UI_METHOD *method,
329     int (*writer)(UI *ui, UI_STRING *uis));
330 int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui));
331 int UI_method_set_reader(UI_METHOD *method,
332     int (*reader)(UI *ui, UI_STRING *uis));
333 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui));
334 int UI_method_set_prompt_constructor(UI_METHOD *method,
335     char *(*prompt_constructor)(UI *ui, const char *object_desc,
336     const char *object_name));
337 int (*UI_method_get_opener(const UI_METHOD *method))(UI *);
338 int (*UI_method_get_writer(const UI_METHOD *method))(UI *, UI_STRING *);
339 int (*UI_method_get_flusher(const UI_METHOD *method))(UI *);
340 int (*UI_method_get_reader(const UI_METHOD *method))(UI *, UI_STRING *);
341 int (*UI_method_get_closer(const UI_METHOD *method))(UI *);
342 char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))(UI *,
343     const char *, const char *);
344 
345 /*
346  * The following functions are helpers for method writers to access relevant
347  * data from a UI_STRING.
348  */
349 /* Return type of the UI_STRING */
350 enum UI_string_types UI_get_string_type(UI_STRING *uis);
351 /* Return input flags of the UI_STRING */
352 int UI_get_input_flags(UI_STRING *uis);
353 /* Return the actual string to output (the prompt, info or error) */
354 const char *UI_get0_output_string(UI_STRING *uis);
355 /* Return the optional action string to output (boolean prompt instruction) */
356 const char *UI_get0_action_string(UI_STRING *uis);
357 /* Return the result of a prompt */
358 const char *UI_get0_result_string(UI_STRING *uis);
359 /* Return the string to test the result against.  Only useful with verifies. */
360 const char *UI_get0_test_string(UI_STRING *uis);
361 /* Return the required minimum size of the result */
362 int UI_get_result_minsize(UI_STRING *uis);
363 /* Return the required maximum size of the result */
364 int UI_get_result_maxsize(UI_STRING *uis);
365 /* Set the result of a UI_STRING. */
366 int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
367 
368 /* A couple of popular utility functions */
369 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
370     int verify);
371 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
372     int verify);
373 
374 void ERR_load_UI_strings(void);
375 
376 /* Error codes for the UI functions. */
377 
378 /* Function codes. */
379 #define UI_F_GENERAL_ALLOCATE_BOOLEAN			 108
380 #define UI_F_GENERAL_ALLOCATE_PROMPT			 109
381 #define UI_F_GENERAL_ALLOCATE_STRING			 100
382 #define UI_F_UI_CTRL					 111
383 #define UI_F_UI_DUP_ERROR_STRING			 101
384 #define UI_F_UI_DUP_INFO_STRING				 102
385 #define UI_F_UI_DUP_INPUT_BOOLEAN			 110
386 #define UI_F_UI_DUP_INPUT_STRING			 103
387 #define UI_F_UI_DUP_VERIFY_STRING			 106
388 #define UI_F_UI_GET0_RESULT				 107
389 #define UI_F_UI_NEW_METHOD				 104
390 #define UI_F_UI_SET_RESULT				 105
391 
392 /* Reason codes. */
393 #define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS		 104
394 #define UI_R_INDEX_TOO_LARGE				 102
395 #define UI_R_INDEX_TOO_SMALL				 103
396 #define UI_R_NO_RESULT_BUFFER				 105
397 #define UI_R_RESULT_TOO_LARGE				 100
398 #define UI_R_RESULT_TOO_SMALL				 101
399 #define UI_R_UNKNOWN_CONTROL_COMMAND			 106
400 
401 #ifdef  __cplusplus
402 }
403 #endif
404 #endif
405