granicus.if.org Git - linux-pam/blob - doc/man/pam_sm_open_session.3

   1 .\"     Title: pam_sm_open_session
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
   4 .\"      Date: 06/19/2006
   5 .\"    Manual: Linux\-PAM Manual
   6 .\"    Source: Linux\-PAM Manual
   7 .\"
   8 .TH "PAM_SM_OPEN_SESSION" "3" "06/19/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 pam_sm_open_session \- PAM service function for session management
  15 .SH "SYNOPSIS"
  16 .sp
  17 .ft B
  18 .nf
  19 #define PAM_SM_SESSION
  20 .fi
  21 .ft
  22 .sp
  23 .ft B
  24 .nf
  25 #include <security/pam_modules.h>
  26 .fi
  27 .ft
  28 .HP 35
  29 .BI "PAM_EXTERN int pam_sm_open_session(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
  30 .SH "DESCRIPTION"
  31 .PP
  32 The
  33 \fBpam_sm_open_session\fR
  34 function is the service module's implementation of the
  35 \fBpam_open_session\fR(3)
  36 interface.
  37 .PP
  38 This function is called to commence a session. The only valid value for
  39 \fIflags\fR
  40 is zero or:
  41 .TP 3n
  42 PAM_SILENT
  43 Do not emit any messages.
  44 .SH "RETURN VALUES"
  45 .TP 3n
  46 PAM_SESSION_ERR
  47 Cannot make/remove an entry for the specified session.
  48 .TP 3n
  49 PAM_SUCCESS
  50 The session was successfully started.
  51 .SH "SEE ALSO"
  52 .PP
  53
  54 \fBpam\fR(3),
  55 \fBpam_open_session\fR(3),
  56 \fBpam_sm_close_session\fR(3),
  57 \fBpam_strerror\fR(3),
  58 \fBPAM\fR(8)