blob: 0cd6730b02ac8c7263b6e0de7d74845c472c7077 (
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
|
<?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_xauth_data">
<refmeta>
<refentrytitle>pam_xauth_data</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv id="pam_xauth_data-name">
<refname>pam_xauth_data</refname>
<refpurpose>structure containing X authentication data</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv>
<funcsynopsis id="pam_xauth_data-synopsis">
<funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo>
</funcsynopsis>
<programlisting>
struct pam_xauth_data {
int namelen;
char *name;
int datalen;
char *data;
};
</programlisting>
</refsynopsisdiv>
<refsect1 id='pam_xauth_data-description'>
<title>DESCRIPTION</title>
<para>
The <function>pam_xauth_data</function> structure contains X
authentication data used to make a connection to an X display.
Using this mechanism, an application can communicate X
authentication data to PAM service modules. This allows modules to
make a connection to the user's X display in order to label the
user's session on login, display visual feedback or for other
purposes.
</para>
<para>
The <emphasis>name</emphasis> field contains the name of the
authentication method, such as "MIT-MAGIC-COOKIE-1". The
<emphasis>namelen</emphasis> field contains the length of this string,
not including the trailing NUL character.
</para>
<para>
The <emphasis>data</emphasis> field contains the authentication
method-specific data corresponding to the specified name. The
<emphasis>datalen</emphasis> field contains its length in bytes.
</para>
<para>
The X authentication data can be changed with the
<emphasis>PAM_XAUTH_DATA</emphasis> item. It can be queried and
set with
<citerefentry>
<refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>
and
<citerefentry>
<refentrytitle>pam_set_item </refentrytitle><manvolnum>3</manvolnum>
</citerefentry> respectively. The value used to set it should be
a pointer to a pam_xauth_data structure. An internal copy of both
the structure itself and its fields is made by PAM when setting the
item.
</para>
</refsect1>
<refsect1 id='pam_xauth_data-see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
</para>
</refsect1>
<refsect1 id='pam_xauth_data-standards'>
<title>STANDARDS</title>
<para>
The <function>pam_xauth_data</function> structure and
<emphasis>PAM_XAUTH_DATA</emphasis> item are
Linux-PAM extensions.
</para>
</refsect1>
</refentry>
|
