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. When everything is
84 fine, they return 0, a positive value or a non-NULL pointer, all depending
87 /* Creators and destructor. */
89 UI *UI_new_method(const UI_METHOD *method);
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 with the following meanings:
95 add add a text or prompt string. The pointers given to these
96 functions are used verbatim, no copying is done.
97 dup make a copy of the text or prompt string, then add the copy
98 to the collection of strings in the user interface.
100 The function is a name for the functionality that the given
101 string shall be used for. It can be one of:
102 input use the string as data prompt.
103 verify use the string as verification prompt. This
104 is used to verify a previous input.
105 info use the string for informational output.
106 error use the string for error output.
107 Honestly, there's currently no difference between info and error for the
110 All of the functions in this group take a UI and a string. The input and
111 verify addition functions also take an echo flag, a buffer for the result
112 to end up with, a minimum input size and a maximum input size (the result
113 buffer MUST be large enough to be able to contain the maximum number of
114 characters). Additionally, the verify addition functions takes another
115 buffer to compare the result against.
117 On success, the all return an index of the added information. That index
118 is usefull when retrieving results with UI_get0_result(). */
119 int UI_add_input_string(UI *ui, const char *prompt, int echo_p,
120 char *result_buf, int minsize, int maxsize);
121 int UI_dup_input_string(UI *ui, const char *prompt, int echo_p,
122 char *result_buf, int minsize, int maxsize);
123 int UI_add_verify_string(UI *ui, const char *prompt, int echo_p,
124 char *result_buf, int minsize, int maxsize, const char *test_buf);
125 int UI_dup_verify_string(UI *ui, const char *prompt, int echo_p,
126 char *result_buf, int minsize, int maxsize, const char *test_buf);
127 int UI_add_info_string(UI *ui, const char *text);
128 int UI_dup_info_string(UI *ui, const char *text);
129 int UI_add_error_string(UI *ui, const char *text);
130 int UI_dup_error_string(UI *ui, const char *text);
132 /* The following function is used to store a pointer to user-specific data.
133 Any previous such pointer will be returned and replaced.
135 For callback purposes, this function makes a lot more sense than using
136 ex_data, since the latter requires that different parts of OpenSSL or
137 applications share the same ex_data index.
139 Note that the UI_OpenSSL() method completely ignores the user data.
140 Other methods may not, however. */
141 void *UI_add_user_data(UI *ui, void *user_data);
142 /* We need a user data retrieving function as well. */
143 void *UI_get0_user_data(UI *ui);
145 /* Return the result associated with a prompt given with the index i. */
146 const char *UI_get0_result(UI *ui, int i);
148 /* When all strings have been added, process the whole thing. */
149 int UI_process(UI *ui);
151 /* Some methods may use extra data */
152 #define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg)
153 #define UI_get_app_data(s) UI_get_ex_data(s,0)
154 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
155 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
156 int UI_set_ex_data(UI *r,int idx,void *arg);
157 void *UI_get_ex_data(UI *r, int idx);
159 /* Use specific methods instead of the built-in one */
160 void UI_set_default_method(const UI_METHOD *meth);
161 const UI_METHOD *UI_get_default_method(void);
162 const UI_METHOD *UI_get_method(UI *ui);
163 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
165 /* The method with all the built-in thingies */
166 UI_METHOD *UI_OpenSSL(void);
169 /* ---------- For method writers ---------- */
170 /* A method contains a number of functions that implement the low level
171 of the User Interface. The functions are:
173 an opener This function starts a session, maybe by opening
174 a channel to a tty, or by opening a window.
175 a writer This function is called to write a given string,
176 maybe to the tty, maybe as a field label in a
178 a reader This function is called to read a given prompt,
179 maybe from the tty, maybe from a field in a
180 window. Note that it's called wth all string
181 structures, not only the prompt ones, so it must
182 check such things itself.
183 a closer This function closes the session, maybe by closing
184 the channel to the tty, or closing the window.
186 The way this is used, the opener is first called, then the writer for all
187 strings, then the reader for all strings and finally the closer. Note that
188 if you want to prompt from a terminal or other command line interface, the
189 best is to have the reader also write the prompts instead of having the
191 All method functions take a UI as argument. Additionally, the writer and
192 the reader take a UI_STRING. */
194 /* The UI_STRING type is the data structure that contains all the needed info
195 about a string or a prompt, including test data for a verification prompt.
197 DECLARE_STACK_OF(UI_STRING)
198 typedef struct ui_string_st UI_STRING;
200 /* The different types of strings that are currently supported.
201 This is only needed by method authors. */
205 UI_STRING_ECHO, /* Prompt for a string */
206 UI_STRING_NOECHO, /* Prompt for a hidden string */
207 UI_VERIFY_ECHO, /* Prompt for a string and verify */
208 UI_VERIFY_NOECHO, /* Prompt for a hidden string and verify */
209 UI_INFO, /* Send info to the user */
210 UI_ERROR /* Send an error message to the user */
213 /* Create and manipulate methods */
214 UI_METHOD *UI_create_method(void);
215 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui));
216 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis));
217 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis));
218 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui));
219 int (*UI_method_get_opener(UI_METHOD *method))(UI*);
220 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*);
221 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*);
222 int (*UI_method_get_closer(UI_METHOD *method))(UI*);
224 /* The following functions are helpers for method writers to access relevant
225 data from a UI_STRING. */
227 /* Return type type of the UI_STRING */
228 enum UI_string_types UI_get_string_type(UI_STRING *uis);
229 /* Return the actual string to output (the prompt, info or error) */
230 const char *UI_get0_output_string(UI_STRING *uis);
231 /* Return the result of a prompt */
232 const char *UI_get0_result_string(UI_STRING *uis);
233 /* Return the string to test the result against. Only useful with verifies. */
234 const char *UI_get0_test_string(UI_STRING *uis);
235 /* Return the required minimum size of the result */
236 int UI_get_result_minsize(UI_STRING *uis);
237 /* Return the required maximum size of the result */
238 int UI_get_result_maxsize(UI_STRING *uis);
239 /* Set the result of a UI_STRING. */
240 int UI_set_result(UI_STRING *uis, char *result);
243 /* BEGIN ERROR CODES */
244 /* The following lines are auto generated by the script mkerr.pl. Any changes
245 * made after this point may be overwritten when the script is next run.
247 void ERR_load_UI_strings(void);
249 /* Error codes for the UI functions. */
251 /* Function codes. */
252 #define UI_F_GENERAL_ALLOCATE_STRING 100
253 #define UI_F_UI_DUP_ERROR_STRING 101
254 #define UI_F_UI_DUP_INFO_STRING 102
255 #define UI_F_UI_DUP_INPUT_STRING 103
256 #define UI_F_UI_DUP_VERIFY_STRING 106
257 #define UI_F_UI_GET0_RESULT 107
258 #define UI_F_UI_NEW_METHOD 104
259 #define UI_F_UI_SET_RESULT 105
262 #define UI_R_INDEX_TOO_LARGE 102
263 #define UI_R_INDEX_TOO_SMALL 103
264 #define UI_R_RESULT_TOO_LARGE 100
265 #define UI_R_RESULT_TOO_SMALL 101