lib/nss_tacplus/nss_tacplus.8

   1 .\"-
   2 .\" Copyright (c) 2023 Klara, Inc.
   3 .\"
   4 .\" SPDX-License-Identifier: BSD-2-Clause
   5 .\"
   6 .Dd June 13, 2023
   7 .Dt NSS_TACPLUS 8
   8 .Os
   9 .Sh NAME
  10 .Nm nss_tacplus
  11 .Nd TACACS+ nsswitch module
  12 .Sh SYNOPSIS
  13 .Ic passwd : files tacplus
  14 .Sh DESCRIPTION
  15 The
  16 .Nm
  17 module is a loadable NSS module which provides a minimal identity
  18 service using a TACACS+ backend.
  19 .Pp
  20 Due to the limitations of the TACACS+ protocol, the functionality
  21 provided by the
  22 .Nm
  23 module is very limited: it can look up a user by name, but not by uid,
  24 and it cannot enumerate users.
  25 .Pp
  26 To look up a user, the
  27 .Nm
  28 module submits an authorization request with authentication method
  29 .Dv TAC_PLUS_AUTHEN_METH_NOT_SET ,
  30 authentication type
  31 .Dv TAC_PLUS_AUTHEN_TYPE_NOT_SET ,
  32 and authentication service
  33 .Dv TAC_PLUS_AUTHEN_SVC_LOGIN ,
  34 for the
  35 .Dq shell
  36 service.
  37 If the response status is either
  38 .Dv TAC_PLUS_AUTHOR_STATUS_PASS_ADD
  39 or
  40 .Dv TAC_PLUS_AUTHOR_STATUS_PASS_REPL ,
  41 the user is considered to exist and the
  42 .Nm
  43 module fills out a
  44 .Vt struct passwd
  45 for it.
  46 .Pp
  47 The following attributes, if included in the response from the TACACS+
  48 server, are used to construct the response:
  49 .Bl -tag -width GECOS
  50 .It Va UID
  51 Numeric user ID.
  52 Must be between 0 and
  53 .Dv UID_MAX .
  54 Defaults to 65534.
  55 .It Va GID
  56 Numeric primary group ID.
  57 Must be between 0 and
  58 .Dv GID_MAX .
  59 Defaults to 65534.
  60 .It Va CLASS
  61 Login class.
  62 Left blank if not provided.
  63 .It Va GECOS
  64 Display name.
  65 If not provided, the user name is used instead.
  66 .It Va HOME
  67 Home directory.
  68 Defaults to
  69 .Pa / .
  70 .It Va SHELL
  71 Shell.
  72 Defaults to
  73 .Pa /bin/sh .
  74 .El
  75 .Pp
  76 Case is ignored when matching attribute names.
  77 If an attribute is included multiple times, the last value takes
  78 effect.
  79 .Sh SEE ALSO
  80 .Xr libtacplus 3 ,
  81 .Xr tacplus.conf 5 ,
  82 .Xr pam_tacplus 8
  83 .Sh HISTORY
  84 .An -nosplit
  85 The
  86 .Nm
  87 module and this manual page were written by
  88 .An Dag-Erling Smørgrav Aq Mt des@FreeBSD.org
  89 for Klara Systems.