Blame doc/man/pam_sm_acct_mgmt.3

Packit Service b29381
'\" t
Packit Service b29381
.\"     Title: pam_sm_acct_mgmt
Packit Service b29381
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
Packit Service b29381
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Packit Service b29381
.\"      Date: 05/18/2017
Packit Service b29381
.\"    Manual: Linux-PAM Manual
Packit Service b29381
.\"    Source: Linux-PAM Manual
Packit Service b29381
.\"  Language: English
Packit Service b29381
.\"
Packit Service b29381
.TH "PAM_SM_ACCT_MGMT" "3" "05/18/2017" "Linux-PAM Manual" "Linux-PAM Manual"
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.\" * Define some portability stuff
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit Service b29381
.\" http://bugs.debian.org/507673
Packit Service b29381
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit Service b29381
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit Service b29381
.ie \n(.g .ds Aq \(aq
Packit Service b29381
.el       .ds Aq '
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.\" * set default formatting
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.\" disable hyphenation
Packit Service b29381
.nh
Packit Service b29381
.\" disable justification (adjust text to left margin only)
Packit Service b29381
.ad l
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.\" * MAIN CONTENT STARTS HERE *
Packit Service b29381
.\" -----------------------------------------------------------------
Packit Service b29381
.SH "NAME"
Packit Service b29381
pam_sm_acct_mgmt \- PAM service function for account management
Packit Service b29381
.SH "SYNOPSIS"
Packit Service b29381
.sp
Packit Service b29381
.ft B
Packit Service b29381
.nf
Packit Service b29381
#define PAM_SM_ACCOUNT
Packit Service b29381
.fi
Packit Service b29381
.ft
Packit Service b29381
.sp
Packit Service b29381
.ft B
Packit Service b29381
.nf
Packit Service b29381
#include <security/pam_modules\&.h>
Packit Service b29381
.fi
Packit Service b29381
.ft
Packit Service b29381
.HP \w'int\ pam_sm_acct_mgmt('u
Packit Service b29381
.BI "int pam_sm_acct_mgmt(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
Packit Service b29381
.SH "DESCRIPTION"
Packit Service b29381
.PP
Packit Service b29381
The
Packit Service b29381
\fBpam_sm_acct_mgmt\fR
Packit Service b29381
function is the service module\*(Aqs implementation of the
Packit Service b29381
\fBpam_acct_mgmt\fR(3)
Packit Service b29381
interface\&.
Packit Service b29381
.PP
Packit Service b29381
This function performs the task of establishing whether the user is permitted to gain access at this time\&. It should be understood that the user has previously been validated by an authentication module\&. This function checks for other things\&. Such things might be: the time of day or the date, the terminal line, remote hostname, etc\&. This function may also determine things like the expiration on passwords, and respond that the user change it before continuing\&.
Packit Service b29381
.PP
Packit Service b29381
Valid flags, which may be logically OR\*(Aqd with
Packit Service b29381
\fIPAM_SILENT\fR, are:
Packit Service b29381
.PP
Packit Service b29381
PAM_SILENT
Packit Service b29381
.RS 4
Packit Service b29381
Do not emit any messages\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_DISALLOW_NULL_AUTHTOK
Packit Service b29381
.RS 4
Packit Service b29381
Return
Packit Service b29381
\fBPAM_AUTH_ERR\fR
Packit Service b29381
if the database of authentication tokens for this authentication mechanism has a
Packit Service b29381
\fINULL\fR
Packit Service b29381
entry for the user\&.
Packit Service b29381
.RE
Packit Service b29381
.SH "RETURN VALUES"
Packit Service b29381
.PP
Packit Service b29381
PAM_ACCT_EXPIRED
Packit Service b29381
.RS 4
Packit Service b29381
User account has expired\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_AUTH_ERR
Packit Service b29381
.RS 4
Packit Service b29381
Authentication failure\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_NEW_AUTHTOK_REQD
Packit Service b29381
.RS 4
Packit Service b29381
The user\*(Aqs authentication token has expired\&. Before calling this function again the application will arrange for a new one to be given\&. This will likely result in a call to
Packit Service b29381
\fBpam_sm_chauthtok()\fR\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_PERM_DENIED
Packit Service b29381
.RS 4
Packit Service b29381
Permission denied\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_SUCCESS
Packit Service b29381
.RS 4
Packit Service b29381
The authentication token was successfully updated\&.
Packit Service b29381
.RE
Packit Service b29381
.PP
Packit Service b29381
PAM_USER_UNKNOWN
Packit Service b29381
.RS 4
Packit Service b29381
User unknown to password service\&.
Packit Service b29381
.RE
Packit Service b29381
.SH "SEE ALSO"
Packit Service b29381
.PP
Packit Service b29381
\fBpam\fR(3),
Packit Service b29381
\fBpam_acct_mgmt\fR(3),
Packit Service b29381
\fBpam_sm_chauthtok\fR(3),
Packit Service b29381
\fBpam_strerror\fR(3),
Packit Service b29381
\fBPAM\fR(8)