]>
Commit | Line | Data |
---|---|---|
ee84a5a7 RL |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5469600e | 5 | UI, |
ee84a5a7 RL |
6 | UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string, |
7 | UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean, | |
8 | UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string, | |
d90e74c5 | 9 | UI_add_error_string, UI_dup_error_string, UI_construct_prompt, |
545360c4 | 10 | UI_add_user_data, UI_dup_user_data, UI_get0_user_data, UI_get0_result, |
4e049e2c | 11 | UI_get_result_length, |
545360c4 RL |
12 | UI_process, UI_ctrl, UI_set_default_method, UI_get_default_method, |
13 | UI_get_method, UI_set_method, UI_OpenSSL, UI_null - user interface | |
ee84a5a7 RL |
14 | |
15 | =head1 SYNOPSIS | |
16 | ||
17 | #include <openssl/ui.h> | |
18 | ||
19 | typedef struct ui_st UI; | |
ee84a5a7 RL |
20 | |
21 | UI *UI_new(void); | |
22 | UI *UI_new_method(const UI_METHOD *method); | |
23 | void UI_free(UI *ui); | |
24 | ||
25 | int UI_add_input_string(UI *ui, const char *prompt, int flags, | |
e9b77246 | 26 | char *result_buf, int minsize, int maxsize); |
ee84a5a7 | 27 | int UI_dup_input_string(UI *ui, const char *prompt, int flags, |
e9b77246 | 28 | char *result_buf, int minsize, int maxsize); |
ee84a5a7 | 29 | int UI_add_verify_string(UI *ui, const char *prompt, int flags, |
e9b77246 BB |
30 | char *result_buf, int minsize, int maxsize, |
31 | const char *test_buf); | |
ee84a5a7 | 32 | int UI_dup_verify_string(UI *ui, const char *prompt, int flags, |
e9b77246 BB |
33 | char *result_buf, int minsize, int maxsize, |
34 | const char *test_buf); | |
ee84a5a7 | 35 | int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, |
e9b77246 BB |
36 | const char *ok_chars, const char *cancel_chars, |
37 | int flags, char *result_buf); | |
ee84a5a7 | 38 | int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, |
e9b77246 BB |
39 | const char *ok_chars, const char *cancel_chars, |
40 | int flags, char *result_buf); | |
ee84a5a7 RL |
41 | int UI_add_info_string(UI *ui, const char *text); |
42 | int UI_dup_info_string(UI *ui, const char *text); | |
43 | int UI_add_error_string(UI *ui, const char *text); | |
44 | int UI_dup_error_string(UI *ui, const char *text); | |
45 | ||
ee84a5a7 | 46 | char *UI_construct_prompt(UI *ui_method, |
1bc74519 | 47 | const char *object_desc, const char *object_name); |
ee84a5a7 RL |
48 | |
49 | void *UI_add_user_data(UI *ui, void *user_data); | |
545360c4 | 50 | int UI_dup_user_data(UI *ui, void *user_data); |
ee84a5a7 RL |
51 | void *UI_get0_user_data(UI *ui); |
52 | ||
53 | const char *UI_get0_result(UI *ui, int i); | |
4e049e2c | 54 | int UI_get_result_length(UI *ui, int i); |
ee84a5a7 RL |
55 | |
56 | int UI_process(UI *ui); | |
57 | ||
58 | int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)()); | |
ee84a5a7 RL |
59 | |
60 | void UI_set_default_method(const UI_METHOD *meth); | |
61 | const UI_METHOD *UI_get_default_method(void); | |
62 | const UI_METHOD *UI_get_method(UI *ui); | |
63 | const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); | |
64 | ||
65 | UI_METHOD *UI_OpenSSL(void); | |
57d0d048 | 66 | const UI_METHOD *UI_null(void); |
ee84a5a7 RL |
67 | |
68 | =head1 DESCRIPTION | |
69 | ||
70 | UI stands for User Interface, and is general purpose set of routines to | |
71 | prompt the user for text-based information. Through user-written methods | |
5469600e | 72 | (see L<UI_create_method(3)>), prompting can be done in any way |
ee84a5a7 RL |
73 | imaginable, be it plain text prompting, through dialog boxes or from a |
74 | cell phone. | |
75 | ||
76 | All the functions work through a context of the type UI. This context | |
77 | contains all the information needed to prompt correctly as well as a | |
78 | reference to a UI_METHOD, which is an ordered vector of functions that | |
79 | carry out the actual prompting. | |
80 | ||
81 | The first thing to do is to create a UI with UI_new() or UI_new_method(), | |
82 | then add information to it with the UI_add or UI_dup functions. Also, | |
83 | user-defined random data can be passed down to the underlying method | |
545360c4 RL |
84 | through calls to UI_add_user_data() or UI_dup_user_data(). The default |
85 | UI method doesn't care about these data, but other methods might. Finally, | |
86 | use UI_process() to actually perform the prompting and UI_get0_result() | |
4e049e2c | 87 | and UI_get_result_length() to find the result to the prompt and its length. |
ee84a5a7 RL |
88 | |
89 | A UI can contain more than one prompt, which are performed in the given | |
90 | sequence. Each prompt gets an index number which is returned by the | |
91 | UI_add and UI_dup functions, and has to be used to get the corresponding | |
4e049e2c | 92 | result with UI_get0_result() and UI_get_result_length(). |
ee84a5a7 | 93 | |
545360c4 RL |
94 | UI_process() can be called more than once on the same UI, thereby allowing |
95 | a UI to have a long lifetime, but can just as well have a short lifetime. | |
96 | ||
ee84a5a7 RL |
97 | The functions are as follows: |
98 | ||
99 | UI_new() creates a new UI using the default UI method. When done with | |
100 | this UI, it should be freed using UI_free(). | |
101 | ||
102 | UI_new_method() creates a new UI using the given UI method. When done with | |
103 | this UI, it should be freed using UI_free(). | |
104 | ||
f4411faa | 105 | UI_OpenSSL() returns the built-in UI method (note: not necessarily the |
789d6ddd RL |
106 | default one, since the default can be changed. See further on). This |
107 | method is the most machine/OS dependent part of OpenSSL and normally | |
108 | generates the most problems when porting. | |
109 | ||
110 | UI_null() returns a UI method that does nothing. Its use is to avoid | |
111 | getting internal defaults for passed UI_METHOD pointers. | |
ee84a5a7 RL |
112 | |
113 | UI_free() removes a UI from memory, along with all other pieces of memory | |
114 | that's connected to it, like duplicated input strings, results and others. | |
46aa6078 | 115 | If B<ui> is NULL nothing is done. |
ee84a5a7 RL |
116 | |
117 | UI_add_input_string() and UI_add_verify_string() add a prompt to the UI, | |
118 | as well as flags and a result buffer and the desired minimum and maximum | |
727ee8cf RL |
119 | sizes of the result, not counting the final NUL character. The given |
120 | information is used to prompt for information, for example a password, | |
121 | and to verify a password (i.e. having the user enter it twice and check | |
122 | that the same string was entered twice). UI_add_verify_string() takes | |
123 | and extra argument that should be a pointer to the result buffer of the | |
124 | input string that it's supposed to verify, or verification will fail. | |
ee84a5a7 RL |
125 | |
126 | UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered | |
127 | in a boolean way, with a single character for yes and a different character | |
128 | for no. A set of characters that can be used to cancel the prompt is given | |
c8d133e4 | 129 | as well. The prompt itself is divided in two, one part being the |
ee84a5a7 RL |
130 | descriptive text (given through the I<prompt> argument) and one describing |
131 | the possible answers (given through the I<action_desc> argument). | |
132 | ||
133 | UI_add_info_string() and UI_add_error_string() add strings that are shown at | |
134 | the same time as the prompt for extra information or to show an error string. | |
135 | The difference between the two is only conceptual. With the builtin method, | |
136 | there's no technical difference between them. Other methods may make a | |
137 | difference between them, however. | |
138 | ||
91da5e77 | 139 | The flags currently supported are B<UI_INPUT_FLAG_ECHO>, which is relevant for |
ee84a5a7 RL |
140 | UI_add_input_string() and will have the users response be echoed (when |
141 | prompting for a password, this flag should obviously not be used, and | |
91da5e77 | 142 | B<UI_INPUT_FLAG_DEFAULT_PWD>, which means that a default password of some |
ee84a5a7 RL |
143 | sort will be used (completely depending on the application and the UI |
144 | method). | |
145 | ||
146 | UI_dup_input_string(), UI_dup_verify_string(), UI_dup_input_boolean(), | |
147 | UI_dup_info_string() and UI_dup_error_string() are basically the same | |
148 | as their UI_add counterparts, except that they make their own copies | |
149 | of all strings. | |
150 | ||
151 | UI_construct_prompt() is a helper function that can be used to create | |
152 | a prompt from two pieces of information: an description and a name. | |
153 | The default constructor (if there is none provided by the method used) | |
154 | creates a string "Enter I<description> for I<name>:". With the | |
155 | description "pass phrase" and the file name "foo.key", that becomes | |
156 | "Enter pass phrase for foo.key:". Other methods may create whatever | |
157 | string and may include encodings that will be processed by the other | |
158 | method functions. | |
159 | ||
545360c4 | 160 | UI_add_user_data() adds a user data pointer for the method to use at any |
ee84a5a7 RL |
161 | time. The builtin UI method doesn't care about this info. Note that several |
162 | calls to this function doesn't add data, it replaces the previous blob | |
163 | with the one given as argument. | |
164 | ||
545360c4 RL |
165 | UI_dup_user_data() duplicates the user data and works as an alternative |
166 | to UI_add_user_data() when the user data needs to be preserved for a longer | |
167 | duration, perhaps even the lifetime of the application. The UI object takes | |
168 | ownership of this duplicate and will free it whenever it gets replaced or | |
169 | the UI is destroyed. UI_dup_user_data() returns 0 on success, or -1 on memory | |
170 | allocation failure or if the method doesn't have a duplicator function. | |
171 | ||
ee84a5a7 | 172 | UI_get0_user_data() retrieves the data that has last been given to the |
545360c4 | 173 | UI with UI_add_user_data() or UI_dup_user_data. |
ee84a5a7 RL |
174 | |
175 | UI_get0_result() returns a pointer to the result buffer associated with | |
176 | the information indexed by I<i>. | |
177 | ||
4e049e2c RL |
178 | UI_get_result_length() returns the length of the result buffer associated with |
179 | the information indexed by I<i>. | |
180 | ||
ee84a5a7 | 181 | UI_process() goes through the information given so far, does all the printing |
5469600e RL |
182 | and prompting and returns the final status, which is -2 on out-of-band events |
183 | (Interrupt, Cancel, ...), -1 on error and 0 on success. | |
ee84a5a7 RL |
184 | |
185 | UI_ctrl() adds extra control for the application author. For now, it | |
91da5e77 | 186 | understands two commands: B<UI_CTRL_PRINT_ERRORS>, which makes UI_process() |
ee84a5a7 | 187 | print the OpenSSL error stack as part of processing the UI, and |
91da5e77 | 188 | B<UI_CTRL_IS_REDOABLE>, which returns a flag saying if the used UI can |
ee84a5a7 RL |
189 | be used again or not. |
190 | ||
191 | UI_set_default_method() changes the default UI method to the one given. | |
076fc555 RS |
192 | This function is not thread-safe and should not be called at the same time |
193 | as other OpenSSL functions. | |
ee84a5a7 RL |
194 | |
195 | UI_get_default_method() returns a pointer to the current default UI method. | |
196 | ||
197 | UI_get_method() returns the UI method associated with a given UI. | |
198 | ||
199 | UI_set_method() changes the UI method associated with a given UI. | |
200 | ||
789d6ddd | 201 | =head1 NOTES |
78b19e90 | 202 | |
789d6ddd RL |
203 | The resulting strings that the built in method UI_OpenSSL() generate |
204 | are assumed to be encoded according to the current locale or (for | |
205 | Windows) code page. | |
206 | For applications having different demands, these strings need to be | |
207 | converted appropriately by the caller. | |
208 | For Windows, if the OPENSSL_WIN32_UTF8 environment variable is set, | |
209 | the built-in method UI_OpenSSL() will produce UTF-8 encoded strings | |
210 | instead. | |
57d0d048 | 211 | |
1f13ad31 PY |
212 | =head1 RETURN VALUES |
213 | ||
214 | UI_new() and UI_new_method() return a valid B<UI> structure or NULL if an error | |
215 | occurred. | |
216 | ||
217 | UI_add_input_string(), UI_dup_input_string(), UI_add_verify_string(), | |
218 | UI_dup_verify_string(), UI_add_input_boolean(), UI_dup_input_boolean(), | |
219 | UI_add_info_string(), UI_dup_info_string(), UI_add_error_string() | |
220 | and UI_dup_error_string() return a positive number on success or a value which | |
221 | is less than or equal to 0 otherwise. | |
222 | ||
223 | UI_construct_prompt() returns a string or NULL if an error occurred. | |
224 | ||
225 | UI_dup_user_data() returns 0 on success or -1 on error. | |
226 | ||
227 | UI_get0_result() returns a string or NULL on error. | |
228 | ||
229 | UI_get_result_length() returns a positive integer or 0 on success; otherwise it | |
230 | returns -1 on error. | |
231 | ||
232 | UI_process() returns 0 on success or a negative value on error. | |
233 | ||
234 | UI_ctrl() returns a mask on success or -1 on error. | |
235 | ||
236 | UI_get_default_method(), UI_get_method(), UI_Openssl(), UI_null() and | |
237 | UI_set_method() return either a valid B<UI_METHOD> structure or NULL | |
238 | respectively. | |
239 | ||
545360c4 RL |
240 | =head1 HISTORY |
241 | ||
242 | UI_dup_user_data() | |
243 | was added in OpenSSL 1.1.1. | |
244 | ||
e2f92610 RS |
245 | =head1 COPYRIGHT |
246 | ||
61f805c1 | 247 | Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 248 | |
4746f25a | 249 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
250 | this file except in compliance with the License. You can obtain a copy |
251 | in the file LICENSE in the source distribution or at | |
252 | L<https://www.openssl.org/source/license.html>. | |
253 | ||
254 | =cut |