1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5 <refentry id='pam_send'>
8 <refentrytitle>pam_open_session</refentrytitle>
9 <manvolnum>3</manvolnum>
10 <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
13 <refnamediv id="pam_open_session-name">
14 <refname>pam_open_session</refname>
15 <refpurpose>start PAM session management</refpurpose>
18 <!-- body begins here -->
21 <funcsynopsis id="pam_open_session-synopsis">
22 <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo>
24 <funcdef>int <function>pam_open_session</function></funcdef>
25 <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
26 <paramdef>int <parameter>flags</parameter></paramdef>
32 <refsect1 id="pam_open_session-description">
33 <title>DESCRIPTION</title>
35 The <function>pam_open_session</function> function sets up a
36 user session for a previously successful authenticated user.
37 The session should later be terminated with a call to
39 <refentrytitle>pam_close_session</refentrytitle><manvolnum>3</manvolnum>
43 It should be noted that the effective uid,
45 <refentrytitle>geteuid</refentrytitle><manvolnum>2</manvolnum>
46 </citerefentry>. of the application should be of sufficient
47 privilege to perform such tasks as creating or mounting the
48 user's home directory for example.
51 The flags argument is the binary or of zero or more of the
56 <term>PAM_SILENT</term>
59 Do not emit any messages.
66 <refsect1 id="pam_open_session-return_values">
67 <title>RETURN VALUES</title>
70 <term>PAM_ABORT</term>
78 <term>PAM_BUF_ERR</term>
86 <term>PAM_SESSION_ERR</term>
94 <term>PAM_SUCCESS</term>
97 Session was successful created.
104 <refsect1 id="pam_open_session-see_also">
105 <title>SEE ALSO</title>
108 <refentrytitle>pam_close_session</refentrytitle><manvolnum>3</manvolnum>
111 <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>