pam_sm_open_session.3 (2010 09)

pam_sm_open_session(3) pam_sm_open_session(3)

NAME

pam_sm_open_session, pam_sm_close_session - Service provider implementation for pam_open_session

and pam_close_session respectively

SYNOPSIS

cc [ ﬂag ... ] ﬁle ...

-lpam [ library ... ]

#include <security/pam_appl.h>

#include <security/pam_modules.h>

int pam_sm_open_session(pam_handle_t *

pamh, int ﬂags, int argc

const char **

argv);

int pam_sm_close_session(pam_handle_t *

pamh, int ﬂags, int

argc,

const char **argv);

DESCRIPTION

In response to a call to pam_open_session()

and

pam_close_session()

, the PAM framework

calls

pam_sm_open_session()

and pam_sm_close_session()

, respectively from the modules

listed in the pam.conf (4) ﬁle. The session management provider supplies the back-end functionality for

this interface function.

pam_sm_open_session()

is called to initiate session management. pam_sm_close_session()

is invoked when a session has terminated. The argument pamh is an authentication handle. The follow-

ing ﬂag may be set in the ﬂags ﬁeld:

PAM_SILENT Session service should not generate any messages.

The argc argument represents the number of module options passed in from the conﬁguration ﬁle

pam.conf (4). argv speciﬁes the module options, which are interpreted and processed by the session

management service. If an unknown option is passed in, an error should be logged through syslog (3C)

and the option ignored.

APPLICATION USAGE

Refer to pam(3) for information on thread-safety of PAM interfaces.

RETURN VALUES

Upon successful completion,

PAM_SUCCESS should be returned. The following values may also be

returned upon error:

PAM_SESSION_ERR Can not make/remove an entry for the speciﬁed session.

PAM_IGNORE Ignore underlying session module regardless of whether the control ﬂag is

required, optional or sufficient