secure/lib/libcrypto/man/UI_STRING.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "UI_STRING 3"
 132 .TH UI_STRING 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ui.h>
 143 \&
 144 \& typedef struct ui_string_st UI_STRING;
 145 \&
 146 \& enum UI_string_types {
 147 \&     UIT_NONE = 0,
 148 \&     UIT_PROMPT,                 /* Prompt for a string */
 149 \&     UIT_VERIFY,                 /* Prompt for a string and verify */
 150 \&     UIT_BOOLEAN,                /* Prompt for a yes/no response */
 151 \&     UIT_INFO,                   /* Send info to the user */
 152 \&     UIT_ERROR                   /* Send an error message to the user */
 153 \& };
 154 \&
 155 \& enum UI_string_types UI_get_string_type(UI_STRING *uis);
 156 \& int UI_get_input_flags(UI_STRING *uis);
 157 \& const char *UI_get0_output_string(UI_STRING *uis);
 158 \& const char *UI_get0_action_string(UI_STRING *uis);
 159 \& const char *UI_get0_result_string(UI_STRING *uis);
 160 \& int UI_get_result_string_length(UI_STRING *uis);
 161 \& const char *UI_get0_test_string(UI_STRING *uis);
 162 \& int UI_get_result_minsize(UI_STRING *uis);
 163 \& int UI_get_result_maxsize(UI_STRING *uis);
 164 \& int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
 165 \& int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len);
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 The \fB\s-1UI_STRING\s0\fR gets created internally and added to a \fB\s-1UI\s0\fR whenever
 170 one of the functions \fIUI_add_input_string()\fR, \fIUI_dup_input_string()\fR,
 171 \&\fIUI_add_verify_string()\fR, \fIUI_dup_verify_string()\fR,
 172 \&\fIUI_add_input_boolean()\fR, \fIUI_dup_input_boolean()\fR, \fIUI_add_info_string()\fR,
 173 \&\fIUI_dup_info_string()\fR, \fIUI_add_error_string()\fR or \fIUI_dup_error_string()\fR
 174 is called.
 175 For a \fB\s-1UI_METHOD\s0\fR user, there's no need to know more.
 176 For a \fB\s-1UI_METHOD\s0\fR creator, it is of interest to fetch text from these
 177 \&\fB\s-1UI_STRING\s0\fR objects as well as adding results to some of them.
 178 .PP
 179 \&\fIUI_get_string_type()\fR is used to retrieve the type of the given
 180 \&\fB\s-1UI_STRING\s0\fR.
 181 .PP
 182 \&\fIUI_get_input_flags()\fR is used to retrieve the flags associated with the
 183 given \fB\s-1UI_STRING\s0\fR.
 184 .PP
 185 \&\fIUI_get0_output_string()\fR is used to retrieve the actual string to
 186 output (prompt, info, error, ...).
 187 .PP
 188 \&\fIUI_get0_action_string()\fR is used to retrieve the action description
 189 associated with a \fB\s-1UIT_BOOLEAN\s0\fR type \fB\s-1UI_STRING\s0\fR.
 190 For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned.
 191 See \fIUI_add_input_boolean\fR\|(3).
 192 .PP
 193 \&\fIUI_get0_result_string()\fR and \fIUI_get_result_string_length()\fR are used to
 194 retrieve the result of a prompt and its length.
 195 This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings.
 196 For all other \fB\s-1UI_STRING\s0\fR types, \fIUI_get0_result_string()\fR returns \s-1NULL\s0
 197 and \fIUI_get_result_string_length()\fR returns \-1.
 198 .PP
 199 \&\fIUI_get0_test_string()\fR is used to retrieve the string to compare the
 200 prompt result with.
 201 This is only useful for \fB\s-1UIT_VERIFY\s0\fR type strings.
 202 For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned.
 203 .PP
 204 \&\fIUI_get_result_minsize()\fR and \fIUI_get_result_maxsize()\fR are used to
 205 retrieve the minimum and maximum required size of the result.
 206 This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings.
 207 For all other \fB\s-1UI_STRING\s0\fR types, \-1 is returned.
 208 .PP
 209 \&\fIUI_set_result_ex()\fR is used to set the result value of a prompt and its length.
 210 For \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, this sets the
 211 result retrievable with \fIUI_get0_result_string()\fR by copying the
 212 contents of \fBresult\fR if its length fits the minimum and maximum size
 213 requirements.
 214 For \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, this sets the first character of
 215 the result retrievable with \fIUI_get0_result_string()\fR to the first
 216 \&\fBok_char\fR given with \fIUI_add_input_boolean()\fR or \fIUI_dup_input_boolean()\fR
 217 if the \fBresult\fR matched any of them, or the first of the
 218 \&\fBcancel_chars\fR if the \fBresult\fR matched any of them, otherwise it's
 219 set to the \s-1NUL\s0 char \f(CW\*(C`\e0\*(C'\fR.
 220 See \fIUI_add_input_boolean\fR\|(3) for more information on \fBok_chars\fR and
 221 \&\fBcancel_chars\fR.
 222 .PP
 223 \&\fIUI_set_result()\fR does the same thing as \fIUI_set_result_ex()\fR, but calculates
 224 its length internally.
 225 It expects the string to be terminated with a \s-1NUL\s0 byte, and is therefore
 226 only useful with normal C strings.
 227 .SH "RETURN VALUES"
 228 .IX Header "RETURN VALUES"
 229 \&\fIUI_get_string_type()\fR returns the \s-1UI\s0 string type.
 230 .PP
 231 \&\fIUI_get_input_flags()\fR returns the \s-1UI\s0 string flags.
 232 .PP
 233 \&\fIUI_get0_output_string()\fR returns the \s-1UI\s0 string output string.
 234 .PP
 235 \&\fIUI_get0_action_string()\fR returns the \s-1UI\s0 string action description
 236 string for \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.
 237 .PP
 238 \&\fIUI_get0_result_string()\fR returns the \s-1UI\s0 string result buffer for
 239 \&\fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other
 240 type.
 241 .PP
 242 \&\fIUI_get_result_string_length()\fR returns the \s-1UI\s0 string result buffer's
 243 content length for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings,
 244 \&\-1 for any other type.
 245 .PP
 246 \&\fIUI_get0_test_string()\fR returns the \s-1UI\s0 string action description
 247 string for \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.
 248 .PP
 249 \&\fIUI_get_result_minsize()\fR returns the minimum allowed result size for
 250 the \s-1UI\s0 string for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings,
 251 \&\-1 for any other type.
 252 .PP
 253 \&\fIUI_get_result_maxsize()\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 \&\fIUI_set_result()\fR returns 0 on success or when the \s-1UI\s0 string is of any
 258 type other than \fB\s-1UIT_PROMPT\s0\fR, \fB\s-1UIT_VERIFY\s0\fR or \fB\s-1UIT_BOOLEAN\s0\fR, \-1 on
 259 error.
 260 .SH "SEE ALSO"
 261 .IX Header "SEE ALSO"
 262 \&\s-1\fIUI\s0\fR\|(3)
 263 .SH "COPYRIGHT"
 264 .IX Header "COPYRIGHT"
 265 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
 266 .PP
 267 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 268 this file except in compliance with the License.  You can obtain a copy
 269 in the file \s-1LICENSE\s0 in the source distribution or at
 270 <https://www.openssl.org/source/license.html>.