contrib/openpam/doc/man/openpam_nullconv.3

   1 .\" Generated from openpam_nullconv.c by gendoc.pl
   2 .\" $Id: openpam_nullconv.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt OPENPAM_NULLCONV 3
   5 .Os
   6 .Sh NAME
   7 .Nm openpam_nullconv
   8 .Nd null conversation function
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .In security/openpam.h
  15 .Ft "int"
  16 .Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  17 .Sh DESCRIPTION
  18 The
  19 .Fn openpam_nullconv
  20 function is a null conversation function suitable
  21 for applications that want to use PAM but don't support interactive
  22 dialog with the user.
  23 Such applications should set
  24 .Dv PAM_AUTHTOK
  25 to whatever authentication
  26 token they've obtained on their own before calling
  27 .Xr pam_authenticate 3
  28 and / or
  29 .Xr pam_chauthtok 3 ,
  30 and their PAM configuration should specify the
  31 .Dv use_first_pass
  32 option for all modules that require access to the
  33 authentication token, to make sure they use
  34 .Dv PAM_AUTHTOK
  35 rather than
  36 try to query the user.
  37 .Pp
  38 .Sh RETURN VALUES
  39 The
  40 .Fn openpam_nullconv
  41 function returns one of the following values:
  42 .Bl -tag -width 18n
  43 .It Bq Er PAM_CONV_ERR
  44 Conversation failure.
  45 .El
  46 .Sh SEE ALSO
  47 .Xr openpam_ttyconv 3 ,
  48 .Xr pam 3 ,
  49 .Xr pam_authenticate 3 ,
  50 .Xr pam_chauthtok 3 ,
  51 .Xr pam_prompt 3 ,
  52 .Xr pam_set_item 3 ,
  53 .Xr pam_strerror 3 ,
  54 .Xr pam_vprompt 3
  55 .Sh STANDARDS
  56 The
  57 .Fn openpam_nullconv
  58 function is an OpenPAM extension.
  59 .Sh AUTHORS
  60 The
  61 .Fn openpam_nullconv
  62 function and this manual page were
  63 developed for the
  64 .Fx
  65 Project by ThinkSec AS and Network Associates Laboratories, the
  66 Security Research Division of Network Associates, Inc.\& under
  67 DARPA/SPAWAR contract N66001-01-C-8035
  68 .Pq Dq CBOSS ,
  69 as part of the DARPA CHATS research program.
  70 .Pp
  71 The OpenPAM library is maintained by
  72 .An Dag-Erling Sm\(/orgrav Aq des@des.no .