doc/man3/UI_UTIL_read_pw.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 UI_UTIL_read_pw_string, UI_UTIL_read_pw,
   6 *UI_UTIL_wrap_read_pem_callback - user interface utilities
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ui.h>
  11
  12  int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
  13                             int verify);
  14  int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
  15                      int verify);
  16  UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int
  17  rwflag);
  18
  19 =head1 DESCRIPTION
  20
  21 UI_UTIL_read_pw_string() asks for a passphrase, using B<prompt> as a
  22 prompt, and stores it in B<buf>.
  23 The maximum allowed size is given with B<length>, including the
  24 terminating NUL byte.
  25 If B<verify> is non-zero, the password will be verified as well.
  26
  27 UI_UTIL_read_pw() does the same as UI_UTIL_read_pw_string(), the
  28 difference is that you can give it an external buffer B<buff> for the
  29 verification passphrase.
  30
  31 UI_UTIL_wrap_read_pem_callback() can be used to create a temporary
  32 B<UI_METHOD> that wraps a given PEM password callback B<cb>.
  33 B<rwflag> is used to specify if this method will be used for
  34 passphrase entry without (0) or with (1) verification.
  35 When not used any more, the returned method should be freed with
  36 UI_destroy_method().
  37
  38 =head1 COPYRIGHT
  39
  40 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
  41
  42 Licensed under the OpenSSL license (the "License").  You may not use
  43 this file except in compliance with the License.  You can obtain a copy
  44 in the file LICENSE in the source distribution or at
  45 L<https://www.openssl.org/source/license.html>.
  46
  47 =cut