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