dist/openpam/doc/man/openpam_nullconv.3

   1 .\"     $NetBSD: openpam_nullconv.3,v 1.6 2006/02/05 02:37:45 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_NULLCONV 3
  41 .Os
  42 .Sh NAME
  43 .Nm openpam_nullconv
  44 .Nd null 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_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 function is a null conversation function suitable
  57 for applications that want to use PAM but don't support interactive
  58 dialog with the user.
  59 Such applications should set
  60 .Dv PAM_AUTHTOK
  61 to whatever authentication
  62 token they've obtained on their own before calling
  63 .Xr pam_authenticate 3
  64 and / or
  65 .Xr pam_chauthtok 3 ,
  66 and their PAM configuration should specify the
  67 .Dv use_first_pass
  68 option for all modules that require access to the
  69 authentication token, to make sure they use
  70 .Dv PAM_AUTHTOK
  71 rather than try to query the user.
  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 ThinkSec AS and Network Associates Laboratories, the
  99 Security Research Division of Network Associates, Inc.\& under
 100 DARPA/SPAWAR contract N66001-01-C-8035
 101 .Pq Dq CBOSS ,
 102 as part of the DARPA CHATS research program.