x11::auth(3pm) [debian man page]
Auth(3pm) User Contributed Perl Documentation Auth(3pm) NAME
X11::Auth - Perl module to read X11 authority files SYNOPSIS
require X11::Auth; $a = new X11::Auth; ($auth_type, $auth_data) = $a->get_by_host($host, $disp_num); DESCRIPTION
This module is an approximate perl replacement for the libXau C library and the xauth(1) program. It reads and interprets the files (usually '~/.Xauthority') that hold authorization data used in connecting to X servers. Since it was written mainly for the use of X11::Protocol, its functionality is currently restricted to reading, not writing, of these files. METHODS
new $auth = X11::Auth->new; $auth = X11::Auth->open($filename); Open an authority file, and create an object to handle it. The filename will be taken from the XAUTHORITY environment variable, if present, or '.Xauthority' in the user's home directory, or it may be overridden by an argument. 'open' may be used as a synonym. get_one ($family, $host_addr, $display_num, $auth_name, $auth_data) = $auth->get_one; Read one entry from the file. Returns a null list at end of file. $family is usually 'Internet' or 'Local', and $display_num can be any string. get_all @auth_data = $auth->get_all; Read all of the entries in the file. Each member of the array returned is an array ref similar to the list returned by get_one(). get_by_host ($auth_name, $auth_data) = $auth->get_by_host($host, $family, $display_num); Get authentication data for a connection of type $family to display $display_num on $host. If $family is 'Internet', the host will be translated into an appropriate address by gethostbyname(). If no data is found, returns an empty list. COMPATIBILITY
The following table shows the (rough) correspondence between libXau calls and X11::Auth methods: libXau X11::Auth ------ --------- XauFileName $ENV{XAUTHORITY} || "$ENV{HOME}/.Xauthority" fopen(XauFileName(), "rb") $auth = new X11::Auth XauReadAuth $auth->get_one XauWriteAuth XauGetAuthByAddr $auth->get_by_host XauGetBestAuthByAddr XauLockAuth XauUnlockAuth XauDisposeAuth AUTHOR
Stephen McCamant <SMCCAM@cpan.org> SEE ALSO
perl(1), X11::Protocol, Xau(3), xauth(1), lib/Xau/README in the X11 source distribution. perl v5.14.2 2006-01-19 Auth(3pm)
Check Out this Related Man Page
Xau(3X) Xau(3X) NAME
Xau, XauFileName, XauReadAuth, XauLockAuth, XauUnlockAuth, XauWriteAuth, XauGetAuthByAddr, XauGetBestAuthByAddr - X authority database rou- tines SYNOPSIS
#include <X11/Xauth.h> typedef struct xauth { unsigned short family; unsigned short address_length; char *address; unsigned short number_length; char *number; unsigned short name_length; char *name; unsigned short data_length; char *data; } Xauth; char *XauFileName() Xauth *XauReadAuth (auth_file) FILE *auth_file; int XauWriteAuth (auth_file, auth) FILE *auth_file; Xauth *auth; Xauth *XauGetAuthByAddr (family, address_length, address, number_length, number) unsigned short family; unsigned short address_length; char *address; unsigned short number_length; char *number; Xauth *XauGetBestAuthByAddr (family, address_length, address, number_length, number, types_length, types, type_lengths) unsigned short family; unsigned short address_length; char *address; unsigned short number_length; char *number; int types_length; char **types; int *type_lengths; int XauLockAuth (file_name, retries, timeout, dead) char *file_name; int retries; int timeout; long dead; int XauUnlockAuth (file_name) char *file_name; XauDisposeAuth (auth) Xauth *auth; DESCRIPTION
XauFileName generates the default authorization file name by first checking the XAUTHORITY environment variable if set, else it returns $HOME/.Xauthority. This name is statically allocated and should not be freed. XauReadAuth reads the next entry from auth_file. The entry is not statically allocated and should be freed by calling XauDisposeAuth. XuWriteAuth writes an authorization entry to auth_file. It returns 1 on success, 0 on failure. XauGetAuthByAddr searches for an entry which matches the given network address/display number pair. The entry is not statically allocated and should be freed by calling XauDisposeAuth. XauGetBestAuthByAddr is similar to XauGetAuthByAddr, except that a list of acceptable authentication methods is specified. Xau will choose the file entry which matches the earliest entry in this list (for example, the most secure authentication method). The types argument is an array of strings, one string for each authentication method. types_length specifies how many elements are in the types array. types_lengths is an array of integers representing the length of each string. XauLockAuth does the work necessary to synchronously update an authorization file. First it makes two file names, one with -c appended to file_name, the other with -l appended. If the -c file already exists and is more than dead seconds old, XauLockAuth removes it and the associated -l file. To prevent possible synchronization troubles with NFS, a dead value of zero forces the files to be removed. XauLock- Auth makes retries attempts to create and link the file names, pausing timeout seconds between each attempt. XauLockAuth returns a collec- tion of values depending on the results: A system error occurred, either a file_name which is too long, or an unexpected failure from a system call. errno may prove useful. gretries attempts failed. The lock succeeded. XauUnlockAuth undoes the work of XauLockAuth by unlinking both the -c and -l file names. XauDisposeAuth frees storage allocated to hold an authorization entry. SEE ALSO
xauth(1X), xdm(1X) AUTHOR
Keith Packard, MIT X Consortium Xau(3X)