dist/openpam/doc/man/openpam_ttyconv.3

   1 .\"     $NetBSD: openpam_ttyconv.3,v 1.6 2006/06/14 16:22:54 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
   6 .\" All rights reserved.
   7 .\"
   8 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   9 .\" Network Associates Laboratories, the Security Research Division of
  10 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
  11 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. The name of the author may not be used to endorse or promote
  22 .\"    products derived from this software without specific prior written
  23 .\"    permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  40 .Dt OPENPAM_TTYCONV 3
  41 .Os
  42 .Sh NAME
  43 .Nm openpam_ttyconv
  44 .Nd simple tty-based conversation function
  45 .Sh LIBRARY
  46 .Lb libpam
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In security/pam_appl.h
  50 .In security/openpam.h
  51 .Ft "int"
  52 .Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 function is a standard conversation function
  57 suitable for use on TTY devices.
  58 It should be adequate for the needs of most text-based interactive
  59 programs.
  60 .Pp
  61 The
  62 .Nm
  63 function displays a prompt to, and reads in a
  64 password from /dev/tty. If this file is not accessible,
  65 .Nm
  66 displays the prompt on the standard error output and reads from the
  67 standard input.
  68 .Pp
  69 The
  70 .Nm
  71 function allows the application to specify a
  72 timeout for user input by setting the global integer variable
  73 .Va openpam_ttyconv_timeout
  74 to the length of the timeout in seconds.
  75 .Pp
  76 .Sh RETURN VALUES
  77 The
  78 .Nm
  79 function returns one of the following values:
  80 .Bl -tag -width 18n
  81 .It Bq Er PAM_BUF_ERR
  82 Memory buffer error.
  83 .It Bq Er PAM_CONV_ERR
  84 Conversation failure.
  85 .It Bq Er PAM_SYSTEM_ERR
  86 System error.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr getpass 3 ,
  90 .Xr openpam_nullconv 3 ,
  91 .Xr pam 3 ,
  92 .Xr pam_prompt 3 ,
  93 .Xr pam_strerror 3 ,
  94 .Xr pam_vprompt 3
  95 .Sh STANDARDS
  96 The
  97 .Nm
  98 function is an OpenPAM extension.
  99 .Sh AUTHORS
 100 The
 101 .Nm
 102 function and this manual page were developed for the
 103 .Fx
 104 Project by ThinkSec AS and Network Associates Laboratories, the
 105 Security Research Division of Network Associates, Inc.\& under
 106 DARPA/SPAWAR contract N66001-01-C-8035
 107 .Pq Dq CBOSS ,
 108 as part of the DARPA CHATS research program.