include/rpcsvc/ypxfrd.x

   1 /*
   2  * Copyright (c) 1995, 1996
   3  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * This protocol definition file describes a file transfer
  35  * system used to very quickly move NIS maps from one host to
  36  * another. This is similar to what Sun does with their ypxfrd
  37  * protocol, but it must be stressed that this protocol is _NOT_
  38  * compatible with Sun's. There are a couple of reasons for this:
  39  *
  40  * 1) Sun's protocol is proprietary. The protocol definition is
  41  *    not freely available in any of the SunRPC source distributions,
  42  *    even though the NIS v2 protocol is.
  43  *
  44  * 2) The idea here is to transfer entire raw files rather than
  45  *    sending just the records. Sun uses ndbm for its NIS map files,
  46  *    while FreeBSD uses Berkeley DB. Both are hash databases, but the
  47  *    formats are incompatible, making it impossible for them to
  48  *    use each others' files. Even if FreeBSD adopted ndbm for its
  49  *    database format, FreeBSD/i386 is a little-endian OS and
  50  *    SunOS/SPARC is big-endian; ndbm is byte-order sensitive and
  51  *    not very smart about it, which means an attempt to read a
  52  *    database on a little-endian box that was created on a big-endian
  53  *    box (or vice-versa) can cause the ndbm code to eat itself.
  54  *    Luckily, Berkeley DB is able to deal with this situation in
  55  *    a more graceful manner.
  56  *
  57  * While the protocol is incompatible, the idea is the same: we just open
  58  * up a TCP pipe to the client and transfer the raw map database
  59  * from the master server to the slave. This is many times faster than
  60  * the standard yppush/ypxfr transfer method since it saves us from
  61  * having to recreate the map databases via the DB library each time.
  62  * For example: creating a passwd database with 30,000 entries with yp_mkdb
  63  * can take a couple of minutes, but to just copy the file takes only a few
  64  * seconds.
  65  */
  66
  67 #ifndef RPC_HDR
  68 %#include <sys/cdefs.h>
  69 %__FBSDID("$FreeBSD$");
  70 #endif
  71
  72 /* XXX cribbed from yp.x */
  73 const _YPMAXRECORD = 1024;
  74 const _YPMAXDOMAIN = 64;
  75 const _YPMAXMAP = 64;
  76 const _YPMAXPEER = 64;
  77
  78 /* Suggested default -- not necessarily the one used. */
  79 const YPXFRBLOCK = 32767;
  80
  81 /*
  82  * Possible return codes from the remote server.
  83  */
  84 enum xfrstat {
  85         XFR_REQUEST_OK  = 1,    /* Transfer request granted */
  86         XFR_DENIED      = 2,    /* Transfer request denied */
  87         XFR_NOFILE      = 3,    /* Requested map file doesn't exist */
  88         XFR_ACCESS      = 4,    /* File exists, but I couldn't access it */
  89         XFR_BADDB       = 5,    /* File is not a hash database */
  90         XFR_READ_OK     = 6,    /* Block read successfully */
  91         XFR_READ_ERR    = 7,    /* Read error during transfer */
  92         XFR_DONE        = 8,    /* Transfer completed */
  93         XFR_DB_ENDIAN_MISMATCH  = 9,    /* Database byte order mismatch */
  94         XFR_DB_TYPE_MISMATCH    = 10    /* Database type mismatch */
  95 };
  96
  97 /*
  98  * Database type specifications. The client can use this to ask
  99  * the server for a particular type of database or just take whatever
 100  * the server has to offer.
 101  */
 102 enum xfr_db_type {
 103         XFR_DB_ASCII            = 1,    /* Flat ASCII text */
 104         XFR_DB_BSD_HASH         = 2,    /* Berkeley DB, hash method */
 105         XFR_DB_BSD_BTREE        = 3,    /* Berkeley DB, btree method */
 106         XFR_DB_BSD_RECNO        = 4,    /* Berkeley DB, recno method */
 107         XFR_DB_BSD_MPOOL        = 5,    /* Berkeley DB, mpool method */
 108         XFR_DB_BSD_NDBM         = 6,    /* Berkeley DB, hash, ndbm compat */
 109         XFR_DB_GNU_GDBM         = 7,    /* GNU GDBM */
 110         XFR_DB_DBM              = 8,    /* Old, deprecated dbm format */
 111         XFR_DB_NDBM             = 9,    /* ndbm format (used by Sun's NISv2) */
 112         XFR_DB_OPAQUE           = 10,   /* Mystery format -- just pass along */
 113         XFR_DB_ANY              = 11,   /* I'll take any format you've got */
 114         XFR_DB_UNKNOWN          = 12    /* Unknown format */
 115 };
 116
 117 /*
 118  * Machine byte order specification. This allows the client to check
 119  * that it's copying a map database from a machine of similar byte sex.
 120  * This is necessary for handling database libraries that are fatally
 121  * byte order sensitive.
 122  *
 123  * The XFR_ENDIAN_ANY type is for use with the Berkeley DB database
 124  * formats; Berkeley DB is smart enough to make up for byte order
 125  * differences, so byte sex isn't important.
 126  */
 127 enum xfr_byte_order {
 128         XFR_ENDIAN_BIG          = 1,    /* We want big endian */
 129         XFR_ENDIAN_LITTLE       = 2,    /* We want little endian */
 130         XFR_ENDIAN_ANY          = 3     /* We'll take whatever you got */
 131 };
 132
 133 typedef string xfrdomain<_YPMAXDOMAIN>;
 134 typedef string xfrmap<_YPMAXMAP>;
 135 typedef string xfrmap_filename<_YPMAXMAP>;      /* actual name of map file */
 136
 137 /*
 138  * Ask the remote ypxfrd for a map using this structure.
 139  * Note: we supply both a map name and a map file name. These are not
 140  * the same thing. In the case of ndbm, maps are stored in two files:
 141  * map.bykey.pag and may.bykey.dir. We may also have to deal with
 142  * file extensions (on the off chance that the remote server is supporting
 143  * multiple DB formats). To handle this, we tell the remote server both
 144  * what map we want and, in the case of ndbm, whether we want the .dir
 145  * or the .pag part. This name should not be a fully qualified path:
 146  * it's up to the remote server to decide which directories to look in.
 147  */
 148 struct ypxfr_mapname {
 149         xfrmap xfrmap;
 150         xfrdomain xfrdomain;
 151         xfrmap_filename xfrmap_filename;
 152         xfr_db_type xfr_db_type;
 153         xfr_byte_order xfr_byte_order;
 154 };
 155
 156 /* Read response using this structure. */
 157 union xfr switch (bool ok) {
 158 case TRUE:
 159         opaque xfrblock_buf<>;
 160 case FALSE:
 161         xfrstat xfrstat;
 162 };
 163
 164 program YPXFRD_FREEBSD_PROG {
 165         version YPXFRD_FREEBSD_VERS {
 166                 union xfr
 167                 YPXFRD_GETMAP(ypxfr_mapname) = 1;
 168         } = 1;
 169 } = 600100069;  /* 100069 + 60000000 -- 100069 is the Sun ypxfrd prog number */