share/man/man5/pam_unix_session.5

   1 '\" te
   2 .\" Copyright 2016 Toomas Soome <tsoome@me.com>
   3 .\" Copyright (C) 2002, Sun Microsystems, Inc.
   4 .\" All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH PAM_UNIX_SESSION 5 "Jan 3, 2016"
   9 .SH NAME
  10 pam_unix_session \- session management PAM module for UNIX
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBpam_unix_session.so.1\fR
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .LP
  19 The \fBpam_unix_session\fR module implements \fBpam_sm_open_session\fR(3PAM)
  20 and \fBpam_sm_close_session\fR(3PAM).
  21 .sp
  22 .LP
  23 \fBpam_sm_open_session()\fR reads \fB/var/log/lastlog.v2\fR to report the
  24 user's last login time via a PAM_TEXT_INFO message as well as updates the file
  25 with information contained in the \fBPAM_USER\fR, \fBPAM_TTY\fR, and
  26 \fBPAM_RHOSTS\fR items.  \fBpam_unix_account\fR(5) also uses this file to
  27 determine the previous time the user logged in.
  28 .sp
  29 .LP
  30 \fBpam_sm_close_session()\fR is a null function.
  31 .sp
  32 .LP
  33 The following options can be passed to the module:
  34 .sp
  35 .ne 2
  36 .na
  37 \fBdebug\fR
  38 .ad
  39 .RS 9n
  40 \fBsyslog\fR(3C) debugging information at the \fBLOG_DEBUG\fR level
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBnowarn\fR\fR
  47 .ad
  48 .RS 9n
  49 Turn off last login PAM_TEXT_INFO message.
  50 .RE
  51
  52 .SH ERRORS
  53 .LP
  54 Upon successful completion, \fBPAM_SUCCESS\fR is returned. The following error
  55 codes are returned upon error:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBPAM_SESSION_ERR\fR\fR
  60 .ad
  61 .RS 20n
  62 Cannot make or remove the entry for the specified session (PAM_TTY is not
  63 present).
  64 .RE
  65
  66 .ne 2
  67 .na
  68 \fB\fBPAM_USER_UNKNOWN\fR\fR
  69 .ad
  70 .RS 20n
  71 No account is present for \fIuser\fR.
  72 .RE
  73
  74 .SH ATTRIBUTES
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Evolving
  87 _
  88 MT Level        MT-Safe with exceptions
  89 .TE
  90
  91 .SH SEE ALSO
  92 .LP
  93 \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM), \fBsyslog\fR(3C),
  94 \fBlibpam\fR(3LIB), \fBpam.conf\fR(4), \fBnsswitch.conf\fR(4),
  95 \fBattributes\fR(5), \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
  96 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
  97 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5)
  98 .SH NOTES
  99 .LP
 100 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe only if each thread within the
 101 multi-threaded application uses its own PAM handle.
 102 .sp
 103 .LP
 104 The \fBpam_unix\fR(5) module is no longer supported. Similar functionality is
 105 provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 106 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 107 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and
 108 \fBpam_unix_session\fR(5).