granicus.if.org Git - linux-pam/blob - doc/man/pam_xauth_data.3.xml

   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">
   4
   5 <refentry id="pam_xauth_data">
   6
   7   <refmeta>
   8     <refentrytitle>pam_xauth_data</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_xauth_data-name">
  14     <refname>pam_xauth_data</refname>
  15     <refpurpose>structure containing X authentication data</refpurpose>
  16   </refnamediv>
  17
  18 <!-- body begins here -->
  19
  20   <refsynopsisdiv>
  21     <funcsynopsis id="pam_xauth_data-synopsis">
  22       <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
  23     </funcsynopsis>
  24     <programlisting>
  25 struct pam_xauth_data {
  26     int namelen;
  27     char *name;
  28     int datalen;
  29     char *data;
  30 };
  31     </programlisting>
  32   </refsynopsisdiv>
  33
  34   <refsect1 id='pam_xauth_data-description'>
  35     <title>DESCRIPTION</title>
  36     <para>
  37       The <function>pam_xauth_data</function> structure contains X
  38       authentication data used to make a connection to an X display.
  39       Using this mechanism, an application can communicate X
  40       authentication data to PAM service modules.  This allows modules to
  41       make a connection to the user's X display in order to label the
  42       user's session on login, display visual feedback or for other
  43       purposes.
  44     </para>
  45     <para>
  46       The <emphasis>name</emphasis> field contains the name of the
  47       authentication method, such as "MIT-MAGIC-COOKIE-1".  The
  48       <emphasis>namelen</emphasis> field contains the length of this string,
  49       not including the trailing NUL character.
  50     </para>
  51     <para>
  52       The <emphasis>data</emphasis> field contains the authentication
  53       method-specific data corresponding to the specified name.  The
  54       <emphasis>datalen</emphasis> field contains its length in bytes.
  55     </para>
  56     <para>
  57       The X authentication data can be changed with the
  58       <emphasis>PAM_XAUTH_DATA</emphasis> item. It can be queried and
  59       set with
  60       <citerefentry>
  61         <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
  62       </citerefentry>
  63       and
  64       <citerefentry>
  65         <refentrytitle>pam_set_item </refentrytitle><manvolnum>3</manvolnum>
  66       </citerefentry>  respectively.  The value used to set it should be
  67       a pointer to a pam_xauth_data structure.  An internal copy of both
  68       the structure itself and its fields is made by PAM when setting the
  69       item.
  70     </para>
  71   </refsect1>
  72
  73   <refsect1 id='pam_xauth_data-see_also'>
  74     <title>SEE ALSO</title>
  75     <para>
  76       <citerefentry>
  77         <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
  78       </citerefentry>,
  79       <citerefentry>
  80         <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
  81       </citerefentry>,
  82     </para>
  83   </refsect1>
  84
  85   <refsect1 id='pam_xauth_data-standards'>
  86     <title>STANDARDS</title>
  87     <para>
  88       The <function>pam_xauth_data</function> structure and
  89       <emphasis>PAM_XAUTH_DATA</emphasis> item are
  90       Linux-PAM extensions.
  91     </para>
  92   </refsect1>
  93
  94 </refentry>