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  * $FreeBSD: src/include/rpcsvc/ypxfrd.x,v 1.7 1999/08/27 23:45:13 peter Exp $
  33  */
  34
  35 /*
  36  * This protocol definition file describes a file transfer
  37  * system used to very quickly move NIS maps from one host to
  38  * another. This is similar to what Sun does with their ypxfrd
  39  * protocol, but it must be stressed that this protocol is _NOT_
  40  * compatible with Sun's. There are a couple of reasons for this:
  41  *
  42  * 1) Sun's protocol is proprietary. The protocol definition is
  43  *    not freely available in any of the SunRPC source distributions,
  44  *    even though the NIS v2 protocol is.
  45  *
  46  * 2) The idea here is to transfer entire raw files rather than
  47  *    sending just the records. Sun uses ndbm for its NIS map files,
  48  *    while FreeBSD uses Berkeley DB. Both are hash databases, but the
  49  *    formats are incompatible, making it impossible for them to
  50  *    use each others' files. Even if FreeBSD adopted ndbm for its
  51  *    database format, FreeBSD/i386 is a little-endian OS and
  52  *    SunOS/SPARC is big-endian; ndbm is byte-order sensitive and
  53  *    not very smart about it, which means an attempt to read a
  54  *    database on a little-endian box that was created on a big-endian
  55  *    box (or vice-versa) can cause the ndbm code to eat itself.
  56  *    Luckily, Berkeley DB is able to deal with this situation in
  57  *    a more graceful manner.
  58  *
  59  * While the protocol is incompatible, the idea is the same: we just open
  60  * up a TCP pipe to the client and transfer the raw map database
  61  * from the master server to the slave. This is many times faster than
  62  * the standard yppush/ypxfr transfer method since it saves us from
  63  * having to recreate the map databases via the DB library each time.
  64  * For example: creating a passwd database with 30,000 entries with yp_mkdb
  65  * can take a couple of minutes, but to just copy the file takes only a few
  66  * seconds.
  67  */
  68
  69 #ifndef RPC_HDR
  70 %#ifndef lint
  71 %static const char rcsid[] =
  72 %  "$FreeBSD: src/include/rpcsvc/ypxfrd.x,v 1.7 1999/08/27 23:45:13 peter Exp $";
  73 %#endif /* not lint */
  74 #endif
  75
  76 /* XXX cribbed from yp.x */
  77 const _YPMAXRECORD = 1024;
  78 const _YPMAXDOMAIN = 64;
  79 const _YPMAXMAP = 64;
  80 const _YPMAXPEER = 64;
  81
  82 /* Suggested default -- not necesarrily the one used. */
  83 const YPXFRBLOCK = 32767;
  84
  85 /*
  86  * Possible return codes from the remote server.
  87  */
  88 enum xfrstat {
  89         XFR_REQUEST_OK  = 1,    /* Transfer request granted */
  90         XFR_DENIED      = 2,    /* Transfer request denied */
  91         XFR_NOFILE      = 3,    /* Requested map file doesn't exist */
  92         XFR_ACCESS      = 4,    /* File exists, but I couldn't access it */
  93         XFR_BADDB       = 5,    /* File is not a hash database */
  94         XFR_READ_OK     = 6,    /* Block read successfully */
  95         XFR_READ_ERR    = 7,    /* Read error during transfer */
  96         XFR_DONE        = 8,    /* Transfer completed */
  97         XFR_DB_ENDIAN_MISMATCH  = 9,    /* Database byte order mismatch */
  98         XFR_DB_TYPE_MISMATCH    = 10    /* Database type mismatch */
  99 };
 100
 101 /*
 102  * Database type specifications. The client can use this to ask
 103  * the server for a particular type of database or just take whatever
 104  * the server has to offer.
 105  */
 106 enum xfr_db_type {
 107         XFR_DB_ASCII            = 1,    /* Flat ASCII text */
 108         XFR_DB_BSD_HASH         = 2,    /* Berkeley DB, hash method */
 109         XFR_DB_BSD_BTREE        = 3,    /* Berkeley DB, btree method */
 110         XFR_DB_BSD_RECNO        = 4,    /* Berkeley DB, recno method */
 111         XFR_DB_BSD_MPOOL        = 5,    /* Berkeley DB, mpool method */
 112         XFR_DB_BSD_NDBM         = 6,    /* Berkeley DB, hash, ndbm compat */
 113         XFR_DB_GNU_GDBM         = 7,    /* GNU GDBM */
 114         XFR_DB_DBM              = 8,    /* Old, deprecated dbm format */
 115         XFR_DB_NDBM             = 9,    /* ndbm format (used by Sun's NISv2) */
 116         XFR_DB_OPAQUE           = 10,   /* Mystery format -- just pass along */
 117         XFR_DB_ANY              = 11,   /* I'll take any format you've got */
 118         XFR_DB_UNKNOWN          = 12    /* Unknown format */
 119 };
 120
 121 /*
 122  * Machine byte order specification. This allows the client to check
 123  * that it's copying a map database from a machine of similar byte sex.
 124  * This is necessary for handling database libraries that are fatally
 125  * byte order sensitive.
 126  *
 127  * The XFR_ENDIAN_ANY type is for use with the Berkeley DB database
 128  * formats; Berkeley DB is smart enough to make up for byte order
 129  * differences, so byte sex isn't important.
 130  */
 131 enum xfr_byte_order {
 132         XFR_ENDIAN_BIG          = 1,    /* We want big endian */
 133         XFR_ENDIAN_LITTLE       = 2,    /* We want little endian */
 134         XFR_ENDIAN_ANY          = 3     /* We'll take whatever you got */
 135 };
 136
 137 typedef string xfrdomain<_YPMAXDOMAIN>;
 138 typedef string xfrmap<_YPMAXMAP>;
 139 typedef string xfrmap_filename<_YPMAXMAP>;      /* actual name of map file */
 140
 141 /*
 142  * Ask the remote ypxfrd for a map using this structure.
 143  * Note: we supply both a map name and a map file name. These are not
 144  * the same thing. In the case of ndbm, maps are stored in two files:
 145  * map.bykey.pag and may.bykey.dir. We may also have to deal with
 146  * file extensions (on the off chance that the remote server is supporting
 147  * multiple DB formats). To handle this, we tell the remote server both
 148  * what map we want and, in the case of ndbm, whether we want the .dir
 149  * or the .pag part. This name should not be a fully qualified path:
 150  * it's up to the remote server to decide which directories to look in.
 151  */
 152 struct ypxfr_mapname {
 153         xfrmap xfrmap;
 154         xfrdomain xfrdomain;
 155         xfrmap_filename xfrmap_filename;
 156         xfr_db_type xfr_db_type;
 157         xfr_byte_order xfr_byte_order;
 158 };
 159
 160 /* Read response using this structure. */
 161 union xfr switch (bool ok) {
 162 case TRUE:
 163         opaque xfrblock_buf<>;
 164 case FALSE:
 165         xfrstat xfrstat;
 166 };
 167
 168 program YPXFRD_FREEBSD_PROG {
 169         version YPXFRD_FREEBSD_VERS {
 170                 union xfr
 171                 YPXFRD_GETMAP(ypxfr_mapname) = 1;
 172         } = 1;
 173 } = 600100069;  /* 100069 + 60000000 -- 100069 is the Sun ypxfrd prog number */