contrib/openpam/doc/man/openpam_nullconv.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4 .\" All rights reserved.
   5 .\"
   6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   7 .\" Network Associates Laboratories, the Security Research Division of
   8 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The name of the author may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $Id$
  36 .\"
  37 .Dd December 18, 2011
  38 .Dt OPENPAM_NULLCONV 3
  39 .Os
  40 .Sh NAME
  41 .Nm openpam_nullconv
  42 .Nd null conversation function
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .In security/openpam.h
  49 .Ft "int"
  50 .Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 function is a null conversation function suitable
  55 for applications that want to use PAM but don't support interactive
  56 dialog with the user.
  57 Such applications should set
  58 .Dv PAM_AUTHTOK
  59 to whatever authentication
  60 token they've obtained on their own before calling
  61 .Xr pam_authenticate 3
  62 and / or
  63 .Xr pam_chauthtok 3 ,
  64 and their PAM configuration should specify the
  65 .Dv use_first_pass
  66 option for all modules that require access to the
  67 authentication token, to make sure they use
  68 .Dv PAM_AUTHTOK
  69 rather than
  70 try to query the user.
  71 .Pp
  72 .Sh RETURN VALUES
  73 The
  74 .Nm
  75 function returns one of the following values:
  76 .Bl -tag -width 18n
  77 .It Bq Er PAM_CONV_ERR
  78 Conversation failure.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr openpam_ttyconv 3 ,
  82 .Xr pam 3 ,
  83 .Xr pam_authenticate 3 ,
  84 .Xr pam_chauthtok 3 ,
  85 .Xr pam_prompt 3 ,
  86 .Xr pam_set_item 3 ,
  87 .Xr pam_strerror 3 ,
  88 .Xr pam_vprompt 3
  89 .Sh STANDARDS
  90 The
  91 .Nm
  92 function is an OpenPAM extension.
  93 .Sh AUTHORS
  94 The
  95 .Nm
  96 function and this manual page were developed for the
  97 .Fx
  98 Project by
  99 ThinkSec AS and Network Associates Laboratories, the
 100 Security Research Division of Network Associates, Inc.\& under
 101 DARPA/SPAWAR contract N66001-01-C-8035
 102 .Pq Dq CBOSS ,
 103 as part of the DARPA CHATS research program.