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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
/* This file is part of the Project Athena Zephyr Notification System.
* It contains global definitions
*
* Created by: Robert French
*
* $Source$
* $Author$
* $Id$
*
* Copyright (c) 1987,1988,1991 by the Massachusetts Institute of
* Technology. For copying and distribution information, see the
* file "mit-copyright.h".
*/
#ifndef __ZEPHYR_H__
#define __ZEPHYR_H__
/* Define if Zephyr uses Kerberos support. */
#undef ZEPHYR_USES_KERBEROS
#include <sys/types.h>
#include <sys/time.h>
#include <zephyr/zephyr_err.h>
#ifdef ZEPHYR_USES_KERBEROS
#include <krb.h>
#endif
#ifndef IPPROTO_MAX /* Make sure not already included */
#include <netinet/in.h>
#endif
/* Use __STDC__ to guess whether we can use stdarg, prototypes, and const.
* This is a public header file, so autoconf can't help us here. */
#ifdef __STDC__
# include <stdarg.h>
# define ZP(x) x
# define ZCONST const
#else
# define ZP(x) ()
# define ZCONST
#endif
/* Service names */
#define HM_SVCNAME "zephyr-hm"
#define HM_SRV_SVCNAME "zephyr-hm-srv"
#define SERVER_SVCNAME "zephyr-clt"
#define SERVER_SERVICE "zephyr"
#define SERVER_INSTANCE "zephyr"
#define ZVERSIONHDR "ZEPH"
#define ZVERSIONMAJOR 0
#define ZVERSIONMINOR 2
#define Z_MAXPKTLEN 1024
#define Z_MAXHEADERLEN 800
#define Z_MAXOTHERFIELDS 10 /* Max unknown fields in ZNotice_t */
#define Z_NUMFIELDS 17
/* Authentication levels returned by ZCheckAuthentication */
#define ZAUTH_FAILED (-1)
#define ZAUTH_YES 1
#define ZAUTH_NO 0
typedef char ZPacket_t[Z_MAXPKTLEN];
/* Packet type */
typedef enum {
UNSAFE, UNACKED, ACKED, HMACK, HMCTL, SERVACK, SERVNAK, CLIENTACK, STAT
} ZNotice_Kind_t;
extern ZCONST char *ZNoticeKinds[9];
/* Unique ID format */
typedef struct _ZUnique_Id_t {
struct in_addr zuid_addr;
struct timeval tv;
} ZUnique_Id_t;
/* Checksum */
typedef unsigned long ZChecksum_t;
/* Notice definition */
typedef struct _ZNotice_t {
char *z_packet;
char *z_version;
ZNotice_Kind_t z_kind;
ZUnique_Id_t z_uid;
#define z_sender_addr z_uid.zuid_addr
struct timeval z_time;
unsigned short z_port;
int z_auth;
int z_checked_auth;
int z_authent_len;
char *z_ascii_authent;
char *z_class;
char *z_class_inst;
char *z_opcode;
char *z_sender;
char *z_recipient;
char *z_default_format;
char *z_multinotice;
ZUnique_Id_t z_multiuid;
ZChecksum_t z_checksum;
int z_num_other_fields;
char *z_other_fields[Z_MAXOTHERFIELDS];
caddr_t z_message;
int z_message_len;
} ZNotice_t;
/* Subscription structure */
typedef struct _ZSubscriptions_t {
char *zsub_recipient;
char *zsub_class;
char *zsub_classinst;
} ZSubscription_t;
/* Function return code */
typedef int Code_t;
/* Locations structure */
typedef struct _ZLocations_t {
char *host;
char *time;
char *tty;
} ZLocations_t;
typedef struct _ZAsyncLocateData_t {
char *user;
ZUnique_Id_t uid;
char *version;
} ZAsyncLocateData_t;
/* for ZSetDebug */
#ifdef Z_DEBUG
void (*__Z_debug_print) ZP((ZCONST char *fmt, va_list args, void *closure));
void *__Z_debug_print_closure;
#endif
int ZCompareUIDPred ZP((ZNotice_t *, void *));
int ZCompareMultiUIDPred ZP((ZNotice_t *, void *));
/* Defines for ZFormatNotice, et al. */
typedef Code_t (*Z_AuthProc) ZP((ZNotice_t*, char *, int, int *));
Code_t ZMakeAuthentication ZP((ZNotice_t*, char *,int, int*));
char *ZGetSender ZP((void));
char *ZGetVariable ZP((char *));
Code_t ZSetVariable ZP((char *var, char *value));
Code_t ZUnsetVariable ZP((char *var));
int ZGetWGPort ZP((void));
Code_t ZSetDestAddr ZP((struct sockaddr_in *));
Code_t ZFormatNoticeList ZP((ZNotice_t*, char**, int,
char **, int*, Z_AuthProc));
Code_t ZParseNotice ZP((char*, int, ZNotice_t *));
Code_t ZReadAscii ZP((char*, int, unsigned char*, int));
Code_t ZReadAscii32 ZP((char *, int, unsigned long *));
Code_t ZReadAscii16 ZP((char *, int, unsigned short *));
Code_t ZSendPacket ZP((char*, int, int));
Code_t ZSendList ZP((ZNotice_t*, char *[], int, Z_AuthProc));
Code_t ZSrvSendList ZP((ZNotice_t*, char*[], int, Z_AuthProc, Code_t (*)()));
Code_t ZSendNotice ZP((ZNotice_t *, Z_AuthProc));
Code_t ZSrvSendNotice ZP((ZNotice_t*, Z_AuthProc, Code_t (*)()));
Code_t ZFormatNotice ZP((ZNotice_t*, char**, int*, Z_AuthProc));
Code_t ZFormatSmallNotice ZP((ZNotice_t*, ZPacket_t, int*, Z_AuthProc));
Code_t ZFormatRawNoticeList ZP((ZNotice_t *notice, char *list[], int nitems,
char **buffer, int *ret_len));
Code_t ZLocateUser ZP((char *, int *, Z_AuthProc));
Code_t ZRequestLocations ZP((char *, ZAsyncLocateData_t *,
ZNotice_Kind_t, Z_AuthProc));
Code_t ZhmStat ZP((struct in_addr *, ZNotice_t *));
Code_t ZInitialize ZP((void));
Code_t ZSetServerState ZP((int));
Code_t ZSetFD ZP((int));
Code_t ZFormatSmallRawNotice ZP((ZNotice_t*, ZPacket_t, int*));
int ZCompareUID ZP((ZUnique_Id_t*, ZUnique_Id_t*));
Code_t ZSrvSendRawList ZP((ZNotice_t*, char*[], int,
Code_t (*)(ZNotice_t *, char *, int, int)));
Code_t ZMakeAscii ZP((char*, int, unsigned char*, int));
Code_t ZMakeAscii32 ZP((char *, int, unsigned long));
Code_t ZMakeAscii16 ZP((char *, int, unsigned int));
Code_t ZReceivePacket ZP((ZPacket_t, int*, struct sockaddr_in*));
Code_t ZCheckAuthentication ZP((ZNotice_t*, struct sockaddr_in*));
Code_t ZInitLocationInfo ZP((char *hostname, char *tty));
Code_t ZSetLocation ZP((char *exposure));
Code_t ZUnsetLocation ZP((void));
Code_t ZFlushMyLocations ZP((void));
char *ZParseExposureLevel ZP((char *text));
#ifdef ZEPHYR_USES_KERBEROS
Code_t ZFormatAuthenticNotice ZP((ZNotice_t*, char*, int, int*, C_Block));
#endif
Code_t ZFormatRawNotice ZP((ZNotice_t *, char**, int *));
Code_t ZRetrieveSubscriptions ZP((unsigned short, int*));
Code_t ZOpenPort ZP((unsigned short *port));
Code_t ZClosePort ZP((void));
Code_t ZFlushLocations ZP((void));
Code_t ZFlushSubscriptions ZP((void));
Code_t ZFreeNotice ZP((ZNotice_t *notice));
Code_t ZParseLocations ZP((register ZNotice_t *notice,
register ZAsyncLocateData_t *zald, int *nlocs,
char **user));
int ZCompareALDPred ZP((ZNotice_t *notice, void *zald));
void ZFreeALD ZP((register ZAsyncLocateData_t *zald));
Code_t ZCheckIfNotice ZP((ZNotice_t *notice, struct sockaddr_in *from,
register int (*predicate) ZP((ZNotice_t *,void *)),
void *args));
Code_t ZPeekPacket ZP((char **buffer, int *ret_len,
struct sockaddr_in *from));
Code_t ZPeekNotice ZP((ZNotice_t *notice, struct sockaddr_in *from));
Code_t ZIfNotice ZP((ZNotice_t *notice, struct sockaddr_in *from,
int (*predicate) ZP((ZNotice_t *, void *)), void *args));
Code_t ZSubscribeTo ZP((ZSubscription_t *sublist, int nitems,
unsigned int port));
Code_t ZSubscribeToSansDefaults ZP((ZSubscription_t *sublist, int nitems,
unsigned int port));
Code_t ZUnsubscribeTo ZP((ZSubscription_t *sublist, int nitems,
unsigned int port));
Code_t ZCancelSubscriptions ZP((unsigned int port));
int ZPending ZP((void));
Code_t ZReceiveNotice ZP((ZNotice_t *notice, struct sockaddr_in *from));
#ifdef Z_DEBUG
void Z_debug ZP((ZCONST char *, ...));
#endif
#undef ZP
/* Compatibility */
#define ZNewLocateUser ZLocateUser
/* Macros to retrieve Zephyr library values. */
extern int __Zephyr_fd;
extern int __Q_CompleteLength;
extern struct sockaddr_in __HM_addr;
extern char __Zephyr_realm[];
#define ZGetFD() __Zephyr_fd
#define ZQLength() __Q_CompleteLength
#define ZGetDestAddr() __HM_addr
#define ZGetRealm() __Zephyr_realm
#ifdef ZEPHYR_USES_KERBEROS
/* Session key for last parsed packet - server only */
extern C_Block __Zephyr_session;
#define ZGetSession() (__Zephyr_session)
#else
#define __Zephyr_realm ("local-realm")
#endif
#ifdef Z_DEBUG
void ZSetDebug ZP((void (*)(ZCONST char *, va_list, void *), void *));
#define ZSetDebug(proc,closure) (__Z_debug_print=(proc), \
__Z_debug_print_closure=(closure), \
(void) 0)
#else
#define ZSetDebug(proc,closure)
#endif
/* Maximum queue length */
#define Z_MAXQLEN 30
/* Successful function return */
#define ZERR_NONE 0
/* Hostmanager wait time (in secs) */
#define HM_TIMEOUT 10
/* Server wait time (in secs) */
#define SRV_TIMEOUT 30
#define ZAUTH (ZMakeAuthentication)
#define ZNOAUTH ((Z_AuthProc)0)
/* Packet strings */
#define ZSRVACK_SENT "SENT" /* SERVACK codes */
#define ZSRVACK_NOTSENT "LOST"
#define ZSRVACK_FAIL "FAIL"
/* Server internal class */
#define ZEPHYR_ADMIN_CLASS "ZEPHYR_ADMIN" /* Class */
/* Control codes sent to a server */
#define ZEPHYR_CTL_CLASS "ZEPHYR_CTL" /* Class */
#define ZEPHYR_CTL_REALM "REALM" /* Inst: From realm */
#define REALM_ADD_SUBSCRIBE "ADD_SUBSCRIBE" /* Opcode: Add subs */
#define REALM_REQ_SUBSCRIBE "REQ_SUBSCRIBE" /* Opcode: Request subs */
#define REALM_SUBSCRIBE "RLM_SUBSCRIBE" /* Opcode: Subscribe realm */
#define REALM_UNSUBSCRIBE "RLM_UNSUBSCRIBE" /* Opcode: Unsub realm */
#define ZEPHYR_CTL_CLIENT "CLIENT" /* Inst: From client */
#define CLIENT_SUBSCRIBE "SUBSCRIBE" /* Opcode: Subscribe */
#define CLIENT_SUBSCRIBE_NODEFS "SUBSCRIBE_NODEFS" /* Opcode: Subscribe */
#define CLIENT_UNSUBSCRIBE "UNSUBSCRIBE" /* Opcode: Unsubsubscribe */
#define CLIENT_CANCELSUB "CLEARSUB" /* Opcode: Clear all subs */
#define CLIENT_GIMMESUBS "GIMME" /* Opcode: Give me subs */
#define CLIENT_GIMMEDEFS "GIMMEDEFS" /* Opcode: Give me default
* subscriptions */
#define ZEPHYR_CTL_HM "HM" /* Inst: From HM */
#define HM_BOOT "BOOT" /* Opcode: Boot msg */
#define HM_FLUSH "FLUSH" /* Opcode: Flush me */
#define HM_DETACH "DETACH" /* Opcode: Detach me */
#define HM_ATTACH "ATTACH" /* Opcode: Attach me */
/* Control codes send to a HostManager */
#define HM_CTL_CLASS "HM_CTL" /* Class */
#define HM_CTL_SERVER "SERVER" /* Inst: From server */
#define SERVER_SHUTDOWN "SHUTDOWN" /* Opcode: Server shutdown */
#define SERVER_PING "PING" /* Opcode: PING */
#define HM_CTL_CLIENT "CLIENT" /* Inst: From client */
#define CLIENT_FLUSH "FLUSH" /* Opcode: Send flush to srv */
#define CLIENT_NEW_SERVER "NEWSERV" /* Opcode: Find new server */
/* HM Statistics */
#define HM_STAT_CLASS "HM_STAT" /* Class */
#define HM_STAT_CLIENT "HMST_CLIENT" /* Inst: From client */
#define HM_GIMMESTATS "GIMMESTATS" /* Opcode: get stats */
/* Login class messages */
#define LOGIN_CLASS "LOGIN" /* Class */
/* Class Instance is principal of user who is logging in or logging out */
#define EXPOSE_NONE "NONE" /* Opcode: Not visible */
#define EXPOSE_OPSTAFF "OPSTAFF" /* Opcode: Opstaff visible */
#define EXPOSE_REALMVIS "REALM-VISIBLE" /* Opcode: Realm visible */
#define EXPOSE_REALMANN "REALM-ANNOUNCED"/* Opcode: Realm announced */
#define EXPOSE_NETVIS "NET-VISIBLE" /* Opcode: Net visible */
#define EXPOSE_NETANN "NET-ANNOUNCED" /* Opcode: Net announced */
#define LOGIN_USER_LOGIN "USER_LOGIN" /* Opcode: user login
(from server) */
#define LOGIN_USER_LOGOUT "USER_LOGOUT" /* Opcode: User logout */
#define LOGIN_USER_FLUSH "USER_FLUSH" /* Opcode: flush all locs */
/* Locate class messages */
#define LOCATE_CLASS "USER_LOCATE" /* Class */
#define LOCATE_HIDE "USER_HIDE" /* Opcode: Hide me */
#define LOCATE_UNHIDE "USER_UNHIDE" /* Opcode: Unhide me */
/* Class Instance is principal of user to locate */
#define LOCATE_LOCATE "LOCATE" /* Opcode: Locate user */
/* WG_CTL class messages */
#define WG_CTL_CLASS "WG_CTL" /* Class */
#define WG_CTL_USER "USER" /* Inst: User request */
#define USER_REREAD "REREAD" /* Opcode: Reread desc file */
#define USER_SHUTDOWN "SHUTDOWN" /* Opcode: Go catatonic */
#define USER_STARTUP "STARTUP" /* Opcode: Come out of it */
#define USER_EXIT "EXIT" /* Opcode: Exit the client */
#endif /* __ZEPHYR_H__ */
|
