Add the changes from the Solaris 2.6 header files, use the new public
[kopensolaris-gnu/glibc.git] / nis / rpcsvc / nis_object.x
1 /*
2  *      nis_object.x
3  *
4  *      Copyright (c) 1988-1992 Sun Microsystems Inc
5  *      All Rights Reserved.
6  */
7
8 %#pragma ident  "@(#)nis_object.x       1.9     96/07/09 SMI"
9
10 #if RPC_HDR
11 %
12 %#ifndef __nis_object_h
13 %#define __nis_object_h
14 %
15 #endif
16 /* 
17  *      This file defines the format for a NIS object in RPC language.
18  * It is included by the main .x file and the database access protocol
19  * file. It is common because both of them need to deal with the same
20  * type of object. Generating the actual code though is a bit messy because
21  * the nis.x file and the nis_dba.x file will generate xdr routines to 
22  * encode/decode objects when only one set is needed. Such is life when
23  * one is using rpcgen.
24  *
25  * Note, the protocol doesn't specify any limits on such things as
26  * maximum name length, number of attributes, etc. These are enforced
27  * by the database backend. When you hit them you will no. Also see
28  * the db_getlimits() function for fetching the limit values.
29  *
30  */
31
32 /* Some manifest constants, chosen to maximize flexibility without
33  * plugging the wire full of data.
34  */
35 const NIS_MAXSTRINGLEN = 255;
36 const NIS_MAXNAMELEN   = 1024;
37 const NIS_MAXATTRNAME  = 32;
38 const NIS_MAXATTRVAL   = 2048;
39 const NIS_MAXCOLUMNS   = 64;
40 const NIS_MAXATTR      = 16;
41 const NIS_MAXPATH      = 1024;
42 const NIS_MAXREPLICAS  = 128;
43 const NIS_MAXLINKS     = 16;
44
45 const NIS_PK_NONE      = 0;     /* no public key (unix/sys auth) */
46 const NIS_PK_DH        = 1;     /* Public key is Diffie-Hellman type */
47 const NIS_PK_RSA       = 2;     /* Public key if RSA type */
48 const NIS_PK_KERB      = 3;     /* Use kerberos style authentication */
49
50 /*
51  * The fundamental name type of NIS. The name may consist of two parts,
52  * the first being the fully qualified name, and the second being an 
53  * optional set of attribute/value pairs.
54  */
55 struct nis_attr {
56         string  zattr_ndx<>;    /* name of the index            */
57         opaque  zattr_val<>;    /* Value for the attribute.     */
58 };
59
60 typedef string nis_name<>;      /* The NIS name itself. */
61
62 /* NIS object types are defined by the following enumeration. The numbers
63  * they use are based on the following scheme :
64  *                   0 - 1023 are reserved for Sun,
65  *              1024 - 2047 are defined to be private to a particular tree.
66  *              2048 - 4095 are defined to be user defined.
67  *              4096 - ...  are reserved for future use.
68  *
69  * EOL Alert - The non-prefixed names are present for backward
70  * compatability only, and will not exist in future releases. Use
71  * the NIS_* names for future compatability.
72  */
73
74 enum zotypes {
75         
76         BOGUS_OBJ       = 0,    /* Uninitialized object structure       */
77         NO_OBJ          = 1,    /* NULL object (no data)                */
78         DIRECTORY_OBJ   = 2,    /* Directory object describing domain   */
79         GROUP_OBJ       = 3,    /* Group object (a list of names)       */
80         TABLE_OBJ       = 4,    /* Table object (a database schema)     */
81         ENTRY_OBJ       = 5,    /* Entry object (a database record)     */
82         LINK_OBJ        = 6,    /* A name link.                         */
83         PRIVATE_OBJ     = 7,    /* Private object (all opaque data)     */
84         
85         NIS_BOGUS_OBJ   = 0,    /* Uninitialized object structure       */
86         NIS_NO_OBJ      = 1,    /* NULL object (no data)                */
87         NIS_DIRECTORY_OBJ = 2, /* Directory object describing domain    */
88         NIS_GROUP_OBJ   = 3,    /* Group object (a list of names)       */
89         NIS_TABLE_OBJ   = 4,    /* Table object (a database schema)     */
90         NIS_ENTRY_OBJ   = 5,    /* Entry object (a database record)     */
91         NIS_LINK_OBJ    = 6,    /* A name link.                         */
92         NIS_PRIVATE_OBJ  = 7 /* Private object (all opaque data) */
93 };
94
95 /*
96  * The types of Name services NIS knows about. They are enumerated
97  * here. The Binder code will use this type to determine if it has
98  * a set of library routines that will access the indicated name service.
99  */
100 enum nstype {
101         UNKNOWN = 0,
102         NIS = 1,        /* Nis Plus Service             */
103         SUNYP = 2,      /* Old NIS Service              */
104         IVY = 3,        /* Nis Plus Plus Service        */
105         DNS = 4,        /* Domain Name Service          */
106         X500 = 5,       /* ISO/CCCIT X.500 Service      */
107         DNANS = 6,      /* Digital DECNet Name Service  */
108         XCHS = 7,       /* Xerox ClearingHouse Service  */
109         CDS= 8
110 };
111
112 /*
113  * DIRECTORY - The name service object. These objects identify other name
114  * servers that are serving some portion of the name space. Each has a
115  * type associated with it. The resolver library will note whether or not
116  * is has the needed routines to access that type of service. 
117  * The oarmask structure defines an access rights mask on a per object 
118  * type basis for the name spaces. The only bits currently used are 
119  * create and destroy. By enabling or disabling these access rights for
120  * a specific object type for a one of the accessor entities (owner,
121  * group, world) the administrator can control what types of objects 
122  * may be freely added to the name space and which require the 
123  * administrator's approval.
124  */
125 struct oar_mask {
126         u_long  oa_rights;      /* Access rights mask   */
127         zotypes oa_otype;       /* Object type          */
128 };
129
130 struct endpoint {
131         string          uaddr<>;
132         string          family<>;   /* Transport family (INET, OSI, etc) */
133         string          proto<>;    /* Protocol (TCP, UDP, CLNP,  etc)   */
134 };
135
136 /*
137  * Note: pkey is a netobj which is limited to 1024 bytes which limits the
138  * keysize to 8192 bits. This is consider to be a reasonable limit for
139  * the expected lifetime of this service.
140  */
141 struct nis_server {
142         nis_name        name;           /* Principal name of the server  */
143         endpoint        ep<>;           /* Universal addr(s) for server  */
144         u_long          key_type;       /* Public key type               */
145         netobj          pkey;           /* server's public key           */
146 };
147
148 struct directory_obj {
149         nis_name   do_name;      /* Name of the directory being served   */
150         nstype     do_type;      /* one of NIS, DNS, IVY, YP, or X.500   */
151         nis_server do_servers<>; /* <0> == Primary name server           */
152         u_long     do_ttl;       /* Time To Live (for caches)            */
153         oar_mask   do_armask<>;  /* Create/Destroy rights by object type */
154 };
155
156 /* 
157  * ENTRY - This is one row of data from an information base. 
158  * The type value is used by the client library to convert the entry to 
159  * it's internal structure representation. The Table name is a back pointer
160  * to the table where the entry is stored. This allows the client library 
161  * to determine where to send a request if the client wishes to change this
162  * entry but got to it through a LINK rather than directly.
163  * If the entry is a "standalone" entry then this field is void.
164  */
165 const EN_BINARY   = 1;  /* Indicates value is binary data       */
166 const EN_CRYPT    = 2;  /* Indicates the value is encrypted     */
167 const EN_XDR      = 4;  /* Indicates the value is XDR encoded   */
168 const EN_MODIFIED = 8;  /* Indicates entry is modified.         */
169 const EN_ASN1     = 64; /* Means contents use ASN.1 encoding    */
170
171 struct entry_col {
172         u_long  ec_flags;       /* Flags for this value */
173         opaque  ec_value<>;     /* It's textual value   */
174 };
175
176 struct entry_obj {
177         string  en_type<>;      /* Type of entry such as "passwd" */
178         entry_col en_cols<>;    /* Value for the entry            */
179 };
180
181 /*
182  * GROUP - The group object contains a list of NIS principal names. Groups
183  * are used to authorize principals. Each object has a set of access rights
184  * for members of its group. Principal names in groups are in the form 
185  * name.directory and recursive groups are expressed as @groupname.directory
186  */
187 struct group_obj {
188         u_long          gr_flags;       /* Flags controlling group      */
189         nis_name        gr_members<>;   /* List of names in group       */
190 };
191
192 /*
193  * LINK - This is the LINK object. It is quite similar to a symbolic link
194  * in the UNIX filesystem. The attributes in the main object structure are
195  * relative to the LINK data and not what it points to (like the file system)
196  * "modify" privleges here indicate the right to modify what the link points
197  * at and not to modify that actual object pointed to by the link.
198  */
199 struct link_obj {
200         zotypes  li_rtype;      /* Real type of the object      */
201         nis_attr li_attrs<>;    /* Attribute/Values for tables  */
202         nis_name li_name;       /* The object's real NIS name   */
203 };
204
205 /*
206  * TABLE - This is the table object. It implements a simple 
207  * data base that applications and use for configuration or 
208  * administration purposes. The role of the table is to group together
209  * a set of related entries. Tables are the simple database component
210  * of NIS. Like many databases, tables are logically divided into columns
211  * and rows. The columns are labeled with indexes and each ENTRY makes
212  * up a row. Rows may be addressed within the table by selecting one
213  * or more indexes, and values for those indexes. Each row which has
214  * a value for the given index that matches the desired value is returned.
215  * Within the definition of each column there is a flags variable, this
216  * variable contains flags which determine whether or not the column is
217  * searchable, contains binary data, and access rights for the entry objects
218  * column value. 
219  */
220
221 const TA_BINARY     = 1;        /* Means table data is binary           */
222 const TA_CRYPT      = 2;        /* Means value should be encrypted      */
223 const TA_XDR        = 4;        /* Means value is XDR encoded           */
224 const TA_SEARCHABLE = 8;        /* Means this column is searchable      */
225 const TA_CASE       = 16;       /* Means this column is Case Sensitive  */
226 const TA_MODIFIED   = 32;       /* Means this columns attrs are modified*/
227 const TA_ASN1       = 64;       /* Means contents use ASN.1 encoding     */
228
229 struct table_col {
230         string  tc_name<64>;    /* Column Name             */
231         u_long  tc_flags;       /* control flags           */
232         u_long  tc_rights;      /* Access rights mask      */
233 };
234
235 struct table_obj {
236         string    ta_type<64>;   /* Table type such as "passwd" */
237         int       ta_maxcol;     /* Total number of columns     */
238         u_char    ta_sep;        /* Separator character         */
239         table_col ta_cols<>;     /* The number of table indexes */
240         string    ta_path<>;     /* A search path for this table */
241 };
242
243 /*
244  * This union joins together all of the currently known objects. 
245  */
246 union objdata switch (zotypes zo_type) {
247         case NIS_DIRECTORY_OBJ :
248                 struct directory_obj di_data;
249         case NIS_GROUP_OBJ :
250                 struct group_obj gr_data;
251         case NIS_TABLE_OBJ :
252                 struct table_obj ta_data;
253         case NIS_ENTRY_OBJ:
254                 struct entry_obj en_data;
255         case NIS_LINK_OBJ :
256                 struct link_obj li_data;
257         case NIS_PRIVATE_OBJ :
258                 opaque  po_data<>;
259         case NIS_NO_OBJ :
260                 void;
261         case NIS_BOGUS_OBJ :
262                 void;
263         default :
264                 void;
265 };
266
267 /*
268  * This is the basic NIS object data type. It consists of a generic part
269  * which all objects contain, and a specialized part which varies depending
270  * on the type of the object. All of the specialized sections have been
271  * described above. You might have wondered why they all start with an 
272  * integer size, followed by the useful data. The answer is, when the 
273  * server doesn't recognize the type returned it treats it as opaque data. 
274  * And the definition for opaque data is {int size; char *data;}. In this
275  * way, servers and utility routines that do not understand a given type
276  * may still pass it around. One has to be careful in setting
277  * this variable accurately, it must take into account such things as
278  * XDR padding of structures etc. The best way to set it is to note one's
279  * position in the XDR encoding stream, encode the structure, look at the
280  * new position and calculate the size. 
281  */
282 struct nis_oid {
283         u_long  ctime;          /* Time of objects creation     */
284         u_long  mtime;          /* Time of objects modification */
285 };
286
287 struct nis_object {
288         nis_oid  zo_oid;        /* object identity verifier.            */ 
289         nis_name zo_name;       /* The NIS name for this object         */
290         nis_name zo_owner;      /* NIS name of object owner.            */
291         nis_name zo_group;      /* NIS name of access group.            */
292         nis_name zo_domain;     /* The administrator for the object     */
293         u_long   zo_access;     /* Access rights (owner, group, world)  */
294         u_long   zo_ttl;        /* Object's time to live in seconds.    */
295         objdata  zo_data;       /* Data structure for this type         */
296 };
297 #if RPC_HDR
298 %
299 %#endif /* if __nis_object_h */
300 %
301 #endif