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

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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_STRING 3"
 136 .TH UI_STRING 3 "2022-05-03" "1.1.1o" "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_STRING, UI_string_types, UI_get_string_type, UI_get_input_flags, UI_get0_output_string, UI_get0_action_string, UI_get0_result_string, UI_get_result_string_length, UI_get0_test_string, UI_get_result_minsize, UI_get_result_maxsize, UI_set_result, UI_set_result_ex \&\- User interface string parsing
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ui.h>
 147 \&
 148 \& typedef struct ui_string_st UI_STRING;
 149 \&
 150 \& enum UI_string_types {
 151 \&     UIT_NONE = 0,
 152 \&     UIT_PROMPT,                 /* Prompt for a string */
 153 \&     UIT_VERIFY,                 /* Prompt for a string and verify */
 154 \&     UIT_BOOLEAN,                /* Prompt for a yes/no response */
 155 \&     UIT_INFO,                   /* Send info to the user */
 156 \&     UIT_ERROR                   /* Send an error message to the user */
 157 \& };
 158 \&
 159 \& enum UI_string_types UI_get_string_type(UI_STRING *uis);
 160 \& int UI_get_input_flags(UI_STRING *uis);
 161 \& const char *UI_get0_output_string(UI_STRING *uis);
 162 \& const char *UI_get0_action_string(UI_STRING *uis);
 163 \& const char *UI_get0_result_string(UI_STRING *uis);
 164 \& int UI_get_result_string_length(UI_STRING *uis);
 165 \& const char *UI_get0_test_string(UI_STRING *uis);
 166 \& int UI_get_result_minsize(UI_STRING *uis);
 167 \& int UI_get_result_maxsize(UI_STRING *uis);
 168 \& int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
 169 \& int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len);
 170 .Ve
 171 .SH "DESCRIPTION"
 172 .IX Header "DESCRIPTION"
 173 The \fB\s-1UI_STRING\s0\fR gets created internally and added to a \fB\s-1UI\s0\fR whenever
 174 one of the functions \fBUI_add_input_string()\fR, \fBUI_dup_input_string()\fR,
 175 \&\fBUI_add_verify_string()\fR, \fBUI_dup_verify_string()\fR,
 176 \&\fBUI_add_input_boolean()\fR, \fBUI_dup_input_boolean()\fR, \fBUI_add_info_string()\fR,
 177 \&\fBUI_dup_info_string()\fR, \fBUI_add_error_string()\fR or \fBUI_dup_error_string()\fR
 178 is called.
 179 For a \fB\s-1UI_METHOD\s0\fR user, there's no need to know more.
 180 For a \fB\s-1UI_METHOD\s0\fR creator, it is of interest to fetch text from these
 181 \&\fB\s-1UI_STRING\s0\fR objects as well as adding results to some of them.
 182 .PP
 183 \&\fBUI_get_string_type()\fR is used to retrieve the type of the given
 184 \&\fB\s-1UI_STRING\s0\fR.
 185 .PP
 186 \&\fBUI_get_input_flags()\fR is used to retrieve the flags associated with the
 187 given \fB\s-1UI_STRING\s0\fR.
 188 .PP
 189 \&\fBUI_get0_output_string()\fR is used to retrieve the actual string to
 190 output (prompt, info, error, ...).
 191 .PP
 192 \&\fBUI_get0_action_string()\fR is used to retrieve the action description
 193 associated with a \fB\s-1UIT_BOOLEAN\s0\fR type \fB\s-1UI_STRING\s0\fR.
 194 For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned.
 195 See \fBUI_add_input_boolean\fR\|(3).
 196 .PP
 197 \&\fBUI_get0_result_string()\fR and \fBUI_get_result_string_length()\fR are used to
 198 retrieve the result of a prompt and its length.
 199 This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings.
 200 For all other \fB\s-1UI_STRING\s0\fR types, \fBUI_get0_result_string()\fR returns \s-1NULL\s0
 201 and \fBUI_get_result_string_length()\fR returns \-1.
 202 .PP
 203 \&\fBUI_get0_test_string()\fR is used to retrieve the string to compare the
 204 prompt result with.
 205 This is only useful for \fB\s-1UIT_VERIFY\s0\fR type strings.
 206 For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned.
 207 .PP
 208 \&\fBUI_get_result_minsize()\fR and \fBUI_get_result_maxsize()\fR are used to
 209 retrieve the minimum and maximum required size of the result.
 210 This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings.
 211 For all other \fB\s-1UI_STRING\s0\fR types, \-1 is returned.
 212 .PP
 213 \&\fBUI_set_result_ex()\fR is used to set the result value of a prompt and its length.
 214 For \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, this sets the
 215 result retrievable with \fBUI_get0_result_string()\fR by copying the
 216 contents of \fBresult\fR if its length fits the minimum and maximum size
 217 requirements.
 218 For \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, this sets the first character of
 219 the result retrievable with \fBUI_get0_result_string()\fR to the first
 220 \&\fBok_char\fR given with \fBUI_add_input_boolean()\fR or \fBUI_dup_input_boolean()\fR
 221 if the \fBresult\fR matched any of them, or the first of the
 222 \&\fBcancel_chars\fR if the \fBresult\fR matched any of them, otherwise it's
 223 set to the \s-1NUL\s0 char \f(CW\*(C`\e0\*(C'\fR.
 224 See \fBUI_add_input_boolean\fR\|(3) for more information on \fBok_chars\fR and
 225 \&\fBcancel_chars\fR.
 226 .PP
 227 \&\fBUI_set_result()\fR does the same thing as \fBUI_set_result_ex()\fR, but calculates
 228 its length internally.
 229 It expects the string to be terminated with a \s-1NUL\s0 byte, and is therefore
 230 only useful with normal C strings.
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fBUI_get_string_type()\fR returns the \s-1UI\s0 string type.
 234 .PP
 235 \&\fBUI_get_input_flags()\fR returns the \s-1UI\s0 string flags.
 236 .PP
 237 \&\fBUI_get0_output_string()\fR returns the \s-1UI\s0 string output string.
 238 .PP
 239 \&\fBUI_get0_action_string()\fR returns the \s-1UI\s0 string action description
 240 string for \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.
 241 .PP
 242 \&\fBUI_get0_result_string()\fR returns the \s-1UI\s0 string result buffer for
 243 \&\fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other
 244 type.
 245 .PP
 246 \&\fBUI_get_result_string_length()\fR returns the \s-1UI\s0 string result buffer's
 247 content length for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings,
 248 \&\-1 for any other type.
 249 .PP
 250 \&\fBUI_get0_test_string()\fR returns the \s-1UI\s0 string action description
 251 string for \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.
 252 .PP
 253 \&\fBUI_get_result_minsize()\fR returns the minimum allowed result size for
 254 the \s-1UI\s0 string for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings,
 255 \&\-1 for any other type.
 256 .PP
 257 \&\fBUI_get_result_maxsize()\fR returns the minimum allowed result size for
 258 the \s-1UI\s0 string for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings,
 259 \&\-1 for any other type.
 260 .PP
 261 \&\fBUI_set_result()\fR returns 0 on success or when the \s-1UI\s0 string is of any
 262 type other than \fB\s-1UIT_PROMPT\s0\fR, \fB\s-1UIT_VERIFY\s0\fR or \fB\s-1UIT_BOOLEAN\s0\fR, \-1 on
 263 error.
 264 .SH "SEE ALSO"
 265 .IX Header "SEE ALSO"
 266 \&\s-1\fBUI\s0\fR\|(3)
 267 .SH "COPYRIGHT"
 268 .IX Header "COPYRIGHT"
 269 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
 270 .PP
 271 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 272 this file except in compliance with the License.  You can obtain a copy
 273 in the file \s-1LICENSE\s0 in the source distribution or at
 274 <https://www.openssl.org/source/license.html>.