secure/lib/libcrypto/man/ui.3

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