1109998Smarkm=pod
2109998Smarkm
3109998Smarkm=head1 NAME
4109998Smarkm
5109998Smarkmdes_read_password, des_read_2passwords, des_read_pw_string, des_read_pw -
6109998SmarkmCompatibility user interface functions
7109998Smarkm
8109998Smarkm=head1 SYNOPSIS
9109998Smarkm
10215697Ssimon #include <openssl/des_old.h>
11215697Ssimon
12109998Smarkm int des_read_password(DES_cblock *key,const char *prompt,int verify);
13109998Smarkm int des_read_2passwords(DES_cblock *key1,DES_cblock *key2,
14109998Smarkm 	const char *prompt,int verify);
15109998Smarkm
16109998Smarkm int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
17109998Smarkm int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
18109998Smarkm
19109998Smarkm=head1 DESCRIPTION
20109998Smarkm
21109998SmarkmThe DES library contained a few routines to prompt for passwords.  These
22109998Smarkmaren't necessarely dependent on DES, and have therefore become part of the
23109998SmarkmUI compatibility library.
24109998Smarkm
25109998Smarkmdes_read_pw() writes the string specified by I<prompt> to standard output
26109998Smarkmturns echo off and reads an input string from the terminal.  The string is
27109998Smarkmreturned in I<buf>, which must have spac for at least I<size> bytes.
28109998SmarkmIf I<verify> is set, the user is asked for the password twice and unless
29109998Smarkmthe two copies match, an error is returned.  The second password is stored
30109998Smarkmin I<buff>, which must therefore also be at least I<size> bytes.  A return
31109998Smarkmcode of -1 indicates a system error, 1 failure due to use interaction, and
32109998Smarkm0 is success.  All other functions described here use des_read_pw() to do
33109998Smarkmthe work.
34109998Smarkm
35109998Smarkmdes_read_pw_string() is a variant of des_read_pw() that provides a buffer
36109998Smarkmfor you if I<verify> is set.
37109998Smarkm
38109998Smarkmdes_read_password() calls des_read_pw() and converts the password to a
39109998SmarkmDES key by calling DES_string_to_key(); des_read_2password() operates in
40109998Smarkmthe same way as des_read_password() except that it generates two keys
41109998Smarkmby using the DES_string_to_2key() function.
42109998Smarkm
43109998Smarkm=head1 NOTES
44109998Smarkm
45109998Smarkmdes_read_pw_string() is available in the MIT Kerberos library as well, and
46109998Smarkmis also available under the name EVP_read_pw_string().
47109998Smarkm
48109998Smarkm=head1 SEE ALSO
49109998Smarkm
50109998SmarkmL<ui(3)|ui(3)>, L<ui_create(3)|ui_create(3)>
51109998Smarkm
52109998Smarkm=head1 AUTHOR
53109998Smarkm
54109998SmarkmRichard Levitte (richard@levitte.org) for the OpenSSL project
55109998Smarkm(http://www.openssl.org).
56109998Smarkm
57109998Smarkm=cut
58