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