Debian Codegraph @

upstream/debian-unstable/man3/UI_UTIL_read_pw.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "UI_UTIL_READ_PW 3SSL"
58 .TH UI_UTIL_READ_PW 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 UI_UTIL_read_pw_string, UI_UTIL_read_pw,
65 UI_UTIL_wrap_read_pem_callback \- user interface utilities
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ui.h>
70 \&
71 \& int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
72 \& int verify);
73 \& int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
74 \& int verify);
75 \& UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBUI_UTIL_read_pw_string()\fR asks for a passphrase, using \fBprompt\fR as a
80 prompt, and stores it in \fBbuf\fR.
81 The maximum allowed size is given with \fBlength\fR, including the
82 terminating NUL byte.
83 If \fBverify\fR is nonzero, the password will be verified as well.
84 .PP
85 \&\fBUI_UTIL_read_pw()\fR does the same as \fBUI_UTIL_read_pw_string()\fR, the
86 difference is that you can give it an external buffer \fBbuff\fR for the
87 verification passphrase.
88 .PP
89 \&\fBUI_UTIL_wrap_read_pem_callback()\fR can be used to create a temporary
90 \&\fBUI_METHOD\fR that wraps a given PEM password callback \fBcb\fR.
91 \&\fBrwflag\fR is used to specify if this method will be used for
92 passphrase entry without (0) or with (1) verification.
93 When not used any more, the returned method should be freed with
94 \&\fBUI_destroy_method()\fR.
95 .SH NOTES
96 .IX Header "NOTES"
97 \&\fBUI_UTIL_read_pw_string()\fR and \fBUI_UTIL_read_pw()\fR use default
98 \&\fBUI_METHOD\fR.
99 See \fBUI_get_default_method\fR\|(3) and friends for more information.
100 .PP
101 The result from the \fBUI_METHOD\fR created by
102 \&\fBUI_UTIL_wrap_read_pem_callback()\fR will generate password strings in the
103 encoding that the given password callback generates.
104 The default password prompting functions (apart from
105 \&\fBUI_UTIL_read_pw_string()\fR and \fBUI_UTIL_read_pw()\fR, there is
106 \&\fBPEM_def_callback()\fR, \fBEVP_read_pw_string()\fR and \fBEVP_read_pw_string_min()\fR)
107 all use the default \fBUI_METHOD\fR.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 \&\fBUI_UTIL_read_pw_string()\fR and \fBUI_UTIL_read_pw()\fR return 0 on success or a negative
111 value on error.
112 .PP
113 \&\fBUI_UTIL_wrap_read_pem_callback()\fR returns a valid \fBUI_METHOD\fR structure or NULL
114 if an error occurred.
115 .SH "SEE ALSO"
116 .IX Header "SEE ALSO"
117 \&\fBUI_get_default_method\fR\|(3)
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
121 .PP
122 Licensed under the Apache License 2.0 (the "License"). You may not use
123 this file except in compliance with the License. You can obtain a copy
124 in the file LICENSE in the source distribution or at
125 <https://www.openssl.org/source/license.html>.