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