1 /* $NetBSD: rpc_prot.c,v 1.16 2000/06/02 23:11:13 fvdl Exp $ */
4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5 * unrestricted use provided that this legend is included on all tape
6 * media and as a part of the software program in whole or part. Users
7 * may copy or modify Sun RPC without charge, but are not authorized
8 * to license or distribute it to anyone else except as part of a product or
9 * program developed by the user.
11 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
13 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
15 * Sun RPC is provided with no support and without any obligation on the
16 * part of Sun Microsystems, Inc. to assist in its use, correction,
17 * modification or enhancement.
19 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21 * OR ANY PART THEREOF.
23 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24 * or profits or other special, indirect and consequential damages, even if
25 * Sun has been advised of the possibility of such damages.
27 * Sun Microsystems, Inc.
29 * Mountain View, California 94043
32 #if defined(LIBC_SCCS) && !defined(lint)
33 static char *sccsid2 = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro";
34 static char *sccsid = "@(#)rpc_prot.c 2.3 88/08/07 4.0 RPCSRC";
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
42 * Copyright (C) 1984, Sun Microsystems, Inc.
44 * This set of routines implements the rpc message definition,
45 * its serializer and some common rpc utility routines.
46 * The routines are meant for various implementations of rpc -
47 * they are NOT for the rpc client or rpc service implementations!
48 * Because authentication stuff is easy and is part of rpc, the opaque
49 * routines are also in this program.
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/malloc.h>
57 #include <rpc/types.h>
61 #include <rpc/rpc_msg.h>
63 MALLOC_DEFINE(M_RPC, "rpc", "Remote Procedure Call");
65 #define assert(exp) KASSERT(exp, ("bad arguments"))
67 static enum clnt_stat accepted(enum accept_stat, struct rpc_err *);
68 static enum clnt_stat rejected(enum reject_stat, struct rpc_err *);
70 /* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */
72 struct opaque_auth _null_auth;
75 * XDR an opaque authentication struct
79 xdr_opaque_auth(XDR *xdrs, struct opaque_auth *ap)
85 if (xdr_enum(xdrs, &(ap->oa_flavor)))
86 return (xdr_bytes(xdrs, &ap->oa_base,
87 &ap->oa_length, MAX_AUTH_BYTES));
91 /* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */
94 * XDR the MSG_ACCEPTED part of a reply message union
97 xdr_accepted_reply(XDR *xdrs, struct accepted_reply *ar)
99 enum accept_stat *par_stat;
101 assert(xdrs != NULL);
104 par_stat = &ar->ar_stat;
106 /* personalized union, rather than calling xdr_union */
107 if (! xdr_opaque_auth(xdrs, &(ar->ar_verf)))
109 if (! xdr_enum(xdrs, (enum_t *) par_stat))
111 switch (ar->ar_stat) {
114 if (ar->ar_results.proc != (xdrproc_t) xdr_void)
115 return ((*(ar->ar_results.proc))(xdrs,
116 ar->ar_results.where));
121 if (! xdr_uint32_t(xdrs, &(ar->ar_vers.low)))
123 return (xdr_uint32_t(xdrs, &(ar->ar_vers.high)));
131 return (TRUE); /* TRUE => open ended set of problems */
135 * XDR the MSG_DENIED part of a reply message union
138 xdr_rejected_reply(XDR *xdrs, struct rejected_reply *rr)
140 enum reject_stat *prj_stat;
141 enum auth_stat *prj_why;
143 assert(xdrs != NULL);
146 prj_stat = &rr->rj_stat;
148 /* personalized union, rather than calling xdr_union */
149 if (! xdr_enum(xdrs, (enum_t *) prj_stat))
151 switch (rr->rj_stat) {
154 if (! xdr_uint32_t(xdrs, &(rr->rj_vers.low)))
156 return (xdr_uint32_t(xdrs, &(rr->rj_vers.high)));
159 prj_why = &rr->rj_why;
160 return (xdr_enum(xdrs, (enum_t *) prj_why));
167 static const struct xdr_discrim reply_dscrm[3] = {
168 { (int)MSG_ACCEPTED, (xdrproc_t)xdr_accepted_reply },
169 { (int)MSG_DENIED, (xdrproc_t)xdr_rejected_reply },
170 { __dontcare__, NULL_xdrproc_t } };
173 * XDR a reply message
176 xdr_replymsg(XDR *xdrs, struct rpc_msg *rmsg)
179 enum msg_type *prm_direction;
180 enum reply_stat *prp_stat;
182 assert(xdrs != NULL);
183 assert(rmsg != NULL);
185 if (xdrs->x_op == XDR_DECODE) {
186 buf = XDR_INLINE(xdrs, 3 * BYTES_PER_XDR_UNIT);
188 rmsg->rm_xid = IXDR_GET_UINT32(buf);
189 rmsg->rm_direction = IXDR_GET_ENUM(buf, enum msg_type);
190 if (rmsg->rm_direction != REPLY) {
193 rmsg->rm_reply.rp_stat =
194 IXDR_GET_ENUM(buf, enum reply_stat);
195 if (rmsg->rm_reply.rp_stat == MSG_ACCEPTED)
196 return (xdr_accepted_reply(xdrs,
197 &rmsg->acpted_rply));
198 else if (rmsg->rm_reply.rp_stat == MSG_DENIED)
199 return (xdr_rejected_reply(xdrs,
200 &rmsg->rjcted_rply));
206 prm_direction = &rmsg->rm_direction;
207 prp_stat = &rmsg->rm_reply.rp_stat;
210 xdr_uint32_t(xdrs, &(rmsg->rm_xid)) &&
211 xdr_enum(xdrs, (enum_t *) prm_direction) &&
212 (rmsg->rm_direction == REPLY) )
213 return (xdr_union(xdrs, (enum_t *) prp_stat,
214 (caddr_t)(void *)&(rmsg->rm_reply.ru), reply_dscrm,
221 * Serializes the "static part" of a call message header.
222 * The fields include: rm_xid, rm_direction, rpcvers, prog, and vers.
223 * The rm_xid is not really static, but the user can easily munge on the fly.
226 xdr_callhdr(XDR *xdrs, struct rpc_msg *cmsg)
228 enum msg_type *prm_direction;
230 assert(xdrs != NULL);
231 assert(cmsg != NULL);
233 prm_direction = &cmsg->rm_direction;
235 cmsg->rm_direction = CALL;
236 cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION;
238 (xdrs->x_op == XDR_ENCODE) &&
239 xdr_uint32_t(xdrs, &(cmsg->rm_xid)) &&
240 xdr_enum(xdrs, (enum_t *) prm_direction) &&
241 xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_rpcvers)) &&
242 xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_prog)) )
243 return (xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_vers)));
247 /* ************************** Client utility routine ************* */
249 static enum clnt_stat
250 accepted(enum accept_stat acpt_stat, struct rpc_err *error)
253 assert(error != NULL);
258 error->re_status = RPC_PROGUNAVAIL;
259 return (RPC_PROGUNAVAIL);
262 error->re_status = RPC_PROGVERSMISMATCH;
263 return (RPC_PROGVERSMISMATCH);
266 return (RPC_PROCUNAVAIL);
269 return (RPC_CANTDECODEARGS);
272 return (RPC_SYSTEMERROR);
275 return (RPC_SUCCESS);
278 /* something's wrong, but we don't know what ... */
279 error->re_lb.s1 = (int32_t)MSG_ACCEPTED;
280 error->re_lb.s2 = (int32_t)acpt_stat;
284 static enum clnt_stat
285 rejected(enum reject_stat rjct_stat, struct rpc_err *error)
288 assert(error != NULL);
292 return (RPC_VERSMISMATCH);
295 return (RPC_AUTHERROR);
297 /* something's wrong, but we don't know what ... */
299 error->re_lb.s1 = (int32_t)MSG_DENIED;
300 error->re_lb.s2 = (int32_t)rjct_stat;
305 * given a reply message, fills in the error
308 _seterr_reply(struct rpc_msg *msg, struct rpc_err *error)
313 assert(error != NULL);
315 /* optimized for normal, SUCCESSful case */
316 switch (msg->rm_reply.rp_stat) {
319 if (msg->acpted_rply.ar_stat == SUCCESS) {
323 stat = accepted(msg->acpted_rply.ar_stat, error);
327 stat = rejected(msg->rjcted_rply.rj_stat, error);
332 error->re_lb.s1 = (int32_t)(msg->rm_reply.rp_stat);
335 error->re_status = stat;
339 case RPC_VERSMISMATCH:
340 error->re_vers.low = msg->rjcted_rply.rj_vers.low;
341 error->re_vers.high = msg->rjcted_rply.rj_vers.high;
345 error->re_why = msg->rjcted_rply.rj_why;
348 case RPC_PROGVERSMISMATCH:
349 error->re_vers.low = msg->acpted_rply.ar_vers.low;
350 error->re_vers.high = msg->acpted_rply.ar_vers.high;
355 case RPC_PROGNOTREGISTERED:
356 case RPC_PMAPFAILURE:
357 case RPC_UNKNOWNPROTO:
358 case RPC_UNKNOWNHOST:
359 case RPC_SYSTEMERROR:
360 case RPC_CANTDECODEARGS:
361 case RPC_PROCUNAVAIL:
362 case RPC_PROGUNAVAIL:
366 case RPC_CANTDECODERES:
367 case RPC_CANTENCODEARGS: