summaryrefslogtreecommitdiff
path: root/doc/man/pam_get_user.3.xml
blob: ff8be69499c93670916b3e76cfcec213a7cfeb31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='pam_get_user'>

  <refmeta>
    <refentrytitle>pam_get_user</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id='pam_get_user-name'>
    <refname>pam_get_user</refname>
    <refpurpose>
       get user name
    </refpurpose>
  </refnamediv>


<!-- body begins here -->

  <refsynopsisdiv>

   <funcsynopsis id="pam_get_user-synopsis">
     <funcsynopsisinfo>#include &lt;security/pam_modules.h&gt;</funcsynopsisinfo>
     <funcprototype>
       <funcdef>int <function>pam_get_user</function></funcdef>
       <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef>
       <paramdef>const char **<parameter>user</parameter></paramdef>
       <paramdef>const char *<parameter>prompt</parameter></paramdef>
     </funcprototype>
   </funcsynopsis>

  </refsynopsisdiv>


  <refsect1 id="pam_get_user-description">
    <title>DESCRIPTION</title>
    <para>
      The <function>pam_get_user</function> function returns the
      name of the user specified by
      <citerefentry>
        <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>. If no user was specified it what 
      <function>pam_get_item (pamh, PAM_USER, ... );</function> would
      have returned. If this is NULL it obtains the username via the
      <citerefentry>
        <refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> mechanism, it prompts the user with the first
      non-NULL string in the following list:
    </para>

    <itemizedlist>
      <listitem>
        <para>
          The <emphasis>prompt</emphasis> argument passed to the function.
        </para>
      </listitem>
      <listitem>
        <para>
          What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... );
        </para>
      </listitem>
      <listitem>
        <para>
          The default prompt: "login: "
        </para>
      </listitem>
    </itemizedlist>
    <para>
      By whatever means the username is obtained, a pointer to it is
      returned as the contents of <emphasis>*user</emphasis>. Note, 
      this memory should <emphasis remap="B">not</emphasis> be 
      <emphasis>free()</emphasis>'d or <emphasis>modified</emphasis>
      by the module.
    </para>
    <para>
      This function sets the <emphasis>PAM_USER</emphasis> item
      associated with the 
      <citerefentry>
        <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> and
      <citerefentry>
        <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> functions.
    </para>
  </refsect1>

  <refsect1 id="pam_get_user-return_values">
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_SUCCESS</term>
        <listitem>
           <para>
             User name was successful retrieved.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_SYSTEM_ERR</term>
        <listitem>
           <para>
             A NULL pointer was submitted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_CONV_ERR</term>
        <listitem>
           <para>
             The conversation method supplied by the
             application failed to obtain the username.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_get_user-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

</refentry>