include/rpcsvc/nis_object.x

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