rpc_prot.c revision 1.19
1 /* $NetBSD: rpc_prot.c,v 1.19 2012/03/13 21:13:45 christos Exp $ */ 2 3 /* 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. 10 * 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. 14 * 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. 18 * 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. 22 * 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. 26 * 27 * Sun Microsystems, Inc. 28 * 2550 Garcia Avenue 29 * Mountain View, California 94043 30 */ 31 32 #include <sys/cdefs.h> 33 #if defined(LIBC_SCCS) && !defined(lint) 34 #if 0 35 static char *sccsid = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro"; 36 static char *sccsid = "@(#)rpc_prot.c 2.3 88/08/07 4.0 RPCSRC"; 37 #else 38 __RCSID("$NetBSD: rpc_prot.c,v 1.19 2012/03/13 21:13:45 christos Exp $"); 39 #endif 40 #endif 41 42 /* 43 * rpc_prot.c 44 * 45 * Copyright (C) 1984, Sun Microsystems, Inc. 46 * 47 * This set of routines implements the rpc message definition, 48 * its serializer and some common rpc utility routines. 49 * The routines are meant for various implementations of rpc - 50 * they are NOT for the rpc client or rpc service implementations! 51 * Because authentication stuff is easy and is part of rpc, the opaque 52 * routines are also in this program. 53 */ 54 55 #include "namespace.h" 56 57 #include <sys/param.h> 58 59 #include <assert.h> 60 61 #include <rpc/rpc.h> 62 63 #ifdef __weak_alias 64 __weak_alias(xdr_accepted_reply,_xdr_accepted_reply) 65 __weak_alias(xdr_callhdr,_xdr_callhdr) 66 __weak_alias(xdr_des_block,_xdr_des_block) 67 __weak_alias(xdr_opaque_auth,_xdr_opaque_auth) 68 __weak_alias(xdr_rejected_reply,_xdr_rejected_reply) 69 __weak_alias(xdr_replymsg,_xdr_replymsg) 70 #endif 71 72 static void accepted __P((enum accept_stat, struct rpc_err *)); 73 static void rejected __P((enum reject_stat, struct rpc_err *)); 74 75 /* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */ 76 77 /* 78 * XDR an opaque authentication struct 79 * (see auth.h) 80 */ 81 bool_t 82 xdr_opaque_auth(xdrs, ap) 83 XDR *xdrs; 84 struct opaque_auth *ap; 85 { 86 87 _DIAGASSERT(xdrs != NULL); 88 _DIAGASSERT(ap != NULL); 89 90 if (xdr_enum(xdrs, &(ap->oa_flavor))) 91 return (xdr_bytes(xdrs, &ap->oa_base, 92 &ap->oa_length, MAX_AUTH_BYTES)); 93 return (FALSE); 94 } 95 96 /* 97 * XDR a DES block 98 */ 99 bool_t 100 xdr_des_block(xdrs, blkp) 101 XDR *xdrs; 102 des_block *blkp; 103 { 104 105 _DIAGASSERT(xdrs != NULL); 106 _DIAGASSERT(blkp != NULL); 107 108 return (xdr_opaque(xdrs, (caddr_t)(void *)blkp, 109 (u_int)sizeof(des_block))); 110 } 111 112 /* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */ 113 114 /* 115 * XDR the MSG_ACCEPTED part of a reply message union 116 */ 117 bool_t 118 xdr_accepted_reply(xdrs, ar) 119 XDR *xdrs; 120 struct accepted_reply *ar; 121 { 122 123 _DIAGASSERT(xdrs != NULL); 124 _DIAGASSERT(ar != NULL); 125 126 /* personalized union, rather than calling xdr_union */ 127 if (! xdr_opaque_auth(xdrs, &(ar->ar_verf))) 128 return (FALSE); 129 if (! xdr_enum(xdrs, (enum_t *)(void *)&(ar->ar_stat))) 130 return (FALSE); 131 switch (ar->ar_stat) { 132 133 case SUCCESS: 134 return ((*(ar->ar_results.proc))(xdrs, ar->ar_results.where)); 135 136 case PROG_MISMATCH: 137 if (! xdr_u_int32_t(xdrs, &(ar->ar_vers.low))) 138 return (FALSE); 139 return (xdr_u_int32_t(xdrs, &(ar->ar_vers.high))); 140 141 case GARBAGE_ARGS: 142 case SYSTEM_ERR: 143 case PROC_UNAVAIL: 144 case PROG_UNAVAIL: 145 break; 146 } 147 return (TRUE); /* TRUE => open ended set of problems */ 148 } 149 150 /* 151 * XDR the MSG_DENIED part of a reply message union 152 */ 153 bool_t 154 xdr_rejected_reply(xdrs, rr) 155 XDR *xdrs; 156 struct rejected_reply *rr; 157 { 158 159 _DIAGASSERT(xdrs != NULL); 160 _DIAGASSERT(rr != NULL); 161 162 /* personalized union, rather than calling xdr_union */ 163 if (! xdr_enum(xdrs, (enum_t *)(void *)&(rr->rj_stat))) 164 return (FALSE); 165 switch (rr->rj_stat) { 166 167 case RPC_MISMATCH: 168 if (! xdr_u_int32_t(xdrs, &(rr->rj_vers.low))) 169 return (FALSE); 170 return (xdr_u_int32_t(xdrs, &(rr->rj_vers.high))); 171 172 case AUTH_ERROR: 173 return (xdr_enum(xdrs, (enum_t *)(void *)&(rr->rj_why))); 174 } 175 /* NOTREACHED */ 176 return (FALSE); 177 } 178 179 static const struct xdr_discrim reply_dscrm[3] = { 180 { (int)MSG_ACCEPTED, (xdrproc_t)xdr_accepted_reply }, 181 { (int)MSG_DENIED, (xdrproc_t)xdr_rejected_reply }, 182 { __dontcare__, NULL_xdrproc_t } }; 183 184 /* 185 * XDR a reply message 186 */ 187 bool_t 188 xdr_replymsg(xdrs, rmsg) 189 XDR *xdrs; 190 struct rpc_msg *rmsg; 191 { 192 _DIAGASSERT(xdrs != NULL); 193 _DIAGASSERT(rmsg != NULL); 194 195 if ( 196 xdr_u_int32_t(xdrs, &(rmsg->rm_xid)) && 197 xdr_enum(xdrs, (enum_t *)(void *)&(rmsg->rm_direction)) && 198 (rmsg->rm_direction == REPLY) ) 199 return (xdr_union(xdrs, (enum_t *)(void *)&(rmsg->rm_reply.rp_stat), 200 (caddr_t)(void *)&(rmsg->rm_reply.ru), reply_dscrm, 201 NULL_xdrproc_t)); 202 return (FALSE); 203 } 204 205 206 /* 207 * Serializes the "static part" of a call message header. 208 * The fields include: rm_xid, rm_direction, rpcvers, prog, and vers. 209 * The rm_xid is not really static, but the user can easily munge on the fly. 210 */ 211 bool_t 212 xdr_callhdr(xdrs, cmsg) 213 XDR *xdrs; 214 struct rpc_msg *cmsg; 215 { 216 217 _DIAGASSERT(xdrs != NULL); 218 _DIAGASSERT(cmsg != NULL); 219 220 cmsg->rm_direction = CALL; 221 cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION; 222 if ( 223 (xdrs->x_op == XDR_ENCODE) && 224 xdr_u_int32_t(xdrs, &(cmsg->rm_xid)) && 225 xdr_enum(xdrs, (enum_t *)(void *)&(cmsg->rm_direction)) && 226 xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_rpcvers)) && 227 xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_prog)) ) 228 return (xdr_u_int32_t(xdrs, &(cmsg->rm_call.cb_vers))); 229 return (FALSE); 230 } 231 232 /* ************************** Client utility routine ************* */ 233 234 static void 235 accepted(acpt_stat, error) 236 enum accept_stat acpt_stat; 237 struct rpc_err *error; 238 { 239 240 _DIAGASSERT(error != NULL); 241 242 switch (acpt_stat) { 243 244 case PROG_UNAVAIL: 245 error->re_status = RPC_PROGUNAVAIL; 246 return; 247 248 case PROG_MISMATCH: 249 error->re_status = RPC_PROGVERSMISMATCH; 250 return; 251 252 case PROC_UNAVAIL: 253 error->re_status = RPC_PROCUNAVAIL; 254 return; 255 256 case GARBAGE_ARGS: 257 error->re_status = RPC_CANTDECODEARGS; 258 return; 259 260 case SYSTEM_ERR: 261 error->re_status = RPC_SYSTEMERROR; 262 return; 263 264 case SUCCESS: 265 error->re_status = RPC_SUCCESS; 266 return; 267 } 268 /* NOTREACHED */ 269 /* something's wrong, but we don't know what ... */ 270 error->re_status = RPC_FAILED; 271 error->re_lb.s1 = (int32_t)MSG_ACCEPTED; 272 error->re_lb.s2 = (int32_t)acpt_stat; 273 } 274 275 static void 276 rejected(rjct_stat, error) 277 enum reject_stat rjct_stat; 278 struct rpc_err *error; 279 { 280 281 _DIAGASSERT(error != NULL); 282 283 switch (rjct_stat) { 284 case RPC_MISMATCH: 285 error->re_status = RPC_VERSMISMATCH; 286 return; 287 288 case AUTH_ERROR: 289 error->re_status = RPC_AUTHERROR; 290 return; 291 } 292 /* something's wrong, but we don't know what ... */ 293 /* NOTREACHED */ 294 error->re_status = RPC_FAILED; 295 error->re_lb.s1 = (int32_t)MSG_DENIED; 296 error->re_lb.s2 = (int32_t)rjct_stat; 297 } 298 299 /* 300 * given a reply message, fills in the error 301 */ 302 void 303 _seterr_reply(msg, error) 304 struct rpc_msg *msg; 305 struct rpc_err *error; 306 { 307 308 _DIAGASSERT(msg != NULL); 309 _DIAGASSERT(error != NULL); 310 311 /* optimized for normal, SUCCESSful case */ 312 switch (msg->rm_reply.rp_stat) { 313 314 case MSG_ACCEPTED: 315 if (msg->acpted_rply.ar_stat == SUCCESS) { 316 error->re_status = RPC_SUCCESS; 317 return; 318 } 319 accepted(msg->acpted_rply.ar_stat, error); 320 break; 321 322 case MSG_DENIED: 323 rejected(msg->rjcted_rply.rj_stat, error); 324 break; 325 326 default: 327 error->re_status = RPC_FAILED; 328 error->re_lb.s1 = (int32_t)(msg->rm_reply.rp_stat); 329 break; 330 } 331 switch (error->re_status) { 332 333 case RPC_VERSMISMATCH: 334 error->re_vers.low = msg->rjcted_rply.rj_vers.low; 335 error->re_vers.high = msg->rjcted_rply.rj_vers.high; 336 break; 337 338 case RPC_AUTHERROR: 339 error->re_why = msg->rjcted_rply.rj_why; 340 break; 341 342 case RPC_PROGVERSMISMATCH: 343 error->re_vers.low = msg->acpted_rply.ar_vers.low; 344 error->re_vers.high = msg->acpted_rply.ar_vers.high; 345 break; 346 347 case RPC_FAILED: 348 case RPC_SUCCESS: 349 case RPC_PROGNOTREGISTERED: 350 case RPC_PMAPFAILURE: 351 case RPC_UNKNOWNPROTO: 352 case RPC_UNKNOWNHOST: 353 case RPC_SYSTEMERROR: 354 case RPC_CANTDECODEARGS: 355 case RPC_PROCUNAVAIL: 356 case RPC_PROGUNAVAIL: 357 case RPC_TIMEDOUT: 358 case RPC_CANTRECV: 359 case RPC_CANTSEND: 360 case RPC_CANTDECODERES: 361 case RPC_CANTENCODEARGS: 362 default: 363 break; 364 } 365 } 366
Indexes created Mon Sep 29 21:09:56 GMT 2025