builddeps/scrypt-1.1.6/lib/util/readpass.h

   1 /*-
   2  * Copyright 2009 Colin Percival
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * This file was originally written by Colin Percival as part of the Tarsnap
  27  * online backup system.
  28  */
  29 #ifndef _READPASS_H_
  30 #define _READPASS_H_
  31
  32 /**
  33  * tarsnap_getpass(passwd, prompt, confirmprompt, devtty)
  34  * If ${devtty} is non-zero, read a password from /dev/tty if possible; if
  35  * not, read from stdin.  If reading from a tty (either /dev/tty or stdin),
  36  * disable echo and prompt the user by printing ${prompt} to stderr.  If
  37  * ${confirmprompt} is non-NULL, read a second password (prompting if a
  38  * terminal is being used) and repeat until the user enters the same password
  39  * twice.  Return the password as a malloced NUL-terminated string via
  40  * ${passwd}.  The obscure name is to avoid namespace collisions due to the
  41  * getpass / readpass / readpassphrase / etc. functions in various libraries.
  42  */
  43 int tarsnap_readpass(char **, const char *, const char *, int);
  44
  45 #endif /* !_READPASS_H_ */