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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
/* This file is part of the Project Athena Zephyr Notification System.
* It contains global definitions
*
* Created by: Robert French
*
* $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__
#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <com_err.h>
#include <zephyr/zephyr_err.h>
#ifndef IPPROTO_MAX /* Make sure not already included */
#include <netinet/in.h>
#endif
#include <stdarg.h>
/* 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 SERVER_KRB5_SERVICE "zephyr"
#define ZVERSIONHDR "ZEPH"
#define ZVERSIONMAJOR 0
#define ZVERSIONMINOR 2
#define Z_MAXPKTLEN 1024
#define Z_MAXHEADERLEN 832
#define Z_MAXOTHERFIELDS 10 /* Max unknown fields in ZNotice_t */
#define Z_NUMFIELDS 19
/* Authentication levels returned by ZCheckAuthentication */
#define ZAUTH_FAILED (-1)
#define ZAUTH_YES 1
#define ZAUTH_NO 0
#define ZNOTICE_SOCKADDR 1
#define ZNOTICE_CHARSET 1
#define ZCHARSET_UNKNOWN 0
/* The following are from http://www.iana.org/assignments/character-sets */
#define ZCHARSET_ISO_8859_1 4
#define ZCHARSET_UTF_8 106
typedef char ZPacket_t[Z_MAXPKTLEN];
/* Packet type */
typedef enum {
UNSAFE = 0, UNACKED = 1, ACKED = 2, HMACK = 3, HMCTL = 4, SERVACK = 5,
SERVNAK = 6, CLIENTACK = 7, STAT = 8
} ZNotice_Kind_t;
extern const char * const ZNoticeKinds[9];
struct _ZTimeval {
int tv_sec;
int tv_usec;
};
/* Unique ID format */
typedef struct _ZUnique_Id_t {
struct in_addr zuid_addr;
struct _ZTimeval tv;
} ZUnique_Id_t;
/* Checksum */
typedef unsigned int ZChecksum_t;
/* Notice definition */
typedef struct _ZNotice_t {
char *z_packet;
char *z_version;
ZNotice_Kind_t z_kind;
ZUnique_Id_t z_uid;
union {
struct sockaddr sa;
struct sockaddr_in ip4;
struct sockaddr_in6 ip6;
} z_sender_sockaddr;
/* heavily deprecated: */
#define z_sender_addr z_sender_sockaddr.ip4.sin_addr
/* probably a bad idea?: */
struct _ZTimeval z_time;
unsigned short z_port;
unsigned short z_charset;
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;
char *z_ascii_checksum;
int z_num_other_fields;
char *z_other_fields[Z_MAXOTHERFIELDS];
char *z_message;
int z_message_len;
int z_num_hdr_fields;
char **z_hdr_fields;
} 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)(const char *fmt, va_list args, void *closure);
void *__Z_debug_print_closure;
#endif
int ZCompareUIDPred(ZNotice_t *, void *);
int ZCompareMultiUIDPred(ZNotice_t *, void *);
/* Defines for ZFormatNotice, et al. */
typedef Code_t (*Z_AuthProc)(ZNotice_t*, char *, int, int *);
Code_t ZMakeAuthentication(ZNotice_t*, char *,int, int*);
Code_t ZMakeZcodeAuthentication(ZNotice_t*, char *,int, int*);
Code_t ZMakeZcodeRealmAuthentication(ZNotice_t*, char *,int, int*, char*);
Code_t ZResetAuthentication(void);
char *ZGetSender(void);
char *ZGetVariable(char *);
Code_t ZSetVariable(char *var, char *value);
Code_t ZUnsetVariable(char *var);
int ZGetWGPort(void);
Code_t ZSetDestAddr(struct sockaddr_in *);
Code_t ZParseNotice(char*, int, ZNotice_t *);
Code_t ZReadAscii(char*, int, unsigned char*, int);
Code_t ZReadAscii32(char *, int, unsigned long *);
Code_t ZReadAscii16(char *, int, unsigned short *);
Code_t ZReadZcode(unsigned char*, unsigned char*, int, int *);
Code_t ZSendPacket(char*, int, int);
Code_t ZSendList(ZNotice_t*, char *[], int, Z_AuthProc);
Code_t ZSrvSendList(ZNotice_t*, char*[], int, Z_AuthProc,
Code_t (*)(ZNotice_t *, char *, int, int));
Code_t ZSendRawList(ZNotice_t*, char *[], int);
Code_t ZSendNotice(ZNotice_t *, Z_AuthProc);
Code_t ZSendRawNotice(ZNotice_t *);
Code_t ZSrvSendNotice(ZNotice_t*, Z_AuthProc,
Code_t (*)(ZNotice_t *, char *, int, int));
Code_t ZFormatNotice(ZNotice_t*, char**, int*, Z_AuthProc);
Code_t ZNewFormatNotice(ZNotice_t*, char**, int*, Z_AuthProc);
Code_t ZFormatNoticeList(ZNotice_t*, char**, int,
char **, int*, Z_AuthProc);
Code_t ZFormatRawNoticeList(ZNotice_t *, char *[], int, char **, int *);
Code_t ZFormatSmallNotice(ZNotice_t*, ZPacket_t, int*, Z_AuthProc);
Code_t ZFormatSmallRawNotice(ZNotice_t *, ZPacket_t, int *);
Code_t ZNewFormatSmallRawNotice(ZNotice_t *, ZPacket_t, int *);
Code_t ZFormatSmallRawNoticeList(ZNotice_t *, char *[], int, ZPacket_t, int *);
Code_t ZLocateUser(char *, int *, Z_AuthProc);
Code_t ZRequestLocations(char *, ZAsyncLocateData_t *,
ZNotice_Kind_t, Z_AuthProc);
Code_t ZhmStat(struct in_addr *, ZNotice_t *);
Code_t ZInitialize(void);
Code_t ZSetServerState(int);
Code_t ZSetFD(int);
int ZCompareUID(ZUnique_Id_t*, ZUnique_Id_t*);
Code_t ZSrvSendRawList(ZNotice_t*, char*[], int,
Code_t (*)(ZNotice_t *, char *, int, int));
Code_t ZMakeAscii(char*, int, unsigned char*, int);
Code_t ZMakeAscii32(char *, int, unsigned long);
Code_t ZMakeAscii16(char *, int, unsigned int);
Code_t ZMakeZcode(char*, int, unsigned char*, int);
Code_t ZMakeZcode32(char *, int, unsigned long);
Code_t ZReceivePacket(ZPacket_t, int*, struct sockaddr_in*);
Code_t ZCheckAuthentication(ZNotice_t*, struct sockaddr_in*);
Code_t ZCheckZcodeAuthentication(ZNotice_t*, struct sockaddr_in*);
Code_t ZCheckZcodeRealmAuthentication(ZNotice_t*, struct sockaddr_in*, char *realm);
Code_t ZInitLocationInfo(char *hostname, char *tty);
Code_t ZSetLocation(char *exposure);
Code_t ZUnsetLocation(void);
Code_t ZFlushMyLocations(void);
Code_t ZFlushUserLocations(char *);
char *ZParseExposureLevel(char *text);
Code_t ZFormatRawNotice(ZNotice_t *, char**, int *);
Code_t ZRetrieveSubscriptions(unsigned short, int*);
Code_t ZRetrieveDefaultSubscriptions(int *);
Code_t ZGetSubscriptions(ZSubscription_t *, int *);
Code_t ZOpenPort(unsigned short *port);
Code_t ZClosePort(void);
Code_t ZFlushLocations(void);
Code_t ZFlushSubscriptions(void);
Code_t ZFreeNotice(ZNotice_t *notice);
Code_t ZGetLocations(ZLocations_t *, int *);
Code_t ZParseLocations(register ZNotice_t *notice,
register ZAsyncLocateData_t *zald, int *nlocs,
char **user);
int ZCompareALDPred(ZNotice_t *notice, void *zald);
void ZFreeALD(register ZAsyncLocateData_t *zald);
Code_t ZCheckIfNotice(ZNotice_t *notice, struct sockaddr_in *from,
register int (*predicate)(ZNotice_t *,void *),
void *args);
Code_t ZPeekPacket(char **buffer, int *ret_len,
struct sockaddr_in *from);
Code_t ZPeekNotice(ZNotice_t *notice, struct sockaddr_in *from);
Code_t ZIfNotice(ZNotice_t *notice, struct sockaddr_in *from,
int (*predicate)(ZNotice_t *, void *), void *args);
Code_t ZPeekIfNotice(ZNotice_t *notice, struct sockaddr_in *from,
int (*predicate)(ZNotice_t *, char *), char *args);
Code_t ZSubscriptions(ZSubscription_t *sublist, int nitems,
unsigned int port,
char *opcode,
Code_t (*send_routine)(ZNotice_t *, char *, int, int));
Code_t ZPunt(ZSubscription_t *sublist, int nitems, unsigned int port);
Code_t ZSubscribeTo(ZSubscription_t *sublist, int nitems,
unsigned int port);
Code_t ZSubscribeToSansDefaults(ZSubscription_t *sublist, int nitems,
unsigned int port);
Code_t ZUnsubscribeTo(ZSubscription_t *sublist, int nitems,
unsigned int port);
Code_t ZCancelSubscriptions(unsigned int port);
Code_t ZFlushUserSubscriptions(char *recip);
int ZPending(void);
Code_t ZReceiveNotice(ZNotice_t *notice, struct sockaddr_in *from);
const char *ZGetCharsetString(char *charset);
unsigned short ZGetCharset(char *charset);
const char *ZCharsetToString(unsigned short charset);
Code_t ZTransliterate(char *in, int inlen, char *inset, char *outset, char **out, int *outlen);
#ifdef Z_DEBUG
void Z_debug(const char *, ...);
#endif
char *ZExpandRealm(char *realm);
Code_t ZDumpSession(char **buffer, int *ret_len);
Code_t ZLoadSession(char *buffer, int len);
/* Compatibility */
#define ZNewLocateUser ZLocateUser
/* Not macros to retrieve Zephyr library values. */
const char *ZGetRealm(void);
int ZGetFD (void);
int ZQLength (void);
struct sockaddr_in ZGetDestAddr (void);
#ifdef Z_DEBUG
void ZSetDebug (void (*)(const char *, va_list, void *), char *);
void Z_debug_stderr(const char *format, va_list args, void *closure);
#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 ZCAUTH (ZMakeZcodeAuthentication)
#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 CLIENT_FLUSHSUBS "FLUSHSUBS" /* Opcode: Clear subs for princ */
#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__ */
|
