Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: UI_UTIL_read_pw.3,v 1.1.1.1 2023/04/18 14:19:15 christos Exp $

 Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

 Standard preamble:
 ========================================================================
..

..


..
 Set up some character translations and predefined strings. \*(-- will
 give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 double quote, and \*(R" will give a right double quote. \*(C+ will
 give a nicer C++. Capital omega is used to do unbreakable dashes and
 therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
 nothing in troff, for use with C<>.
.tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF

 Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] 
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
 ========================================================================

 Title "UI_UTIL_read_pw 3" 
 UI_UTIL_read_pw 3 "2020-12-10" "1.1.1i" "OpenSSL"
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 "NAME"
UI_UTIL_read_pw_string, UI_UTIL_read_pw,
UI_UTIL_wrap_read_pem_callback - user interface utilities

 "LIBRARY"
libcrypto, -lcrypto

 "SYNOPSIS"
 Header "SYNOPSIS" .Vb 1
 #include <openssl/ui.h>
\&
 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
  int verify);
 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
  int verify);
 UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag);
.Ve

 "DESCRIPTION"
 Header "DESCRIPTION" \fBUI_UTIL_read_pw_string() asks for a passphrase, using prompt as a
prompt, and stores it in buf.
The maximum allowed size is given with length, including the
terminating \s-1NUL\s0 byte.
If verify is nonzero, the password will be verified as well.


\fBUI_UTIL_read_pw() does the same as UI_UTIL_read_pw_string(), the
difference is that you can give it an external buffer buff for the
verification passphrase.


\fBUI_UTIL_wrap_read_pem_callback() can be used to create a temporary
\fB\s-1UI_METHOD\s0 that wraps a given \s-1PEM\s0 password callback cb.
\fBrwflag is used to specify if this method will be used for
passphrase entry without (0) or with (1) verification.
When not used any more, the returned method should be freed with
\fBUI_destroy_method().

 "NOTES"
 Header "NOTES" \fBUI_UTIL_read_pw_string() and UI_UTIL_read_pw() use default
\fB\s-1UI_METHOD\s0.
See UI_get_default_method\|(3) and friends for more information.


The result from the \s-1UI_METHOD\s0 created by
\fBUI_UTIL_wrap_read_pem_callback() will generate password strings in the
encoding that the given password callback generates.
The default password prompting functions (apart from
\fBUI_UTIL_read_pw_string() and UI_UTIL_read_pw(), there is
\fBPEM_def_callback(), EVP_read_pw_string() and EVP_read_pw_string_min())
all use the default \s-1UI_METHOD\s0.

 "RETURN VALUES"
 Header "RETURN VALUES" \fBUI_UTIL_read_pw_string() and UI_UTIL_read_pw() return 0 on success or a negative
value on error.


\fBUI_UTIL_wrap_read_pem_callback() returns a valid \s-1UI_METHOD\s0 structure or \s-1NULL\s0
if an error occurred.

 "SEE ALSO"
 Header "SEE ALSO" \fBUI_get_default_method\|(3)

 "COPYRIGHT"
 Header "COPYRIGHT" Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved.


Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.