secure/lib/libcrypto/man/man3/UI_new.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   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 >0, 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_NEW 3"
 136 .TH UI_NEW 3 "2020-09-22" "1.1.1h" "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, UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string, UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean, UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string, UI_add_error_string, UI_dup_error_string, UI_construct_prompt, UI_add_user_data, UI_dup_user_data, UI_get0_user_data, UI_get0_result, UI_get_result_length, UI_process, UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method, UI_set_method, UI_OpenSSL, UI_null \- user interface
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ui.h>
 147 \&
 148 \& typedef struct ui_st UI;
 149 \&
 150 \& UI *UI_new(void);
 151 \& UI *UI_new_method(const UI_METHOD *method);
 152 \& void UI_free(UI *ui);
 153 \&
 154 \& int UI_add_input_string(UI *ui, const char *prompt, int flags,
 155 \&                         char *result_buf, int minsize, int maxsize);
 156 \& int UI_dup_input_string(UI *ui, const char *prompt, int flags,
 157 \&                         char *result_buf, int minsize, int maxsize);
 158 \& int UI_add_verify_string(UI *ui, const char *prompt, int flags,
 159 \&                          char *result_buf, int minsize, int maxsize,
 160 \&                          const char *test_buf);
 161 \& int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
 162 \&                          char *result_buf, int minsize, int maxsize,
 163 \&                          const char *test_buf);
 164 \& int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
 165 \&                          const char *ok_chars, const char *cancel_chars,
 166 \&                          int flags, char *result_buf);
 167 \& int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
 168 \&                          const char *ok_chars, const char *cancel_chars,
 169 \&                          int flags, char *result_buf);
 170 \& int UI_add_info_string(UI *ui, const char *text);
 171 \& int UI_dup_info_string(UI *ui, const char *text);
 172 \& int UI_add_error_string(UI *ui, const char *text);
 173 \& int UI_dup_error_string(UI *ui, const char *text);
 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 \& int UI_dup_user_data(UI *ui, void *user_data);
 180 \& void *UI_get0_user_data(UI *ui);
 181 \&
 182 \& const char *UI_get0_result(UI *ui, int i);
 183 \& int UI_get_result_length(UI *ui, int i);
 184 \&
 185 \& int UI_process(UI *ui);
 186 \&
 187 \& int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
 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 \& const UI_METHOD *UI_null(void);
 196 .Ve
 197 .SH "DESCRIPTION"
 198 .IX Header "DESCRIPTION"
 199 \&\s-1UI\s0 stands for User Interface, and is general purpose set of routines to
 200 prompt the user for text-based information.  Through user-written methods
 201 (see \fBUI_create_method\fR\|(3)), prompting can be done in any way
 202 imaginable, be it plain text prompting, through dialog boxes or from a
 203 cell phone.
 204 .PP
 205 All the functions work through a context of the type \s-1UI.\s0  This context
 206 contains all the information needed to prompt correctly as well as a
 207 reference to a \s-1UI_METHOD,\s0 which is an ordered vector of functions that
 208 carry out the actual prompting.
 209 .PP
 210 The first thing to do is to create a \s-1UI\s0 with \fBUI_new()\fR or \fBUI_new_method()\fR,
 211 then add information to it with the UI_add or UI_dup functions.  Also,
 212 user-defined random data can be passed down to the underlying method
 213 through calls to \fBUI_add_user_data()\fR or \fBUI_dup_user_data()\fR.  The default
 214 \&\s-1UI\s0 method doesn't care about these data, but other methods might.  Finally,
 215 use \fBUI_process()\fR to actually perform the prompting and \fBUI_get0_result()\fR
 216 and \fBUI_get_result_length()\fR to find the result to the prompt and its length.
 217 .PP
 218 A \s-1UI\s0 can contain more than one prompt, which are performed in the given
 219 sequence.  Each prompt gets an index number which is returned by the
 220 UI_add and UI_dup functions, and has to be used to get the corresponding
 221 result with \fBUI_get0_result()\fR and \fBUI_get_result_length()\fR.
 222 .PP
 223 \&\fBUI_process()\fR can be called more than once on the same \s-1UI,\s0 thereby allowing
 224 a \s-1UI\s0 to have a long lifetime, but can just as well have a short lifetime.
 225 .PP
 226 The functions are as follows:
 227 .PP
 228 \&\fBUI_new()\fR creates a new \s-1UI\s0 using the default \s-1UI\s0 method.  When done with
 229 this \s-1UI,\s0 it should be freed using \fBUI_free()\fR.
 230 .PP
 231 \&\fBUI_new_method()\fR creates a new \s-1UI\s0 using the given \s-1UI\s0 method.  When done with
 232 this \s-1UI,\s0 it should be freed using \fBUI_free()\fR.
 233 .PP
 234 \&\fBUI_OpenSSL()\fR returns the built-in \s-1UI\s0 method (note: not necessarily the
 235 default one, since the default can be changed.  See further on).  This
 236 method is the most machine/OS dependent part of OpenSSL and normally
 237 generates the most problems when porting.
 238 .PP
 239 \&\fBUI_null()\fR returns a \s-1UI\s0 method that does nothing.  Its use is to avoid
 240 getting internal defaults for passed \s-1UI_METHOD\s0 pointers.
 241 .PP
 242 \&\fBUI_free()\fR removes a \s-1UI\s0 from memory, along with all other pieces of memory
 243 that's connected to it, like duplicated input strings, results and others.
 244 If \fBui\fR is \s-1NULL\s0 nothing is done.
 245 .PP
 246 \&\fBUI_add_input_string()\fR and \fBUI_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, not counting the final \s-1NUL\s0 character.  The given
 249 information is used to prompt for information, for example a password,
 250 and to verify a password (i.e. having the user enter it twice and check
 251 that the same string was entered twice).  \fBUI_add_verify_string()\fR takes
 252 and extra argument that should be a pointer to the result buffer of the
 253 input string that it's supposed to verify, or verification will fail.
 254 .PP
 255 \&\fBUI_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 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 \&\fBUI_add_info_string()\fR and \fBUI_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 \fB\s-1UI_INPUT_FLAG_ECHO\s0\fR, which is relevant for
 269 \&\fBUI_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 \&\fB\s-1UI_INPUT_FLAG_DEFAULT_PWD\s0\fR, 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 \&\fBUI_dup_input_string()\fR, \fBUI_dup_verify_string()\fR, \fBUI_dup_input_boolean()\fR,
 276 \&\fBUI_dup_info_string()\fR and \fBUI_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 \&\fBUI_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 filename \*(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 \&\fBUI_add_user_data()\fR adds a user data pointer 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 \&\fBUI_dup_user_data()\fR duplicates the user data and works as an alternative
 295 to \fBUI_add_user_data()\fR when the user data needs to be preserved for a longer
 296 duration, perhaps even the lifetime of the application.  The \s-1UI\s0 object takes
 297 ownership of this duplicate and will free it whenever it gets replaced or
 298 the \s-1UI\s0 is destroyed.  \fBUI_dup_user_data()\fR returns 0 on success, or \-1 on memory
 299 allocation failure or if the method doesn't have a duplicator function.
 300 .PP
 301 \&\fBUI_get0_user_data()\fR retrieves the data that has last been given to the
 302 \&\s-1UI\s0 with \fBUI_add_user_data()\fR or UI_dup_user_data.
 303 .PP
 304 \&\fBUI_get0_result()\fR returns a pointer to the result buffer associated with
 305 the information indexed by \fIi\fR.
 306 .PP
 307 \&\fBUI_get_result_length()\fR returns the length of the result buffer associated with
 308 the information indexed by \fIi\fR.
 309 .PP
 310 \&\fBUI_process()\fR goes through the information given so far, does all the printing
 311 and prompting and returns the final status, which is \-2 on out-of-band events
 312 (Interrupt, Cancel, ...), \-1 on error and 0 on success.
 313 .PP
 314 \&\fBUI_ctrl()\fR adds extra control for the application author.  For now, it
 315 understands two commands: \fB\s-1UI_CTRL_PRINT_ERRORS\s0\fR, which makes \fBUI_process()\fR
 316 print the OpenSSL error stack as part of processing the \s-1UI,\s0 and
 317 \&\fB\s-1UI_CTRL_IS_REDOABLE\s0\fR, which returns a flag saying if the used \s-1UI\s0 can
 318 be used again or not.
 319 .PP
 320 \&\fBUI_set_default_method()\fR changes the default \s-1UI\s0 method to the one given.
 321 This function is not thread-safe and should not be called at the same time
 322 as other OpenSSL functions.
 323 .PP
 324 \&\fBUI_get_default_method()\fR returns a pointer to the current default \s-1UI\s0 method.
 325 .PP
 326 \&\fBUI_get_method()\fR returns the \s-1UI\s0 method associated with a given \s-1UI.\s0
 327 .PP
 328 \&\fBUI_set_method()\fR changes the \s-1UI\s0 method associated with a given \s-1UI.\s0
 329 .SH "NOTES"
 330 .IX Header "NOTES"
 331 The resulting strings that the built in method \fBUI_OpenSSL()\fR generate
 332 are assumed to be encoded according to the current locale or (for
 333 Windows) code page.
 334 For applications having different demands, these strings need to be
 335 converted appropriately by the caller.
 336 For Windows, if the \s-1OPENSSL_WIN32_UTF8\s0 environment variable is set,
 337 the built-in method \fBUI_OpenSSL()\fR will produce \s-1UTF\-8\s0 encoded strings
 338 instead.
 339 .SH "RETURN VALUES"
 340 .IX Header "RETURN VALUES"
 341 \&\fBUI_new()\fR and \fBUI_new_method()\fR return a valid \fB\s-1UI\s0\fR structure or \s-1NULL\s0 if an error
 342 occurred.
 343 .PP
 344 \&\fBUI_add_input_string()\fR, \fBUI_dup_input_string()\fR, \fBUI_add_verify_string()\fR,
 345 \&\fBUI_dup_verify_string()\fR, \fBUI_add_input_boolean()\fR, \fBUI_dup_input_boolean()\fR,
 346 \&\fBUI_add_info_string()\fR, \fBUI_dup_info_string()\fR, \fBUI_add_error_string()\fR
 347 and \fBUI_dup_error_string()\fR return a positive number on success or a value which
 348 is less than or equal to 0 otherwise.
 349 .PP
 350 \&\fBUI_construct_prompt()\fR returns a string or \s-1NULL\s0 if an error occurred.
 351 .PP
 352 \&\fBUI_dup_user_data()\fR returns 0 on success or \-1 on error.
 353 .PP
 354 \&\fBUI_get0_result()\fR returns a string or \s-1NULL\s0 on error.
 355 .PP
 356 \&\fBUI_get_result_length()\fR returns a positive integer or 0 on success; otherwise it
 357 returns \-1 on error.
 358 .PP
 359 \&\fBUI_process()\fR returns 0 on success or a negative value on error.
 360 .PP
 361 \&\fBUI_ctrl()\fR returns a mask on success or \-1 on error.
 362 .PP
 363 \&\fBUI_get_default_method()\fR, \fBUI_get_method()\fR, \fBUI_OpenSSL()\fR, \fBUI_null()\fR and
 364 \&\fBUI_set_method()\fR return either a valid \fB\s-1UI_METHOD\s0\fR structure or \s-1NULL\s0
 365 respectively.
 366 .SH "HISTORY"
 367 .IX Header "HISTORY"
 368 The \fBUI_dup_user_data()\fR function was added in OpenSSL 1.1.1.
 369 .SH "COPYRIGHT"
 370 .IX Header "COPYRIGHT"
 371 Copyright 2001\-2020 The OpenSSL Project Authors. All Rights Reserved.
 372 .PP
 373 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 374 this file except in compliance with the License.  You can obtain a copy
 375 in the file \s-1LICENSE\s0 in the source distribution or at
 376 <https://www.openssl.org/source/license.html>.