Debian Codegraph @

upstream/debian-unstable/man3/pam_xauth_data.3

raw
1 '\" t
2 .\" Title: pam_xauth_data
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_XAUTH_DATA" "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_xauth_data \- structure containing X authentication data
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_appl\&.h>
37 .fi
38 .ft
39 .sp
40 .nf
41 struct pam_xauth_data {
42 int namelen;
43 char *name;
44 int datalen;
45 char *data;
46 };
47
48 .fi
49 .SH "DESCRIPTION"
50 .PP
51 The
52 \fBpam_xauth_data\fR
53 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\*(Aqs X display in order to label the user\*(Aqs session on login, display visual feedback or for other purposes\&.
54 .PP
55 The
56 \fIname\fR
57 field contains the name of the authentication method, such as "MIT\-MAGIC\-COOKIE\-1"\&. The
58 \fInamelen\fR
59 field contains the length of this string, not including the trailing NUL character\&.
60 .PP
61 The
62 \fIdata\fR
63 field contains the authentication method\-specific data corresponding to the specified name\&. The
64 \fIdatalen\fR
65 field contains its length in bytes\&.
66 .PP
67 The X authentication data can be changed with the
68 \fIPAM_XAUTH_DATA\fR
69 item\&. It can be queried and set with
70 \fBpam_get_item\fR(3)
71 and
72 \fBpam_set_item \fR(3)
73 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\&.
74 .SH "SEE ALSO"
75 .PP
76 \fBpam_start\fR(3),
77 \fBpam_get_item\fR(3),
78 .SH "STANDARDS"
79 .PP
80 The
81 \fBpam_xauth_data\fR
82 structure and
83 \fIPAM_XAUTH_DATA\fR
84 item are Linux\-PAM extensions\&.