rpc.subproj/svc.c

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.1 (the "License").  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  26  * unrestricted use provided that this legend is included on all tape
  27  * media and as a part of the software program in whole or part.  Users
  28  * may copy or modify Sun RPC without charge, but are not authorized
  29  * to license or distribute it to anyone else except as part of a product or
  30  * program developed by the user.
  31  *
  32  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  33  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  34  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  35  *
  36  * Sun RPC is provided with no support and without any obligation on the
  37  * part of Sun Microsystems, Inc. to assist in its use, correction,
  38  * modification or enhancement.
  39  *
  40  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  41  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  42  * OR ANY PART THEREOF.
  43  *
  44  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  45  * or profits or other special, indirect and consequential damages, even if
  46  * Sun has been advised of the possibility of such damages.
  47  *
  48  * Sun Microsystems, Inc.
  49  * 2550 Garcia Avenue
  50  * Mountain View, California  94043
  51  */
  52
  53 #if defined(LIBC_SCCS) && !defined(lint)
  54 /*static char *sccsid = "from: @(#)svc.c 1.44 88/02/08 Copyr 1984 Sun Micro";*/
  55 /*static char *sccsid = "from: @(#)svc.c        2.4 88/08/11 4.0 RPCSRC";*/
  56 static char *rcsid = "$Id: svc.c,v 1.4 2002/02/19 20:36:24 epeyton Exp $";
  57 #endif
  58
  59 /*
  60  * svc.c, Server-side remote procedure call interface.
  61  *
  62  * There are two sets of procedures here.  The xprt routines are
  63  * for handling transport handles.  The svc routines handle the
  64  * list of service routines.
  65  *
  66  * Copyright (C) 1984, Sun Microsystems, Inc.
  67  */
  68
  69 #include <stdlib.h>
  70 #include <string.h>
  71 #include <sys/errno.h>
  72 #include <rpc/rpc.h>
  73 #include <rpc/pmap_clnt.h>
  74
  75 extern int errno;
  76
  77 static SVCXPRT **xports;
  78
  79 #define NULL_SVC ((struct svc_callout *)0)
  80 #define RQCRED_SIZE     400             /* this size is excessive */
  81
  82 #define max(a, b) (a > b ? a : b)
  83
  84 /*
  85  * The services list
  86  * Each entry represents a set of procedures (an rpc program).
  87  * The dispatch routine takes request structs and runs the
  88  * apropriate procedure.
  89  */
  90 static struct svc_callout {
  91         struct svc_callout *sc_next;
  92         u_long              sc_prog;
  93         u_long              sc_vers;
  94         void                (*sc_dispatch)();
  95 } *svc_head;
  96
  97 static struct svc_callout *svc_find();
  98
  99 /* ***************  SVCXPRT related stuff **************** */
 100
 101 extern int svc_maxfd;
 102
 103 /*
 104  * Activate a transport handle.
 105  */
 106 void
 107 xprt_register(xprt)
 108         SVCXPRT *xprt;
 109 {
 110         register int sock = xprt->xp_sock;
 111
 112         if (xports == NULL) {
 113                 xports = (SVCXPRT **)
 114                         mem_alloc(FD_SETSIZE * sizeof(SVCXPRT *));
 115         }
 116         if (sock < FD_SETSIZE) {
 117                 xports[sock] = xprt;
 118                 FD_SET(sock, &svc_fdset);
 119                 svc_maxfd = max(svc_maxfd, sock);
 120         }
 121 }
 122
 123 /*
 124  * De-activate a transport handle.
 125  */
 126 void
 127 xprt_unregister(xprt)
 128         SVCXPRT *xprt;
 129 {
 130         register int sock = xprt->xp_sock;
 131
 132         if ((sock < FD_SETSIZE) && (xports[sock] == xprt)) {
 133                 xports[sock] = (SVCXPRT *)0;
 134                 FD_CLR(sock, &svc_fdset);
 135                 if (sock == svc_maxfd) {
 136                         for (svc_maxfd--; svc_maxfd>=0; svc_maxfd--)
 137                                 if (xports[svc_maxfd])
 138                                         break;
 139                 }
 140         }
 141 }
 142
 143
 144 /* ********************** CALLOUT list related stuff ************* */
 145
 146 /*
 147  * Add a service program to the callout list.
 148  * The dispatch routine will be called when a rpc request for this
 149  * program number comes in.
 150  */
 151 bool_t
 152 svc_register(xprt, prog, vers, dispatch, protocol)
 153         SVCXPRT *xprt;
 154         u_long prog;
 155         u_long vers;
 156         void (*dispatch)();
 157         int protocol;
 158 {
 159         struct svc_callout *prev;
 160         register struct svc_callout *s;
 161
 162         if ((s = svc_find(prog, vers, &prev)) != NULL_SVC) {
 163                 if (s->sc_dispatch == dispatch)
 164                         goto pmap_it;  /* he is registering another xptr */
 165                 return (FALSE);
 166         }
 167         s = (struct svc_callout *)mem_alloc(sizeof(struct svc_callout));
 168         if (s == (struct svc_callout *)0) {
 169                 return (FALSE);
 170         }
 171         s->sc_prog = prog;
 172         s->sc_vers = vers;
 173         s->sc_dispatch = dispatch;
 174         s->sc_next = svc_head;
 175         svc_head = s;
 176 pmap_it:
 177         /* now register the information with the local binder service */
 178         if (protocol) {
 179                 return (pmap_set(prog, vers, protocol, xprt->xp_port));
 180         }
 181         return (TRUE);
 182 }
 183
 184 /*
 185  * Remove a service program from the callout list.
 186  */
 187 void
 188 svc_unregister(prog, vers)
 189         u_long prog;
 190         u_long vers;
 191 {
 192         struct svc_callout *prev;
 193         register struct svc_callout *s;
 194
 195         if ((s = svc_find(prog, vers, &prev)) == NULL_SVC)
 196                 return;
 197         if (prev == NULL_SVC) {
 198                 svc_head = s->sc_next;
 199         } else {
 200                 prev->sc_next = s->sc_next;
 201         }
 202         s->sc_next = NULL_SVC;
 203         mem_free((char *) s, (u_int) sizeof(struct svc_callout));
 204         /* now unregister the information with the local binder service */
 205         (void)pmap_unset(prog, vers);
 206 }
 207
 208 /*
 209  * Search the callout list for a program number, return the callout
 210  * struct.
 211  */
 212 static struct svc_callout *
 213 svc_find(prog, vers, prev)
 214         u_long prog;
 215         u_long vers;
 216         struct svc_callout **prev;
 217 {
 218         register struct svc_callout *s, *p;
 219
 220         p = NULL_SVC;
 221         for (s = svc_head; s != NULL_SVC; s = s->sc_next) {
 222                 if ((s->sc_prog == prog) && (s->sc_vers == vers))
 223                         goto done;
 224                 p = s;
 225         }
 226 done:
 227         *prev = p;
 228         return (s);
 229 }
 230
 231 /* ******************* REPLY GENERATION ROUTINES  ************ */
 232
 233 /*
 234  * Send a reply to an rpc request
 235  */
 236 bool_t
 237 svc_sendreply(xprt, xdr_results, xdr_location)
 238         register SVCXPRT *xprt;
 239         xdrproc_t xdr_results;
 240         caddr_t xdr_location;
 241 {
 242         struct rpc_msg rply;
 243
 244         rply.rm_direction = REPLY;
 245         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 246         rply.acpted_rply.ar_verf = xprt->xp_verf;
 247         rply.acpted_rply.ar_stat = SUCCESS;
 248         rply.acpted_rply.ar_results.where = xdr_location;
 249         rply.acpted_rply.ar_results.proc = xdr_results;
 250         return (SVC_REPLY(xprt, &rply));
 251 }
 252
 253 /*
 254  * No procedure error reply
 255  */
 256 void
 257 svcerr_noproc(xprt)
 258         register SVCXPRT *xprt;
 259 {
 260         struct rpc_msg rply;
 261
 262         rply.rm_direction = REPLY;
 263         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 264         rply.acpted_rply.ar_verf = xprt->xp_verf;
 265         rply.acpted_rply.ar_stat = PROC_UNAVAIL;
 266         SVC_REPLY(xprt, &rply);
 267 }
 268
 269 /*
 270  * Can't decode args error reply
 271  */
 272 void
 273 svcerr_decode(xprt)
 274         register SVCXPRT *xprt;
 275 {
 276         struct rpc_msg rply;
 277
 278         rply.rm_direction = REPLY;
 279         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 280         rply.acpted_rply.ar_verf = xprt->xp_verf;
 281         rply.acpted_rply.ar_stat = GARBAGE_ARGS;
 282         SVC_REPLY(xprt, &rply);
 283 }
 284
 285 /*
 286  * Some system error
 287  */
 288 void
 289 svcerr_systemerr(xprt)
 290         register SVCXPRT *xprt;
 291 {
 292         struct rpc_msg rply;
 293
 294         rply.rm_direction = REPLY;
 295         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 296         rply.acpted_rply.ar_verf = xprt->xp_verf;
 297         rply.acpted_rply.ar_stat = SYSTEM_ERR;
 298         SVC_REPLY(xprt, &rply);
 299 }
 300
 301 /*
 302  * Authentication error reply
 303  */
 304 void
 305 svcerr_auth(xprt, why)
 306         SVCXPRT *xprt;
 307         enum auth_stat why;
 308 {
 309         struct rpc_msg rply;
 310
 311         rply.rm_direction = REPLY;
 312         rply.rm_reply.rp_stat = MSG_DENIED;
 313         rply.rjcted_rply.rj_stat = AUTH_ERROR;
 314         rply.rjcted_rply.rj_why = why;
 315         SVC_REPLY(xprt, &rply);
 316 }
 317
 318 /*
 319  * Auth too weak error reply
 320  */
 321 void
 322 svcerr_weakauth(xprt)
 323         SVCXPRT *xprt;
 324 {
 325
 326         svcerr_auth(xprt, AUTH_TOOWEAK);
 327 }
 328
 329 /*
 330  * Program unavailable error reply
 331  */
 332 void
 333 svcerr_noprog(xprt)
 334         register SVCXPRT *xprt;
 335 {
 336         struct rpc_msg rply;
 337
 338         rply.rm_direction = REPLY;
 339         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 340         rply.acpted_rply.ar_verf = xprt->xp_verf;
 341         rply.acpted_rply.ar_stat = PROG_UNAVAIL;
 342         SVC_REPLY(xprt, &rply);
 343 }
 344
 345 /*
 346  * Program version mismatch error reply
 347  */
 348 void
 349 svcerr_progvers(xprt, low_vers, high_vers)
 350         register SVCXPRT *xprt;
 351         u_long low_vers;
 352         u_long high_vers;
 353 {
 354         struct rpc_msg rply;
 355
 356         rply.rm_direction = REPLY;
 357         rply.rm_reply.rp_stat = MSG_ACCEPTED;
 358         rply.acpted_rply.ar_verf = xprt->xp_verf;
 359         rply.acpted_rply.ar_stat = PROG_MISMATCH;
 360         rply.acpted_rply.ar_vers.low = low_vers;
 361         rply.acpted_rply.ar_vers.high = high_vers;
 362         SVC_REPLY(xprt, &rply);
 363 }
 364
 365 /* ******************* SERVER INPUT STUFF ******************* */
 366
 367 /*
 368  * Get server side input from some transport.
 369  *
 370  * Statement of authentication parameters management:
 371  * This function owns and manages all authentication parameters, specifically
 372  * the "raw" parameters (msg.rm_call.cb_cred and msg.rm_call.cb_verf) and
 373  * the "cooked" credentials (rqst->rq_clntcred).
 374  * However, this function does not know the structure of the cooked
 375  * credentials, so it make the following assumptions:
 376  *   a) the structure is contiguous (no pointers), and
 377  *   b) the cred structure size does not exceed RQCRED_SIZE bytes.
 378  * In all events, all three parameters are freed upon exit from this routine.
 379  * The storage is trivially management on the call stack in user land, but
 380  * is mallocated in kernel land.
 381  */
 382
 383 void
 384 svc_getreq(rdfds)
 385         int rdfds;
 386 {
 387         fd_set readfds;
 388
 389         FD_ZERO(&readfds);
 390         readfds.fds_bits[0] = rdfds;
 391         svc_getreqset(&readfds);
 392 }
 393
 394 void
 395 svc_getreqset(readfds)
 396         fd_set *readfds;
 397 {
 398         enum xprt_stat stat;
 399         struct rpc_msg msg;
 400         int prog_found;
 401         u_long low_vers;
 402         u_long high_vers;
 403         struct svc_req r;
 404         register SVCXPRT *xprt;
 405         register u_long mask;
 406         register int bit;
 407         register u_long *maskp;
 408         register int sock;
 409         char cred_area[2*MAX_AUTH_BYTES + RQCRED_SIZE];
 410         msg.rm_call.cb_cred.oa_base = cred_area;
 411         msg.rm_call.cb_verf.oa_base = &(cred_area[MAX_AUTH_BYTES]);
 412         r.rq_clntcred = &(cred_area[2*MAX_AUTH_BYTES]);
 413
 414
 415         maskp = (u_long *)readfds->fds_bits;
 416         for (sock = 0; sock <= svc_maxfd; sock += NFDBITS) {
 417             for (mask = *maskp++; (bit = ffs(mask)); mask ^= (1 << (bit - 1))) {
 418                 if ((sock + bit) > (svc_maxfd + 1))
 419                         /* if we're past our sockets */
 420                         return;
 421                 /* sock has input waiting */
 422                 xprt = xports[sock + bit - 1];
 423                 if (xprt == NULL)
 424                         /* But do we control sock? */
 425                         continue;
 426                 /* now receive msgs from xprtprt (support batch calls) */
 427                 do {
 428                         if (SVC_RECV(xprt, &msg)) {
 429
 430                                 /* now find the exported program and call it */
 431                                 register struct svc_callout *s;
 432                                 enum auth_stat why;
 433
 434                                 r.rq_xprt = xprt;
 435                                 r.rq_prog = msg.rm_call.cb_prog;
 436                                 r.rq_vers = msg.rm_call.cb_vers;
 437                                 r.rq_proc = msg.rm_call.cb_proc;
 438                                 r.rq_cred = msg.rm_call.cb_cred;
 439                                 /* first authenticate the message */
 440                                 if ((why= _authenticate(&r, &msg)) != AUTH_OK) {
 441                                         svcerr_auth(xprt, why);
 442                                         goto call_done;
 443                                 }
 444                                 /* now match message with a registered service*/
 445                                 prog_found = FALSE;
 446                                 low_vers = 0 - 1;
 447                                 high_vers = 0;
 448                                 for (s = svc_head; s != NULL_SVC; s = s->sc_next) {
 449                                         if (s->sc_prog == r.rq_prog) {
 450                                                 if (s->sc_vers == r.rq_vers) {
 451                                                         (*s->sc_dispatch)(&r, xprt);
 452                                                         goto call_done;
 453                                                 }  /* found correct version */
 454                                                 prog_found = TRUE;
 455                                                 if (s->sc_vers < low_vers)
 456                                                         low_vers = s->sc_vers;
 457                                                 if (s->sc_vers > high_vers)
 458                                                         high_vers = s->sc_vers;
 459                                         }   /* found correct program */
 460                                 }
 461                                 /*
 462                                  * if we got here, the program or version
 463                                  * is not served ...
 464                                  */
 465                                 if (prog_found)
 466                                         svcerr_progvers(xprt,
 467                                         low_vers, high_vers);
 468                                 else
 469                                          svcerr_noprog(xprt);
 470                                 /* Fall through to ... */
 471                         }
 472                 call_done:
 473                         if ((stat = SVC_STAT(xprt)) == XPRT_DIED){
 474                                 SVC_DESTROY(xprt);
 475                                 break;
 476                         }
 477                 } while (stat == XPRT_MOREREQS);
 478             }
 479         }
 480 }