1 /* @(#)rpc_prot.c 2.3 88/08/07 4.0 RPCSRC */
2 /*
3 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4 * unrestricted use provided that this legend is included on all tape
5 * media and as a part of the software program in whole or part. Users
6 * may copy or modify Sun RPC without charge, but are not authorized
7 * to license or distribute it to anyone else except as part of a product or
8 * program developed by the user.
9 *
10 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13 *
14 * Sun RPC is provided with no support and without any obligation on the
15 * part of Sun Microsystems, Inc. to assist in its use, correction,
16 * modification or enhancement.
17 *
18 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20 * OR ANY PART THEREOF.
21 *
22 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23 * or profits or other special, indirect and consequential damages, even if
24 * Sun has been advised of the possibility of such damages.
25 *
26 * Sun Microsystems, Inc.
27 * 2550 Garcia Avenue
28 * Mountain View, California 94043
29 */
30 #if 0
31 static char sccsid[] = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro";
32 #endif
33
34 /*
35 * rpc_prot.c
36 *
37 * Copyright (C) 1984, Sun Microsystems, Inc.
38 *
39 * This set of routines implements the rpc message definition,
40 * its serializer and some common rpc utility routines.
41 * The routines are meant for various implementations of rpc -
42 * they are NOT for the rpc client or rpc service implementations!
43 * Because authentication stuff is easy and is part of rpc, the opaque
44 * routines are also in this program.
45 */
46
47 #include <sys/param.h>
48
49 #include <rpc/rpc.h>
50
51
52 /* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */
53
54 /*
55 * XDR an opaque authentication struct
56 * (see auth.h)
57 */
58 bool_t
xdr_opaque_auth(XDR * xdrs,struct opaque_auth * ap)59 xdr_opaque_auth (XDR *xdrs, struct opaque_auth *ap)
60 {
61
62 if (xdr_enum (xdrs, &(ap->oa_flavor)))
63 return xdr_bytes (xdrs, &ap->oa_base,
64 &ap->oa_length, MAX_AUTH_BYTES);
65 return FALSE;
66 }
libc_hidden_def(xdr_opaque_auth)67 libc_hidden_def(xdr_opaque_auth)
68
69 /*
70 * XDR a DES block
71 */
72 bool_t
73 xdr_des_block (XDR *xdrs, des_block *blkp)
74 {
75 return xdr_opaque (xdrs, (caddr_t) blkp, sizeof (des_block));
76 }
77
78 /* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */
79
80 /*
81 * XDR the MSG_ACCEPTED part of a reply message union
82 */
83 bool_t
xdr_accepted_reply(XDR * xdrs,struct accepted_reply * ar)84 xdr_accepted_reply (XDR *xdrs, struct accepted_reply *ar)
85 {
86 /* personalized union, rather than calling xdr_union */
87 if (!xdr_opaque_auth (xdrs, &(ar->ar_verf)))
88 return FALSE;
89 if (!xdr_enum (xdrs, (enum_t *) & (ar->ar_stat)))
90 return FALSE;
91 switch (ar->ar_stat)
92 {
93 case SUCCESS:
94 return ((*(ar->ar_results.proc)) (xdrs, ar->ar_results.where));
95 case PROG_MISMATCH:
96 if (!xdr_u_long (xdrs, &(ar->ar_vers.low)))
97 return FALSE;
98 return (xdr_u_long (xdrs, &(ar->ar_vers.high)));
99 default:
100 return TRUE;
101 }
102 return TRUE; /* TRUE => open ended set of problems */
103 }
libc_hidden_def(xdr_accepted_reply)104 libc_hidden_def(xdr_accepted_reply)
105
106 /*
107 * XDR the MSG_DENIED part of a reply message union
108 */
109 bool_t
110 xdr_rejected_reply (XDR *xdrs, struct rejected_reply *rr)
111 {
112 /* personalized union, rather than calling xdr_union */
113 if (!xdr_enum (xdrs, (enum_t *) & (rr->rj_stat)))
114 return FALSE;
115 switch (rr->rj_stat)
116 {
117 case RPC_MISMATCH:
118 if (!xdr_u_long (xdrs, &(rr->rj_vers.low)))
119 return FALSE;
120 return xdr_u_long (xdrs, &(rr->rj_vers.high));
121
122 case AUTH_ERROR:
123 return xdr_enum (xdrs, (enum_t *) & (rr->rj_why));
124 }
125 return FALSE;
126 }
127 libc_hidden_def(xdr_rejected_reply)
128
129 static const struct xdr_discrim reply_dscrm[3] =
130 {
131 {(int) MSG_ACCEPTED, (xdrproc_t) xdr_accepted_reply},
132 {(int) MSG_DENIED, (xdrproc_t) xdr_rejected_reply},
133 {__dontcare__, NULL_xdrproc_t}};
134
135 /*
136 * XDR a reply message
137 */
138 bool_t
xdr_replymsg(XDR * xdrs,struct rpc_msg * rmsg)139 xdr_replymsg (XDR *xdrs, struct rpc_msg *rmsg)
140 {
141 if (xdr_u_long (xdrs, &(rmsg->rm_xid)) &&
142 xdr_enum (xdrs, (enum_t *) & (rmsg->rm_direction)) &&
143 (rmsg->rm_direction == REPLY))
144 return xdr_union (xdrs, (enum_t *) & (rmsg->rm_reply.rp_stat),
145 (caddr_t) & (rmsg->rm_reply.ru), reply_dscrm,
146 NULL_xdrproc_t);
147 return FALSE;
148 }
libc_hidden_def(xdr_replymsg)149 libc_hidden_def(xdr_replymsg)
150
151
152 /*
153 * Serializes the "static part" of a call message header.
154 * The fields include: rm_xid, rm_direction, rpcvers, prog, and vers.
155 * The rm_xid is not really static, but the user can easily munge on the fly.
156 */
157 bool_t
158 xdr_callhdr (XDR *xdrs, struct rpc_msg *cmsg)
159 {
160
161 cmsg->rm_direction = CALL;
162 cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION;
163 if (
164 (xdrs->x_op == XDR_ENCODE) &&
165 xdr_u_long (xdrs, &(cmsg->rm_xid)) &&
166 xdr_enum (xdrs, (enum_t *) & (cmsg->rm_direction)) &&
167 xdr_u_long (xdrs, &(cmsg->rm_call.cb_rpcvers)) &&
168 xdr_u_long (xdrs, &(cmsg->rm_call.cb_prog)))
169 return xdr_u_long (xdrs, &(cmsg->rm_call.cb_vers));
170 return FALSE;
171 }
libc_hidden_def(xdr_callhdr)172 libc_hidden_def(xdr_callhdr)
173
174 /* ************************** Client utility routine ************* */
175
176 static void
177 accepted (enum accept_stat acpt_stat,
178 struct rpc_err *error)
179 {
180 switch (acpt_stat)
181 {
182
183 case PROG_UNAVAIL:
184 error->re_status = RPC_PROGUNAVAIL;
185 return;
186
187 case PROG_MISMATCH:
188 error->re_status = RPC_PROGVERSMISMATCH;
189 return;
190
191 case PROC_UNAVAIL:
192 error->re_status = RPC_PROCUNAVAIL;
193 return;
194
195 case GARBAGE_ARGS:
196 error->re_status = RPC_CANTDECODEARGS;
197 return;
198
199 case SYSTEM_ERR:
200 error->re_status = RPC_SYSTEMERROR;
201 return;
202
203 case SUCCESS:
204 error->re_status = RPC_SUCCESS;
205 return;
206 }
207 /* something's wrong, but we don't know what ... */
208 error->re_status = RPC_FAILED;
209 error->re_lb.s1 = (long) MSG_ACCEPTED;
210 error->re_lb.s2 = (long) acpt_stat;
211 }
212
213 static void
rejected(enum reject_stat rjct_stat,struct rpc_err * error)214 rejected (enum reject_stat rjct_stat,
215 struct rpc_err *error)
216 {
217 switch (rjct_stat)
218 {
219 case RPC_MISMATCH:
220 error->re_status = RPC_VERSMISMATCH;
221 return;
222 case AUTH_ERROR:
223 error->re_status = RPC_AUTHERROR;
224 return;
225 default:
226 /* something's wrong, but we don't know what ... */
227 error->re_status = RPC_FAILED;
228 error->re_lb.s1 = (long) MSG_DENIED;
229 error->re_lb.s2 = (long) rjct_stat;
230 return;
231 }
232 }
233
234 /*
235 * given a reply message, fills in the error
236 */
237 void
_seterr_reply(struct rpc_msg * msg,struct rpc_err * error)238 _seterr_reply (struct rpc_msg *msg,
239 struct rpc_err *error)
240 {
241 /* optimized for normal, SUCCESSful case */
242 switch (msg->rm_reply.rp_stat)
243 {
244 case MSG_ACCEPTED:
245 if (msg->acpted_rply.ar_stat == SUCCESS)
246 {
247 error->re_status = RPC_SUCCESS;
248 return;
249 };
250 accepted (msg->acpted_rply.ar_stat, error);
251 break;
252
253 case MSG_DENIED:
254 rejected (msg->rjcted_rply.rj_stat, error);
255 break;
256
257 default:
258 error->re_status = RPC_FAILED;
259 error->re_lb.s1 = (long) (msg->rm_reply.rp_stat);
260 break;
261 }
262 switch (error->re_status)
263 {
264
265 case RPC_VERSMISMATCH:
266 error->re_vers.low = msg->rjcted_rply.rj_vers.low;
267 error->re_vers.high = msg->rjcted_rply.rj_vers.high;
268 break;
269
270 case RPC_AUTHERROR:
271 error->re_why = msg->rjcted_rply.rj_why;
272 break;
273
274 case RPC_PROGVERSMISMATCH:
275 error->re_vers.low = msg->acpted_rply.ar_vers.low;
276 error->re_vers.high = msg->acpted_rply.ar_vers.high;
277 break;
278 default:
279 break;
280 }
281 }
282 libc_hidden_def(_seterr_reply)
283