Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: UI_UTIL_read_pw.3,v 1.5 2026/04/08 17:06:49 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)

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

..


..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. 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

 Required to disable full justification in groff 1.23.0.
 ========================================================================

 Title "UI_UTIL_read_pw 3" 
 UI_UTIL_read_pw 3 2026-04-07 3.5.6 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

 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 NUL 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
\fBUI_METHOD that wraps a given PEM 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
\fBUI_METHOD.
See UI_get_default_method\|(3) and friends for more information.


The result from the UI_METHOD 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 UI_METHOD.

 "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 UI_METHOD structure or NULL
if an error occurred.

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

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


Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.