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