Correct some links...
[openssl.git] / doc / crypto / ui_compat.pod
1 =pod
2
3 =head1 NAME
4
5 des_read_password, des_read_2passwords, des_read_pw_string, des_read_pw -
6 Compatibility user interface functions
7
8 =head1 SYNOPSIS
9
10  int des_read_password(DES_cblock *key,const char *prompt,int verify);
11  int des_read_2passwords(DES_cblock *key1,DES_cblock *key2,
12         const char *prompt,int verify);
13
14  int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
15  int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
16
17 =head1 DESCRIPTION
18
19 The DES library contained a few routines to prompt for passwords.  These
20 aren't necessarely dependent on DES, and have therefore become part of the
21 UI compatibility library.
22
23 des_read_pw() writes the string specified by I<prompt> to standard output
24 turns echo off and reads an input string from the terminal.  The string is
25 returned in I<buf>, which must have spac for at least I<size> bytes.
26 If I<verify> is set, the user is asked for the password twice and unless
27 the two copies match, an error is returned.  The second password is stored
28 in I<buff>, which must therefore also be at least I<size> bytes.  A return
29 code of -1 indicates a system error, 1 failure due to use interaction, and
30 0 is success.  All other functions described here use des_read_pw() to do
31 the work.
32
33 des_read_pw_string() is a variant of des_read_pw() that provides a buffer
34 for you if I<verify> is set.
35
36 des_read_password() calls des_read_pw() and converts the password to a
37 DES key by calling DES_string_to_key(); des_read_2password() operates in
38 the same way as des_read_password() except that it generates two keys
39 by using the DES_string_to_2key() function.
40
41 =head1 NOTES
42
43 des_read_pw_string() is available in the MIT Kerberos library as well, and
44 is also available under the name EVP_read_pw_string().
45
46 =head1 SEE ALSO
47
48 L<ui(3)|ui(3)>, L<ui_create(3)|ui_create(3)>
49
50 =head1 AUTHOR
51
52 Richard Levitte (richard@levitte.org) for the OpenSSL project
53 (http://www.openssl.org).
54
55 =cut