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