]> git.saurik.com Git - apple/libinfo.git/blame - nis.subproj/yp_prot.h
Libinfo-406.17.tar.gz
[apple/libinfo.git] / nis.subproj / yp_prot.h
CommitLineData
03fb6eb0 1/*
e44d8d47 2 * Copyright (c) 1992/3 Theo de Raadt <deraadt@fsa.ca>
03fb6eb0
A
3 * 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.
e44d8d47
A
13 * 3. The name of the author may not be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
03fb6eb0
A
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
e44d8d47
A
28 *
29 * $FreeBSD: src/include/rpcsvc/yp_prot.h,v 1.13 2005/12/06 02:01:06 peter Exp $
03fb6eb0
A
30 */
31
32#ifndef _RPCSVC_YP_PROT_H_
33#define _RPCSVC_YP_PROT_H_
34
35/*
36 * YPSERV PROTOCOL:
e44d8d47 37 *
03fb6eb0 38 * ypserv supports the following procedures:
e44d8d47 39 *
03fb6eb0
A
40 * YPPROC_NULL takes (void), returns (void).
41 * called to check if server is alive.
42 * YPPROC_DOMAIN takes (char *), returns (bool_t).
43 * true if ypserv serves the named domain.
44 * YPPROC_DOMAIN_NOACK takes (char *), returns (bool_t).
45 * true if ypserv serves the named domain.
46 * used for broadcasts, does not ack if ypserv
47 * doesn't handle named domain.
48 * YPPROC_MATCH takes (struct ypreq_key), returns (struct ypresp_val)
49 * does a lookup.
50 * YPPROC_FIRST takes (struct ypreq_nokey) returns (ypresp_key_val).
51 * gets the first key/datum from the map.
52 * YPPROC_NEXT takes (struct ypreq_key) returns (ypresp_key_val).
53 * gets the next key/datum from the map.
54 * YPPROC_XFR takes (struct ypreq_xfr), returns (void).
55 * tells ypserv to check if there is a new version of
56 * the map.
57 * YPPROC_CLEAR takes (void), returns (void).
58 * tells ypserv to flush it's file cache, so that
59 * newly transferred files will get read.
60 * YPPROC_ALL takes (struct ypreq_nokey), returns (bool_t and
61 * struct ypresp_key_val).
62 * returns an array of data, with the bool_t being
63 * false on the last datum. read the source, it's
64 * convoluted.
65 * YPPROC_MASTER takes (struct ypreq_nokey), returns (ypresp_master).
66 * YPPROC_ORDER takes (struct ypreq_nokey), returns (ypresp_order).
67 * YPPROC_MAPLIST takes (char *), returns (struct ypmaplist *).
68 */
69
03fb6eb0 70/* Program and version symbols, magic numbers */
e44d8d47
A
71
72#define YPPROG ((u_long)100004)
73#define YPVERS ((u_long)2)
74#define YPVERS_ORIG ((u_long)1)
75#define YPMAXRECORD ((u_long)1024)
76#define YPMAXDOMAIN ((u_long)64)
77#define YPMAXMAP ((u_long)64)
78#define YPMAXPEER ((u_long)256)
03fb6eb0
A
79
80/*
81 * I don't know if anything of sun's depends on this, or if they
82 * simply defined it so that their own code wouldn't try to send
83 * packets over the ethernet MTU. This YP code doesn't use it.
84 */
85#define YPMSGSZ 1600
86
87#ifndef DATUM
88typedef struct {
e44d8d47
A
89 char *dptr;
90 int dsize;
03fb6eb0
A
91} datum;
92#define DATUM
93#endif
94
95struct ypmap_parms {
e44d8d47
A
96 char *domain;
97 char *map;
98 u_int ordernum;
03fb6eb0
A
99 char *owner;
100};
101
102struct ypreq_key {
e44d8d47
A
103 char *domain;
104 char *map;
03fb6eb0
A
105 datum keydat;
106};
107
108struct ypreq_nokey {
e44d8d47
A
109 char *domain;
110 char *map;
03fb6eb0
A
111};
112
113struct ypreq_xfr {
114 struct ypmap_parms map_parms;
e44d8d47
A
115 u_int transid;
116 u_int proto;
117 u_int port;
03fb6eb0
A
118};
119#define ypxfr_domain map_parms.domain
120#define ypxfr_map map_parms.map
121#define ypxfr_ordernum map_parms.ordernum
122#define ypxfr_owner map_parms.owner
123
124struct ypresp_val {
e44d8d47 125 u_int status;
03fb6eb0
A
126 datum valdat;
127};
128
129struct ypresp_key_val {
e44d8d47 130 u_int status;
03fb6eb0
A
131 datum keydat;
132 datum valdat;
133};
134
135struct ypresp_master {
e44d8d47 136 u_int status;
03fb6eb0
A
137 char *master;
138};
139
140struct ypresp_order {
e44d8d47
A
141 u_int status;
142 u_int ordernum;
03fb6eb0
A
143};
144
145struct ypresp_all {
146 bool_t more;
147 union {
148 struct ypresp_key_val val;
149 } ypresp_all_u;
150};
151
152struct ypmaplist {
e44d8d47 153 char *ypml_name;
03fb6eb0
A
154 struct ypmaplist *ypml_next;
155};
156
157struct ypresp_maplist {
e44d8d47 158 u_int status;
03fb6eb0
A
159 struct ypmaplist *list;
160};
161
162/* ypserv procedure numbers */
e44d8d47
A
163#define YPPROC_NULL ((u_long)0)
164#define YPPROC_DOMAIN ((u_long)1)
165#define YPPROC_DOMAIN_NONACK ((u_long)2)
166#define YPPROC_MATCH ((u_long)3)
167#define YPPROC_FIRST ((u_long)4)
168#define YPPROC_NEXT ((u_long)5)
169#define YPPROC_XFR ((u_long)6)
170#define YPPROC_CLEAR ((u_long)7)
171#define YPPROC_ALL ((u_long)8)
172#define YPPROC_MASTER ((u_long)9)
173#define YPPROC_ORDER ((u_long)10)
174#define YPPROC_MAPLIST ((u_long)11)
03fb6eb0
A
175
176/* ypserv procedure return status values */
177#define YP_TRUE ((long)1) /* general purpose success code */
178#define YP_NOMORE ((long)2) /* no more entries in map */
179#define YP_FALSE ((long)0) /* general purpose failure code */
180#define YP_NOMAP ((long)-1) /* no such map in domain */
181#define YP_NODOM ((long)-2) /* domain not supported */
182#define YP_NOKEY ((long)-3) /* no such key in map */
183#define YP_BADOP ((long)-4) /* invalid operation */
184#define YP_BADDB ((long)-5) /* server data base is bad */
185#define YP_YPERR ((long)-6) /* YP server error */
186#define YP_BADARGS ((long)-7) /* request arguments bad */
187#define YP_VERS ((long)-8) /* YP server version mismatch */
188
189/*
190 * Sun's header file says:
191 * "Domain binding data structure, used by ypclnt package and ypserv modules.
192 * Users of the ypclnt package (or of this protocol) don't HAVE to know about
193 * it, but it must be available to users because _yp_dobind is a public
194 * interface."
e44d8d47 195 *
03fb6eb0
A
196 * This is totally bogus! Nowhere else does Sun state that _yp_dobind() is
197 * a public interface, and I don't know any reason anyone would want to call
198 * it. But, just in case anyone does actually expect it to be available..
199 * we provide this.. exactly as Sun wants it.
200 */
201struct dom_binding {
202 struct dom_binding *dom_pnext;
203 char dom_domain[YPMAXDOMAIN + 1];
204 struct sockaddr_in dom_server_addr;
e44d8d47 205 u_short dom_server_port;
03fb6eb0
A
206 int dom_socket;
207 CLIENT *dom_client;
e44d8d47 208 u_short dom_local_port;
03fb6eb0
A
209 long dom_vers;
210};
211
212/*
213 * YPBIND PROTOCOL:
e44d8d47 214 *
03fb6eb0
A
215 * ypbind supports the following procedures:
216 *
217 * YPBINDPROC_NULL takes (void), returns (void).
218 * to check if ypbind is running.
219 * YPBINDPROC_DOMAIN takes (char *), returns (struct ypbind_resp).
220 * requests that ypbind start to serve the
221 * named domain (if it doesn't already)
222 * YPBINDPROC_SETDOM takes (struct ypbind_setdom), returns (void).
223 * used by ypset.
224 */
e44d8d47
A
225
226#define YPBINDPROG ((u_long)100007)
227#define YPBINDVERS ((u_long)2)
228#define YPBINDVERS_ORIG ((u_long)1)
03fb6eb0
A
229
230/* ypbind procedure numbers */
e44d8d47
A
231#define YPBINDPROC_NULL ((u_long)0)
232#define YPBINDPROC_DOMAIN ((u_long)1)
233#define YPBINDPROC_SETDOM ((u_long)2)
03fb6eb0
A
234
235/* error code in ypbind_resp.ypbind_status */
236enum ypbind_resptype {
237 YPBIND_SUCC_VAL = 1,
238 YPBIND_FAIL_VAL = 2
239};
240
241/* network order, of course */
242struct ypbind_binding {
243 struct in_addr ypbind_binding_addr;
e44d8d47 244 u_short ypbind_binding_port;
03fb6eb0
A
245};
246
247struct ypbind_resp {
248 enum ypbind_resptype ypbind_status;
249 union {
e44d8d47 250 u_int ypbind_error;
03fb6eb0
A
251 struct ypbind_binding ypbind_bindinfo;
252 } ypbind_respbody;
253};
254
255/* error code in ypbind_resp.ypbind_respbody.ypbind_error */
256#define YPBIND_ERR_ERR 1 /* internal error */
257#define YPBIND_ERR_NOSERV 2 /* no bound server for passed domain */
258#define YPBIND_ERR_RESC 3 /* system resource allocation failure */
259
260/*
261 * Request data structure for ypbind "Set domain" procedure.
262 */
263struct ypbind_setdom {
264 char ypsetdom_domain[YPMAXDOMAIN + 1];
265 struct ypbind_binding ypsetdom_binding;
e44d8d47 266 u_int ypsetdom_vers;
03fb6eb0
A
267};
268#define ypsetdom_addr ypsetdom_binding.ypbind_binding_addr
269#define ypsetdom_port ypsetdom_binding.ypbind_binding_port
270
271/*
272 * YPPUSH PROTOCOL:
e44d8d47 273 *
03fb6eb0
A
274 * Sun says:
275 * "Protocol between clients (ypxfr, only) and yppush
276 * yppush speaks a protocol in the transient range, which
277 * is supplied to ypxfr as a command-line parameter when it
278 * is activated by ypserv."
e44d8d47
A
279 *
280 * This protocol is not implemented, naturally, because this YP
281 * implementation only does the client side.
03fb6eb0 282 */
e44d8d47
A
283#define YPPUSHVERS ((u_long)1)
284#define YPPUSHVERS_ORIG ((u_long)1)
03fb6eb0
A
285
286/* yppush procedure numbers */
e44d8d47
A
287#define YPPUSHPROC_NULL ((u_long)0)
288#define YPPUSHPROC_XFRRESP ((u_long)1)
03fb6eb0
A
289
290struct yppushresp_xfr {
e44d8d47
A
291 u_int transid;
292 u_int status;
03fb6eb0
A
293};
294
295/* yppush status value in yppushresp_xfr.status */
296#define YPPUSH_SUCC ((long)1) /* Success */
297#define YPPUSH_AGE ((long)2) /* Master's version not newer */
298#define YPPUSH_NOMAP ((long)-1) /* Can't find server for map */
299#define YPPUSH_NODOM ((long)-2) /* Domain not supported */
e44d8d47 300#define YPPUSH_RSRC ((long)-3) /* Local resource alloc failure */
03fb6eb0
A
301#define YPPUSH_RPC ((long)-4) /* RPC failure talking to server */
302#define YPPUSH_MADDR ((long)-5) /* Can't get master address */
303#define YPPUSH_YPERR ((long)-6) /* YP server/map db error */
304#define YPPUSH_BADARGS ((long)-7) /* Request arguments bad */
305#define YPPUSH_DBM ((long)-8) /* Local dbm operation failed */
306#define YPPUSH_FILE ((long)-9) /* Local file I/O operation failed */
307#define YPPUSH_SKEW ((long)-10) /* Map version skew during transfer */
308#define YPPUSH_CLEAR ((long)-11) /* Can't send "Clear" req to local ypserv */
309#define YPPUSH_FORCE ((long)-12) /* No local order number in map - use -f */
310#define YPPUSH_XFRERR ((long)-13) /* ypxfr error */
311#define YPPUSH_REFUSED ((long)-14) /* Transfer request refused by ypserv */
312
313__BEGIN_DECLS
314bool_t xdr_domainname __P((XDR *, char *));
315bool_t xdr_peername __P((XDR *, char *));
316bool_t xdr_datum __P((XDR *, datum *));
317bool_t xdr_mapname __P((XDR *, char *));
318bool_t xdr_ypreq_key __P((XDR *, struct ypreq_key *));
319bool_t xdr_ypreq_nokey __P((XDR *, struct ypreq_nokey *));
320bool_t xdr_yp_inaddr __P((XDR *, struct in_addr *));
321bool_t xdr_ypbind_binding __P((XDR *, struct ypbind_binding *));
322bool_t xdr_ypbind_resptype __P((XDR *, enum ypbind_resptype *));
323bool_t xdr_ypstat __P((XDR *, enum ypbind_resptype *));
324bool_t xdr_ypbind_resp __P((XDR *, struct ypbind_resp *));
325bool_t xdr_ypresp_val __P((XDR *, struct ypresp_val *));
326bool_t xdr_ypbind_setdom __P((XDR *, struct ypbind_setdom *));
327bool_t xdr_ypresp_key_val __P((XDR *, struct ypresp_key_val *));
328bool_t xdr_ypresp_all __P((XDR *, struct ypresp_all *));
c29f2fcc 329bool_t xdr_ypresp_all_seq __P((XDR *, unsigned long *));
03fb6eb0
A
330bool_t xdr_ypresp_master __P((XDR *, struct ypresp_master *));
331bool_t xdr_ypmaplist_str __P((XDR *, char *));
332bool_t xdr_ypmaplist __P((XDR *, struct ypmaplist *));
333bool_t xdr_ypresp_maplist __P((XDR *, struct ypresp_maplist *));
334bool_t xdr_ypresp_order __P((XDR *, struct ypresp_order *));
335__END_DECLS
336
337#endif /* _RPCSVC_YP_PROT_H_ */