Various typo
[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_get_result_length,
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
14
15 =head1 SYNOPSIS
16
17  #include <openssl/ui.h>
18
19  typedef struct ui_st UI;
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,
26                          char *result_buf, int minsize, int maxsize);
27  int UI_dup_input_string(UI *ui, const char *prompt, int flags,
28                          char *result_buf, int minsize, int maxsize);
29  int UI_add_verify_string(UI *ui, const char *prompt, int flags,
30                           char *result_buf, int minsize, int maxsize,
31                           const char *test_buf);
32  int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
33                           char *result_buf, int minsize, int maxsize,
34                           const char *test_buf);
35  int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
36                           const char *ok_chars, const char *cancel_chars,
37                           int flags, char *result_buf);
38  int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
39                           const char *ok_chars, const char *cancel_chars,
40                           int flags, char *result_buf);
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
46  char *UI_construct_prompt(UI *ui_method,
47         const char *object_desc, const char *object_name);
48
49  void *UI_add_user_data(UI *ui, void *user_data);
50  int UI_dup_user_data(UI *ui, void *user_data);
51  void *UI_get0_user_data(UI *ui);
52
53  const char *UI_get0_result(UI *ui, int i);
54  int UI_get_result_length(UI *ui, int i);
55
56  int UI_process(UI *ui);
57
58  int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
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);
66  const UI_METHOD *UI_null(void);
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
72 (see L<UI_create_method(3)>), prompting can be done in any way
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
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()
87 and UI_get_result_length() to find the result to the prompt and its length.
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
92 result with UI_get0_result() and UI_get_result_length().
93
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
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
105 UI_OpenSSL() returns the built-in UI method (note: not necessarily the
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.
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.
115 If B<ui> is NULL nothing is done.
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
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.
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
129 as well.  The prompt itself is divided in two, one part being the
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
139 The flags currently supported are B<UI_INPUT_FLAG_ECHO>, which is relevant for
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
142 B<UI_INPUT_FLAG_DEFAULT_PWD>, which means that a default password of some
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
160 UI_add_user_data() adds a user data pointer for the method to use at any
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
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
172 UI_get0_user_data() retrieves the data that has last been given to the
173 UI with UI_add_user_data() or UI_dup_user_data.
174
175 UI_get0_result() returns a pointer to the result buffer associated with
176 the information indexed by I<i>.
177
178 UI_get_result_length() returns the length of the result buffer associated with
179 the information indexed by I<i>.
180
181 UI_process() goes through the information given so far, does all the printing
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.
184
185 UI_ctrl() adds extra control for the application author.  For now, it
186 understands two commands: B<UI_CTRL_PRINT_ERRORS>, which makes UI_process()
187 print the OpenSSL error stack as part of processing the UI, and
188 B<UI_CTRL_IS_REDOABLE>, which returns a flag saying if the used UI can
189 be used again or not.
190
191 UI_set_default_method() changes the default UI method to the one given.
192 This function is not thread-safe and should not be called at the same time
193 as other OpenSSL functions.
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
201 =head1 NOTES
202
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.
211
212 =head1 HISTORY
213
214 UI_dup_user_data()
215 was added in OpenSSL 1.1.1.
216
217 =head1 COPYRIGHT
218
219 Copyright 2001-2017 The OpenSSL Project Authors. All Rights Reserved.
220
221 Licensed under the OpenSSL license (the "License").  You may not use
222 this file except in compliance with the License.  You can obtain a copy
223 in the file LICENSE in the source distribution or at
224 L<https://www.openssl.org/source/license.html>.
225
226 =cut