From a5391cd680a2395b7b8d49a99958006747167abf Mon Sep 17 00:00:00 2001
From: schwarze <>
Date: Fri, 6 Jan 2017 17:17:29 +0000
Subject: Add EVP_read_pw_string(3) to NAME and SYNOPSIS, resolving a dangling
 cross reference reported by jmc@.

Sort NAME and SYNOPSIS to agree with .Dt and DESCRIPTION.
Unify parameter names.
Delete a sentence about an implementation detail that is no longer true.
Mention the length limitation of the *_string() variants.
---
 src/lib/libcrypto/man/des_read_pw.3 | 43 +++++++++++++++++++++++++------------
 1 file changed, 29 insertions(+), 14 deletions(-)

(limited to 'src')

diff --git a/src/lib/libcrypto/man/des_read_pw.3 b/src/lib/libcrypto/man/des_read_pw.3
index 50c1390b35..e772d0a65a 100644
--- a/src/lib/libcrypto/man/des_read_pw.3
+++ b/src/lib/libcrypto/man/des_read_pw.3
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: des_read_pw.3,v 1.5 2016/12/10 22:01:26 schwarze Exp $
+.\"	$OpenBSD: des_read_pw.3,v 1.6 2017/01/06 17:17:29 schwarze Exp $
 .\"	OpenSSL doc/crypto/ui_compat.pod May 14 11:28:00 2006 +0000
 .\"	OpenSSL doc/crypto/des.pod 2a9aca32 Oct 25 08:44:10 2001 +0000
 .\"
@@ -50,27 +50,36 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 10 2016 $
+.Dd $Mdocdate: January 6 2017 $
 .Dt DES_READ_PW 3
 .Os
 .Sh NAME
+.Nm des_read_pw ,
 .Nm des_read_pw_string ,
-.Nm des_read_pw
+.Nm EVP_read_pw_string
 .Nd compatibility user interface functions
 .Sh SYNOPSIS
 .In openssl/ui_compat.h
 .Ft int
+.Fo des_read_pw
+.Fa "char *buf"
+.Fa "char *buff"
+.Fa "int length"
+.Fa "const char *prompt"
+.Fa "int verify"
+.Fc
+.Ft int
 .Fo des_read_pw_string
 .Fa "char *buf"
 .Fa "int length"
 .Fa "const char *prompt"
 .Fa "int verify"
 .Fc
+.In openssl/evp.h
 .Ft int
-.Fo des_read_pw
+.Fo EVP_read_pw_string
 .Fa "char *buf"
-.Fa "char *buff"
-.Fa "int size"
+.Fa "int length"
 .Fa "const char *prompt"
 .Fa "int verify"
 .Fc
@@ -87,7 +96,7 @@ terminal.
 The string is returned in
 .Fa buf ,
 which must have space for at least
-.Fa size
+.Fa length
 bytes.
 If
 .Fa verify
@@ -96,13 +105,10 @@ copies match, an error is returned.
 The second password is stored in
 .Fa buff ,
 which must therefore also be at least
-.Fa size
+.Fa length
 bytes.
 A return code of -1 indicates a system error, 1 failure due to use
 interaction, and 0 is success.
-All other functions described here use
-.Fn des_read_pw
-to do the work.
 .Pp
 .Fn des_read_pw_string
 is a variant of
@@ -110,9 +116,18 @@ is a variant of
 that provides a buffer if
 .Fa verify
 is set.
-It is available in the MIT Kerberos library as well,
-and is also available under the name
-.Xr EVP_read_pw_string 3 .
+It is available in the MIT Kerberos library as well.
+If
+.Fa length
+exceeds
+.Dv BUFSIZ ,
+.Fn des_read_pw_string
+uses
+.Dv BUFSIZ .
+.Pp
+.Fn EVP_read_pw_string
+is functionally similar to
+.Fn des_read_pw_string .
 .Sh SEE ALSO
 .Xr UI_new 3
 .Sh AUTHORS
-- 
cgit v1.2.3-55-g6feb