usr/src/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 .sp
  19 .LP
  20 The \fBpam_unix_session\fR module implements \fBpam_sm_open_session\fR(3PAM)
  21 and \fBpam_sm_close_session\fR(3PAM).
  22 .sp
  23 .LP
  24 \fBpam_sm_open_session()\fR updates the \fB/var/adm/lastlog\fR file with the
  25 information contained in the \fBPAM_USER\fR, \fBPAM_TTY\fR, and
  26 \fBPAM_RHOSTS\fR items. \fBpam_unix_account\fR(5) uses this account 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 .sp
  54 .LP
  55 Upon successful completion, \fBPAM_SUCCESS\fR is returned. The following error
  56 codes are returned upon error:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBPAM_SESSION_ERR\fR\fR
  61 .ad
  62 .RS 20n
  63 Cannot make or remove the entry for the specified session (PAM_TTY is not
  64 present).
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBPAM_USER_UNKNOWN\fR\fR
  71 .ad
  72 .RS 20n
  73 No account is present for \fIuser\fR.
  74 .RE
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Evolving
  90 _
  91 MT Level        MT-Safe with exceptions
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM), \fBsyslog\fR(3C),
  98 \fBlibpam\fR(3LIB), \fBpam.conf\fR(4), \fBnsswitch.conf\fR(4),
  99 \fBattributes\fR(5), \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 100 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 101 \fBpam_unix_account\fR(5),\fBpam_unix_auth\fR(5),
 102 .SH NOTES
 103 .sp
 104 .LP
 105 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe only if each thread within the
 106 multi-threaded application uses its own PAM handle.
 107 .sp
 108 .LP
 109 The \fBpam_unix\fR(5) module is no longer supported. Similar functionality is
 110 provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 111 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 112 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and
 113 \fBpam_unix_session\fR(5).