contrib/openpam/doc/man/openpam_nullconv.3

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