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