summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/UI_UTIL_read_pw.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/UI_UTIL_read_pw.3107
1 files changed, 0 insertions, 107 deletions
diff --git a/src/lib/libcrypto/man/UI_UTIL_read_pw.3 b/src/lib/libcrypto/man/UI_UTIL_read_pw.3
deleted file mode 100644
index aa3cefe8dd..0000000000
--- a/src/lib/libcrypto/man/UI_UTIL_read_pw.3
+++ /dev/null
@@ -1,107 +0,0 @@
1.\" $OpenBSD: UI_UTIL_read_pw.3,v 1.3 2018/03/22 21:08:22 schwarze Exp $
2.\" full merge up to: OpenSSL 23103a52 Jan 12 15:17:42 2017 +0100
3.\" selective merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800
4.\"
5.\" This file was written by Richard Levitte <levitte@openssl.org>.
6.\" Copyright (c) 2017 The OpenSSL Project. All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\"
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in
17.\" the documentation and/or other materials provided with the
18.\" distribution.
19.\"
20.\" 3. All advertising materials mentioning features or use of this
21.\" software must display the following acknowledgment:
22.\" "This product includes software developed by the OpenSSL Project
23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24.\"
25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26.\" endorse or promote products derived from this software without
27.\" prior written permission. For written permission, please contact
28.\" openssl-core@openssl.org.
29.\"
30.\" 5. Products derived from this software may not be called "OpenSSL"
31.\" nor may "OpenSSL" appear in their names without prior written
32.\" permission of the OpenSSL Project.
33.\"
34.\" 6. Redistributions of any form whatsoever must retain the following
35.\" acknowledgment:
36.\" "This product includes software developed by the OpenSSL Project
37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\"
52.Dd $Mdocdate: March 22 2018 $
53.Dt UI_UTIL_READ_PW 3
54.Os
55.Sh NAME
56.Nm UI_UTIL_read_pw ,
57.Nm UI_UTIL_read_pw_string
58.Nd get a password from the user
59.Sh SYNOPSIS
60.In openssl/ui.h
61.Ft int
62.Fo UI_UTIL_read_pw_string
63.Fa "char *buf"
64.Fa "int length"
65.Fa "const char *prompt"
66.Fa "int verify"
67.Fc
68.Ft int
69.Fo UI_UTIL_read_pw
70.Fa "char *buf"
71.Fa "char *buff"
72.Fa "int size"
73.Fa "const char *prompt"
74.Fa "int verify"
75.Fc
76.Sh DESCRIPTION
77.Fn UI_UTIL_read_pw_string
78asks for a passphrase, using
79.Fa prompt
80as a prompt, and stores it in
81.Fa buf .
82The maximum allowed size is given with
83.Fa length ,
84including the terminating NUL byte.
85If
86.Fa verify
87is non-zero, the password will be verified as well.
88.Pp
89.Fn UI_UTIL_read_pw
90does the same as
91.Fn UI_UTIL_read_pw_string ,
92but takes an external buffer
93.Fa buff
94for the verification passphrase.
95.Sh RETURN VALUES
96.Fn UI_UTIL_read_pw_string
97and
98.Fn UI_UTIL_read_pw
99return 0 on success or a negative value on error.
100.Sh SEE ALSO
101.Xr UI_new 3
102.Sh HISTORY
103.Fn UI_UTIL_read_pw
104and
105.Fn UI_UTIL_read_pw_string
106first appeared in OpenSSL 0.9.7 and have been available since
107.Ox 3.2 .