Home | History | Annotate | Line # | Download | only in nfs
krpc_subr.c revision 1.36
      1 /*	$NetBSD: krpc_subr.c,v 1.36 2009/03/14 21:04:25 dsl Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1995 Gordon Ross, Adam Glass
      5  * Copyright (c) 1992 Regents of the University of California.
      6  * All rights reserved.
      7  *
      8  * This software was developed by the Computer Systems Engineering group
      9  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
     10  * contributed to Berkeley.
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  * 3. All advertising materials mentioning features or use of this software
     21  *    must display the following acknowledgement:
     22  *	This product includes software developed by the University of
     23  *	California, Lawrence Berkeley Laboratory and its contributors.
     24  * 4. Neither the name of the University nor the names of its contributors
     25  *    may be used to endorse or promote products derived from this software
     26  *    without specific prior written permission.
     27  *
     28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     38  * SUCH DAMAGE.
     39  *
     40  * partially based on:
     41  *      libnetboot/rpc.c
     42  *               @(#) Header: rpc.c,v 1.12 93/09/28 08:31:56 leres Exp  (LBL)
     43  */
     44 
     45 #include <sys/cdefs.h>
     46 __KERNEL_RCSID(0, "$NetBSD: krpc_subr.c,v 1.36 2009/03/14 21:04:25 dsl Exp $");
     47 
     48 #include <sys/param.h>
     49 #include <sys/systm.h>
     50 #include <sys/ioctl.h>
     51 #include <sys/proc.h>
     52 #include <sys/mount.h>
     53 #include <sys/mbuf.h>
     54 #include <sys/reboot.h>
     55 #include <sys/socket.h>
     56 #include <sys/socketvar.h>
     57 
     58 #include <netinet/in.h>
     59 
     60 #include <nfs/rpcv2.h>
     61 #include <nfs/krpc.h>
     62 #include <nfs/xdr_subs.h>
     63 #include <nfs/nfsproto.h> /* XXX NFSX_V3FHMAX for next */
     64 #include <nfs/nfs.h>
     65 #include <nfs/nfsmount.h>
     66 #include <nfs/nfsdiskless.h> /* XXX decl nfs_boot_sendrecv */
     67 
     68 /*
     69  * Kernel support for Sun RPC
     70  *
     71  * Used currently for bootstrapping in nfs diskless configurations.
     72  */
     73 
     74 /*
     75  * Generic RPC headers
     76  */
     77 
     78 struct auth_info {
     79 	u_int32_t 	authtype;	/* auth type */
     80 	u_int32_t	authlen;	/* auth length */
     81 };
     82 
     83 struct auth_unix {
     84 	int32_t   ua_time;
     85 	int32_t   ua_hostname;	/* null */
     86 	int32_t   ua_uid;
     87 	int32_t   ua_gid;
     88 	int32_t   ua_gidlist;	/* null */
     89 };
     90 
     91 struct rpc_call {
     92 	u_int32_t	rp_xid;		/* request transaction id */
     93 	int32_t 	rp_direction;	/* call direction (0) */
     94 	u_int32_t	rp_rpcvers;	/* rpc version (2) */
     95 	u_int32_t	rp_prog;	/* program */
     96 	u_int32_t	rp_vers;	/* version */
     97 	u_int32_t	rp_proc;	/* procedure */
     98 	struct	auth_info rpc_auth;
     99 	struct	auth_unix rpc_unix;
    100 	struct	auth_info rpc_verf;
    101 };
    102 
    103 struct rpc_reply {
    104 	u_int32_t rp_xid;		/* request transaction id */
    105 	int32_t  rp_direction;		/* call direction (1) */
    106 	int32_t  rp_astatus;		/* accept status (0: accepted) */
    107 	union {
    108 		/* rejected */
    109 		struct {
    110 			u_int32_t rej_stat;
    111 			u_int32_t rej_val1;
    112 			u_int32_t rej_val2;
    113 		} rpu_rej;
    114 		/* accepted */
    115 		struct {
    116 			struct auth_info rok_auth;
    117 			u_int32_t	rok_status;
    118 		} rpu_rok;
    119 	} rp_u;
    120 };
    121 #define rp_rstat  rp_u.rpu_rej.rej_stat
    122 #define rp_auth   rp_u.rpu_rok.rok_auth
    123 #define rp_status rp_u.rpu_rok.rok_status
    124 
    125 #define MIN_REPLY_HDR 16	/* xid, dir, astat, errno */
    126 
    127 static int krpccheck(struct mbuf*, void*);
    128 
    129 /*
    130  * Call portmap to lookup a port number for a particular rpc program
    131  * Returns non-zero error on failure.
    132  */
    133 int
    134 krpc_portmap(struct sockaddr_in *sin, u_int prog, u_int vers, u_int proto, u_int16_t *portp, struct lwp *l)
    135 	/* sin:		 server address */
    136 	/* prog, vers, proto:	 host order */
    137 	/* portp:	 network order */
    138 {
    139 	struct sdata {
    140 		u_int32_t prog;		/* call program */
    141 		u_int32_t vers;		/* call version */
    142 		u_int32_t proto;	/* call protocol */
    143 		u_int32_t port;		/* call port (unused) */
    144 	} *sdata;
    145 	struct rdata {
    146 		u_int16_t pad;
    147 		u_int16_t port;
    148 	} *rdata;
    149 	struct mbuf *m;
    150 	int error;
    151 
    152 	/* The portmapper port is fixed. */
    153 	if (prog == PMAPPROG) {
    154 		*portp = htons(PMAPPORT);
    155 		return 0;
    156 	}
    157 
    158 	m = m_get(M_WAIT, MT_DATA);
    159 	sdata = mtod(m, struct sdata *);
    160 	m->m_len = sizeof(*sdata);
    161 
    162 	/* Do the RPC to get it. */
    163 	sdata->prog = txdr_unsigned(prog);
    164 	sdata->vers = txdr_unsigned(vers);
    165 	sdata->proto = txdr_unsigned(proto);
    166 	sdata->port = 0;
    167 
    168 	sin->sin_port = htons(PMAPPORT);
    169 	error = krpc_call(sin, PMAPPROG, PMAPVERS,
    170 					  PMAPPROC_GETPORT, &m, NULL, l);
    171 	if (error)
    172 		return error;
    173 
    174 	if (m->m_len < sizeof(*rdata)) {
    175 		m = m_pullup(m, sizeof(*rdata));
    176 		if (m == NULL)
    177 			return ENOBUFS;
    178 	}
    179 	rdata = mtod(m, struct rdata *);
    180 	*portp = rdata->port;
    181 
    182 	m_freem(m);
    183 	return 0;
    184 }
    185 
    186 static int krpccheck(m, context)
    187 struct mbuf *m;
    188 void *context;
    189 {
    190 	struct rpc_reply *reply;
    191 
    192 	/* Does the reply contain at least a header? */
    193 	if (m->m_pkthdr.len < MIN_REPLY_HDR)
    194 		return(-1);
    195 	if (m->m_len < sizeof(struct rpc_reply)) {
    196 		m = m_pullup(m, sizeof(struct rpc_reply));
    197 		if (m == NULL)
    198 			return(-1);
    199 	}
    200 	reply = mtod(m, struct rpc_reply *);
    201 
    202 	/* Is it the right reply? */
    203 	if (reply->rp_direction != txdr_unsigned(RPC_REPLY))
    204 		return(-1);
    205 
    206 	if (reply->rp_xid != txdr_unsigned(*(u_int32_t*)context))
    207 		return(-1);
    208 
    209 	return(0);
    210 }
    211 
    212 /*
    213  * Do a remote procedure call (RPC) and wait for its reply.
    214  * If from_p is non-null, then we are doing broadcast, and
    215  * the address from whence the response came is saved there.
    216  */
    217 int
    218 krpc_call(struct sockaddr_in *sa, u_int prog, u_int vers, u_int func, struct mbuf **data, struct mbuf **from_p, struct lwp *l)
    219 	/* data:	 input/output */
    220 	/* from_p:	 output */
    221 {
    222 	struct socket *so;
    223 	struct sockaddr_in *sin;
    224 	struct mbuf *m, *nam, *mhead, *from;
    225 	struct rpc_call *call;
    226 	struct rpc_reply *reply;
    227 	int error, len;
    228 	static u_int32_t xid = ~0xFF;
    229 	u_int16_t tport;
    230 
    231 	/*
    232 	 * Validate address family.
    233 	 * Sorry, this is INET specific...
    234 	 */
    235 	if (sa->sin_family != AF_INET)
    236 		return (EAFNOSUPPORT);
    237 
    238 	/* Free at end if not null. */
    239 	nam = mhead = NULL;
    240 	from = NULL;
    241 
    242 	/*
    243 	 * Create socket and set its receive timeout.
    244 	 */
    245 	if ((error = socreate(AF_INET, &so, SOCK_DGRAM, 0, l, NULL)))
    246 		goto out;
    247 
    248 	if ((error = nfs_boot_setrecvtimo(so)))
    249 		goto out;
    250 
    251 	/*
    252 	 * Enable broadcast if necessary.
    253 	 */
    254 	if (from_p) {
    255 		if ((error = nfs_boot_enbroadcast(so)))
    256 			goto out;
    257 	}
    258 
    259 	/*
    260 	 * Bind the local endpoint to a reserved port,
    261 	 * because some NFS servers refuse requests from
    262 	 * non-reserved (non-privileged) ports.
    263 	 */
    264 	tport = IPPORT_RESERVED;
    265 	do {
    266 		tport--;
    267 		error = nfs_boot_sobind_ipport(so, tport, l);
    268 	} while (error == EADDRINUSE &&
    269 			 tport > IPPORT_RESERVED / 2);
    270 	if (error) {
    271 		printf("bind failed\n");
    272 		goto out;
    273 	}
    274 
    275 	/*
    276 	 * Setup socket address for the server.
    277 	 */
    278 	nam = m_get(M_WAIT, MT_SONAME);
    279 	sin = mtod(nam, struct sockaddr_in *);
    280 	memcpy((void *)sin, (void *)sa,
    281 		  (nam->m_len = sa->sin_len));
    282 
    283 	/*
    284 	 * Prepend RPC message header.
    285 	 */
    286 	mhead = m_gethdr(M_WAIT, MT_DATA);
    287 	mhead->m_next = *data;
    288 	call = mtod(mhead, struct rpc_call *);
    289 	mhead->m_len = sizeof(*call);
    290 	memset((void *)call, 0, sizeof(*call));
    291 	/* rpc_call part */
    292 	xid++;
    293 	call->rp_xid = txdr_unsigned(xid);
    294 	/* call->rp_direction = 0; */
    295 	call->rp_rpcvers = txdr_unsigned(2);
    296 	call->rp_prog = txdr_unsigned(prog);
    297 	call->rp_vers = txdr_unsigned(vers);
    298 	call->rp_proc = txdr_unsigned(func);
    299 	/* rpc_auth part (auth_unix as root) */
    300 	call->rpc_auth.authtype = txdr_unsigned(RPCAUTH_UNIX);
    301 	call->rpc_auth.authlen  = txdr_unsigned(sizeof(struct auth_unix));
    302 	/* rpc_verf part (auth_null) */
    303 	call->rpc_verf.authtype = 0;
    304 	call->rpc_verf.authlen  = 0;
    305 
    306 	/*
    307 	 * Setup packet header
    308 	 */
    309 	len = 0;
    310 	m = mhead;
    311 	while (m) {
    312 		len += m->m_len;
    313 		m = m->m_next;
    314 	}
    315 	mhead->m_pkthdr.len = len;
    316 	mhead->m_pkthdr.rcvif = NULL;
    317 
    318 	error = nfs_boot_sendrecv(so, nam, 0, mhead, krpccheck, &m, &from,
    319 	    &xid, l);
    320 	if (error)
    321 		goto out;
    322 
    323 	/* m_pullup() was done in krpccheck() */
    324 	reply = mtod(m, struct rpc_reply *);
    325 
    326 	/* Was RPC accepted? (authorization OK) */
    327 	if (reply->rp_astatus != 0) {
    328 		/* Note: This is NOT an error code! */
    329 		error = fxdr_unsigned(u_int32_t, reply->rp_rstat);
    330 		switch (error) {
    331 		    case RPC_MISMATCH:
    332 			/* .re_status = RPC_VERSMISMATCH; */
    333 			error = ERPCMISMATCH;
    334 			break;
    335 		    case RPC_AUTHERR:
    336 			/* .re_status = RPC_AUTHERROR; */
    337 			error = EAUTH;
    338 			break;
    339 		    default:
    340 			/* unexpected */
    341 			error = EBADRPC;
    342 			break;
    343 		}
    344 		goto out;
    345 	}
    346 
    347 	/* Did the call succeed? */
    348 	if (reply->rp_status != 0) {
    349 		/* Note: This is NOT an error code! */
    350 		error = fxdr_unsigned(u_int32_t, reply->rp_status);
    351 		switch (error) {
    352 		    case RPC_PROGUNAVAIL:
    353 			error = EPROGUNAVAIL;
    354 			break;
    355 		    case RPC_PROGMISMATCH:
    356 			error = EPROGMISMATCH;
    357 			break;
    358 		    case RPC_PROCUNAVAIL:
    359 			error = EPROCUNAVAIL;
    360 			break;
    361 		    case RPC_GARBAGE:
    362 		    default:
    363 			error = EBADRPC;
    364 		}
    365 		goto out;
    366 	}
    367 
    368 	/*
    369 	 * OK, we have received a good reply!
    370 	 * Get its length, then strip it off.
    371 	 */
    372 	len = sizeof(*reply);
    373 	if (reply->rp_auth.authtype != 0) {
    374 		len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen);
    375 		len = (len + 3) & ~3; /* XXX? */
    376 	}
    377 	m_adj(m, len);
    378 
    379 	/* result */
    380 	*data = m;
    381 	if (from_p && error == 0) {
    382 		*from_p = from;
    383 		from = NULL;
    384 	}
    385 
    386  out:
    387 	if (nam) m_freem(nam);
    388 	if (mhead) m_freem(mhead);
    389 	if (from) m_freem(from);
    390 	soclose(so);
    391 	return error;
    392 }
    393 
    394 /*
    395  * eXternal Data Representation routines.
    396  * (but with non-standard args...)
    397  */
    398 
    399 /*
    400  * String representation for RPC.
    401  */
    402 struct xdr_string {
    403 	u_int32_t len;		/* length without null or padding */
    404 	char data[4];	/* data (longer, of course) */
    405     /* data is padded to a long-word boundary */
    406 };
    407 
    408 struct mbuf *
    409 xdr_string_encode(char *str, int len)
    410 {
    411 	struct mbuf *m;
    412 	struct xdr_string *xs;
    413 	int dlen;	/* padded string length */
    414 	int mlen;	/* message length */
    415 
    416 	dlen = (len + 3) & ~3;
    417 	mlen = dlen + 4;
    418 
    419 	if (mlen > MCLBYTES)		/* If too big, we just can't do it. */
    420 		return (NULL);
    421 
    422 	m = m_get(M_WAIT, MT_DATA);
    423 	if (mlen > MLEN) {
    424 		m_clget(m, M_WAIT);
    425 		if ((m->m_flags & M_EXT) == 0) {
    426 			(void) m_free(m);	/* There can be only one. */
    427 			return (NULL);
    428 		}
    429 	}
    430 	xs = mtod(m, struct xdr_string *);
    431 	m->m_len = mlen;
    432 	xs->len = txdr_unsigned(len);
    433 	memcpy(xs->data, str, len);
    434 	return (m);
    435 }
    436 
    437 struct mbuf *
    438 xdr_string_decode(struct mbuf *m, char *str, int *len_p)
    439 	/* len_p:		 bufsize - 1 */
    440 {
    441 	struct xdr_string *xs;
    442 	int mlen;	/* message length */
    443 	int slen;	/* string length */
    444 
    445 	if (m->m_len < 4) {
    446 		m = m_pullup(m, 4);
    447 		if (m == NULL)
    448 			return (NULL);
    449 	}
    450 	xs = mtod(m, struct xdr_string *);
    451 	slen = fxdr_unsigned(u_int32_t, xs->len);
    452 	mlen = 4 + ((slen + 3) & ~3);
    453 
    454 	if (slen > *len_p)
    455 		slen = *len_p;
    456 	m_copydata(m, 4, slen, str);
    457 	m_adj(m, mlen);
    458 
    459 	str[slen] = '\0';
    460 	*len_p = slen;
    461 
    462 	return (m);
    463 }
    464 
    465 
    466 /*
    467  * Inet address in RPC messages
    468  * (Note, really four ints, NOT chars.  Blech.)
    469  */
    470 struct xdr_inaddr {
    471 	u_int32_t atype;
    472 	u_int32_t addr[4];
    473 };
    474 
    475 struct mbuf *
    476 xdr_inaddr_encode(struct in_addr *ia)
    477 	/* ia:		 already in network order */
    478 {
    479 	struct mbuf *m;
    480 	struct xdr_inaddr *xi;
    481 	u_int8_t *cp;
    482 	u_int32_t *ip;
    483 
    484 	m = m_get(M_WAIT, MT_DATA);
    485 	xi = mtod(m, struct xdr_inaddr *);
    486 	m->m_len = sizeof(*xi);
    487 	xi->atype = txdr_unsigned(1);
    488 	ip = xi->addr;
    489 	cp = (u_int8_t *)&ia->s_addr;
    490 	*ip++ = txdr_unsigned(*cp++);
    491 	*ip++ = txdr_unsigned(*cp++);
    492 	*ip++ = txdr_unsigned(*cp++);
    493 	*ip++ = txdr_unsigned(*cp++);
    494 
    495 	return (m);
    496 }
    497 
    498 struct mbuf *
    499 xdr_inaddr_decode(struct mbuf *m, struct in_addr *ia)
    500 	/* ia:		 already in network order */
    501 {
    502 	struct xdr_inaddr *xi;
    503 	u_int8_t *cp;
    504 	u_int32_t *ip;
    505 
    506 	if (m->m_len < sizeof(*xi)) {
    507 		m = m_pullup(m, sizeof(*xi));
    508 		if (m == NULL)
    509 			return (NULL);
    510 	}
    511 	xi = mtod(m, struct xdr_inaddr *);
    512 	if (xi->atype != txdr_unsigned(1)) {
    513 		ia->s_addr = INADDR_ANY;
    514 		goto out;
    515 	}
    516 	ip = xi->addr;
    517 	cp = (u_int8_t *)&ia->s_addr;
    518 	*cp++ = fxdr_unsigned(u_int8_t, *ip++);
    519 	*cp++ = fxdr_unsigned(u_int8_t, *ip++);
    520 	*cp++ = fxdr_unsigned(u_int8_t, *ip++);
    521 	*cp++ = fxdr_unsigned(u_int8_t, *ip++);
    522 
    523 out:
    524 	m_adj(m, sizeof(*xi));
    525 	return (m);
    526 }
    527