Debian Codegraph @

upstream/debian-unstable/man3/pam_sm_open_session.3

raw
1 '\" t
2 .\" Title: pam_sm_open_session
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_SM_OPEN_SESSION" "3" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_sm_open_session \- PAM service function to start session management
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_modules\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_sm_open_session('u
40 .BI "int pam_sm_open_session(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_sm_open_session\fR
45 function is the service module\*(Aqs implementation of the
46 \fBpam_open_session\fR(3)
47 interface\&.
48 .PP
49 This function is called to commence a session\&. The only valid value for
50 \fIflags\fR
51 is zero or:
52 .PP
53 PAM_SILENT
54 .RS 4
55 Do not emit any messages\&.
56 .RE
57 .SH "RETURN VALUES"
58 .PP
59 PAM_SESSION_ERR
60 .RS 4
61 Cannot make/remove an entry for the specified session\&.
62 .RE
63 .PP
64 PAM_SUCCESS
65 .RS 4
66 The session was successfully started\&.
67 .RE
68 .SH "SEE ALSO"
69 .PP
70 \fBpam\fR(3),
71 \fBpam_open_session\fR(3),
72 \fBpam_sm_close_session\fR(3),
73 \fBpam_strerror\fR(3),
74 \fBPAM\fR(8)