e91498bc8c732d6dd0c995e02905114fb4955215
[dragonfly.git] / secure / lib / libcrypto / man / ui.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "ui 3"
136 .TH ui 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string,
143 UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean,
144 UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string,
145 UI_add_error_string, UI_dup_error_string, UI_construct_prompt,
146 UI_add_user_data, UI_get0_user_data, UI_get0_result, UI_process,
147 UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method,
148 UI_set_method, UI_OpenSSL, ERR_load_UI_strings \- New User Interface
149 .SH "SYNOPSIS"
150 .IX Header "SYNOPSIS"
151 .Vb 1
152 \& #include <openssl/ui.h>
153 \&
154 \& typedef struct ui_st UI;
155 \& typedef struct ui_method_st UI_METHOD;
156 \&
157 \& UI *UI_new(void);
158 \& UI *UI_new_method(const UI_METHOD *method);
159 \& void UI_free(UI *ui);
160 \&
161 \& int UI_add_input_string(UI *ui, const char *prompt, int flags,
162 \&        char *result_buf, int minsize, int maxsize);
163 \& int UI_dup_input_string(UI *ui, const char *prompt, int flags,
164 \&        char *result_buf, int minsize, int maxsize);
165 \& int UI_add_verify_string(UI *ui, const char *prompt, int flags,
166 \&        char *result_buf, int minsize, int maxsize, const char *test_buf);
167 \& int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
168 \&        char *result_buf, int minsize, int maxsize, const char *test_buf);
169 \& int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
170 \&        const char *ok_chars, const char *cancel_chars,
171 \&        int flags, char *result_buf);
172 \& int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
173 \&        const char *ok_chars, const char *cancel_chars,
174 \&        int flags, char *result_buf);
175 \& int UI_add_info_string(UI *ui, const char *text);
176 \& int UI_dup_info_string(UI *ui, const char *text);
177 \& int UI_add_error_string(UI *ui, const char *text);
178 \& int UI_dup_error_string(UI *ui, const char *text);
179 \&
180 \& /* These are the possible flags.  They can be or\*(Aqed together. */
181 \& #define UI_INPUT_FLAG_ECHO             0x01
182 \& #define UI_INPUT_FLAG_DEFAULT_PWD      0x02
183 \&
184 \& char *UI_construct_prompt(UI *ui_method,
185 \&        const char *object_desc, const char *object_name);
186 \&
187 \& void *UI_add_user_data(UI *ui, void *user_data);
188 \& void *UI_get0_user_data(UI *ui);
189 \&
190 \& const char *UI_get0_result(UI *ui, int i);
191 \&
192 \& int UI_process(UI *ui);
193 \&
194 \& int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
195 \& #define UI_CTRL_PRINT_ERRORS           1
196 \& #define UI_CTRL_IS_REDOABLE            2
197 \&
198 \& void UI_set_default_method(const UI_METHOD *meth);
199 \& const UI_METHOD *UI_get_default_method(void);
200 \& const UI_METHOD *UI_get_method(UI *ui);
201 \& const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
202 \&
203 \& UI_METHOD *UI_OpenSSL(void);
204 .Ve
205 .SH "DESCRIPTION"
206 .IX Header "DESCRIPTION"
207 \&\s-1UI\s0 stands for User Interface, and is general purpose set of routines to
208 prompt the user for text-based information.  Through user-written methods
209 (see \fIui_create\fR\|(3)), prompting can be done in any way
210 imaginable, be it plain text prompting, through dialog boxes or from a
211 cell phone.
212 .PP
213 All the functions work through a context of the type \s-1UI. \s0 This context
214 contains all the information needed to prompt correctly as well as a
215 reference to a \s-1UI_METHOD,\s0 which is an ordered vector of functions that
216 carry out the actual prompting.
217 .PP
218 The first thing to do is to create a \s-1UI\s0 with \fIUI_new()\fR or \fIUI_new_method()\fR,
219 then add information to it with the UI_add or UI_dup functions.  Also,
220 user-defined random data can be passed down to the underlying method
221 through calls to UI_add_user_data.  The default \s-1UI\s0 method doesn't care
222 about these data, but other methods might.  Finally, use \fIUI_process()\fR
223 to actually perform the prompting and \fIUI_get0_result()\fR to find the result
224 to the prompt.
225 .PP
226 A \s-1UI\s0 can contain more than one prompt, which are performed in the given
227 sequence.  Each prompt gets an index number which is returned by the
228 UI_add and UI_dup functions, and has to be used to get the corresponding
229 result with \fIUI_get0_result()\fR.
230 .PP
231 The functions are as follows:
232 .PP
233 \&\fIUI_new()\fR creates a new \s-1UI\s0 using the default \s-1UI\s0 method.  When done with
234 this \s-1UI,\s0 it should be freed using \fIUI_free()\fR.
235 .PP
236 \&\fIUI_new_method()\fR creates a new \s-1UI\s0 using the given \s-1UI\s0 method.  When done with
237 this \s-1UI,\s0 it should be freed using \fIUI_free()\fR.
238 .PP
239 \&\fIUI_OpenSSL()\fR returns the built-in \s-1UI\s0 method (note: not the default one,
240 since the default can be changed.  See further on).  This method is the
241 most machine/OS dependent part of OpenSSL and normally generates the
242 most problems when porting.
243 .PP
244 \&\fIUI_free()\fR removes a \s-1UI\s0 from memory, along with all other pieces of memory
245 that's connected to it, like duplicated input strings, results and others.
246 .PP
247 \&\fIUI_add_input_string()\fR and \fIUI_add_verify_string()\fR add a prompt to the \s-1UI,\s0
248 as well as flags and a result buffer and the desired minimum and maximum
249 sizes of the result.  The given information is used to prompt for
250 information, for example a password, and to verify a password (i.e. having
251 the user enter it twice and check that the same string was entered twice).
252 \&\fIUI_add_verify_string()\fR takes and extra argument that should be a pointer
253 to the result buffer of the input string that it's supposed to verify, or
254 verification will fail.
255 .PP
256 \&\fIUI_add_input_boolean()\fR adds a prompt to the \s-1UI\s0 that's supposed to be answered
257 in a boolean way, with a single character for yes and a different character
258 for no.  A set of characters that can be used to cancel the prompt is given
259 as well.  The prompt itself is divided in two, one part being the
260 descriptive text (given through the \fIprompt\fR argument) and one describing
261 the possible answers (given through the \fIaction_desc\fR argument).
262 .PP
263 \&\fIUI_add_info_string()\fR and \fIUI_add_error_string()\fR add strings that are shown at
264 the same time as the prompt for extra information or to show an error string.
265 The difference between the two is only conceptual.  With the builtin method,
266 there's no technical difference between them.  Other methods may make a
267 difference between them, however.
268 .PP
269 The flags currently supported are \s-1UI_INPUT_FLAG_ECHO,\s0 which is relevant for
270 \&\fIUI_add_input_string()\fR and will have the users response be echoed (when
271 prompting for a password, this flag should obviously not be used, and
272 \&\s-1UI_INPUT_FLAG_DEFAULT_PWD,\s0 which means that a default password of some
273 sort will be used (completely depending on the application and the \s-1UI\s0
274 method).
275 .PP
276 \&\fIUI_dup_input_string()\fR, \fIUI_dup_verify_string()\fR, \fIUI_dup_input_boolean()\fR,
277 \&\fIUI_dup_info_string()\fR and \fIUI_dup_error_string()\fR are basically the same
278 as their UI_add counterparts, except that they make their own copies
279 of all strings.
280 .PP
281 \&\fIUI_construct_prompt()\fR is a helper function that can be used to create
282 a prompt from two pieces of information: an description and a name.
283 The default constructor (if there is none provided by the method used)
284 creates a string "Enter \fIdescription\fR for \fIname\fR:\*(L".  With the
285 description \*(R"pass phrase\*(L" and the file name \*(R"foo.key\*(L", that becomes
286 \&\*(R"Enter pass phrase for foo.key:".  Other methods may create whatever
287 string and may include encodings that will be processed by the other
288 method functions.
289 .PP
290 \&\fIUI_add_user_data()\fR adds a piece of memory for the method to use at any
291 time.  The builtin \s-1UI\s0 method doesn't care about this info.  Note that several
292 calls to this function doesn't add data, it replaces the previous blob
293 with the one given as argument.
294 .PP
295 \&\fIUI_get0_user_data()\fR retrieves the data that has last been given to the
296 \&\s-1UI\s0 with \fIUI_add_user_data()\fR.
297 .PP
298 \&\fIUI_get0_result()\fR returns a pointer to the result buffer associated with
299 the information indexed by \fIi\fR.
300 .PP
301 \&\fIUI_process()\fR goes through the information given so far, does all the printing
302 and prompting and returns.
303 .PP
304 \&\fIUI_ctrl()\fR adds extra control for the application author.  For now, it
305 understands two commands: \s-1UI_CTRL_PRINT_ERRORS,\s0 which makes \fIUI_process()\fR
306 print the OpenSSL error stack as part of processing the \s-1UI,\s0 and
307 \&\s-1UI_CTRL_IS_REDOABLE,\s0 which returns a flag saying if the used \s-1UI\s0 can
308 be used again or not.
309 .PP
310 \&\fIUI_set_default_method()\fR changes the default \s-1UI\s0 method to the one given.
311 .PP
312 \&\fIUI_get_default_method()\fR returns a pointer to the current default \s-1UI\s0 method.
313 .PP
314 \&\fIUI_get_method()\fR returns the \s-1UI\s0 method associated with a given \s-1UI.\s0
315 .PP
316 \&\fIUI_set_method()\fR changes the \s-1UI\s0 method associated with a given \s-1UI.\s0
317 .SH "SEE ALSO"
318 .IX Header "SEE ALSO"
319 \&\fIui_create\fR\|(3), \fIui_compat\fR\|(3)
320 .SH "HISTORY"
321 .IX Header "HISTORY"
322 The \s-1UI\s0 section was first introduced in OpenSSL 0.9.7.
323 .SH "AUTHOR"
324 .IX Header "AUTHOR"
325 Richard Levitte (richard@levitte.org) for the OpenSSL project
326 (http://www.openssl.org).