Debian Codegraph @

upstream/debian-unstable/man3/pam_open_session.3

raw
1 '\" t
2 .\" Title: pam_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_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_open_session \- start PAM session management
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_appl\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_open_session('u
40 .BI "int pam_open_session(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_open_session\fR
45 function sets up a user session for a previously successful authenticated user\&. The session should later be terminated with a call to
46 \fBpam_close_session\fR(3)\&.
47 .PP
48 It should be noted that the effective uid,
49 \fBgeteuid\fR(2), of the application should be of sufficient privilege to perform such tasks as creating or mounting the user\*(Aqs home directory for example\&.
50 .PP
51 The flags argument is the binary or of zero or more of the following values:
52 .PP
53 PAM_SILENT
54 .RS 4
55 Do not emit any messages\&.
56 .RE
57 .SH "RETURN VALUES"
58 .PP
59 PAM_ABORT
60 .RS 4
61 General failure\&.
62 .RE
63 .PP
64 PAM_BUF_ERR
65 .RS 4
66 Memory buffer error\&.
67 .RE
68 .PP
69 PAM_SESSION_ERR
70 .RS 4
71 Session failure\&.
72 .RE
73 .PP
74 PAM_SUCCESS
75 .RS 4
76 Session was successful created\&.
77 .RE
78 .SH "SEE ALSO"
79 .PP
80 \fBpam_close_session\fR(3),
81 \fBpam_strerror\fR(3)