2 * dhcp.c Functions to send/receive dhcp packets.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2008 The FreeRADIUS server project
21 * Copyright 2008 Alan DeKok <aland@deployingradius.com>
26 #include <freeradius-devel/libradius.h>
27 #include <freeradius-devel/udpfromto.h>
28 #include <freeradius-devel/dhcp.h>
31 #include <sys/ioctl.h>
34 #ifdef HAVE_SYS_SOCKET_H
35 #include <sys/socket.h>
37 #ifdef HAVE_SYS_TYPES_H
38 #include <sys/types.h>
42 #include <net/if_arp.h>
45 #define DHCP_CHADDR_LEN (16)
46 #define DHCP_SNAME_LEN (64)
47 #define DHCP_FILE_LEN (128)
48 #define DHCP_VEND_LEN (308)
49 #define DHCP_OPTION_MAGIC_NUMBER (0x63825363)
51 #ifndef INADDR_BROADCAST
52 #define INADDR_BROADCAST INADDR_NONE
55 /* @todo: this is a hack */
56 # define DEBUG if (fr_debug_flag && fr_log_fp) fr_printf_log
57 # define debug_pair(vp) do { if (fr_debug_flag && fr_log_fp) { \
58 vp_print(fr_log_fp, vp); \
62 typedef struct dhcp_packet_t {
68 uint16_t secs; /* 8 */
70 uint32_t ciaddr; /* 12 */
71 uint32_t yiaddr; /* 16 */
72 uint32_t siaddr; /* 20 */
73 uint32_t giaddr; /* 24 */
74 uint8_t chaddr[DHCP_CHADDR_LEN]; /* 28 */
75 uint8_t sname[DHCP_SNAME_LEN]; /* 44 */
76 uint8_t file[DHCP_FILE_LEN]; /* 108 */
77 uint32_t option_format; /* 236 */
78 uint8_t options[DHCP_VEND_LEN];
81 typedef struct dhcp_option_t {
87 * INADDR_ANY : 68 -> INADDR_BROADCAST : 67 DISCOVER
88 * INADDR_BROADCAST : 68 <- SERVER_IP : 67 OFFER
89 * INADDR_ANY : 68 -> INADDR_BROADCAST : 67 REQUEST
90 * INADDR_BROADCAST : 68 <- SERVER_IP : 67 ACK
92 static char const *dhcp_header_names[] = {
95 "DHCP-Hardware-Address-Length",
97 "DHCP-Transaction-Id",
98 "DHCP-Number-of-Seconds",
100 "DHCP-Client-IP-Address",
101 "DHCP-Your-IP-Address",
102 "DHCP-Server-IP-Address",
103 "DHCP-Gateway-IP-Address",
104 "DHCP-Client-Hardware-Address",
105 "DHCP-Server-Host-Name",
106 "DHCP-Boot-Filename",
111 static char const *dhcp_message_types[] = {
124 static int dhcp_header_sizes[] = {
135 * Some clients silently ignore responses less than 300 bytes.
137 #define MIN_PACKET_SIZE (244)
138 #define DEFAULT_PACKET_SIZE (300)
139 #define MAX_PACKET_SIZE (1500 - 40)
141 #define DHCP_OPTION_FIELD (0)
142 #define DHCP_FILE_FIELD (1)
143 #define DHCP_SNAME_FIELD (2)
145 static uint8_t *dhcp_get_option(dhcp_packet_t *packet, size_t packet_size,
149 int field = DHCP_OPTION_FIELD;
154 size = packet_size - offsetof(dhcp_packet_t, options);
155 data = &packet->options[where];
157 while (where < size) {
158 if (data[0] == 0) { /* padding */
163 if (data[0] == 255) { /* end of options */
164 if ((field == DHCP_OPTION_FIELD) &&
165 (overload & DHCP_FILE_FIELD)) {
168 size = sizeof(packet->file);
169 field = DHCP_FILE_FIELD;
172 } else if ((field == DHCP_FILE_FIELD) &&
173 (overload & DHCP_SNAME_FIELD)) {
174 data = packet->sname;
176 size = sizeof(packet->sname);
177 field = DHCP_SNAME_FIELD;
185 * We MUST have a real option here.
187 if ((where + 2) > size) {
188 fr_strerror_printf("Options overflow field at %u",
189 (unsigned int) (data - (uint8_t *) packet));
193 if ((where + 2 + data[1]) > size) {
194 fr_strerror_printf("Option length overflows field at %u",
195 (unsigned int) (data - (uint8_t *) packet));
199 if (data[0] == option) return data;
201 if (data[0] == 52) { /* overload sname and/or file */
205 where += data[1] + 2;
213 * DHCPv4 is only for IPv4. Broadcast only works if udpfromto is
216 RADIUS_PACKET *fr_dhcp_recv(int sockfd)
219 struct sockaddr_storage src;
220 struct sockaddr_storage dst;
221 socklen_t sizeof_src;
222 socklen_t sizeof_dst;
223 RADIUS_PACKET *packet;
228 packet = rad_alloc(NULL, 0);
230 fr_strerror_printf("Failed allocating packet");
234 packet->data = talloc_zero_array(packet, uint8_t, MAX_PACKET_SIZE);
236 fr_strerror_printf("Out of memory");
241 packet->sockfd = sockfd;
242 sizeof_src = sizeof(src);
243 #ifdef WITH_UDPFROMTO
244 sizeof_dst = sizeof(dst);
245 data_len = recvfromto(sockfd, packet->data, MAX_PACKET_SIZE, 0,
246 (struct sockaddr *)&src, &sizeof_src,
247 (struct sockaddr *)&dst, &sizeof_dst);
249 data_len = recvfrom(sockfd, packet->data, MAX_PACKET_SIZE, 0,
250 (struct sockaddr *)&src, &sizeof_src);
254 fr_strerror_printf("Failed reading DHCP socket: %s", fr_syserror(errno));
259 packet->data_len = data_len;
260 if (packet->data_len < MIN_PACKET_SIZE) {
261 fr_strerror_printf("DHCP packet is too small (%zu < %d)",
262 packet->data_len, MIN_PACKET_SIZE);
267 if (packet->data_len > MAX_PACKET_SIZE) {
268 fr_strerror_printf("DHCP packet is too large (%zx > %d)",
269 packet->data_len, MAX_PACKET_SIZE);
274 if (packet->data[1] != 1) {
275 fr_strerror_printf("DHCP can only receive ethernet requests, not type %02x",
281 if (packet->data[2] != 6) {
282 fr_strerror_printf("Ethernet HW length is wrong length %d",
288 memcpy(&magic, packet->data + 236, 4);
289 magic = ntohl(magic);
290 if (magic != DHCP_OPTION_MAGIC_NUMBER) {
291 fr_strerror_printf("Cannot do BOOTP");
297 * Create unique keys for the packet.
299 memcpy(&magic, packet->data + 4, 4);
300 packet->id = ntohl(magic);
302 code = dhcp_get_option((dhcp_packet_t *) packet->data,
303 packet->data_len, 53);
305 fr_strerror_printf("No message-type option was found in the packet");
310 if ((code[1] < 1) || (code[2] == 0) || (code[2] > 8)) {
311 fr_strerror_printf("Unknown value for message-type option");
316 packet->code = code[2] | PW_DHCP_OFFSET;
319 * Create a unique vector from the MAC address and the
320 * DHCP opcode. This is a hack for the RADIUS
321 * infrastructure in the rest of the server.
323 * Note: packet->data[2] == 6, which is smaller than
324 * sizeof(packet->vector)
326 * FIXME: Look for client-identifier in packet,
329 memset(packet->vector, 0, sizeof(packet->vector));
330 memcpy(packet->vector, packet->data + 28, packet->data[2]);
331 packet->vector[packet->data[2]] = packet->code & 0xff;
334 * FIXME: for DISCOVER / REQUEST: src_port == dst_port + 1
335 * FIXME: for OFFER / ACK : src_port = dst_port - 1
339 * Unique keys are xid, client mac, and client ID?
343 * FIXME: More checks, like DHCP packet type?
346 sizeof_dst = sizeof(dst);
348 #ifndef WITH_UDPFROMTO
350 * This should never fail...
352 if (getsockname(sockfd, (struct sockaddr *) &dst, &sizeof_dst) < 0) {
353 fr_strerror_printf("getsockname failed: %s", fr_syserror(errno));
359 fr_sockaddr2ipaddr(&dst, sizeof_dst, &packet->dst_ipaddr, &port);
360 packet->dst_port = port;
362 fr_sockaddr2ipaddr(&src, sizeof_src, &packet->src_ipaddr, &port);
363 packet->src_port = port;
365 if (fr_debug_flag > 1) {
367 char const *name = type_buf;
368 char src_ip_buf[256], dst_ip_buf[256];
370 if ((packet->code >= PW_DHCP_DISCOVER) &&
371 (packet->code <= PW_DHCP_INFORM)) {
372 name = dhcp_message_types[packet->code - PW_DHCP_OFFSET];
374 snprintf(type_buf, sizeof(type_buf), "%d",
375 packet->code - PW_DHCP_OFFSET);
378 DEBUG("Received %s of Id %08x from %s:%d to %s:%d\n",
379 name, (unsigned int) packet->id,
380 inet_ntop(packet->src_ipaddr.af,
381 &packet->src_ipaddr.ipaddr,
382 src_ip_buf, sizeof(src_ip_buf)),
384 inet_ntop(packet->dst_ipaddr.af,
385 &packet->dst_ipaddr.ipaddr,
386 dst_ip_buf, sizeof(dst_ip_buf)),
395 * Send a DHCP packet.
397 int fr_dhcp_send(RADIUS_PACKET *packet)
399 struct sockaddr_storage dst;
400 socklen_t sizeof_dst;
401 #ifdef WITH_UDPFROMTO
402 struct sockaddr_storage src;
403 socklen_t sizeof_src;
405 fr_ipaddr2sockaddr(&packet->src_ipaddr, packet->src_port,
409 fr_ipaddr2sockaddr(&packet->dst_ipaddr, packet->dst_port,
412 if (packet->data_len == 0) {
413 fr_strerror_printf("No data to send");
417 if (fr_debug_flag > 1) {
419 char const *name = type_buf;
420 #ifdef WITH_UDPFROMTO
421 char src_ip_buf[INET6_ADDRSTRLEN];
423 char dst_ip_buf[INET6_ADDRSTRLEN];
425 if ((packet->code >= PW_DHCP_DISCOVER) &&
426 (packet->code <= PW_DHCP_INFORM)) {
427 name = dhcp_message_types[packet->code - PW_DHCP_OFFSET];
429 snprintf(type_buf, sizeof(type_buf), "%d",
430 packet->code - PW_DHCP_OFFSET);
434 #ifdef WITH_UDPFROMTO
435 "Sending %s Id %08x from %s:%d to %s:%d\n",
437 "Sending %s Id %08x to %s:%d\n",
439 name, (unsigned int) packet->id,
440 #ifdef WITH_UDPFROMTO
441 inet_ntop(packet->src_ipaddr.af, &packet->src_ipaddr.ipaddr, src_ip_buf, sizeof(src_ip_buf)),
444 inet_ntop(packet->dst_ipaddr.af, &packet->dst_ipaddr.ipaddr, dst_ip_buf, sizeof(dst_ip_buf)),
448 #ifndef WITH_UDPFROMTO
450 * Assume that the packet is encoded before sending it.
452 return sendto(packet->sockfd, packet->data, packet->data_len, 0,
453 (struct sockaddr *)&dst, sizeof_dst);
456 return sendfromto(packet->sockfd, packet->data, packet->data_len, 0,
457 (struct sockaddr *)&src, sizeof_src,
458 (struct sockaddr *)&dst, sizeof_dst);
462 static int fr_dhcp_attr2vp(RADIUS_PACKET *packet, VALUE_PAIR *vp, uint8_t const *p, size_t alen);
464 static int decode_tlv(RADIUS_PACKET *packet, VALUE_PAIR *tlv, uint8_t const *data, size_t data_len)
467 VALUE_PAIR *head, *vp;
471 * Take a pass at parsing it.
474 while (p < (data + data_len)) {
475 if ((p + 2) > (data + data_len)) goto make_tlv;
477 if ((p + p[1] + 2) > (data + data_len)) goto make_tlv;
482 * Got here... must be well formed.
485 fr_cursor_init(&cursor, &head);
488 while (p < (data + data_len)) {
489 vp = paircreate(packet, tlv->da->attr | (p[0] << 8), DHCP_MAGIC_VENDOR);
495 if (fr_dhcp_attr2vp(packet, vp, p + 2, p[1]) < 0) {
500 fr_cursor_insert(&cursor, vp);
505 * The caller allocated TLV, so we need to copy the FIRST
506 * attribute over top of that.
508 * This is a pretty awful hack, but we should be able to
509 * clean it up when we get nested VPs so lets leave it for
513 /* Cleanup any old TLV data */
514 talloc_free(tlv->vp_tlv);
517 memcpy(tlv, head, sizeof(*tlv));
519 /* If the VP has a talloced value we need to reparent it to the original TLV attribute */
520 switch (head->da->type) {
524 (void) talloc_steal(tlv, head->data.ptr);
528 tlv->next = head->next;
535 tlv->vp_tlv = talloc_array(tlv, uint8_t, data_len);
537 fr_strerror_printf("No memory");
540 memcpy(tlv->vp_tlv, data, data_len);
541 tlv->length = data_len;
548 * Decode ONE value into a VP
550 static int fr_dhcp_attr2vp(RADIUS_PACKET *packet, VALUE_PAIR *vp, uint8_t const *p, size_t alen)
554 switch (vp->da->type) {
556 if (alen != 1) goto raw;
561 if (alen != 2) goto raw;
562 memcpy(&vp->vp_short, p, 2);
563 vp->vp_short = ntohs(vp->vp_short);
566 case PW_TYPE_INTEGER:
567 if (alen != 4) goto raw;
568 memcpy(&vp->vp_integer, p, 4);
569 vp->vp_integer = ntohl(vp->vp_integer);
572 case PW_TYPE_IPV4_ADDR:
573 if (alen != 4) goto raw;
575 * Keep value in Network Order!
577 memcpy(&vp->vp_ipaddr, p , 4);
582 vp->vp_strvalue = q = talloc_array(vp, char, alen + 1);
588 case PW_TYPE_ETHERNET:
589 memcpy(vp->vp_ether, p, sizeof(vp->vp_ether));
590 vp->length = sizeof(vp->vp_ether);
594 * Value doesn't match up with attribute type, overwrite the
595 * vp's original DICT_ATTR with an unknown one.
598 if (pair2unknown(vp) < 0) return -1;
601 if (alen > 255) return -1;
602 pairmemcpy(vp, p, alen);
606 return decode_tlv(packet, vp, p, alen);
609 fr_strerror_printf("Internal sanity check %d %d", vp->da->type, __LINE__);
611 } /* switch over type */
617 ssize_t fr_dhcp_decode_options(RADIUS_PACKET *packet,
618 uint8_t const *data, size_t len, VALUE_PAIR **head)
623 uint8_t const *p, *next;
627 fr_cursor_init(&cursor, head);
630 * FIXME: This should also check sname && file fields.
631 * See the dhcp_get_option() function above.
633 while (next < (data + len)) {
634 int num_entries, alen;
639 if (*p == 0) { /* 0x00 - Padding option */
643 if (*p == 255) break; /* 0xff - End of options signifier */
645 if ((p + 2) > (data + len)) break;
649 da = dict_attrbyvalue(p[0], DHCP_MAGIC_VENDOR);
651 fr_strerror_printf("Attribute not in our dictionary: %u", p[0]);
661 * Could be an array of bytes, integers, etc.
663 if (da->flags.array) {
670 case PW_TYPE_SHORT: /* ignore any trailing data */
671 num_entries = alen >> 1;
675 case PW_TYPE_IPV4_ADDR:
676 case PW_TYPE_INTEGER:
677 case PW_TYPE_DATE: /* ignore any trailing data */
678 num_entries = alen >> 2;
684 break; /* really an internal sanity failure */
689 * Loop over all of the entries, building VPs
691 for (i = 0; i < num_entries; i++) {
692 vp = pairmake(packet, NULL, da->name, NULL, T_OP_ADD);
694 fr_strerror_printf("Cannot build attribute %s",
700 if (fr_dhcp_attr2vp(packet, vp, p, alen) < 0) {
706 fr_cursor_insert(&cursor, vp);
708 for (vp = fr_cursor_current(&cursor);
710 vp = fr_cursor_next(&cursor)) {
714 } /* loop over array entries */
715 } /* loop over the entire packet */
720 int fr_dhcp_decode(RADIUS_PACKET *packet)
726 VALUE_PAIR *head = NULL, *vp;
727 VALUE_PAIR *maxms, *mtu;
729 fr_cursor_init(&cursor, &head);
732 if ((fr_debug_flag > 2) && fr_log_fp) {
733 for (i = 0; i < packet->data_len; i++) {
734 if ((i & 0x0f) == 0x00) fprintf(fr_log_fp, "%d: ", (int) i);
735 fprintf(fr_log_fp, "%02x ", packet->data[i]);
736 if ((i & 0x0f) == 0x0f) fprintf(fr_log_fp, "\n");
738 fprintf(fr_log_fp, "\n");
741 if (packet->data[1] != 1) {
742 fr_strerror_printf("Packet is not Ethernet: %u",
750 for (i = 0; i < 14; i++) {
753 vp = pairmake(packet, NULL, dhcp_header_names[i], NULL, T_OP_EQ);
756 strlcpy(buffer, fr_strerror(), sizeof(buffer));
757 fr_strerror_printf("Cannot decode packet due to internal error: %s", buffer);
763 * If chaddr does != 6 bytes it's probably not ethernet, and we should store
764 * it as an opaque type (octets).
766 if ((i == 11) && (packet->data[1] == 1) && (packet->data[2] != sizeof(vp->vp_ether))) {
767 DICT_ATTR const *da = dict_attrunknown(vp->da->attr, vp->da->vendor, true);
774 switch (vp->da->type) {
781 vp->vp_short = (p[0] << 8) | p[1];
785 case PW_TYPE_INTEGER:
786 memcpy(&vp->vp_integer, p, 4);
787 vp->vp_integer = ntohl(vp->vp_integer);
791 case PW_TYPE_IPV4_ADDR:
792 memcpy(&vp->vp_ipaddr, p, 4);
797 vp->vp_strvalue = q = talloc_array(vp, char, dhcp_header_sizes[i] + 1);
799 memcpy(q, p, dhcp_header_sizes[i]);
800 q[dhcp_header_sizes[i]] = '\0';
801 vp->length = strlen(vp->vp_strvalue);
802 if (vp->length == 0) {
808 pairmemcpy(vp, p, packet->data[2]);
811 case PW_TYPE_ETHERNET:
812 memcpy(vp->vp_ether, p, sizeof(vp->vp_ether));
813 vp->length = sizeof(vp->vp_ether);
817 fr_strerror_printf("BAD TYPE %d", vp->da->type);
821 p += dhcp_header_sizes[i];
826 fr_cursor_insert(&cursor, vp);
830 * Loop over the options.
834 * Nothing uses tail after this call, if it does in the future
835 * it'll need to find the new tail...
838 VALUE_PAIR *options = NULL;
840 if (fr_dhcp_decode_options(packet,
841 packet->data + 240, packet->data_len - 240,
847 fr_cursor_insert(&cursor, options);
852 * If DHCP request, set ciaddr to zero.
856 * Set broadcast flag for broken vendors, but only if
859 memcpy(&giaddr, packet->data + 24, sizeof(giaddr));
860 if (giaddr == htonl(INADDR_ANY)) {
862 * DHCP Opcode is request
864 vp = pairfind(head, 256, DHCP_MAGIC_VENDOR, TAG_ANY);
865 if (vp && vp->vp_integer == 3) {
867 * Vendor is "MSFT 98"
869 vp = pairfind(head, 63, DHCP_MAGIC_VENDOR, TAG_ANY);
870 if (vp && (strcmp(vp->vp_strvalue, "MSFT 98") == 0)) {
871 vp = pairfind(head, 262, DHCP_MAGIC_VENDOR, TAG_ANY);
874 * Reply should be broadcast.
876 if (vp) vp->vp_integer |= 0x8000;
877 packet->data[10] |= 0x80;
883 * FIXME: Nuke attributes that aren't used in the normal
884 * header for discover/requests.
889 * Client can request a LARGER size, but not a smaller
890 * one. They also cannot request a size larger than MTU.
892 maxms = pairfind(packet->vps, 57, DHCP_MAGIC_VENDOR, TAG_ANY);
893 mtu = pairfind(packet->vps, 26, DHCP_MAGIC_VENDOR, TAG_ANY);
895 if (mtu && (mtu->vp_integer < DEFAULT_PACKET_SIZE)) {
896 fr_strerror_printf("DHCP Fatal: Client says MTU is smaller than minimum permitted by the specification");
900 if (maxms && (maxms->vp_integer < DEFAULT_PACKET_SIZE)) {
901 fr_strerror_printf("DHCP WARNING: Client says maximum message size is smaller than minimum permitted by the specification: fixing it");
902 maxms->vp_integer = DEFAULT_PACKET_SIZE;
905 if (maxms && mtu && (maxms->vp_integer > mtu->vp_integer)) {
906 fr_strerror_printf("DHCP WARNING: Client says MTU is smaller than maximum message size: fixing it");
907 maxms->vp_integer = mtu->vp_integer;
910 if (fr_debug_flag) fflush(stdout);
916 int8_t fr_dhcp_attr_cmp(void const *a, void const *b)
918 VALUE_PAIR const *my_a = a;
919 VALUE_PAIR const *my_b = b;
925 * DHCP-Message-Type is first, for simplicity.
927 if ((my_a->da->attr == 53) && (my_b->da->attr != 53)) return -1;
930 * Relay-Agent is last
932 if ((my_a->da->attr == 82) && (my_b->da->attr != 82)) return 1;
934 if (my_a->da->attr < my_b->da->attr) return -1;
935 if (my_a->da->attr > my_b->da->attr) return 1;
940 /** Write DHCP option value into buffer
942 * Does not include DHCP option length or number.
944 * @param out where to write the DHCP option.
945 * @param outlen length of output buffer.
946 * @param vp option to encode.
947 * @return the length of data writen, -1 if out of buffer, -2 if unsupported type.
949 static ssize_t fr_dhcp_vp2attr(uint8_t *out, size_t outlen, VALUE_PAIR *vp)
954 if (outlen < vp->length) {
958 switch (vp->da->type) {
964 p[0] = (vp->vp_short >> 8) & 0xff;
965 p[1] = vp->vp_short & 0xff;
968 case PW_TYPE_INTEGER:
969 lvalue = htonl(vp->vp_integer);
970 memcpy(p, &lvalue, 4);
973 case PW_TYPE_IPV4_ADDR:
974 memcpy(p, &vp->vp_ipaddr, 4);
977 case PW_TYPE_ETHERNET:
978 memcpy(p, &vp->vp_ether, 6);
982 memcpy(p, vp->vp_strvalue, vp->length);
985 case PW_TYPE_TLV: /* FIXME: split it on 255? */
986 memcpy(p, vp->vp_tlv, vp->length);
990 memcpy(p, vp->vp_octets, vp->length);
994 fr_strerror_printf("Unsupported option type %d", vp->da->type);
1001 /** Create a new TLV attribute from multiple sub options
1003 * @param[in,out] ctx to allocate new attribute in.
1004 * @param[in,out] cursor should be set to the start of the list of TLV attributes.
1005 * Will be advanced to the first non-TLV attribute.
1006 * @return attribute holding the concatenation of the values of the sub options.
1008 static VALUE_PAIR *fr_dhcp_vp2suboption(TALLOC_CTX *ctx, vp_cursor_t *cursor)
1011 unsigned int parent; /* Parent attribute of suboption */
1013 uint8_t *p, *opt_len = NULL;
1014 vp_cursor_t to_pack;
1015 VALUE_PAIR *vp, *tlv;
1017 #define SUBOPTION_PARENT(_x) (_x & 0xffff00ff)
1018 #define SUBOPTION_ATTR(_x) ((_x & 0xff00) >> 8)
1020 vp = fr_cursor_current(cursor);
1021 if (!vp) return NULL;
1023 parent = SUBOPTION_PARENT(vp->da->attr);
1024 tlv = paircreate(ctx, parent, DHCP_MAGIC_VENDOR);
1025 if (!tlv) return NULL;
1027 fr_cursor_copy(&to_pack, cursor);
1030 * Loop over TLVs to determine how much memory we need to allocate
1032 * We advanced the cursor we were passed, so if we fail encoding,
1033 * the cursor is at the right position for the next potentially
1036 for (vp = fr_cursor_current(cursor);
1037 vp && vp->da->flags.is_tlv && !vp->da->flags.extended && (SUBOPTION_PARENT(vp->da->attr) == parent);
1038 vp = fr_cursor_next(cursor)) {
1040 * If it's not an array type or is an array type, but is not the same
1041 * as the previous attribute, we add 2 for the additional sub-option
1044 if (!vp->da->flags.array || (SUBOPTION_ATTR(vp->da->attr) != attr)) {
1045 attr = SUBOPTION_ATTR(vp->da->attr);
1048 tlv->length += vp->length;
1051 tlv->vp_tlv = talloc_array(tlv, uint8_t, tlv->length);
1059 for (vp = fr_cursor_current(&to_pack);
1060 vp && vp->da->flags.is_tlv && !vp->da->flags.extended && (SUBOPTION_PARENT(vp->da->attr) == parent);
1061 vp = fr_cursor_next(&to_pack)) {
1062 if (SUBOPTION_ATTR(vp->da->attr) == 0) {
1063 fr_strerror_printf("Invalid attribute number 0");
1067 /* Don't write out the header, were packing array options */
1068 if (!vp->da->flags.array || (attr != SUBOPTION_ATTR(vp->da->attr))) {
1069 attr = SUBOPTION_ATTR(vp->da->attr);
1074 length = fr_dhcp_vp2attr(p, (tlv->vp_tlv + tlv->length) - p, vp);
1075 if ((length < 0) || (length > 255)) {
1088 /** Encode a DHCP option and any sub-options.
1090 * @param out Where to write encoded DHCP attributes.
1091 * @param outlen Length of out buffer.
1092 * @param ctx to use for any allocated memory.
1093 * @param cursor with current VP set to the option to be encoded. Will be advanced to the next option to encode.
1094 * @return > 0 length of data written, < 0 error, 0 not valid option (skipping).
1096 ssize_t fr_dhcp_encode_option(uint8_t *out, size_t outlen, TALLOC_CTX *ctx, vp_cursor_t *cursor)
1099 DICT_ATTR const *previous;
1100 uint8_t *opt_len, *p = out;
1101 size_t freespace = outlen;
1104 vp = fr_cursor_current(cursor);
1107 if (vp->da->vendor != DHCP_MAGIC_VENDOR) goto next; /* not a DHCP option */
1108 if (vp->da->attr == 53) goto next; /* already done */
1109 if ((vp->da->attr > 255) && (DHCP_BASE_ATTR(vp->da->attr) != PW_DHCP_OPTION_82)) goto next;
1111 if (vp->da->flags.extended) {
1113 fr_strerror_printf("Attribute \"%s\" is not a DHCP option", vp->da->name);
1114 fr_cursor_next(cursor);
1118 /* Write out the option number */
1119 *(p++) = vp->da->attr & 0xff;
1121 /* Pointer to the length field of the option */
1124 /* Zero out the option's length field */
1127 /* We just consumed two bytes for the header */
1130 /* DHCP options with the same number get coalesced into a single option */
1132 VALUE_PAIR *tlv = NULL;
1135 if (vp->da->flags.is_tlv) {
1137 * Coalesce TLVs into one sub-option.
1138 * Cursor will be advanced to next non-TLV attribute.
1140 tlv = vp = fr_dhcp_vp2suboption(ctx, cursor);
1143 * Skip if there's an issue coalescing the sub-options.
1144 * Cursor will still have been advanced to next non-TLV attribute.
1148 * If not calling fr_dhcp_vp2suboption() advance the cursor, so fr_cursor_current()
1149 * returns the next attribute.
1152 fr_cursor_next(cursor);
1155 if ((*opt_len + vp->length) > 255) {
1156 fr_strerror_printf("Skipping \"%s\": Option splitting not supported "
1157 "(option > 255 bytes)", vp->da->name);
1162 len = fr_dhcp_vp2attr(p, freespace, vp);
1165 /* Failed encoding option */
1174 } while ((vp = fr_cursor_current(cursor)) && (previous == vp->da) && vp->da->flags.array);
1179 int fr_dhcp_encode(RADIUS_PACKET *packet)
1190 # ifdef WITH_UDPFROMTO
1191 char src_ip_buf[256];
1193 char dst_ip_buf[256];
1196 if (packet->data) return 0;
1198 packet->data_len = MAX_PACKET_SIZE;
1199 packet->data = talloc_zero_array(packet, uint8_t, packet->data_len);
1201 /* XXX Ugly ... should be set by the caller */
1202 if (packet->code == 0) packet->code = PW_DHCP_NAK;
1205 if ((packet->code >= PW_DHCP_DISCOVER) &&
1206 (packet->code <= PW_DHCP_INFORM)) {
1207 name = dhcp_message_types[packet->code - PW_DHCP_OFFSET];
1213 # ifdef WITH_UDPFROMTO
1214 "Encoding %s of id %08x from %s:%d to %s:%d\n",
1216 "Encoding %s of id %08x to %s:%d\n",
1218 name, (unsigned int) packet->id,
1219 # ifdef WITH_UDPFROMTO
1220 inet_ntop(packet->src_ipaddr.af,
1221 &packet->src_ipaddr.ipaddr,
1222 src_ip_buf, sizeof(src_ip_buf)),
1225 inet_ntop(packet->dst_ipaddr.af,
1226 &packet->dst_ipaddr.ipaddr,
1227 dst_ip_buf, sizeof(dst_ip_buf)),
1234 * @todo: Make this work again.
1237 mms = DEFAULT_PACKET_SIZE; /* maximum message size */
1240 * Clients can request a LARGER size, but not a
1241 * smaller one. They also cannot request a size
1245 /* DHCP-DHCP-Maximum-Msg-Size */
1246 vp = pairfind(packet->vps, 57, DHCP_MAGIC_VENDOR, TAG_ANY);
1247 if (vp && (vp->vp_integer > mms)) {
1248 mms = vp->vp_integer;
1250 if (mms > MAX_PACKET_SIZE) mms = MAX_PACKET_SIZE;
1254 vp = pairfind(packet->vps, 256, DHCP_MAGIC_VENDOR, TAG_ANY);
1256 *p++ = vp->vp_integer & 0xff;
1258 *p++ = 1; /* client message */
1261 /* DHCP-Hardware-Type */
1262 if ((vp = pairfind(packet->vps, 257, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1263 *p++ = vp->vp_integer & 0xFF;
1265 *p++ = 1; /* hardware type = ethernet */
1268 /* DHCP-Hardware-Address-Length */
1269 if ((vp = pairfind(packet->vps, 258, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1270 *p++ = vp->vp_integer & 0xFF;
1272 *p++ = 6; /* 6 bytes of ethernet */
1275 /* DHCP-Hop-Count */
1276 if ((vp = pairfind(packet->vps, 259, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1277 *p = vp->vp_integer & 0xff;
1281 /* DHCP-Transaction-Id */
1282 if ((vp = pairfind(packet->vps, 260, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1283 lvalue = htonl(vp->vp_integer);
1287 memcpy(p, &lvalue, 4);
1290 /* DHCP-Number-of-Seconds */
1291 if ((vp = pairfind(packet->vps, 261, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1292 lvalue = htonl(vp->vp_integer);
1293 memcpy(p, &lvalue, 2);
1298 if ((vp = pairfind(packet->vps, 262, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1299 lvalue = htons(vp->vp_integer);
1300 memcpy(p, &lvalue, 2);
1304 /* DHCP-Client-IP-Address */
1305 if ((vp = pairfind(packet->vps, 263, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1306 memcpy(p, &vp->vp_ipaddr, 4);
1310 /* DHCP-Your-IP-address */
1311 if ((vp = pairfind(packet->vps, 264, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1312 lvalue = vp->vp_ipaddr;
1314 lvalue = htonl(INADDR_ANY);
1316 memcpy(p, &lvalue, 4);
1319 /* DHCP-Server-IP-Address */
1320 vp = pairfind(packet->vps, 265, DHCP_MAGIC_VENDOR, TAG_ANY);
1322 /* DHCP-DHCP-Server-Identifier */
1323 if (!vp && (vp = pairfind(packet->vps, 54, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1324 lvalue = vp->vp_ipaddr;
1326 lvalue = htonl(INADDR_ANY);
1328 memcpy(p, &lvalue, 4);
1332 * DHCP-Gateway-IP-Address
1334 if ((vp = pairfind(packet->vps, 266, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1335 lvalue = vp->vp_ipaddr;
1337 lvalue = htonl(INADDR_ANY);
1339 memcpy(p, &lvalue, 4);
1342 /* DHCP-Client-Hardware-Address */
1343 if ((vp = pairfind(packet->vps, 267, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1344 if (vp->length == sizeof(vp->vp_ether)) {
1345 memcpy(p, vp->vp_ether, vp->length);
1346 } /* else ignore it */
1348 p += DHCP_CHADDR_LEN;
1350 /* DHCP-Server-Host-Name */
1351 if ((vp = pairfind(packet->vps, 268, DHCP_MAGIC_VENDOR, TAG_ANY))) {
1352 if (vp->length > DHCP_SNAME_LEN) {
1353 memcpy(p, vp->vp_strvalue, DHCP_SNAME_LEN);
1355 memcpy(p, vp->vp_strvalue, vp->length);
1358 p += DHCP_SNAME_LEN;
1361 * Copy over DHCP-Boot-Filename.
1363 * FIXME: This copy should be delayed until AFTER the options
1364 * have been processed. If there are too many options for
1365 * the packet, then they go into the sname && filename fields.
1366 * When that happens, the boot filename is passed as an option,
1367 * instead of being placed verbatim in the filename field.
1370 /* DHCP-Boot-Filename */
1371 vp = pairfind(packet->vps, 269, DHCP_MAGIC_VENDOR, TAG_ANY);
1373 if (vp->length > DHCP_FILE_LEN) {
1374 memcpy(p, vp->vp_strvalue, DHCP_FILE_LEN);
1376 memcpy(p, vp->vp_strvalue, vp->length);
1381 /* DHCP magic number */
1382 lvalue = htonl(DHCP_OPTION_MAGIC_NUMBER);
1383 memcpy(p, &lvalue, 4);
1389 if (fr_debug_flag > 1) {
1394 for (i = 0; i < 14; i++) {
1397 vp = pairmake(packet, NULL,
1398 dhcp_header_names[i], NULL, T_OP_EQ);
1401 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1402 fr_strerror_printf("Cannot decode packet due to internal error: %s", buffer);
1406 switch (vp->da->type) {
1412 vp->vp_short = (p[0] << 8) | p[1];
1415 case PW_TYPE_INTEGER:
1416 memcpy(&vp->vp_integer, p, 4);
1417 vp->vp_integer = ntohl(vp->vp_integer);
1420 case PW_TYPE_IPV4_ADDR:
1421 memcpy(&vp->vp_ipaddr, p, 4);
1424 case PW_TYPE_STRING:
1425 vp->vp_strvalue = q = talloc_array(vp, char, dhcp_header_sizes[i] + 1);
1427 memcpy(q, p, dhcp_header_sizes[i]);
1428 q[dhcp_header_sizes[i]] = '\0';
1429 vp->length = strlen(vp->vp_strvalue);
1432 case PW_TYPE_OCTETS: /* only for Client HW Address */
1433 pairmemcpy(vp, p, packet->data[2]);
1436 case PW_TYPE_ETHERNET: /* only for Client HW Address */
1437 memcpy(vp->vp_ether, p, sizeof(vp->vp_ether));
1441 fr_strerror_printf("Internal sanity check failed %d %d", vp->da->type, __LINE__);
1446 p += dhcp_header_sizes[i];
1453 * Jump over DHCP magic number, response, etc.
1458 p[0] = 0x35; /* DHCP-Message-Type */
1460 p[2] = packet->code - PW_DHCP_OFFSET;
1465 * Pre-sort attributes into contiguous blocks so that fr_dhcp_encode_option
1466 * operates correctly. This changes the order of the list, but never mind...
1468 pairsort(&packet->vps, fr_dhcp_attr_cmp);
1469 fr_cursor_init(&cursor, &packet->vps);
1472 * Each call to fr_dhcp_encode_option will encode one complete DHCP option,
1475 while ((vp = fr_cursor_current(&cursor))) {
1476 len = fr_dhcp_encode_option(p, packet->data_len - (p - packet->data), packet, &cursor);
1478 if (len > 0) debug_pair(vp);
1482 p[0] = 0xff; /* end of option option */
1485 dhcp_size = p - packet->data;
1488 * FIXME: if (dhcp_size > mms),
1489 * then we put the extra options into the "sname" and "file"
1490 * fields, AND set the "end option option" in the "options"
1491 * field. We also set the "overload option",
1492 * and put options into the "file" field, followed by
1493 * the "sname" field. Where each option is completely
1494 * enclosed in the "file" and/or "sname" field, AND
1495 * followed by the "end of option", and MUST be followed
1496 * by padding option.
1498 * Yuck. That sucks...
1500 packet->data_len = dhcp_size;
1502 if (packet->data_len < DEFAULT_PACKET_SIZE) {
1503 memset(packet->data + packet->data_len, 0,
1504 DEFAULT_PACKET_SIZE - packet->data_len);
1505 packet->data_len = DEFAULT_PACKET_SIZE;
1508 if ((fr_debug_flag > 2) && fr_log_fp) {
1509 fprintf(fr_log_fp, "DHCP Sending %zu bytes\n", packet->data_len);
1510 for (i = 0; i < packet->data_len; i++) {
1511 if ((i & 0x0f) == 0x00) fprintf(fr_log_fp, "%d: ", i);
1512 fprintf(fr_log_fp, "%02x ", packet->data[i]);
1513 if ((i & 0x0f) == 0x0f) fprintf(fr_log_fp, "\n");
1515 fprintf(fr_log_fp, "\n");
1522 int fr_dhcp_add_arp_entry(int fd, char const *interface,
1523 VALUE_PAIR *macaddr, VALUE_PAIR *ip)
1525 struct sockaddr_in *sin;
1529 fr_strerror_printf("No interface specified. Cannot update ARP table");
1533 if (!fr_assert(macaddr) ||
1534 !fr_assert((macaddr->da->type == PW_TYPE_ETHERNET) || (macaddr->da->type == PW_TYPE_OCTETS))) {
1535 fr_strerror_printf("Wrong VP type (%s) for chaddr",
1536 fr_int2str(dict_attr_types, macaddr->da->type, "<invalid>"));
1540 if (macaddr->length > sizeof(req.arp_ha.sa_data)) {
1541 fr_strerror_printf("arp sa_data field too small (%zu octets) to contain chaddr (%zu octets)",
1542 sizeof(req.arp_ha.sa_data), macaddr->length);
1546 memset(&req, 0, sizeof(req));
1547 sin = (struct sockaddr_in *) &req.arp_pa;
1548 sin->sin_family = AF_INET;
1549 sin->sin_addr.s_addr = ip->vp_ipaddr;
1551 strlcpy(req.arp_dev, interface, sizeof(req.arp_dev));
1553 if (macaddr->da->type == PW_TYPE_ETHERNET) {
1554 memcpy(&req.arp_ha.sa_data, &macaddr->vp_ether, sizeof(macaddr->vp_ether));
1556 memcpy(&req.arp_ha.sa_data, macaddr->vp_octets, macaddr->length);
1559 req.arp_flags = ATF_COM;
1560 if (ioctl(fd, SIOCSARP, &req) < 0) {
1561 fr_strerror_printf("Failed to add entry in ARP cache: %s (%d)", fr_syserror(errno), errno);
1568 int fr_dhcp_add_arp_entry(UNUSED int fd, UNUSED char const *interface,
1569 UNUSED VALUE_PAIR *macaddr, UNUSED VALUE_PAIR *ip)
1571 fr_strerror_printf("Adding ARP entry is unsupported on this system");