| blob | 2d19f379314c7b96a145383333b30c7e778ed821 |
1 %/*
2 % * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3 % * unrestricted use provided that this legend is included on all tape
4 % * media and as a part of the software program in whole or part. Users
5 % * may copy or modify Sun RPC without charge, but are not authorized
6 % * to license or distribute it to anyone else except as part of a product or
7 % * program developed by the user or with the express written consent of
8 % * Sun Microsystems, Inc.
9 % *
10 % * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11 % * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12 % * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13 % *
14 % * Sun RPC is provided with no support and without any obligation on the
15 % * part of Sun Microsystems, Inc. to assist in its use, correction,
16 % * modification or enhancement.
17 % *
18 % * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19 % * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20 % * OR ANY PART THEREOF.
21 % *
22 % * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23 % * or profits or other special, indirect and consequential damages, even if
24 % * Sun has been advised of the possibility of such damages.
25 % *
26 % * Sun Microsystems, Inc.
27 % * 2550 Garcia Avenue
28 % * Mountain View, California 94043
29 % */
31 #ifdef RPC_HDR
32 %/*
33 % * nis.h
34 % *
35 % * This file is the main include file for NIS clients. It contains
36 % * both the client library function defines and the various data
37 % * structures used by the NIS service. It includes the file nis_tags.h
38 % * which defines the tag values. This allows the tags to change without
39 % * having to change the nis.x file.
40 % *
41 % * NOTE : DO NOT EDIT THIS FILE! It is automatically generated when
42 % * rpcgen is run on the nis.x file. Note that there is a
43 % * simple sed script to remove some unneeded lines. (See the
44 % * Makefile target nis.h)
45 % *
46 % */
47 %#include <rpcsvc/nis_tags.h>
48 #endif
50 /* This gets stuffed into the source files. */
51 #if RPC_HDR
52 %#include <rpc/xdr.h>
53 #endif
54 #if RPC_SVC
55 %#include "nis_svc.h"
56 #endif
58 /* Include the RPC Language description of NIS objects */
59 #include "nis_object.x"
61 /* Errors that can be returned by the service */
62 enum nis_error {
63 NIS_SUCCESS = 0, /* A-ok, let's rock n roll */
64 NIS_S_SUCCESS = 1, /* Name found (maybe) */
65 NIS_NOTFOUND = 2, /* Name definitely not found */
66 NIS_S_NOTFOUND = 3, /* Name maybe not found */
67 NIS_CACHEEXPIRED = 4, /* Name exists but cache out of date */
68 NIS_NAMEUNREACHABLE = 5, /* Can't get there from here */
69 NIS_UNKNOWNOBJ = 6, /* Object type is bogus */
70 NIS_TRYAGAIN = 7, /* I'm busy, call back */
71 NIS_SYSTEMERROR = 8, /* Generic system error */
72 NIS_CHAINBROKEN = 9, /* First/Next warning */
73 NIS_PERMISSION = 10, /* Not enough permission to access */
74 NIS_NOTOWNER = 11, /* You don't own it, sorry */
75 NIS_NOT_ME = 12, /* I don't serve this name */
76 NIS_NOMEMORY = 13, /* Outta VM! Help! */
77 NIS_NAMEEXISTS = 14, /* Can't create over another name */
78 NIS_NOTMASTER = 15, /* I'm justa secondaray, don't ask me */
79 NIS_INVALIDOBJ = 16, /* Object is broken somehow */
80 NIS_BADNAME = 17, /* Unparsable name */
81 NIS_NOCALLBACK = 18, /* Couldn't talk to call back proc */
82 NIS_CBRESULTS = 19, /* Results being called back to you */
83 NIS_NOSUCHNAME = 20, /* Name unknown */
84 NIS_NOTUNIQUE = 21, /* Value is not uniques (entry) */
85 NIS_IBMODERROR = 22, /* Inf. Base. Modify error. */
86 NIS_NOSUCHTABLE = 23, /* Name for table was wrong */
87 NIS_TYPEMISMATCH = 24, /* Entry and table type mismatch */
88 NIS_LINKNAMEERROR = 25, /* Link points to bogus name */
89 NIS_PARTIAL = 26, /* Partial success, found table */
90 NIS_TOOMANYATTRS = 27, /* Too many attributes */
91 NIS_RPCERROR = 28, /* RPC error encountered */
92 NIS_BADATTRIBUTE = 29, /* Bad or invalid attribute */
93 NIS_NOTSEARCHABLE = 30, /* Non-searchable object searched */
94 NIS_CBERROR = 31, /* Error during callback (svc crash) */
95 NIS_FOREIGNNS = 32, /* Foreign Namespace */
96 NIS_BADOBJECT = 33, /* Malformed object structure */
97 NIS_NOTSAMEOBJ = 34, /* Object swapped during deletion */
98 NIS_MODFAIL = 35, /* Failure during a Modify. */
99 NIS_BADREQUEST = 36, /* Illegal query for table */
100 NIS_NOTEMPTY = 37, /* Attempt to remove a non-empty tbl */
101 NIS_COLDSTART_ERR = 38, /* Error accesing the cold start file */
102 NIS_RESYNC = 39, /* Transaction log too far out of date */
103 NIS_FAIL = 40, /* NIS operation failed. */
104 NIS_UNAVAIL = 41, /* NIS+ service is unavailable (client) */
105 NIS_RES2BIG = 42, /* NIS+ result too big for datagram */
106 NIS_SRVAUTH = 43, /* NIS+ server wasn't authenticated. */
107 NIS_CLNTAUTH = 44, /* NIS+ Client wasn't authenticated. */
108 NIS_NOFILESPACE = 45, /* NIS+ server ran out of disk space */
109 NIS_NOPROC = 46, /* NIS+ server couldn't create new proc */
110 NIS_DUMPLATER = 47 /* NIS+ server already has dump child */
111 };
114 /*
115 * Structure definitions for the parameters and results of the actual
116 * NIS RPC calls.
117 *
118 * This is the standard result (in the protocol) of most of the nis
119 * requests.
120 */
122 struct nis_result {
123 nis_error status; /* Status of the response */
124 nis_object objects<>; /* objects found */
125 netobj cookie; /* Cookie Data */
126 u_long zticks; /* server ticks */
127 u_long dticks; /* DBM ticks. */
128 u_long aticks; /* Cache (accel) ticks */
129 u_long cticks; /* Client ticks */
130 };
132 /*
133 * A Name Service request
134 * This request is used to access the name space, ns_name is the name
135 * of the object within the namespace and the object is it's value, for
136 * add/modify, a copy of the original for remove.
137 */
139 struct ns_request {
140 nis_name ns_name; /* Name in the NIS name space */
141 nis_object ns_object<1>; /* Optional Object (add/remove) */
142 };
144 /*
145 * An information base request
146 * This request includes the NIS name of the table we wish to search, the
147 * search criteria in the form of attribute/value pairs and an optional
148 * callback program number. If the callback program number is provided
149 * the server will send back objects one at a time, otherwise it will
150 * return them all in the response.
151 */
153 struct ib_request {
154 nis_name ibr_name; /* The name of the Table */
155 nis_attr ibr_srch<>; /* The search critereia */
156 u_long ibr_flags; /* Optional flags */
157 nis_object ibr_obj<1>; /* optional object (add/modify) */
158 nis_server ibr_cbhost<1>; /* Optional callback info */
159 u_long ibr_bufsize; /* Optional first/next bufsize */
160 netobj ibr_cookie; /* The first/next cookie */
161 };
163 /*
164 * This argument to the PING call notifies the replicas that something in
165 * a directory has changed and this is it's timestamp. The replica will use
166 * the timestamp to determine if its resync operation was successful.
167 */
168 struct ping_args {
169 nis_name dir; /* Directory that had the change */
170 u_long stamp; /* timestamp of the transaction */
171 };
173 /*
174 * These are the type of entries that are stored in the transaction log,
175 * note that modifications will appear as two entries, for names, they have
176 * a "OLD" entry followed by a "NEW" entry. For entries in tables, there
177 * is a remove followed by an add. It is done this way so that we can read
178 * the log backwards to back out transactions and forwards to propogate
179 * updated.
180 */
181 enum log_entry_t {
182 LOG_NOP = 0,
183 ADD_NAME = 1, /* Name Added to name space */
184 REM_NAME = 2, /* Name removed from name space */
185 MOD_NAME_OLD = 3, /* Name was modified in the name space */
186 MOD_NAME_NEW = 4, /* Name was modified in the name space */
187 ADD_IBASE = 5, /* Entry added to information base */
188 REM_IBASE = 6, /* Entry removed from information base */
189 MOD_IBASE = 7, /* Entry was modified in information base */
190 UPD_STAMP = 8 /* Update timestamp (used as fenceposts) */
191 };
193 /*
194 * This result is returned from the name service when it is requested to
195 * dump logged entries from its transaction log. Information base updates
196 * will have the name of the information base in the le_name field and
197 * a canonical set of attribute/value pairs to fully specify the entry's
198 * 'name'.
199 */
200 struct log_entry {
201 u_long le_time; /* Time in seconds */
202 log_entry_t le_type; /* Type of log entry */
203 nis_name le_princp; /* Principal making the change */
204 nis_name le_name; /* Name of table/dir involved */
205 nis_attr le_attrs<>; /* List of AV pairs. */
206 nis_object le_object; /* Actual object value */
207 };
209 struct log_result {
210 nis_error lr_status; /* The status itself */
211 netobj lr_cookie; /* Used by the dump callback */
212 log_entry lr_entries<>; /* zero or more entries */
213 };
215 struct cp_result {
216 nis_error cp_status; /* Status of the checkpoint */
217 u_long cp_zticks; /* Service 'ticks' */
218 u_long cp_dticks; /* Database 'ticks' */
219 };
221 /*
222 * This structure defines a generic NIS tag list. The taglist contains
223 * zero or tags, each of which is a type and a value. (u_long).
224 * These are used to report statistics (see tag definitions below)
225 * and to set or reset state variables.
226 */
227 struct nis_tag {
228 u_long tag_type; /* Statistic tag (may vary) */
229 string tag_val<1024>; /* Statistic value may also vary */
230 };
232 struct nis_taglist {
233 nis_tag tags<>; /* List of tags */
234 };
236 struct dump_args {
237 nis_name da_dir; /* Directory to dump */
238 u_long da_time; /* From this timestamp */
239 nis_server da_cbhost<1>; /* Callback to use. */
240 };
242 struct fd_args {
243 nis_name dir_name; /* The directory we're looking for */
244 nis_name requester; /* Host principal name for signature */
245 };
247 struct fd_result {
248 nis_error status; /* Status returned by function */
249 nis_name source; /* Source of this answer */
250 opaque dir_data<>; /* Directory Data (XDR'ed) */
251 opaque signature<>; /* Signature of the source */
252 };
254 %/*
255 % * Structures used for server binding.
256 % */
257 struct nis_bound_endpoint {
258 endpoint ep;
259 int generation;
260 int rank;
261 u_long flags;
262 int hostnum;
263 int epnum;
264 nis_name uaddr;
265 endpoint cbep;
266 };
267 typedef struct nis_bound_endpoint nis_bound_endpoint;
269 struct nis_bound_directory {
270 int generation;
271 int min_rank; /* minimum rank of bound endpoints */
272 int optimal_rank; /* best possible rank of all endpoints */
273 directory_obj dobj;
274 nis_bound_endpoint BEP<>;
275 };
276 typedef struct nis_bound_directory nis_bound_directory;
277 %#define bep_len BEP.BEP_len
278 %#define bep_val BEP.BEP_val
280 struct nis_active_endpoint {
281 endpoint ep;
282 nis_name hostname;
283 int rank;
284 int uaddr_generation;
285 nis_name uaddr;
286 int cbep_generation;
287 endpoint cbep;
288 };
289 typedef struct nis_active_endpoint nis_active_endpoint;
291 %/* defines for nis_bound_endpoint.flags */
292 %#define NIS_BOUND 0x1
293 %#define NIS_TRANSIENT_ERRORS 0x2
297 /*
298 * What's going on here? Well, it's like this. When the service
299 * is being compiled it wants to have the service definition specific
300 * info included, and when the client is being compiled it wants that
301 * info. This includes the appropriate file which was generated by
302 * make in the protocols directory (probably /usr/include/rpcsvc).
303 */
304 #ifdef RPC_SVC
305 %#include "nis_svc.h"
306 #endif
307 #ifdef RPC_CLNT
308 %#include "nis_clnt.h"
309 #endif
311 program NIS_PROG {
313 /* RPC Language description of the NIS+ protocol */
314 version NIS_VERSION {
315 /* The name service functions */
316 nis_result NIS_LOOKUP(ns_request) = 1;
317 nis_result NIS_ADD(ns_request) = 2;
318 nis_result NIS_MODIFY(ns_request) = 3;
319 nis_result NIS_REMOVE(ns_request) = 4;
321 /* The information base functions */
322 nis_result NIS_IBLIST(ib_request) = 5;
323 nis_result NIS_IBADD(ib_request) = 6;
324 nis_result NIS_IBMODIFY(ib_request) = 7;
325 nis_result NIS_IBREMOVE(ib_request) = 8;
326 nis_result NIS_IBFIRST(ib_request) = 9;
327 nis_result NIS_IBNEXT(ib_request) = 10;
329 /* NIS Administrative functions */
330 fd_result NIS_FINDDIRECTORY(fd_args) = 12;
332 /* If fetch and optionally reset statistics */
333 nis_taglist NIS_STATUS(nis_taglist) = 14;
335 /* Dump changes to directory since time in da_time */
336 log_result NIS_DUMPLOG(dump_args) = 15;
338 /* Dump contents of directory named */
339 log_result NIS_DUMP(dump_args) = 16;
341 /* Check status of callback thread */
342 bool NIS_CALLBACK(netobj) = 17;
344 /* Return last update time for named dir */
345 u_long NIS_CPTIME(nis_name) = 18;
347 /* Checkpoint directory or table named */
348 cp_result NIS_CHECKPOINT(nis_name) = 19;
350 /* Send 'status changed' ping to replicates */
351 void NIS_PING(ping_args) = 20;
353 /* Modify server behaviour (such as debugging) */
354 nis_taglist NIS_SERVSTATE(nis_taglist) = 21;
356 /* Create a Directory */
357 nis_error NIS_MKDIR(nis_name) = 22;
359 /* Remove a Directory */
360 nis_error NIS_RMDIR(nis_name) = 23;
362 /* Update public keys of a directory object */
363 nis_error NIS_UPDKEYS(nis_name) = 24;
364 } = 3;
365 } = 100300;
367 /*
368 * Included below are the defines that become part of nis.h,
369 * they are technically not part of the protocol, but do define
370 * key aspects of the implementation and are therefore useful
371 * in building a conforming server or client.
372 */
373 #if RPC_HDR
374 %/*
375 % * Generic "hash" datastructures, used by all types of hashed data.
376 % */
377 %struct nis_hash_data {
378 % nis_name name; /* NIS name of hashed item */
379 % int keychain; /* It's hash key (for pop) */
380 % struct nis_hash_data *next; /* Hash collision pointer */
381 % struct nis_hash_data *prv_item; /* A serial, doubly linked list */
382 % struct nis_hash_data *nxt_item; /* of items in the hash table */
383 %};
384 %typedef struct nis_hash_data NIS_HASH_ITEM;
385 %
386 %struct nis_hash_table {
387 % NIS_HASH_ITEM *keys[64]; /* A hash table of items */
388 % NIS_HASH_ITEM *first; /* The first "item" in serial list */
389 %};
390 %typedef struct nis_hash_table NIS_HASH_TABLE;
391 %
392 %/* Structure for storing dynamically allocated static data */
393 %struct nis_sdata {
394 % void *buf; /* Memory allocation pointer */
395 % u_long size; /* Buffer size */
396 %};
397 %
398 %/* Generic client creating flags */
399 %#define ZMH_VC 1
400 %#define ZMH_DG 2
401 %#define ZMH_AUTH 4
402 %
403 %/* Testing Access rights for objects */
404 %
405 %#define NIS_READ_ACC 1
406 %#define NIS_MODIFY_ACC 2
407 %#define NIS_CREATE_ACC 4
408 %#define NIS_DESTROY_ACC 8
409 %/* Test macros. a == access rights, m == desired rights. */
410 %#define NIS_WORLD(a, m) (((a) & (m)) != 0)
411 %#define NIS_GROUP(a, m) (((a) & ((m) << 8)) != 0)
412 %#define NIS_OWNER(a, m) (((a) & ((m) << 16)) != 0)
413 %#define NIS_NOBODY(a, m) (((a) & ((m) << 24)) != 0)
414 %/*
415 % * EOL Alert - The following non-prefixed test macros are
416 % * here for backward compatability, and will be not be present
417 % * in future releases - use the NIS_*() macros above.
418 % */
419 %#define WORLD(a, m) (((a) & (m)) != 0)
420 %#define GROUP(a, m) (((a) & ((m) << 8)) != 0)
421 %#define OWNER(a, m) (((a) & ((m) << 16)) != 0)
422 %#define NOBODY(a, m) (((a) & ((m) << 24)) != 0)
423 %
424 %#define OATYPE(d, n) (((d)->do_armask.do_armask_val+n)->oa_otype)
425 %#define OARIGHTS(d, n) (((d)->do_armask.do_armask_val+n)->oa_rights)
426 %#define WORLD_DEFAULT (NIS_READ_ACC)
427 %#define GROUP_DEFAULT (NIS_READ_ACC << 8)
428 %#define OWNER_DEFAULT ((NIS_READ_ACC +\
429 NIS_MODIFY_ACC +\
430 NIS_CREATE_ACC +\
431 NIS_DESTROY_ACC) << 16)
432 %#define DEFAULT_RIGHTS (WORLD_DEFAULT | GROUP_DEFAULT | OWNER_DEFAULT)
433 %
434 %/* Result manipulation defines ... */
435 %#define NIS_RES_NUMOBJ(x) ((x)->objects.objects_len)
436 %#define NIS_RES_OBJECT(x) ((x)->objects.objects_val)
437 %#define NIS_RES_COOKIE(x) ((x)->cookie)
438 %#define NIS_RES_STATUS(x) ((x)->status)
439 %
440 %/* These defines make getting at the variant part of the object easier. */
441 %#define TA_data zo_data.objdata_u.ta_data
442 %#define EN_data zo_data.objdata_u.en_data
443 %#define DI_data zo_data.objdata_u.di_data
444 %#define LI_data zo_data.objdata_u.li_data
445 %#define GR_data zo_data.objdata_u.gr_data
446 %
447 %#define __type_of(o) ((o)->zo_data.zo_type)
448 %
449 %/* Declarations for the internal subroutines in nislib.c */
450 %enum name_pos {SAME_NAME, HIGHER_NAME, LOWER_NAME, NOT_SEQUENTIAL, BAD_NAME};
451 %typedef enum name_pos name_pos;
452 %
453 %/*
454 % * Defines for getting at column data in entry objects. Because RPCGEN
455 % * generates some rather wordy structures, we create some defines that
456 % * collapse the needed keystrokes to access a particular value using
457 % * these definitions they take an nis_object *, and an int and return
458 % * a u_char * for Value, and an int for length.
459 % */
460 %#define ENTRY_VAL(obj, col) \
461 % (obj)->EN_data.en_cols.en_cols_val[col].ec_value.ec_value_val
462 %#define ENTRY_LEN(obj, col) \
463 % (obj)->EN_data.en_cols.en_cols_val[col].ec_value.ec_value_len
464 %
465 %
466 %
467 %#ifdef __cplusplus
468 %}
469 %#endif
470 %
471 %/* Prototypes, and extern declarations for the NIS library functions. */
472 %#include <rpcsvc/nislib.h>
473 %#endif /* __NIS_RPCGEN_H */
474 %/* EDIT_START */
475 %
476 %/*
477 % * nis_3.h
478 % *
479 % * This file contains definitions that are only of interest to the actual
480 % * service daemon and client stubs. Normal users of NIS will not include
481 % * this file.
482 % *
483 % * NOTE : This include file is automatically created by a combination
484 % * of rpcgen and sed. DO NOT EDIT IT, change the nis.x file instead
485 % * and then remake this file.
486 % */
487 %#ifndef __nis_3_h
488 %#define __nis_3_h
489 %#ifdef __cplusplus
490 %extern "C" {
491 %#endif
492 #endif