From aa5dd405c3fabb441a32ed68e00a439d6592e59c Mon Sep 17 00:00:00 2001
From: schwarze <>
Date: Sun, 26 Mar 2017 00:06:10 +0000
Subject: merge new UI documentation from OpenSSL

---
 src/lib/libcrypto/man/UI_UTIL_read_pw.3 | 95 +++++++++++++++++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 src/lib/libcrypto/man/UI_UTIL_read_pw.3

(limited to 'src/lib/libcrypto/man/UI_UTIL_read_pw.3')

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 @@
+.\"	$OpenBSD: UI_UTIL_read_pw.3,v 1.1 2017/03/26 00:06:10 schwarze Exp $
+.\"	OpenSSL UI_UTIL_read_pw.pod 23103a52 Jan 12 15:17:42 2017 +0100
+.\"
+.\" This file was written by Richard Levitte <levitte@openssl.org>.
+.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\"    software must display the following acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\"    endorse or promote products derived from this software without
+.\"    prior written permission. For written permission, please contact
+.\"    openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\"    nor may "OpenSSL" appear in their names without prior written
+.\"    permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\"    acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: March 26 2017 $
+.Dt UI_UTIL_READ_PW 3
+.Os
+.Sh NAME
+.Nm UI_UTIL_read_pw ,
+.Nm UI_UTIL_read_pw_string
+.Nd get a password from the user
+.Sh SYNOPSIS
+.In openssl/ui.h
+.Ft int
+.Fo UI_UTIL_read_pw_string
+.Fa "char *buf"
+.Fa "int length"
+.Fa "const char *prompt"
+.Fa "int verify"
+.Fc
+.Ft int
+.Fo UI_UTIL_read_pw
+.Fa "char *buf"
+.Fa "char *buff"
+.Fa "int size"
+.Fa "const char *prompt"
+.Fa "int verify"
+.Fc
+.Sh DESCRIPTION
+.Fn UI_UTIL_read_pw_string
+asks for a passphrase, using
+.Fa prompt
+as a prompt, and stores it in
+.Fa buf .
+The maximum allowed size is given with
+.Fa length ,
+including the terminating NUL byte.
+If
+.Fa verify
+is non-zero, the password will be verified as well.
+.Pp
+.Fn UI_UTIL_read_pw
+does the same as
+.Fn UI_UTIL_read_pw_string ,
+but takes an external buffer
+.Fa buff
+for the verification passphrase.
+.Sh SEE ALSO
+.Xr UI_new 3
-- 
cgit v1.2.3-55-g6feb