]>
Commit | Line | Data |
---|---|---|
0f113f3e | 1 | /* |
33388b44 | 2 | * Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved. |
a63d5eaa | 3 | * |
48f4ad77 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
21dcbebc RS |
5 | * this file except in compliance with the License. You can obtain a copy |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
a63d5eaa RL |
8 | */ |
9 | ||
ae4186b0 DMSP |
10 | #ifndef OPENSSL_UI_H |
11 | # define OPENSSL_UI_H | |
d86167ec DMSP |
12 | # pragma once |
13 | ||
14 | # include <openssl/macros.h> | |
00db8c60 | 15 | # ifndef OPENSSL_NO_DEPRECATED_3_0 |
d86167ec DMSP |
16 | # define HEADER_UI_H |
17 | # endif | |
a63d5eaa | 18 | |
98186eb4 | 19 | # include <openssl/opensslconf.h> |
a63d5eaa | 20 | |
00db8c60 | 21 | # ifndef OPENSSL_NO_DEPRECATED_1_1_0 |
48feaceb RL |
22 | # include <openssl/crypto.h> |
23 | # endif | |
24 | # include <openssl/safestack.h> | |
25 | # include <openssl/pem.h> | |
50cd4768 | 26 | # include <openssl/types.h> |
48feaceb RL |
27 | # include <openssl/uierr.h> |
28 | ||
29 | /* For compatibility reasons, the macro OPENSSL_NO_UI is currently retained */ | |
936c2b9e | 30 | # ifndef OPENSSL_NO_DEPRECATED_3_0 |
48feaceb RL |
31 | # ifdef OPENSSL_NO_UI_CONSOLE |
32 | # define OPENSSL_NO_UI | |
00deac3e | 33 | # endif |
48feaceb | 34 | # endif |
00deac3e | 35 | |
48feaceb | 36 | # ifdef __cplusplus |
a63d5eaa | 37 | extern "C" { |
48feaceb | 38 | # endif |
a63d5eaa | 39 | |
0f113f3e MC |
40 | /* |
41 | * All the following functions return -1 or NULL on error and in some cases | |
42 | * (UI_process()) -2 if interrupted or in some other way cancelled. When | |
43 | * everything is fine, they return 0, a positive value or a non-NULL pointer, | |
44 | * all depending on their purpose. | |
45 | */ | |
a63d5eaa RL |
46 | |
47 | /* Creators and destructor. */ | |
48 | UI *UI_new(void); | |
49 | UI *UI_new_method(const UI_METHOD *method); | |
50 | void UI_free(UI *ui); | |
51 | ||
1d97c843 TH |
52 | /*- |
53 | The following functions are used to add strings to be printed and prompt | |
2d2ed9df RL |
54 | strings to prompt for data. The names are UI_{add,dup}_<function>_string |
55 | and UI_{add,dup}_input_boolean. | |
56 | ||
57 | UI_{add,dup}_<function>_string have the following meanings: | |
0f113f3e MC |
58 | add add a text or prompt string. The pointers given to these |
59 | functions are used verbatim, no copying is done. | |
60 | dup make a copy of the text or prompt string, then add the copy | |
61 | to the collection of strings in the user interface. | |
62 | <function> | |
63 | The function is a name for the functionality that the given | |
64 | string shall be used for. It can be one of: | |
65 | input use the string as data prompt. | |
66 | verify use the string as verification prompt. This | |
67 | is used to verify a previous input. | |
68 | info use the string for informational output. | |
69 | error use the string for error output. | |
a63d5eaa RL |
70 | Honestly, there's currently no difference between info and error for the |
71 | moment. | |
72 | ||
2d2ed9df RL |
73 | UI_{add,dup}_input_boolean have the same semantics for "add" and "dup", |
74 | and are typically used when one wants to prompt for a yes/no response. | |
75 | ||
2d2ed9df RL |
76 | All of the functions in this group take a UI and a prompt string. |
77 | The string input and verify addition functions also take a flag argument, | |
78 | a buffer for the result to end up with, a minimum input size and a maximum | |
79 | input size (the result buffer MUST be large enough to be able to contain | |
80 | the maximum number of characters). Additionally, the verify addition | |
81 | functions takes another buffer to compare the result against. | |
82 | The boolean input functions take an action description string (which should | |
83 | be safe to ignore if the expected user action is obvious, for example with | |
84 | a dialog box with an OK button and a Cancel button), a string of acceptable | |
85 | characters to mean OK and to mean Cancel. The two last strings are checked | |
86 | to make sure they don't have common characters. Additionally, the same | |
87 | flag argument as for the string input is taken, as well as a result buffer. | |
88 | The result buffer is required to be at least one byte long. Depending on | |
89 | the answer, the first character from the OK or the Cancel character strings | |
90 | will be stored in the first byte of the result buffer. No NUL will be | |
91 | added, so the result is *not* a string. | |
a63d5eaa RL |
92 | |
93 | On success, the all return an index of the added information. That index | |
0d4fb843 | 94 | is useful when retrieving results with UI_get0_result(). */ |
9ad0f681 | 95 | int UI_add_input_string(UI *ui, const char *prompt, int flags, |
0f113f3e | 96 | char *result_buf, int minsize, int maxsize); |
9ad0f681 | 97 | int UI_dup_input_string(UI *ui, const char *prompt, int flags, |
0f113f3e | 98 | char *result_buf, int minsize, int maxsize); |
9ad0f681 | 99 | int UI_add_verify_string(UI *ui, const char *prompt, int flags, |
0f113f3e MC |
100 | char *result_buf, int minsize, int maxsize, |
101 | const char *test_buf); | |
9ad0f681 | 102 | int UI_dup_verify_string(UI *ui, const char *prompt, int flags, |
0f113f3e MC |
103 | char *result_buf, int minsize, int maxsize, |
104 | const char *test_buf); | |
2d2ed9df | 105 | int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, |
0f113f3e MC |
106 | const char *ok_chars, const char *cancel_chars, |
107 | int flags, char *result_buf); | |
2d2ed9df | 108 | int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, |
0f113f3e MC |
109 | const char *ok_chars, const char *cancel_chars, |
110 | int flags, char *result_buf); | |
a63d5eaa RL |
111 | int UI_add_info_string(UI *ui, const char *text); |
112 | int UI_dup_info_string(UI *ui, const char *text); | |
113 | int UI_add_error_string(UI *ui, const char *text); | |
114 | int UI_dup_error_string(UI *ui, const char *text); | |
115 | ||
9ad0f681 RL |
116 | /* These are the possible flags. They can be or'ed together. */ |
117 | /* Use to have echoing of input */ | |
0f113f3e MC |
118 | # define UI_INPUT_FLAG_ECHO 0x01 |
119 | /* | |
120 | * Use a default password. Where that password is found is completely up to | |
121 | * the application, it might for example be in the user data set with | |
122 | * UI_add_user_data(). It is not recommended to have more than one input in | |
123 | * each UI being marked with this flag, or the application might get | |
124 | * confused. | |
125 | */ | |
48feaceb | 126 | # define UI_INPUT_FLAG_DEFAULT_PWD 0x02 |
9ad0f681 | 127 | |
c80fd6b2 MC |
128 | /*- |
129 | * The user of these routines may want to define flags of their own. The core | |
130 | * UI won't look at those, but will pass them on to the method routines. They | |
131 | * must use higher bits so they don't get confused with the UI bits above. | |
132 | * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good | |
133 | * example of use is this: | |
134 | * | |
0f113f3e | 135 | * #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE) |
c80fd6b2 | 136 | * |
9ad0f681 | 137 | */ |
48feaceb | 138 | # define UI_INPUT_FLAG_USER_BASE 16 |
9ad0f681 | 139 | |
c80fd6b2 MC |
140 | /*- |
141 | * The following function helps construct a prompt. object_desc is a | |
142 | * textual short description of the object, for example "pass phrase", | |
143 | * and object_name is the name of the object (might be a card name or | |
144 | * a file name. | |
145 | * The returned string shall always be allocated on the heap with | |
146 | * OPENSSL_malloc(), and need to be free'd with OPENSSL_free(). | |
147 | * | |
148 | * If the ui_method doesn't contain a pointer to a user-defined prompt | |
149 | * constructor, a default string is built, looking like this: | |
150 | * | |
151 | * "Enter {object_desc} for {object_name}:" | |
152 | * | |
153 | * So, if object_desc has the value "pass phrase" and object_name has | |
154 | * the value "foo.key", the resulting string is: | |
155 | * | |
156 | * "Enter pass phrase for foo.key:" | |
9ad0f681 RL |
157 | */ |
158 | char *UI_construct_prompt(UI *ui_method, | |
0f113f3e | 159 | const char *object_desc, const char *object_name); |
9ad0f681 | 160 | |
0f113f3e MC |
161 | /* |
162 | * The following function is used to store a pointer to user-specific data. | |
163 | * Any previous such pointer will be returned and replaced. | |
164 | * | |
165 | * For callback purposes, this function makes a lot more sense than using | |
166 | * ex_data, since the latter requires that different parts of OpenSSL or | |
167 | * applications share the same ex_data index. | |
168 | * | |
169 | * Note that the UI_OpenSSL() method completely ignores the user data. Other | |
170 | * methods may not, however. | |
171 | */ | |
1e7e62f8 | 172 | void *UI_add_user_data(UI *ui, void *user_data); |
545360c4 RL |
173 | /* |
174 | * Alternatively, this function is used to duplicate the user data. | |
175 | * This uses the duplicator method function. The destroy function will | |
176 | * be used to free the user data in this case. | |
177 | */ | |
178 | int UI_dup_user_data(UI *ui, void *user_data); | |
1e7e62f8 RL |
179 | /* We need a user data retrieving function as well. */ |
180 | void *UI_get0_user_data(UI *ui); | |
181 | ||
a63d5eaa RL |
182 | /* Return the result associated with a prompt given with the index i. */ |
183 | const char *UI_get0_result(UI *ui, int i); | |
4e049e2c | 184 | int UI_get_result_length(UI *ui, int i); |
a63d5eaa RL |
185 | |
186 | /* When all strings have been added, process the whole thing. */ | |
187 | int UI_process(UI *ui); | |
188 | ||
0f113f3e | 189 | /* |
46f4e1be | 190 | * Give a user interface parameterised control commands. This can be used to |
0f113f3e MC |
191 | * send down an integer, a data pointer or a function pointer, as well as be |
192 | * used to get information from a UI. | |
193 | */ | |
194 | int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void)); | |
2d2ed9df RL |
195 | |
196 | /* The commands */ | |
0f113f3e MC |
197 | /* |
198 | * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the | |
199 | * OpenSSL error stack before printing any info or added error messages and | |
200 | * before any prompting. | |
201 | */ | |
48feaceb | 202 | # define UI_CTRL_PRINT_ERRORS 1 |
0f113f3e MC |
203 | /* |
204 | * Check if a UI_process() is possible to do again with the same instance of | |
205 | * a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0 | |
206 | * if not. | |
207 | */ | |
208 | # define UI_CTRL_IS_REDOABLE 2 | |
2d2ed9df | 209 | |
a63d5eaa | 210 | /* Some methods may use extra data */ |
0f113f3e MC |
211 | # define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg) |
212 | # define UI_get_app_data(s) UI_get_ex_data(s,0) | |
e6390aca | 213 | |
48feaceb | 214 | # define UI_get_ex_new_index(l, p, newf, dupf, freef) \ |
e6390aca | 215 | CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, l, p, newf, dupf, freef) |
0f113f3e | 216 | int UI_set_ex_data(UI *r, int idx, void *arg); |
8cc86b81 | 217 | void *UI_get_ex_data(const UI *r, int idx); |
a63d5eaa RL |
218 | |
219 | /* Use specific methods instead of the built-in one */ | |
220 | void UI_set_default_method(const UI_METHOD *meth); | |
221 | const UI_METHOD *UI_get_default_method(void); | |
222 | const UI_METHOD *UI_get_method(UI *ui); | |
223 | const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); | |
224 | ||
48feaceb RL |
225 | # ifndef OPENSSL_NO_UI_CONSOLE |
226 | ||
a63d5eaa RL |
227 | /* The method with all the built-in thingies */ |
228 | UI_METHOD *UI_OpenSSL(void); | |
229 | ||
48feaceb RL |
230 | # endif |
231 | ||
57d0d048 | 232 | /* |
69687aa8 | 233 | * NULL method. Literally does nothing, but may serve as a placeholder |
57d0d048 RL |
234 | * to avoid internal default. |
235 | */ | |
236 | const UI_METHOD *UI_null(void); | |
237 | ||
a63d5eaa | 238 | /* ---------- For method writers ---------- */ |
1d97c843 TH |
239 | /*- |
240 | A method contains a number of functions that implement the low level | |
a63d5eaa RL |
241 | of the User Interface. The functions are: |
242 | ||
0f113f3e MC |
243 | an opener This function starts a session, maybe by opening |
244 | a channel to a tty, or by opening a window. | |
245 | a writer This function is called to write a given string, | |
246 | maybe to the tty, maybe as a field label in a | |
247 | window. | |
248 | a flusher This function is called to flush everything that | |
249 | has been output so far. It can be used to actually | |
250 | display a dialog box after it has been built. | |
251 | a reader This function is called to read a given prompt, | |
252 | maybe from the tty, maybe from a field in a | |
8483a003 | 253 | window. Note that it's called with all string |
0f113f3e MC |
254 | structures, not only the prompt ones, so it must |
255 | check such things itself. | |
256 | a closer This function closes the session, maybe by closing | |
257 | the channel to the tty, or closing the window. | |
a63d5eaa | 258 | |
9ad0f681 RL |
259 | All these functions are expected to return: |
260 | ||
0f113f3e MC |
261 | 0 on error. |
262 | 1 on success. | |
263 | -1 on out-of-band events, for example if some prompting has | |
264 | been canceled (by pressing Ctrl-C, for example). This is | |
265 | only checked when returned by the flusher or the reader. | |
9ad0f681 | 266 | |
a63d5eaa | 267 | The way this is used, the opener is first called, then the writer for all |
9ad0f681 RL |
268 | strings, then the flusher, then the reader for all strings and finally the |
269 | closer. Note that if you want to prompt from a terminal or other command | |
270 | line interface, the best is to have the reader also write the prompts | |
271 | instead of having the writer do it. If you want to prompt from a dialog | |
272 | box, the writer can be used to build up the contents of the box, and the | |
273 | flusher to actually display the box and run the event loop until all data | |
274 | has been given, after which the reader only grabs the given data and puts | |
275 | them back into the UI strings. | |
276 | ||
a63d5eaa | 277 | All method functions take a UI as argument. Additionally, the writer and |
9ad0f681 RL |
278 | the reader take a UI_STRING. |
279 | */ | |
a63d5eaa | 280 | |
0f113f3e MC |
281 | /* |
282 | * The UI_STRING type is the data structure that contains all the needed info | |
283 | * about a string or a prompt, including test data for a verification prompt. | |
284 | */ | |
a63d5eaa | 285 | typedef struct ui_string_st UI_STRING; |
852c2ed2 RS |
286 | |
287 | DEFINE_OR_DECLARE_STACK_OF(UI_STRING) | |
a63d5eaa | 288 | |
0f113f3e MC |
289 | /* |
290 | * The different types of strings that are currently supported. This is only | |
291 | * needed by method authors. | |
292 | */ | |
293 | enum UI_string_types { | |
294 | UIT_NONE = 0, | |
295 | UIT_PROMPT, /* Prompt for a string */ | |
296 | UIT_VERIFY, /* Prompt for a string and verify */ | |
297 | UIT_BOOLEAN, /* Prompt for a yes/no response */ | |
298 | UIT_INFO, /* Send info to the user */ | |
299 | UIT_ERROR /* Send an error message to the user */ | |
300 | }; | |
a63d5eaa RL |
301 | |
302 | /* Create and manipulate methods */ | |
472f727c | 303 | UI_METHOD *UI_create_method(const char *name); |
eb929eef | 304 | void UI_destroy_method(UI_METHOD *ui_method); |
0f113f3e MC |
305 | int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui)); |
306 | int UI_method_set_writer(UI_METHOD *method, | |
307 | int (*writer) (UI *ui, UI_STRING *uis)); | |
308 | int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui)); | |
309 | int UI_method_set_reader(UI_METHOD *method, | |
310 | int (*reader) (UI *ui, UI_STRING *uis)); | |
311 | int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui)); | |
545360c4 RL |
312 | int UI_method_set_data_duplicator(UI_METHOD *method, |
313 | void *(*duplicator) (UI *ui, void *ui_data), | |
314 | void (*destructor)(UI *ui, void *ui_data)); | |
0f113f3e MC |
315 | int UI_method_set_prompt_constructor(UI_METHOD *method, |
316 | char *(*prompt_constructor) (UI *ui, | |
317 | const char | |
318 | *object_desc, | |
319 | const char | |
320 | *object_name)); | |
18cfc668 | 321 | int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data); |
a223ffe6 RL |
322 | int (*UI_method_get_opener(const UI_METHOD *method)) (UI *); |
323 | int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *); | |
324 | int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *); | |
325 | int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *); | |
326 | int (*UI_method_get_closer(const UI_METHOD *method)) (UI *); | |
327 | char *(*UI_method_get_prompt_constructor(const UI_METHOD *method)) | |
328 | (UI *, const char *, const char *); | |
545360c4 RL |
329 | void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *); |
330 | void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *); | |
18cfc668 | 331 | const void *UI_method_get_ex_data(const UI_METHOD *method, int idx); |
0f113f3e MC |
332 | |
333 | /* | |
334 | * The following functions are helpers for method writers to access relevant | |
335 | * data from a UI_STRING. | |
336 | */ | |
a63d5eaa | 337 | |
9ad0f681 | 338 | /* Return type of the UI_STRING */ |
a63d5eaa | 339 | enum UI_string_types UI_get_string_type(UI_STRING *uis); |
9ad0f681 RL |
340 | /* Return input flags of the UI_STRING */ |
341 | int UI_get_input_flags(UI_STRING *uis); | |
a63d5eaa RL |
342 | /* Return the actual string to output (the prompt, info or error) */ |
343 | const char *UI_get0_output_string(UI_STRING *uis); | |
0f113f3e | 344 | /* |
8483a003 | 345 | * Return the optional action string to output (the boolean prompt |
0f113f3e MC |
346 | * instruction) |
347 | */ | |
2d2ed9df | 348 | const char *UI_get0_action_string(UI_STRING *uis); |
a63d5eaa RL |
349 | /* Return the result of a prompt */ |
350 | const char *UI_get0_result_string(UI_STRING *uis); | |
4e049e2c | 351 | int UI_get_result_string_length(UI_STRING *uis); |
0f113f3e MC |
352 | /* |
353 | * Return the string to test the result against. Only useful with verifies. | |
354 | */ | |
a63d5eaa RL |
355 | const char *UI_get0_test_string(UI_STRING *uis); |
356 | /* Return the required minimum size of the result */ | |
357 | int UI_get_result_minsize(UI_STRING *uis); | |
358 | /* Return the required maximum size of the result */ | |
359 | int UI_get_result_maxsize(UI_STRING *uis); | |
360 | /* Set the result of a UI_STRING. */ | |
2d2ed9df | 361 | int UI_set_result(UI *ui, UI_STRING *uis, const char *result); |
4e049e2c | 362 | int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len); |
a63d5eaa | 363 | |
44bdb056 | 364 | /* A couple of popular utility functions */ |
0f113f3e MC |
365 | int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt, |
366 | int verify); | |
367 | int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt, | |
368 | int verify); | |
545360c4 | 369 | UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag); |
44bdb056 | 370 | |
a63d5eaa | 371 | |
48feaceb | 372 | # ifdef __cplusplus |
a63d5eaa | 373 | } |
0cd0a820 | 374 | # endif |
a63d5eaa | 375 | #endif |