1/*
2
3Copyright 1988, 1998  The Open Group
4
5Permission to use, copy, modify, distribute, and sell this software and its
6documentation for any purpose is hereby granted without fee, provided that
7the above copyright notice appear in all copies and that both that
8copyright notice and this permission notice appear in supporting
9documentation.
10
11The above copyright notice and this permission notice shall be included in
12all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21Except as contained in this notice, the name of The Open Group shall not be
22used in advertising or otherwise to promote the sale, use or other dealings
23in this Software without prior written authorization from The Open Group.
24
25*/
26
27#ifndef _Xauth_h
28#define _Xauth_h
29
30/* struct xauth is full of implicit padding to properly align the pointers
31   after the length fields.   We can't clean that up without breaking ABI,
32   so tell clang not to bother complaining about it. */
33#ifdef __clang__
34#pragma clang diagnostic push
35#pragma clang diagnostic ignored "-Wpadded"
36#endif
37
38typedef struct xauth {
39    unsigned short   family;
40    unsigned short   address_length;
41    char    	    *address;
42    unsigned short   number_length;
43    char    	    *number;
44    unsigned short   name_length;
45    char    	    *name;
46    unsigned short   data_length;
47    char   	    *data;
48} Xauth;
49
50#ifdef __clang__
51#pragma clang diagnostic pop
52#endif
53
54#ifndef _XAUTH_STRUCT_ONLY
55
56# include   <X11/Xfuncproto.h>
57# include   <X11/Xfuncs.h>
58
59# include   <stdio.h>
60
61# define FamilyLocal (256)	/* not part of X standard (i.e. X.h) */
62# define FamilyWild  (65535)
63# define FamilyNetname    (254)   /* not part of X standard */
64# define FamilyKrb5Principal (253) /* Kerberos 5 principal name */
65# define FamilyLocalHost (252)	/* for local non-net authentication */
66
67
68_XFUNCPROTOBEGIN
69
70#ifndef __has_attribute
71# define __has_attribute(x) 0  /* Compatibility with older compilers */
72#endif
73
74#if __has_attribute(access)
75# define XAU_ACCESS_ATTRIBUTE(X) __attribute__((access X))
76#else
77# define XAU_ACCESS_ATTRIBUTE(X)
78#endif
79
80#if __has_attribute(malloc)
81# if defined(__clang__) || (defined(__GNUC__) && __GNUC__ < 11)
82/* Clang or gcc do not support the optional deallocator argument */
83#  define XAU_MALLOC_ATTRIBUTE(X) __attribute__((malloc))
84# else
85#  define XAU_MALLOC_ATTRIBUTE(X) __attribute__((malloc X))
86# endif
87#else
88# define XAU_MALLOC_ATTRIBUTE(X)
89#endif
90
91char *XauFileName(void);
92
93void XauDisposeAuth(
94Xauth*		/* auth */
95);
96
97XAU_MALLOC_ATTRIBUTE((XauDisposeAuth, 1))
98Xauth *XauReadAuth(
99FILE*	/* auth_file */
100);
101
102XAU_ACCESS_ATTRIBUTE((read_only, 1)) /* file_name */
103int XauLockAuth(
104_Xconst char*	/* file_name */,
105int		/* retries */,
106int		/* timeout */,
107long		/* dead */
108);
109
110XAU_ACCESS_ATTRIBUTE((read_only, 1)) /* file_name */
111int XauUnlockAuth(
112_Xconst char*	/* file_name */
113);
114
115XAU_ACCESS_ATTRIBUTE((read_only, 2)) /* auth */
116int XauWriteAuth(
117FILE*		/* auth_file */,
118Xauth*		/* auth */
119);
120
121XAU_ACCESS_ATTRIBUTE((read_only, 3, 2)) /* address */
122XAU_ACCESS_ATTRIBUTE((read_only, 5, 4)) /* number */
123XAU_ACCESS_ATTRIBUTE((read_only, 7, 6)) /* name */
124Xauth *XauGetAuthByAddr(
125#if NeedWidePrototypes
126unsigned int	/* family */,
127unsigned int	/* address_length */,
128#else
129unsigned short	/* family */,
130unsigned short	/* address_length */,
131#endif
132_Xconst char*	/* address */,
133#if NeedWidePrototypes
134unsigned int	/* number_length */,
135#else
136unsigned short	/* number_length */,
137#endif
138_Xconst char*	/* number */,
139#if NeedWidePrototypes
140unsigned int	/* name_length */,
141#else
142unsigned short	/* name_length */,
143#endif
144_Xconst char*	/* name */
145);
146
147XAU_ACCESS_ATTRIBUTE((read_only, 3, 2)) /* address */
148XAU_ACCESS_ATTRIBUTE((read_only, 5, 4)) /* number */
149XAU_ACCESS_ATTRIBUTE((read_only, 7, 6)) /* type_names */
150XAU_ACCESS_ATTRIBUTE((read_only, 8, 6)) /* type_lengths */
151Xauth *XauGetBestAuthByAddr(
152#if NeedWidePrototypes
153unsigned int	/* family */,
154unsigned int	/* address_length */,
155#else
156unsigned short	/* family */,
157unsigned short	/* address_length */,
158#endif
159_Xconst char*	/* address */,
160#if NeedWidePrototypes
161unsigned int	/* number_length */,
162#else
163unsigned short	/* number_length */,
164#endif
165_Xconst char*	/* number */,
166int		/* types_length */,
167char**		/* type_names */,
168_Xconst int*	/* type_lengths */
169);
170
171_XFUNCPROTOEND
172
173/* Return values from XauLockAuth */
174
175# define LOCK_SUCCESS	0	/* lock succeeded */
176# define LOCK_ERROR	1	/* lock unexpectedly failed, check errno */
177# define LOCK_TIMEOUT	2	/* lock failed, timeouts expired */
178
179#endif /* _XAUTH_STRUCT_ONLY */
180
181#endif /* _Xauth_h */
182