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