lib/libpam/modules/pam_tacplus/pam_tacplus.8

   1 .\" Copyright (c) 1999
   2 .\"     Andrzej Bialecki <abial@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Copyright (c) 1992, 1993, 1994
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\" All rights reserved.
   7 .\"
   8 .\" This code is derived from software donated to Berkeley by
   9 .\" Jan-Simon Pendry.
  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. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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 .\" $FreeBSD: src/lib/libpam/modules/pam_tacplus/pam_tacplus.8,v 1.4 2004/07/02 23:52:18 ru Exp $
  36 .\"
  37 .Dd August 2, 1999
  38 .Dt PAM_TACPLUS 8
  39 .Os
  40 .Sh NAME
  41 .Nm pam_tacplus
  42 .Nd TACACS+ authentication PAM module
  43 .Sh SYNOPSIS
  44 .Op Ar service-name
  45 .Ar module-type
  46 .Ar control-flag
  47 .Pa pam_tacplus
  48 .Op Ar options
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 module provides authentication services based
  53 upon the TACACS+ protocol
  54 for the PAM (Pluggable Authentication Module) framework.
  55 .Pp
  56 The
  57 .Nm
  58 module accepts these optional parameters:
  59 .Bl -tag -width ".Cm use_first_pass"
  60 .It Cm use_first_pass
  61 causes
  62 .Nm
  63 to use a previously entered password instead of prompting for a new one.
  64 If no password has been entered then authentication fails.
  65 .It Cm try_first_pass
  66 causes
  67 .Nm
  68 to use a previously entered password, if one is available.
  69 If no
  70 password has been entered,
  71 .Nm
  72 prompts for one as usual.
  73 .It Cm echo_pass
  74 causes echoing to be left on if
  75 .Nm
  76 prompts for a password.
  77 .It Cm conf Ns = Ns Ar pathname
  78 specifies a non-standard location for the TACACS+ client configuration file
  79 (normally located in
  80 .Pa /etc/tacplus.conf ) .
  81 .It Cm template_user Ns = Ns Ar username
  82 specifies a user whose
  83 .Xr passwd 5
  84 entry will be used as a template to create the session environment
  85 if the supplied username does not exist in local password database.
  86 The user
  87 will be authenticated with the supplied username and password, but his
  88 credentials to the system will be presented as the ones for
  89 .Ar username ,
  90 i.e., his login class, home directory, resource limits, etc.\& will be set to ones
  91 defined for
  92 .Ar username .
  93 .Pp
  94 If this option is omitted, and there is no username
  95 in the system databases equal to the supplied one (as determined by call to
  96 .Xr getpwnam 3 ) ,
  97 the authentication will fail.
  98 .El
  99 .Sh FILES
 100 .Bl -tag -width /etc/tacplus.conf -compact
 101 .It Pa /etc/tacplus.conf
 102 The standard TACACS+ client configuration file for
 103 .Nm
 104 .El
 105 .Sh SEE ALSO
 106 .Xr passwd 5 ,
 107 .Xr tacplus.conf 5 ,
 108 .Xr pam 8
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 module first appeared in
 113 .Fx 3.1 .
 114 .Sh AUTHORS
 115 .An -nosplit
 116 The
 117 .Nm
 118 manual page was written by
 119 .An Andrzej Bialecki Aq Mt abial@FreeBSD.org
 120 and adapted to TACACS+ from RADIUS by
 121 .An Mark R V Murray Aq Mt markm@FreeBSD.org .
 122 .Pp
 123 The
 124 .Nm
 125 module was written by
 126 .An John D. Polstra Aq Mt jdp@FreeBSD.org .