aboutsummaryrefslogtreecommitdiffstats
path: root/doc/crypto/ui_compat.pod
blob: 9ab3c69bf256db8653d4996ea55e26502aca6aa9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
=pod

=head1 NAME

des_read_password, des_read_2passwords, des_read_pw_string, des_read_pw -
Compatibility user interface functions

=head1 SYNOPSIS

 int des_read_password(DES_cblock *key,const char *prompt,int verify);
 int des_read_2passwords(DES_cblock *key1,DES_cblock *key2,
 	const char *prompt,int verify);

 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);

=head1 DESCRIPTION

The DES library contained a few routines to prompt for passwords.  These
aren't necessarely dependent on DES, and have therefore become part of the
UI compatibility library.

des_read_pw() writes the string specified by I<prompt> to standard output
turns echo off and reads an input string from the terminal.  The string is
returned in I<buf>, which must have spac for at least I<size> bytes.
If I<verify> is set, the user is asked for the password twice and unless
the two copies match, an error is returned.  The second password is stored
in I<buff>, which must therefore also be at least I<size> 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 des_read_pw() to do
the work.

des_read_pw_string() is a variant of des_read_pw() that provides a buffer
for you if I<verify> is set.

des_read_password() calls des_read_pw() and converts the password to a
DES key by calling DES_string_to_key(); des_read_2password() operates in
the same way as des_read_password() except that it generates two keys
by using the DES_string_to_2key() function.

=head1 NOTES

des_read_pw_string() is available in the MIT Kerberos library as well, and
is also available under the name EVP_read_pw_string().

=head1 SEE ALSO

L<ui(3)|ui(3)>, L<ui_create(3)|ui_create(3)>

=head1 AUTHOR

Richard Levitte (richard@levitte.org) for the OpenSSL project
(http://www.openssl.org).

=cut