2 * Copyright (c) 1988, 1992 The University of Utah and the Center
3 * for Software Science (CSS).
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * the Center for Software Science of the University of Utah Computer
9 * Science Department. CSS requests users of this software to return
10 * to css-dist@cs.utah.edu any improvements that they make and grant
11 * CSS redistribution rights.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the University of
24 * California, Berkeley and its contributors.
25 * 4. Neither the name of the University nor the names of its contributors
26 * may be used to endorse or promote products derived from this software
27 * without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * from: @(#)rmpproto.c 8.1 (Berkeley) 6/4/93
43 * From: Utah Hdr: rmpproto.c 3.1 92/07/06
44 * Author: Jeff Forys, University of Utah CSS
46 * @(#)rmpproto.c 8.1 (Berkeley) 6/4/93
47 * $FreeBSD: src/libexec/rbootd/rmpproto.c,v 1.6.2.1 2001/02/18 02:54:11 kris Exp $
48 * $DragonFly: src/libexec/rbootd/rmpproto.c,v 1.2 2003/06/17 04:27:07 dillon Exp $
51 #include <sys/param.h>
63 ** ProcessPacket -- determine packet type and do what's required.
65 ** An RMP BOOT packet has been received. Look at the type field
66 ** and process Boot Requests, Read Requests, and Boot Complete
67 ** packets. Any other type will be dropped with a warning msg.
70 ** rconn - the new connection
71 ** client - list of files available to this host
77 ** - If this is a valid boot request, it will be added to
78 ** the linked list of outstanding requests (RmpConns).
79 ** - If this is a valid boot complete, its associated
80 ** entry in RmpConns will be deleted.
81 ** - Also, unless we run out of memory, a reply will be
82 ** sent to the host that sent the packet.
85 ProcessPacket(rconn, client)
89 struct rmp_packet *rmp;
92 rmp = &rconn->rmp; /* cache pointer to RMP packet */
94 switch(rmp->r_type) { /* do what we came here to do */
95 case RMP_BOOT_REQ: /* boot request */
96 if ((rconnout = NewConn(rconn)) == NULL)
100 * If the Session ID is 0xffff, this is a "probe"
101 * packet and we do not want to add the connection
102 * to the linked list of active connections. There
103 * are two types of probe packets, if the Sequence
104 * Number is 0 they want to know our host name, o/w
105 * they want the name of the file associated with
106 * the number spec'd by the Sequence Number.
108 * If this is an actual boot request, open the file
109 * and send a reply. If SendBootRepl() does not
110 * return 0, add the connection to the linked list
111 * of active connections, otherwise delete it since
112 * an error was encountered.
114 if (ntohs(rmp->r_brq.rmp_session) == RMP_PROBESID) {
115 if (WORDZE(rmp->r_brq.rmp_seqno))
116 (void) SendServerID(rconnout);
118 (void) SendFileNo(rmp, rconnout,
119 client? client->files:
123 if (SendBootRepl(rmp, rconnout,
124 client? client->files: BootFiles))
131 case RMP_BOOT_REPL: /* boot reply (not valid) */
132 syslog(LOG_WARNING, "%s: sent a boot reply",
136 case RMP_READ_REQ: /* read request */
138 * Send a portion of the boot file.
140 (void) SendReadRepl(rconn);
143 case RMP_READ_REPL: /* read reply (not valid) */
144 syslog(LOG_WARNING, "%s: sent a read reply",
148 case RMP_BOOT_DONE: /* boot complete */
150 * Remove the entry from the linked list of active
153 (void) BootDone(rconn);
156 default: /* unknown RMP packet type */
157 syslog(LOG_WARNING, "%s: unknown packet type (%u)",
158 EnetStr(rconn), rmp->r_type);
163 ** SendServerID -- send our host name to who ever requested it.
166 ** rconn - the reply packet to be formatted.
169 ** 1 on success, 0 on failure.
178 struct rmp_packet *rpl;
182 rpl = &rconn->rmp; /* cache ptr to RMP packet */
185 * Set up assorted fields in reply packet.
187 rpl->r_brpl.rmp_type = RMP_BOOT_REPL;
188 rpl->r_brpl.rmp_retcode = RMP_E_OKAY;
189 ZEROWORD(rpl->r_brpl.rmp_seqno);
190 rpl->r_brpl.rmp_session = 0;
191 rpl->r_brpl.rmp_version = htons(RMP_VERSION);
193 size = &rpl->r_brpl.rmp_flnmsize; /* ptr to length of host name */
196 * Copy our host name into the reply packet incrementing the
197 * length as we go. Stop at RMP_HOSTLEN or the first dot.
200 dst = (char *) &rpl->r_brpl.rmp_flnm;
201 for (*size = 0; *size < RMP_HOSTLEN; (*size)++) {
202 if (*src == '.' || *src == '\0')
207 rconn->rmplen = RMPBOOTSIZE(*size); /* set packet length */
209 return(SendPacket(rconn)); /* send packet */
213 ** SendFileNo -- send the name of a bootable file to the requester.
216 ** req - RMP BOOT packet containing the request.
217 ** rconn - the reply packet to be formatted.
218 ** filelist - list of files available to the requester.
221 ** 1 on success, 0 on failure.
227 SendFileNo(req, rconn, filelist)
228 struct rmp_packet *req;
232 struct rmp_packet *rpl;
237 GETWORD(req->r_brpl.rmp_seqno, i); /* SeqNo is really FileNo */
238 rpl = &rconn->rmp; /* cache ptr to RMP packet */
241 * Set up assorted fields in reply packet.
243 rpl->r_brpl.rmp_type = RMP_BOOT_REPL;
244 PUTWORD(i, rpl->r_brpl.rmp_seqno);
246 rpl->r_brpl.rmp_session = 0;
247 rpl->r_brpl.rmp_version = htons(RMP_VERSION);
249 size = &rpl->r_brpl.rmp_flnmsize; /* ptr to length of filename */
250 *size = 0; /* init length to zero */
253 * Copy the file name into the reply packet incrementing the
254 * length as we go. Stop at end of string or when RMPBOOTDATA
255 * characters have been copied. Also, set return code to
256 * indicate success or "no more files".
258 if (i < C_MAXFILE && filelist[i] != NULL) {
260 dst = (char *)&rpl->r_brpl.rmp_flnm;
261 for (; *src && *size < RMPBOOTDATA; (*size)++) {
266 rpl->r_brpl.rmp_retcode = RMP_E_OKAY;
268 rpl->r_brpl.rmp_retcode = RMP_E_NODFLT;
270 rconn->rmplen = RMPBOOTSIZE(*size); /* set packet length */
272 return(SendPacket(rconn)); /* send packet */
276 ** SendBootRepl -- open boot file and respond to boot request.
279 ** req - RMP BOOT packet containing the request.
280 ** rconn - the reply packet to be formatted.
281 ** filelist - list of files available to the requester.
284 ** 1 on success, 0 on failure.
290 SendBootRepl(req, rconn, filelist)
291 struct rmp_packet *req;
296 char *filename, filepath[RMPBOOTDATA+1];
298 struct rmp_packet *rpl;
299 char *src, *dst1, *dst2;
303 * If another connection already exists, delete it since we
304 * are obviously starting again.
306 if ((oldconn = FindConn(rconn)) != NULL) {
307 syslog(LOG_WARNING, "%s: dropping existing connection",
312 rpl = &rconn->rmp; /* cache ptr to RMP packet */
315 * Set up assorted fields in reply packet.
317 rpl->r_brpl.rmp_type = RMP_BOOT_REPL;
318 COPYWORD(req->r_brq.rmp_seqno, rpl->r_brpl.rmp_seqno);
319 rpl->r_brpl.rmp_session = htons(GenSessID());
320 rpl->r_brpl.rmp_version = htons(RMP_VERSION);
321 rpl->r_brpl.rmp_flnmsize = req->r_brq.rmp_flnmsize;
324 * Copy file name to `filepath' string, and into reply packet.
326 src = &req->r_brq.rmp_flnm;
328 dst2 = &rpl->r_brpl.rmp_flnm;
329 for (i = 0; i < req->r_brq.rmp_flnmsize; i++)
330 *dst1++ = *dst2++ = *src++;
334 * If we are booting HP-UX machines, their secondary loader will
335 * ask for files like "/hp-ux". As a security measure, we do not
336 * allow boot files to lay outside the boot directory (unless they
337 * are purposely link'd out. So, make `filename' become the path-
338 * stripped file name and spoof the client into thinking that it
339 * really got what it wanted.
341 filename = (filename = strrchr(filepath,'/'))? ++filename: filepath;
344 * Check that this is a valid boot file name.
346 for (i = 0; i < C_MAXFILE && filelist[i] != NULL; i++)
347 if (STREQN(filename, filelist[i]))
351 * Invalid boot file name, set error and send reply packet.
353 rpl->r_brpl.rmp_retcode = RMP_E_NOFILE;
359 * This is a valid boot file. Open the file and save the file
360 * descriptor associated with this connection and set success
361 * indication. If the file couldnt be opened, set error:
362 * "no such file or dir" - RMP_E_NOFILE
363 * "file table overflow" - RMP_E_BUSY
364 * "too many open files" - RMP_E_BUSY
365 * anything else - RMP_E_OPENFILE
367 if ((rconn->bootfd = open(filename, O_RDONLY, 0600)) < 0) {
368 rpl->r_brpl.rmp_retcode = (errno == ENOENT)? RMP_E_NOFILE:
369 (errno == EMFILE || errno == ENFILE)? RMP_E_BUSY:
373 rpl->r_brpl.rmp_retcode = RMP_E_OKAY;
378 syslog(LOG_INFO, "%s: request to boot %s (%s)",
379 EnetStr(rconn), filename, retval? "granted": "denied");
381 rconn->rmplen = RMPBOOTSIZE(rpl->r_brpl.rmp_flnmsize);
383 return (retval & SendPacket(rconn));
387 ** SendReadRepl -- send a portion of the boot file to the requester.
390 ** rconn - the reply packet to be formatted.
393 ** 1 on success, 0 on failure.
404 struct rmp_packet *rpl, *req;
409 * Find the old connection. If one doesnt exist, create one only
410 * to return the error code.
412 if ((oldconn = FindConn(rconn)) == NULL) {
413 if ((oldconn = NewConn(rconn)) == NULL)
415 syslog(LOG_ERR, "SendReadRepl: no active connection (%s)",
420 req = &rconn->rmp; /* cache ptr to request packet */
421 rpl = &oldconn->rmp; /* cache ptr to reply packet */
423 if (madeconn) { /* no active connection above; abort */
424 rpl->r_rrpl.rmp_retcode = RMP_E_ABORT;
430 * Make sure Session ID's match.
432 if (ntohs(req->r_rrq.rmp_session) !=
433 ((rpl->r_type == RMP_BOOT_REPL)? ntohs(rpl->r_brpl.rmp_session):
434 ntohs(rpl->r_rrpl.rmp_session))) {
435 syslog(LOG_ERR, "SendReadRepl: bad session id (%s)",
437 rpl->r_rrpl.rmp_retcode = RMP_E_BADSID;
443 * If the requester asks for more data than we can fit,
444 * silently clamp the request size down to RMPREADDATA.
446 * N.B. I do not know if this is "legal", however it seems
447 * to work. This is necessary for bpfwrite() on machines
448 * with MCLBYTES less than 1514.
450 if (ntohs(req->r_rrq.rmp_size) > RMPREADDATA)
451 req->r_rrq.rmp_size = htons(RMPREADDATA);
454 * Position read head on file according to info in request packet.
456 GETWORD(req->r_rrq.rmp_offset, size);
457 if (lseek(oldconn->bootfd, (off_t)size, SEEK_SET) < 0) {
458 syslog(LOG_ERR, "SendReadRepl: lseek: %m (%s)",
460 rpl->r_rrpl.rmp_retcode = RMP_E_ABORT;
466 * Read data directly into reply packet.
468 if ((size = read(oldconn->bootfd, &rpl->r_rrpl.rmp_data,
469 (int) ntohs(req->r_rrq.rmp_size))) <= 0) {
471 syslog(LOG_ERR, "SendReadRepl: read: %m (%s)",
473 rpl->r_rrpl.rmp_retcode = RMP_E_ABORT;
475 rpl->r_rrpl.rmp_retcode = RMP_E_EOF;
482 * Set success indication.
484 rpl->r_rrpl.rmp_retcode = RMP_E_OKAY;
488 * Set up assorted fields in reply packet.
490 rpl->r_rrpl.rmp_type = RMP_READ_REPL;
491 COPYWORD(req->r_rrq.rmp_offset, rpl->r_rrpl.rmp_offset);
492 rpl->r_rrpl.rmp_session = req->r_rrq.rmp_session;
494 oldconn->rmplen = RMPREADSIZE(size); /* set size of packet */
496 retval &= SendPacket(oldconn); /* send packet */
498 if (madeconn) /* clean up after ourself */
505 ** BootDone -- free up memory allocated for a connection.
508 ** rconn - incoming boot complete packet.
511 ** 1 on success, 0 on failure.
521 struct rmp_packet *rpl;
524 * If we cant find the connection, ignore the request.
526 if ((oldconn = FindConn(rconn)) == NULL) {
527 syslog(LOG_ERR, "BootDone: no existing connection (%s)",
532 rpl = &oldconn->rmp; /* cache ptr to RMP packet */
535 * Make sure Session ID's match.
537 if (ntohs(rconn->rmp.r_rrq.rmp_session) !=
538 ((rpl->r_type == RMP_BOOT_REPL)? ntohs(rpl->r_brpl.rmp_session):
539 ntohs(rpl->r_rrpl.rmp_session))) {
540 syslog(LOG_ERR, "BootDone: bad session id (%s)",
545 RemoveConn(oldconn); /* remove connection */
547 syslog(LOG_INFO, "%s: boot complete", EnetStr(rconn));
553 ** SendPacket -- send an RMP packet to a remote host.
556 ** rconn - packet to be sent.
559 ** 1 on success, 0 on failure.
569 * Set Ethernet Destination address to Source (BPF and the enet
570 * driver will take care of getting our source address set).
572 memmove((char *)&rconn->rmp.hp_hdr.daddr[0],
573 (char *)&rconn->rmp.hp_hdr.saddr[0], RMP_ADDRLEN);
574 rconn->rmp.hp_hdr.len = htons(rconn->rmplen - sizeof(struct hp_hdr));
577 * Reverse 802.2/HP Extended Source & Destination Access Pts.
579 rconn->rmp.hp_llc.dxsap = htons(HPEXT_SXSAP);
580 rconn->rmp.hp_llc.sxsap = htons(HPEXT_DXSAP);
583 * Last time this connection was active.
585 (void) gettimeofday(&rconn->tstamp, (struct timezone *)0);
587 if (DbgFp != NULL) /* display packet */
588 DispPkt(rconn,DIR_SENT);
591 * Send RMP packet to remote host.
593 return(BpfWrite(rconn));