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#endif
70
71/* XXX cribbed from yp.x */
72const _YPMAXRECORD = 16777216;
73const _YPMAXDOMAIN = 64;
74const _YPMAXMAP = 64;
75const _YPMAXPEER = 64;
76
77/* Suggested default -- not necessarily the one used. */
78const YPXFRBLOCK = 32767;
79
80/*
81 * Possible return codes from the remote server.
82 */
83enum xfrstat {
84	XFR_REQUEST_OK	= 1,	/* Transfer request granted */
85	XFR_DENIED	= 2,	/* Transfer request denied */
86	XFR_NOFILE	= 3,	/* Requested map file doesn't exist */
87	XFR_ACCESS	= 4,	/* File exists, but I couldn't access it */
88	XFR_BADDB	= 5,	/* File is not a hash database */
89	XFR_READ_OK	= 6,	/* Block read successfully */
90	XFR_READ_ERR	= 7,	/* Read error during transfer */
91	XFR_DONE	= 8,	/* Transfer completed */
92	XFR_DB_ENDIAN_MISMATCH	= 9,	/* Database byte order mismatch */
93	XFR_DB_TYPE_MISMATCH	= 10	/* Database type mismatch */
94};
95
96/*
97 * Database type specifications. The client can use this to ask
98 * the server for a particular type of database or just take whatever
99 * the server has to offer.
100 */
101enum xfr_db_type {
102	XFR_DB_ASCII		= 1,	/* Flat ASCII text */
103	XFR_DB_BSD_HASH		= 2,	/* Berkeley DB, hash method */
104	XFR_DB_BSD_BTREE	= 3,	/* Berkeley DB, btree method */
105	XFR_DB_BSD_RECNO	= 4,	/* Berkeley DB, recno method */
106	XFR_DB_BSD_MPOOL	= 5,	/* Berkeley DB, mpool method */
107	XFR_DB_BSD_NDBM		= 6,	/* Berkeley DB, hash, ndbm compat */
108	XFR_DB_GNU_GDBM		= 7,	/* GNU GDBM */
109	XFR_DB_DBM		= 8,	/* Old, deprecated dbm format */
110	XFR_DB_NDBM		= 9,	/* ndbm format (used by Sun's NISv2) */
111	XFR_DB_OPAQUE		= 10,	/* Mystery format -- just pass along */
112	XFR_DB_ANY		= 11,	/* I'll take any format you've got */
113	XFR_DB_UNKNOWN		= 12	/* Unknown format */
114};
115
116/*
117 * Machine byte order specification. This allows the client to check
118 * that it's copying a map database from a machine of similar byte sex.
119 * This is necessary for handling database libraries that are fatally
120 * byte order sensitive.
121 *
122 * The XFR_ENDIAN_ANY type is for use with the Berkeley DB database
123 * formats; Berkeley DB is smart enough to make up for byte order
124 * differences, so byte sex isn't important.
125 */
126enum xfr_byte_order {
127	XFR_ENDIAN_BIG		= 1,	/* We want big endian */
128	XFR_ENDIAN_LITTLE	= 2,	/* We want little endian */
129	XFR_ENDIAN_ANY		= 3	/* We'll take whatever you got */
130};
131
132typedef string xfrdomain<_YPMAXDOMAIN>;
133typedef string xfrmap<_YPMAXMAP>;
134typedef string xfrmap_filename<_YPMAXMAP>;	/* actual name of map file */
135
136/*
137 * Ask the remote ypxfrd for a map using this structure.
138 * Note: we supply both a map name and a map file name. These are not
139 * the same thing. In the case of ndbm, maps are stored in two files:
140 * map.bykey.pag and may.bykey.dir. We may also have to deal with
141 * file extensions (on the off chance that the remote server is supporting
142 * multiple DB formats). To handle this, we tell the remote server both
143 * what map we want and, in the case of ndbm, whether we want the .dir
144 * or the .pag part. This name should not be a fully qualified path:
145 * it's up to the remote server to decide which directories to look in.
146 */
147struct ypxfr_mapname {
148	xfrmap xfrmap;
149	xfrdomain xfrdomain;
150	xfrmap_filename xfrmap_filename;
151	xfr_db_type xfr_db_type;
152	xfr_byte_order xfr_byte_order;
153};
154
155/* Read response using this structure. */
156union xfr switch (bool ok) {
157case TRUE:
158	opaque xfrblock_buf<>;
159case FALSE:
160	xfrstat xfrstat;
161};
162
163program YPXFRD_FREEBSD_PROG {
164	version YPXFRD_FREEBSD_VERS {
165		union xfr
166		YPXFRD_GETMAP(ypxfr_mapname) = 1;
167	} = 1;
168} = 600100069;	/* 100069 + 60000000 -- 100069 is the Sun ypxfrd prog number */
169