lib/libpam/modules/pam_afslog/pam_afslog.8

   1 .\" $NetBSD: pam_afslog.8,v 1.1 2005/09/21 14:19:08 tsarna Exp $
   2 .\"
   3 .\" Copyright 2005 Tyler C. Sarna <tsarna@netbsd.org>
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Tyler C. Sarna
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Neither the name of The NetBSD Foundation nor the names of its
  14 .\"    contributors may be used to endorse or promote products derived
  15 .\"    from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 .\" POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd September 20, 2005
  30 .Dt PAM_AFSLOG 8
  31 .Os
  32 .Sh NAME
  33 .Nm pam_afslog
  34 .Nd AFS credentials PAM module
  35 .Sh SYNOPSIS
  36 .Op Ar service-name
  37 .Ar module-type
  38 .Ar control-flag
  39 .Pa pam_afslog
  40 .Op Ar arguments
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 authentication service module for PAM provides functionality for
  45 only one PAM category: authentication
  46 .Ar ( module-type
  47 of
  48 .Dq Li auth ) .
  49 .Pp
  50 The
  51 .Fn pam_sm_authenticate
  52 function does nothing and thus the module should be used with an
  53 .Ar control-flag
  54 of
  55 .Dq Li optional .
  56 .Pp
  57 The value of the module comes from its
  58 .Fn pam_sm_setcred
  59 function.
  60 If the
  61 .Ar afslog
  62 parameter is enabled in
  63 .Xr krb5.conf 5 ,
  64 then the module will take Kerberos 5 credentials from the cache
  65 created by
  66 .Xr pam_krb5 8
  67 and convert them into AFS tokens, after first creating a PAG (Process
  68 Authentication Group) if necessary.
  69 .Sh SEE ALSO
  70 .Xr kafs 3 ,
  71 .Xr pam.conf 5 ,
  72 .Xr pam 8 ,
  73 .Xr pam_krb5 8
  74 .Sh HISTORY
  75 The
  76 .Nm
  77 module was developed for
  78 .Nx
  79 by
  80 .An Tyler C. Sarna .
  81 The
  82 .Nm
  83 module appeared in
  84 .Nx 4.0 .