1177633Sdfr/* $NetBSD: rpc_prot.c,v 1.16 2000/06/02 23:11:13 fvdl Exp $ */ 2177633Sdfr 3261057Smav/*- 4261057Smav * Copyright (c) 2009, Sun Microsystems, Inc. 5261057Smav * All rights reserved. 6177633Sdfr * 7261057Smav * Redistribution and use in source and binary forms, with or without 8261057Smav * modification, are permitted provided that the following conditions are met: 9261057Smav * - Redistributions of source code must retain the above copyright notice, 10261057Smav * this list of conditions and the following disclaimer. 11261057Smav * - Redistributions in binary form must reproduce the above copyright notice, 12261057Smav * this list of conditions and the following disclaimer in the documentation 13261057Smav * and/or other materials provided with the distribution. 14261057Smav * - Neither the name of Sun Microsystems, Inc. nor the names of its 15261057Smav * contributors may be used to endorse or promote products derived 16261057Smav * from this software without specific prior written permission. 17261057Smav * 18261057Smav * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19261057Smav * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20261057Smav * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21261057Smav * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22261057Smav * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23261057Smav * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24261057Smav * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25261057Smav * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26261057Smav * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27261057Smav * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28261057Smav * POSSIBILITY OF SUCH DAMAGE. 29177633Sdfr */ 30177633Sdfr 31177633Sdfr#if defined(LIBC_SCCS) && !defined(lint) 32177633Sdfrstatic char *sccsid2 = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro"; 33177633Sdfrstatic char *sccsid = "@(#)rpc_prot.c 2.3 88/08/07 4.0 RPCSRC"; 34177633Sdfr#endif 35177633Sdfr#include <sys/cdefs.h> 36177633Sdfr__FBSDID("$FreeBSD$"); 37177633Sdfr 38177633Sdfr/* 39177633Sdfr * rpc_prot.c 40177633Sdfr * 41177633Sdfr * Copyright (C) 1984, Sun Microsystems, Inc. 42177633Sdfr * 43177633Sdfr * This set of routines implements the rpc message definition, 44177633Sdfr * its serializer and some common rpc utility routines. 45177633Sdfr * The routines are meant for various implementations of rpc - 46177633Sdfr * they are NOT for the rpc client or rpc service implementations! 47177633Sdfr * Because authentication stuff is easy and is part of rpc, the opaque 48177633Sdfr * routines are also in this program. 49177633Sdfr */ 50177633Sdfr 51177633Sdfr#include <sys/param.h> 52177633Sdfr#include <sys/systm.h> 53177633Sdfr#include <sys/kernel.h> 54177633Sdfr#include <sys/malloc.h> 55177633Sdfr 56177633Sdfr#include <rpc/types.h> 57177633Sdfr#include <rpc/xdr.h> 58177633Sdfr#include <rpc/auth.h> 59177633Sdfr#include <rpc/clnt.h> 60177633Sdfr#include <rpc/rpc_msg.h> 61177633Sdfr 62177633SdfrMALLOC_DEFINE(M_RPC, "rpc", "Remote Procedure Call"); 63177633Sdfr 64177633Sdfr#define assert(exp) KASSERT(exp, ("bad arguments")) 65177633Sdfr 66184588Sdfrstatic enum clnt_stat accepted(enum accept_stat, struct rpc_err *); 67184588Sdfrstatic enum clnt_stat rejected(enum reject_stat, struct rpc_err *); 68177633Sdfr 69177633Sdfr/* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */ 70177633Sdfr 71177633Sdfrstruct opaque_auth _null_auth; 72177633Sdfr 73177633Sdfr/* 74177633Sdfr * XDR an opaque authentication struct 75177633Sdfr * (see auth.h) 76177633Sdfr */ 77177633Sdfrbool_t 78177633Sdfrxdr_opaque_auth(XDR *xdrs, struct opaque_auth *ap) 79177633Sdfr{ 80177633Sdfr 81177633Sdfr assert(xdrs != NULL); 82177633Sdfr assert(ap != NULL); 83177633Sdfr 84177633Sdfr if (xdr_enum(xdrs, &(ap->oa_flavor))) 85177633Sdfr return (xdr_bytes(xdrs, &ap->oa_base, 86177633Sdfr &ap->oa_length, MAX_AUTH_BYTES)); 87177633Sdfr return (FALSE); 88177633Sdfr} 89177633Sdfr 90177633Sdfr/* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */ 91177633Sdfr 92177633Sdfr/* 93177633Sdfr * XDR the MSG_ACCEPTED part of a reply message union 94177633Sdfr */ 95177633Sdfrbool_t 96177633Sdfrxdr_accepted_reply(XDR *xdrs, struct accepted_reply *ar) 97177633Sdfr{ 98177633Sdfr enum accept_stat *par_stat; 99177633Sdfr 100177633Sdfr assert(xdrs != NULL); 101177633Sdfr assert(ar != NULL); 102177633Sdfr 103177633Sdfr par_stat = &ar->ar_stat; 104177633Sdfr 105177633Sdfr /* personalized union, rather than calling xdr_union */ 106177633Sdfr if (! xdr_opaque_auth(xdrs, &(ar->ar_verf))) 107177633Sdfr return (FALSE); 108177633Sdfr if (! xdr_enum(xdrs, (enum_t *) par_stat)) 109177633Sdfr return (FALSE); 110177633Sdfr switch (ar->ar_stat) { 111177633Sdfr 112177633Sdfr case SUCCESS: 113184588Sdfr if (ar->ar_results.proc != (xdrproc_t) xdr_void) 114184588Sdfr return ((*(ar->ar_results.proc))(xdrs, 115184588Sdfr ar->ar_results.where)); 116184588Sdfr else 117184588Sdfr return (TRUE); 118177633Sdfr 119177633Sdfr case PROG_MISMATCH: 120177633Sdfr if (! xdr_uint32_t(xdrs, &(ar->ar_vers.low))) 121177633Sdfr return (FALSE); 122177633Sdfr return (xdr_uint32_t(xdrs, &(ar->ar_vers.high))); 123177633Sdfr 124177633Sdfr case GARBAGE_ARGS: 125177633Sdfr case SYSTEM_ERR: 126177633Sdfr case PROC_UNAVAIL: 127177633Sdfr case PROG_UNAVAIL: 128177633Sdfr break; 129177633Sdfr } 130177633Sdfr return (TRUE); /* TRUE => open ended set of problems */ 131177633Sdfr} 132177633Sdfr 133177633Sdfr/* 134177633Sdfr * XDR the MSG_DENIED part of a reply message union 135177633Sdfr */ 136177633Sdfrbool_t 137177633Sdfrxdr_rejected_reply(XDR *xdrs, struct rejected_reply *rr) 138177633Sdfr{ 139177633Sdfr enum reject_stat *prj_stat; 140177633Sdfr enum auth_stat *prj_why; 141177633Sdfr 142177633Sdfr assert(xdrs != NULL); 143177633Sdfr assert(rr != NULL); 144177633Sdfr 145177633Sdfr prj_stat = &rr->rj_stat; 146177633Sdfr 147177633Sdfr /* personalized union, rather than calling xdr_union */ 148177633Sdfr if (! xdr_enum(xdrs, (enum_t *) prj_stat)) 149177633Sdfr return (FALSE); 150177633Sdfr switch (rr->rj_stat) { 151177633Sdfr 152177633Sdfr case RPC_MISMATCH: 153177633Sdfr if (! xdr_uint32_t(xdrs, &(rr->rj_vers.low))) 154177633Sdfr return (FALSE); 155177633Sdfr return (xdr_uint32_t(xdrs, &(rr->rj_vers.high))); 156177633Sdfr 157177633Sdfr case AUTH_ERROR: 158177633Sdfr prj_why = &rr->rj_why; 159177633Sdfr return (xdr_enum(xdrs, (enum_t *) prj_why)); 160177633Sdfr } 161177633Sdfr /* NOTREACHED */ 162177633Sdfr assert(0); 163177633Sdfr return (FALSE); 164177633Sdfr} 165177633Sdfr 166177633Sdfrstatic const struct xdr_discrim reply_dscrm[3] = { 167177633Sdfr { (int)MSG_ACCEPTED, (xdrproc_t)xdr_accepted_reply }, 168177633Sdfr { (int)MSG_DENIED, (xdrproc_t)xdr_rejected_reply }, 169177633Sdfr { __dontcare__, NULL_xdrproc_t } }; 170177633Sdfr 171177633Sdfr/* 172177633Sdfr * XDR a reply message 173177633Sdfr */ 174177633Sdfrbool_t 175177633Sdfrxdr_replymsg(XDR *xdrs, struct rpc_msg *rmsg) 176177633Sdfr{ 177184588Sdfr int32_t *buf; 178177633Sdfr enum msg_type *prm_direction; 179177633Sdfr enum reply_stat *prp_stat; 180177633Sdfr 181177633Sdfr assert(xdrs != NULL); 182177633Sdfr assert(rmsg != NULL); 183177633Sdfr 184184588Sdfr if (xdrs->x_op == XDR_DECODE) { 185184588Sdfr buf = XDR_INLINE(xdrs, 3 * BYTES_PER_XDR_UNIT); 186184588Sdfr if (buf != NULL) { 187184588Sdfr rmsg->rm_xid = IXDR_GET_UINT32(buf); 188184588Sdfr rmsg->rm_direction = IXDR_GET_ENUM(buf, enum msg_type); 189184588Sdfr if (rmsg->rm_direction != REPLY) { 190184588Sdfr return (FALSE); 191184588Sdfr } 192184588Sdfr rmsg->rm_reply.rp_stat = 193184588Sdfr IXDR_GET_ENUM(buf, enum reply_stat); 194184588Sdfr if (rmsg->rm_reply.rp_stat == MSG_ACCEPTED) 195184588Sdfr return (xdr_accepted_reply(xdrs, 196184588Sdfr &rmsg->acpted_rply)); 197184588Sdfr else if (rmsg->rm_reply.rp_stat == MSG_DENIED) 198184588Sdfr return (xdr_rejected_reply(xdrs, 199184588Sdfr &rmsg->rjcted_rply)); 200184588Sdfr else 201184588Sdfr return (FALSE); 202184588Sdfr } 203184588Sdfr } 204184588Sdfr 205177633Sdfr prm_direction = &rmsg->rm_direction; 206177633Sdfr prp_stat = &rmsg->rm_reply.rp_stat; 207177633Sdfr 208177633Sdfr if ( 209177633Sdfr xdr_uint32_t(xdrs, &(rmsg->rm_xid)) && 210177633Sdfr xdr_enum(xdrs, (enum_t *) prm_direction) && 211177633Sdfr (rmsg->rm_direction == REPLY) ) 212177633Sdfr return (xdr_union(xdrs, (enum_t *) prp_stat, 213177633Sdfr (caddr_t)(void *)&(rmsg->rm_reply.ru), reply_dscrm, 214177633Sdfr NULL_xdrproc_t)); 215177633Sdfr return (FALSE); 216177633Sdfr} 217177633Sdfr 218177633Sdfr 219177633Sdfr/* 220177633Sdfr * Serializes the "static part" of a call message header. 221177633Sdfr * The fields include: rm_xid, rm_direction, rpcvers, prog, and vers. 222177633Sdfr * The rm_xid is not really static, but the user can easily munge on the fly. 223177633Sdfr */ 224177633Sdfrbool_t 225177633Sdfrxdr_callhdr(XDR *xdrs, struct rpc_msg *cmsg) 226177633Sdfr{ 227177633Sdfr enum msg_type *prm_direction; 228177633Sdfr 229177633Sdfr assert(xdrs != NULL); 230177633Sdfr assert(cmsg != NULL); 231177633Sdfr 232177633Sdfr prm_direction = &cmsg->rm_direction; 233177633Sdfr 234177633Sdfr cmsg->rm_direction = CALL; 235177633Sdfr cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION; 236177633Sdfr if ( 237177633Sdfr (xdrs->x_op == XDR_ENCODE) && 238177633Sdfr xdr_uint32_t(xdrs, &(cmsg->rm_xid)) && 239177633Sdfr xdr_enum(xdrs, (enum_t *) prm_direction) && 240177633Sdfr xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_rpcvers)) && 241177633Sdfr xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_prog)) ) 242177633Sdfr return (xdr_uint32_t(xdrs, &(cmsg->rm_call.cb_vers))); 243177633Sdfr return (FALSE); 244177633Sdfr} 245177633Sdfr 246177633Sdfr/* ************************** Client utility routine ************* */ 247177633Sdfr 248184588Sdfrstatic enum clnt_stat 249177633Sdfraccepted(enum accept_stat acpt_stat, struct rpc_err *error) 250177633Sdfr{ 251177633Sdfr 252177633Sdfr assert(error != NULL); 253177633Sdfr 254177633Sdfr switch (acpt_stat) { 255177633Sdfr 256177633Sdfr case PROG_UNAVAIL: 257177633Sdfr error->re_status = RPC_PROGUNAVAIL; 258184588Sdfr return (RPC_PROGUNAVAIL); 259177633Sdfr 260177633Sdfr case PROG_MISMATCH: 261177633Sdfr error->re_status = RPC_PROGVERSMISMATCH; 262184588Sdfr return (RPC_PROGVERSMISMATCH); 263177633Sdfr 264177633Sdfr case PROC_UNAVAIL: 265184588Sdfr return (RPC_PROCUNAVAIL); 266177633Sdfr 267177633Sdfr case GARBAGE_ARGS: 268184588Sdfr return (RPC_CANTDECODEARGS); 269177633Sdfr 270177633Sdfr case SYSTEM_ERR: 271184588Sdfr return (RPC_SYSTEMERROR); 272177633Sdfr 273177633Sdfr case SUCCESS: 274184588Sdfr return (RPC_SUCCESS); 275177633Sdfr } 276177633Sdfr /* NOTREACHED */ 277177633Sdfr /* something's wrong, but we don't know what ... */ 278177633Sdfr error->re_lb.s1 = (int32_t)MSG_ACCEPTED; 279177633Sdfr error->re_lb.s2 = (int32_t)acpt_stat; 280184588Sdfr return (RPC_FAILED); 281177633Sdfr} 282177633Sdfr 283184588Sdfrstatic enum clnt_stat 284177633Sdfrrejected(enum reject_stat rjct_stat, struct rpc_err *error) 285177633Sdfr{ 286177633Sdfr 287177633Sdfr assert(error != NULL); 288177633Sdfr 289177633Sdfr switch (rjct_stat) { 290177633Sdfr case RPC_MISMATCH: 291184588Sdfr return (RPC_VERSMISMATCH); 292177633Sdfr 293177633Sdfr case AUTH_ERROR: 294184588Sdfr return (RPC_AUTHERROR); 295177633Sdfr } 296177633Sdfr /* something's wrong, but we don't know what ... */ 297177633Sdfr /* NOTREACHED */ 298177633Sdfr error->re_lb.s1 = (int32_t)MSG_DENIED; 299177633Sdfr error->re_lb.s2 = (int32_t)rjct_stat; 300184588Sdfr return (RPC_FAILED); 301177633Sdfr} 302177633Sdfr 303177633Sdfr/* 304177633Sdfr * given a reply message, fills in the error 305177633Sdfr */ 306184588Sdfrenum clnt_stat 307177633Sdfr_seterr_reply(struct rpc_msg *msg, struct rpc_err *error) 308177633Sdfr{ 309184588Sdfr enum clnt_stat stat; 310177633Sdfr 311177633Sdfr assert(msg != NULL); 312177633Sdfr assert(error != NULL); 313177633Sdfr 314177633Sdfr /* optimized for normal, SUCCESSful case */ 315177633Sdfr switch (msg->rm_reply.rp_stat) { 316177633Sdfr 317177633Sdfr case MSG_ACCEPTED: 318177633Sdfr if (msg->acpted_rply.ar_stat == SUCCESS) { 319184588Sdfr stat = RPC_SUCCESS; 320184588Sdfr return (stat); 321177633Sdfr } 322184588Sdfr stat = accepted(msg->acpted_rply.ar_stat, error); 323177633Sdfr break; 324177633Sdfr 325177633Sdfr case MSG_DENIED: 326184588Sdfr stat = rejected(msg->rjcted_rply.rj_stat, error); 327177633Sdfr break; 328177633Sdfr 329177633Sdfr default: 330184588Sdfr stat = RPC_FAILED; 331177633Sdfr error->re_lb.s1 = (int32_t)(msg->rm_reply.rp_stat); 332177633Sdfr break; 333177633Sdfr } 334184588Sdfr error->re_status = stat; 335177633Sdfr 336184588Sdfr switch (stat) { 337184588Sdfr 338177633Sdfr case RPC_VERSMISMATCH: 339177633Sdfr error->re_vers.low = msg->rjcted_rply.rj_vers.low; 340177633Sdfr error->re_vers.high = msg->rjcted_rply.rj_vers.high; 341177633Sdfr break; 342177633Sdfr 343177633Sdfr case RPC_AUTHERROR: 344177633Sdfr error->re_why = msg->rjcted_rply.rj_why; 345177633Sdfr break; 346177633Sdfr 347177633Sdfr case RPC_PROGVERSMISMATCH: 348177633Sdfr error->re_vers.low = msg->acpted_rply.ar_vers.low; 349177633Sdfr error->re_vers.high = msg->acpted_rply.ar_vers.high; 350177633Sdfr break; 351177633Sdfr 352177633Sdfr case RPC_FAILED: 353177633Sdfr case RPC_SUCCESS: 354177633Sdfr case RPC_PROGNOTREGISTERED: 355177633Sdfr case RPC_PMAPFAILURE: 356177633Sdfr case RPC_UNKNOWNPROTO: 357177633Sdfr case RPC_UNKNOWNHOST: 358177633Sdfr case RPC_SYSTEMERROR: 359177633Sdfr case RPC_CANTDECODEARGS: 360177633Sdfr case RPC_PROCUNAVAIL: 361177633Sdfr case RPC_PROGUNAVAIL: 362177633Sdfr case RPC_TIMEDOUT: 363177633Sdfr case RPC_CANTRECV: 364177633Sdfr case RPC_CANTSEND: 365177633Sdfr case RPC_CANTDECODERES: 366177633Sdfr case RPC_CANTENCODEARGS: 367177633Sdfr default: 368177633Sdfr break; 369177633Sdfr } 370184588Sdfr 371184588Sdfr return (stat); 372177633Sdfr} 373