3148a8d8b278a3d490b5c6edd43d0bdc44445ab8
[kopensolaris-gnu/glibc.git] / nis / rpcsvc / nis.h
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
31 #ifndef _RPCSVC_NIS_H
32 #define _RPCSVC_NIS_H 1
33
34 #include <features.h>
35 #include <rpc/rpc.h>
36 #include <rpcsvc/nis_tags.h>
37
38 __BEGIN_DECLS
39
40 /*
41  *      nis.h
42  *
43  *      This file is the main include file for NIS clients. It contains
44  *      both the client library function defines and the various data
45  *      structures used by the NIS service. It includes the file nis_tags.h
46  *      which defines the tag values. This allows the tags to change without
47  *      having to change the nis.x file.
48  *
49  *      NOTE : THIS FILE IS NOT GENERATED WITH RPCGEN ! SO YOU HAVE TO
50  *             ADD ALL THE CHANGES ON nis_*.x FILES HERE AGAIN !
51  *
52  *      I have removed all the Solaris internal structs and variables,
53  *      because they are not supported, Sun changed them between various
54  *      releases and they shouldn't be used in user programs.
55  *                                              <kukuk@vt.uni-paderborn.de>
56  */
57
58
59 #ifndef __nis_object_h
60 #define __nis_object_h
61
62 #define NIS_MAXSTRINGLEN 255
63 #define NIS_MAXNAMELEN 1024
64 #define NIS_MAXATTRNAME 32
65 #define NIS_MAXATTRVAL 2048
66 #define NIS_MAXCOLUMNS 64
67 #define NIS_MAXATTR 16
68 #define NIS_MAXPATH 1024
69 #define NIS_MAXREPLICAS 128
70 #define NIS_MAXLINKS 16
71 #define NIS_PK_NONE 0
72 #define NIS_PK_DH 1
73 #define NIS_PK_RSA 2
74 #define NIS_PK_KERB 3
75
76 struct nis_attr {
77         char *zattr_ndx;
78         struct {
79                 u_int zattr_val_len;
80                 char *zattr_val_val;
81         } zattr_val;
82 };
83 typedef struct nis_attr nis_attr;
84
85 typedef char *nis_name;
86
87 enum zotypes {
88         BOGUS_OBJ = 0,
89         NO_OBJ = 1,
90         DIRECTORY_OBJ = 2,
91         GROUP_OBJ = 3,
92         TABLE_OBJ = 4,
93         ENTRY_OBJ = 5,
94         LINK_OBJ = 6,
95         PRIVATE_OBJ = 7,
96         NIS_BOGUS_OBJ = 0,
97         NIS_NO_OBJ = 1,
98         NIS_DIRECTORY_OBJ = 2,
99         NIS_GROUP_OBJ = 3,
100         NIS_TABLE_OBJ = 4,
101         NIS_ENTRY_OBJ = 5,
102         NIS_LINK_OBJ = 6,
103         NIS_PRIVATE_OBJ = 7
104 };
105 typedef enum zotypes zotypes;
106
107 enum nstype {
108         UNKNOWN = 0,
109         NIS = 1,
110         SUNYP = 2,
111         IVY = 3,
112         DNS = 4,
113         X500 = 5,
114         DNANS = 6,
115         XCHS = 7,
116         CDS = 8,
117 };
118 typedef enum nstype nstype;
119
120 struct oar_mask {
121         u_long oa_rights;
122         zotypes oa_otype;
123 };
124 typedef struct oar_mask oar_mask;
125
126 struct endpoint {
127         char *uaddr;
128         char *family;
129         char *proto;
130 };
131 typedef struct endpoint endpoint;
132
133 struct nis_server {
134         nis_name name;
135         struct {
136                 u_int ep_len;
137                 endpoint *ep_val;
138         } ep;
139         u_long key_type;
140         netobj pkey;
141 };
142 typedef struct nis_server nis_server;
143
144 struct directory_obj {
145         nis_name do_name;
146         nstype do_type;
147         struct {
148                 u_int do_servers_len;
149                 nis_server *do_servers_val;
150         } do_servers;
151         u_long do_ttl;
152         struct {
153                 u_int do_armask_len;
154                 oar_mask *do_armask_val;
155         } do_armask;
156 };
157 typedef struct directory_obj directory_obj;
158
159 #define EN_BINARY 1
160 #define EN_CRYPT 2
161 #define EN_XDR 4
162 #define EN_MODIFIED 8
163 #define EN_ASN1 64
164
165 struct entry_col {
166         u_long ec_flags;
167         struct {
168                 u_int ec_value_len;
169                 char *ec_value_val;
170         } ec_value;
171 };
172 typedef struct entry_col entry_col;
173
174 struct entry_obj {
175         char *en_type;
176         struct {
177                 u_int en_cols_len;
178                 entry_col *en_cols_val;
179         } en_cols;
180 };
181 typedef struct entry_obj entry_obj;
182
183 struct group_obj {
184         u_long gr_flags;
185         struct {
186                 u_int gr_members_len;
187                 nis_name *gr_members_val;
188         } gr_members;
189 };
190 typedef struct group_obj group_obj;
191
192 struct link_obj {
193         zotypes li_rtype;
194         struct {
195                 u_int li_attrs_len;
196                 nis_attr *li_attrs_val;
197         } li_attrs;
198         nis_name li_name;
199 };
200 typedef struct link_obj link_obj;
201
202 #define TA_BINARY 1
203 #define TA_CRYPT 2
204 #define TA_XDR 4
205 #define TA_SEARCHABLE 8
206 #define TA_CASE 16
207 #define TA_MODIFIED 32
208 #define TA_ASN1 64
209
210 struct table_col {
211         char *tc_name;
212         u_long tc_flags;
213         u_long tc_rights;
214 };
215 typedef struct table_col table_col;
216
217 struct table_obj {
218         char *ta_type;
219         int ta_maxcol;
220         u_char ta_sep;
221         struct {
222                 u_int ta_cols_len;
223                 table_col *ta_cols_val;
224         } ta_cols;
225         char *ta_path;
226 };
227 typedef struct table_obj table_obj;
228
229 struct objdata {
230         zotypes zo_type;
231         union {
232                 struct directory_obj di_data;
233                 struct group_obj gr_data;
234                 struct table_obj ta_data;
235                 struct entry_obj en_data;
236                 struct link_obj li_data;
237                 struct {
238                         u_int po_data_len;
239                         char *po_data_val;
240                 } po_data;
241         } objdata_u;
242 };
243 typedef struct objdata objdata;
244
245 struct nis_oid {
246         u_long ctime;
247         u_long mtime;
248 };
249 typedef struct nis_oid nis_oid;
250
251 struct nis_object {
252         nis_oid zo_oid;
253         nis_name zo_name;
254         nis_name zo_owner;
255         nis_name zo_group;
256         nis_name zo_domain;
257         u_long zo_access;
258         u_long zo_ttl;
259         objdata zo_data;
260 };
261 typedef struct nis_object nis_object;
262
263 #endif /* if __nis_object_h */
264
265 enum nis_error {
266         NIS_SUCCESS = 0,
267         NIS_S_SUCCESS = 1,
268         NIS_NOTFOUND = 2,
269         NIS_S_NOTFOUND = 3,
270         NIS_CACHEEXPIRED = 4,
271         NIS_NAMEUNREACHABLE = 5,
272         NIS_UNKNOWNOBJ = 6,
273         NIS_TRYAGAIN = 7,
274         NIS_SYSTEMERROR = 8,
275         NIS_CHAINBROKEN = 9,
276         NIS_PERMISSION = 10,
277         NIS_NOTOWNER = 11,
278         NIS_NOT_ME = 12,
279         NIS_NOMEMORY = 13,
280         NIS_NAMEEXISTS = 14,
281         NIS_NOTMASTER = 15,
282         NIS_INVALIDOBJ = 16,
283         NIS_BADNAME = 17,
284         NIS_NOCALLBACK = 18,
285         NIS_CBRESULTS = 19,
286         NIS_NOSUCHNAME = 20,
287         NIS_NOTUNIQUE = 21,
288         NIS_IBMODERROR = 22,
289         NIS_NOSUCHTABLE = 23,
290         NIS_TYPEMISMATCH = 24,
291         NIS_LINKNAMEERROR = 25,
292         NIS_PARTIAL = 26,
293         NIS_TOOMANYATTRS = 27,
294         NIS_RPCERROR = 28,
295         NIS_BADATTRIBUTE = 29,
296         NIS_NOTSEARCHABLE = 30,
297         NIS_CBERROR = 31,
298         NIS_FOREIGNNS = 32,
299         NIS_BADOBJECT = 33,
300         NIS_NOTSAMEOBJ = 34,
301         NIS_MODFAIL = 35,
302         NIS_BADREQUEST = 36,
303         NIS_NOTEMPTY = 37,
304         NIS_COLDSTART_ERR = 38,
305         NIS_RESYNC = 39,
306         NIS_FAIL = 40,
307         NIS_UNAVAIL = 41,
308         NIS_RES2BIG = 42,
309         NIS_SRVAUTH = 43,
310         NIS_CLNTAUTH = 44,
311         NIS_NOFILESPACE = 45,
312         NIS_NOPROC = 46,
313         NIS_DUMPLATER = 47,
314 };
315 typedef enum nis_error nis_error;
316
317 struct nis_result {
318         nis_error status;
319         struct {
320                 u_int objects_len;
321                 nis_object *objects_val;
322         } objects;
323         netobj cookie;
324         u_long zticks;
325         u_long dticks;
326         u_long aticks;
327         u_long cticks;
328 };
329 typedef struct nis_result nis_result;
330
331 struct ns_request {
332         nis_name ns_name;
333         struct {
334                 u_int ns_object_len;
335                 nis_object *ns_object_val;
336         } ns_object;
337 };
338 typedef struct ns_request ns_request;
339
340 struct ib_request {
341         nis_name ibr_name;
342         struct {
343                 u_int ibr_srch_len;
344                 nis_attr *ibr_srch_val;
345         } ibr_srch;
346         u_long ibr_flags;
347         struct {
348                 u_int ibr_obj_len;
349                 nis_object *ibr_obj_val;
350         } ibr_obj;
351         struct {
352                 u_int ibr_cbhost_len;
353                 nis_server *ibr_cbhost_val;
354         } ibr_cbhost;
355         u_long ibr_bufsize;
356         netobj ibr_cookie;
357 };
358 typedef struct ib_request ib_request;
359
360 struct ping_args {
361         nis_name dir;
362         u_long stamp;
363 };
364 typedef struct ping_args ping_args;
365
366 enum log_entry_t {
367         LOG_NOP = 0,
368         ADD_NAME = 1,
369         REM_NAME = 2,
370         MOD_NAME_OLD = 3,
371         MOD_NAME_NEW = 4,
372         ADD_IBASE = 5,
373         REM_IBASE = 6,
374         MOD_IBASE = 7,
375         UPD_STAMP = 8,
376 };
377 typedef enum log_entry_t log_entry_t;
378
379 struct log_entry {
380         u_long le_time;
381         log_entry_t le_type;
382         nis_name le_princp;
383         nis_name le_name;
384         struct {
385                 u_int le_attrs_len;
386                 nis_attr *le_attrs_val;
387         } le_attrs;
388         nis_object le_object;
389 };
390 typedef struct log_entry log_entry;
391
392 struct log_result {
393         nis_error lr_status;
394         netobj lr_cookie;
395         struct {
396                 u_int lr_entries_len;
397                 log_entry *lr_entries_val;
398         } lr_entries;
399 };
400 typedef struct log_result log_result;
401
402 struct cp_result {
403         nis_error cp_status;
404         u_long cp_zticks;
405         u_long cp_dticks;
406 };
407 typedef struct cp_result cp_result;
408
409 struct nis_tag {
410         u_long tag_type;
411         char *tag_val;
412 };
413 typedef struct nis_tag nis_tag;
414
415 struct nis_taglist {
416         struct {
417                 u_int tags_len;
418                 nis_tag *tags_val;
419         } tags;
420 };
421 typedef struct nis_taglist nis_taglist;
422
423 struct dump_args {
424         nis_name da_dir;
425         u_long da_time;
426         struct {
427                 u_int da_cbhost_len;
428                 nis_server *da_cbhost_val;
429         } da_cbhost;
430 };
431 typedef struct dump_args dump_args;
432
433 struct fd_args {
434         nis_name dir_name;
435         nis_name requester;
436 };
437 typedef struct fd_args fd_args;
438
439 struct fd_result {
440         nis_error status;
441         nis_name source;
442         struct {
443                 u_int dir_data_len;
444                 char *dir_data_val;
445         } dir_data;
446         struct {
447                 u_int signature_len;
448                 char *signature_val;
449         } signature;
450 };
451 typedef struct fd_result fd_result;
452
453 /* Generic client creating flags */
454 #define ZMH_VC          1
455 #define ZMH_DG          2
456 #define ZMH_AUTH        4
457
458 /* Testing Access rights for objects */
459
460 #define NIS_READ_ACC            1
461 #define NIS_MODIFY_ACC          2
462 #define NIS_CREATE_ACC          4
463 #define NIS_DESTROY_ACC 8
464 /* Test macros. a == access rights, m == desired rights. */
465 #define NIS_WORLD(a, m)        (((a) & (m)) != 0)
466 #define NIS_GROUP(a, m)        (((a) & ((m) << 8)) != 0)
467 #define NIS_OWNER(a, m)        (((a) & ((m) << 16)) != 0)
468 #define NIS_NOBODY(a, m)       (((a) & ((m) << 24)) != 0)
469 /*
470  * EOL Alert - The following non-prefixed test macros are
471  * here for backward compatability, and will be not be present
472  * in future releases - use the NIS_*() macros above.
473  */
474 #define WORLD(a, m)     (((a) & (m)) != 0)
475 #define GROUP(a, m)     (((a) & ((m) << 8)) != 0)
476 #define OWNER(a, m)     (((a) & ((m) << 16)) != 0)
477 #define NOBODY(a, m)    (((a) & ((m) << 24)) != 0)
478
479 #define OATYPE(d, n) (((d)->do_armask.do_armask_val+n)->oa_otype)
480 #define OARIGHTS(d, n) (((d)->do_armask.do_armask_val+n)->oa_rights)
481 #define WORLD_DEFAULT (NIS_READ_ACC)
482 #define GROUP_DEFAULT (NIS_READ_ACC << 8)
483 #define OWNER_DEFAULT ((NIS_READ_ACC + NIS_MODIFY_ACC + NIS_CREATE_ACC +\
484                         NIS_DESTROY_ACC) << 16)
485 #define DEFAULT_RIGHTS (WORLD_DEFAULT | GROUP_DEFAULT | OWNER_DEFAULT)
486
487 /* Result manipulation defines ... */
488 #define NIS_RES_NUMOBJ(x)       ((x)->objects.objects_len)
489 #define NIS_RES_OBJECT(x)       ((x)->objects.objects_val)
490 #define NIS_RES_COOKIE(x)       ((x)->cookie)
491 #define NIS_RES_STATUS(x)       ((x)->status)
492
493 /* These defines make getting at the variant part of the object easier. */
494 #define TA_data zo_data.objdata_u.ta_data
495 #define EN_data zo_data.objdata_u.en_data
496 #define DI_data zo_data.objdata_u.di_data
497 #define LI_data zo_data.objdata_u.li_data
498 #define GR_data zo_data.objdata_u.gr_data
499
500 #define __type_of(o) ((o)->zo_data.zo_type)
501
502 /* Declarations for the internal subroutines in nislib.c */
503 enum name_pos {SAME_NAME, HIGHER_NAME, LOWER_NAME, NOT_SEQUENTIAL, BAD_NAME};
504 typedef enum name_pos name_pos;
505
506 /*
507  * Defines for getting at column data in entry objects. Because RPCGEN
508  * generates some rather wordy structures, we create some defines that
509  * collapse the needed keystrokes to access a particular value using
510  * these definitions they take an nis_object *, and an int and return
511  * a u_char * for Value, and an int for length.
512  */
513 #define ENTRY_VAL(obj, col) (obj)->EN_data.en_cols.en_cols_val[col].ec_value.ec_value_val
514 #define ENTRY_LEN(obj, col) (obj)->EN_data.en_cols.en_cols_val[col].ec_value.ec_value_len
515
516
517 /* Prototypes, and extern declarations for the NIS library functions. */
518 #include <rpcsvc/nislib.h>
519 #endif
520
521 /*
522  * nis_3.h
523  *
524  * This file contains definitions that are only of interest to the actual
525  * service daemon and client stubs. Normal users of NIS will not include
526  * this file.
527  *
528  * NOTE : This include file is automatically created by a combination
529  * of rpcgen and sed. DO NOT EDIT IT, change the nis.x file instead
530  * and then remake this file.
531  */
532 #ifndef __nis_3_h
533 #define __nis_3_h
534
535 #define NIS_PROG ((u_long)100300)
536 #define NIS_VERSION ((u_long)3)
537
538 #define NIS_LOOKUP ((u_long)1)
539 extern  nis_result * nis_lookup_3 __P ((ns_request *, CLIENT *));
540 extern  nis_result * nis_lookup_3_svc __P ((ns_request *, struct svc_req *));
541 #define NIS_ADD ((u_long)2)
542 extern  nis_result * nis_add_3 __P ((ns_request *, CLIENT *));
543 extern  nis_result * nis_add_3_svc __P ((ns_request *, struct svc_req *));
544 #define NIS_MODIFY ((u_long)3)
545 extern  nis_result * nis_modify_3 __P ((ns_request *, CLIENT *));
546 extern  nis_result * nis_modify_3_svc __P ((ns_request *, struct svc_req *));
547 #define NIS_REMOVE ((u_long)4)
548 extern  nis_result * nis_remove_3 __P ((ns_request *, CLIENT *));
549 extern  nis_result * nis_remove_3_svc __P ((ns_request *, struct svc_req *));
550 #define NIS_IBLIST ((u_long)5)
551 extern  nis_result * nis_iblist_3 __P ((ib_request *, CLIENT *));
552 extern  nis_result * nis_iblist_3_svc __P ((ib_request *, struct svc_req *));
553 #define NIS_IBADD ((u_long)6)
554 extern  nis_result * nis_ibadd_3 __P ((ib_request *, CLIENT *));
555 extern  nis_result * nis_ibadd_3_svc __P ((ib_request *, struct svc_req *));
556 #define NIS_IBMODIFY ((u_long)7)
557 extern  nis_result * nis_ibmodify_3 __P ((ib_request *, CLIENT *));
558 extern  nis_result * nis_ibmodify_3_svc __P ((ib_request *, struct svc_req *));
559 #define NIS_IBREMOVE ((u_long)8)
560 extern  nis_result * nis_ibremove_3 __P ((ib_request *, CLIENT *));
561 extern  nis_result * nis_ibremove_3_svc __P ((ib_request *, struct svc_req *));
562 #define NIS_IBFIRST ((u_long)9)
563 extern  nis_result * nis_ibfirst_3 __P ((ib_request *, CLIENT *));
564 extern  nis_result * nis_ibfirst_3_svc __P ((ib_request *, struct svc_req *));
565 #define NIS_IBNEXT ((u_long)10)
566 extern  nis_result * nis_ibnext_3 __P ((ib_request *, CLIENT *));
567 extern  nis_result * nis_ibnext_3_svc __P ((ib_request *, struct svc_req *));
568 #define NIS_FINDDIRECTORY ((u_long)12)
569 extern  fd_result * nis_finddirectory_3 __P ((fd_args *, CLIENT *));
570 extern  fd_result * nis_finddirectory_3_svc __P ((fd_args *,
571                                                   struct svc_req *));
572 #define NIS_STATUS ((u_long)14)
573 extern  nis_taglist * nis_status_3 __P ((nis_taglist *, CLIENT *));
574 extern  nis_taglist * nis_status_3_svc __P ((nis_taglist *, struct svc_req *));
575 #define NIS_DUMPLOG ((u_long)15)
576 extern  log_result * nis_dumplog_3 __P ((dump_args *, CLIENT *));
577 extern  log_result * nis_dumplog_3_svc __P ((dump_args *, struct svc_req *));
578 #define NIS_DUMP ((u_long)16)
579 extern  log_result * nis_dump_3 __P ((dump_args *, CLIENT *));
580 extern  log_result * nis_dump_3_svc __P ((dump_args *, struct svc_req *));
581 #define NIS_CALLBACK ((u_long)17)
582 extern  bool_t * nis_callback_3 __P ((netobj *, CLIENT *));
583 extern  bool_t * nis_callback_3_svc __P ((netobj *, struct svc_req *));
584 #define NIS_CPTIME ((u_long)18)
585 extern  u_long * nis_cptime_3 __P ((nis_name *, CLIENT *));
586 extern  u_long * nis_cptime_3_svc __P ((nis_name *, struct svc_req *));
587 #define NIS_CHECKPOINT ((u_long)19)
588 extern  cp_result * nis_checkpoint_3 __P ((nis_name *, CLIENT *));
589 extern  cp_result * nis_checkpoint_3_svc __P ((nis_name *, struct svc_req *));
590 #define NIS_PING ((u_long)20)
591 extern  void * nis_ping_3 __P ((ping_args *, CLIENT *));
592 extern  void * nis_ping_3_svc __P ((ping_args *, struct svc_req *));
593 #define NIS_SERVSTATE ((u_long)21)
594 extern  nis_taglist * nis_servstate_3 __P ((nis_taglist *, CLIENT *));
595 extern  nis_taglist * nis_servstate_3_svc __P ((nis_taglist *,
596                                                 struct svc_req *));
597 #define NIS_MKDIR ((u_long)22)
598 extern  nis_error * nis_mkdir_3 __P ((nis_name *, CLIENT *));
599 extern  nis_error * nis_mkdir_3_svc __P ((nis_name *, struct svc_req *));
600 #define NIS_RMDIR ((u_long)23)
601 extern  nis_error * nis_rmdir_3 __P ((nis_name *, CLIENT *));
602 extern  nis_error * nis_rmdir_3_svc __P ((nis_name *, struct svc_req *));
603 #define NIS_UPDKEYS ((u_long)24)
604 extern  nis_error * nis_updkeys_3 __P ((nis_name *, CLIENT *));
605 extern  nis_error * nis_updkeys_3_svc __P ((nis_name *, struct svc_req *));
606
607 __END_DECLS
608
609 #endif /* !_NIS_H_RPCGEN */