3 * DHCP Server library with GLib integration
5 * Copyright (C) 2009-2012 Intel Corporation. All rights reserved.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * This program 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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31 #include <sys/ioctl.h>
32 #include <arpa/inet.h>
34 #include <netpacket/packet.h>
35 #include <net/ethernet.h>
36 #include <net/if_arp.h>
39 #include <linux/filter.h>
46 #define DEFAULT_DHCP_LEASE_SEC (8*60*60)
49 #define OFFER_TIME (5*60)
59 uint32_t server_nip; /* our address in network byte order */
60 uint32_t lease_seconds;
63 GIOChannel *listener_channel;
65 GHashTable *nip_lease_hash;
66 GHashTable *option_hash; /* Options send to client */
67 GDHCPSaveLeaseFunc save_lease_func;
68 GDHCPLeaseAddedCb lease_added_cb;
69 GDHCPSaveACKLeaseFunc save_ack_lease_func;
70 GDHCPDebugFunc debug_func;
77 uint8_t lease_mac[ETH_ALEN];
80 static inline void debug(GDHCPServer *server, const char *format, ...)
85 if (!server->debug_func)
90 if (vsnprintf(str, sizeof(str), format, ap) > 0)
91 server->debug_func(str, server->debug_data);
96 static struct dhcp_lease *find_lease_by_mac(GDHCPServer *dhcp_server,
101 for (list = dhcp_server->lease_list; list; list = list->next) {
102 struct dhcp_lease *lease = list->data;
104 if (memcmp(lease->lease_mac, mac, ETH_ALEN) == 0)
111 static void remove_lease(GDHCPServer *dhcp_server, struct dhcp_lease *lease)
113 dhcp_server->lease_list =
114 g_list_remove(dhcp_server->lease_list, lease);
116 g_hash_table_remove(dhcp_server->nip_lease_hash,
117 GINT_TO_POINTER((int) lease->lease_nip));
121 /* Clear the old lease and create the new one */
122 static int get_lease(GDHCPServer *dhcp_server, uint32_t yiaddr,
123 const uint8_t *mac, struct dhcp_lease **lease)
125 struct dhcp_lease *lease_nip, *lease_mac;
130 if (ntohl(yiaddr) < dhcp_server->start_ip)
133 if (ntohl(yiaddr) > dhcp_server->end_ip)
136 if (memcmp(mac, MAC_BCAST_ADDR, ETH_ALEN) == 0)
139 if (memcmp(mac, MAC_ANY_ADDR, ETH_ALEN) == 0)
142 lease_mac = find_lease_by_mac(dhcp_server, mac);
144 lease_nip = g_hash_table_lookup(dhcp_server->nip_lease_hash,
145 GINT_TO_POINTER((int) ntohl(yiaddr)));
146 debug(dhcp_server, "lease_mac %p lease_nip %p", lease_mac, lease_nip);
149 dhcp_server->lease_list =
150 g_list_remove(dhcp_server->lease_list,
152 g_hash_table_remove(dhcp_server->nip_lease_hash,
153 GINT_TO_POINTER((int) ntohl(yiaddr)));
157 else if (lease_nip != lease_mac) {
158 remove_lease(dhcp_server, lease_mac);
167 dhcp_server->lease_list =
168 g_list_remove(dhcp_server->lease_list,
170 g_hash_table_remove(dhcp_server->nip_lease_hash,
171 GINT_TO_POINTER((int) lease_mac->lease_nip));
177 *lease = g_try_new0(struct dhcp_lease, 1);
184 static gint compare_expire(gconstpointer a, gconstpointer b)
186 const struct dhcp_lease *lease1 = a;
187 const struct dhcp_lease *lease2 = b;
189 return lease2->expire - lease1->expire;
192 static struct dhcp_lease *add_lease(GDHCPServer *dhcp_server, uint32_t expire,
193 const uint8_t *chaddr, uint32_t yiaddr)
195 struct dhcp_lease *lease = NULL;
198 ret = get_lease(dhcp_server, yiaddr, chaddr, &lease);
202 memset(lease, 0, sizeof(*lease));
204 memcpy(lease->lease_mac, chaddr, ETH_ALEN);
205 lease->lease_nip = ntohl(yiaddr);
208 lease->expire = time(NULL) + dhcp_server->lease_seconds;
210 lease->expire = expire;
212 dhcp_server->lease_list = g_list_insert_sorted(dhcp_server->lease_list,
213 lease, compare_expire);
215 g_hash_table_insert(dhcp_server->nip_lease_hash,
216 GINT_TO_POINTER((int) lease->lease_nip), lease);
221 static struct dhcp_lease *find_lease_by_nip(GDHCPServer *dhcp_server,
224 return g_hash_table_lookup(dhcp_server->nip_lease_hash,
225 GINT_TO_POINTER((int) nip));
228 /* Check if the IP is taken; if it is, add it to the lease table */
229 static bool arp_check(uint32_t nip, const uint8_t *safe_mac)
231 /* TODO: Add ARP checking */
235 static bool is_expired_lease(struct dhcp_lease *lease)
237 if (lease->expire < time(NULL))
243 static uint32_t find_free_or_expired_nip(GDHCPServer *dhcp_server,
244 const uint8_t *safe_mac)
247 struct dhcp_lease *lease;
249 ip_addr = dhcp_server->start_ip;
250 for (; ip_addr <= dhcp_server->end_ip; ip_addr++) {
251 /* e.g. 192.168.55.0 */
252 if ((ip_addr & 0xff) == 0)
255 /* e.g. 192.168.55.255 */
256 if ((ip_addr & 0xff) == 0xff)
259 lease = find_lease_by_nip(dhcp_server, ip_addr);
263 if (arp_check(htonl(ip_addr), safe_mac))
267 /* The last lease is the oldest one */
268 list = g_list_last(dhcp_server->lease_list);
276 if (!is_expired_lease(lease))
279 if (!arp_check(lease->lease_nip, safe_mac))
282 return lease->lease_nip;
285 static void lease_set_expire(GDHCPServer *dhcp_server,
286 struct dhcp_lease *lease, uint32_t expire)
288 dhcp_server->lease_list = g_list_remove(dhcp_server->lease_list, lease);
290 lease->expire = expire;
292 dhcp_server->lease_list = g_list_insert_sorted(dhcp_server->lease_list,
293 lease, compare_expire);
296 static void destroy_lease_table(GDHCPServer *dhcp_server)
300 g_hash_table_destroy(dhcp_server->nip_lease_hash);
302 dhcp_server->nip_lease_hash = NULL;
304 for (list = dhcp_server->lease_list; list; list = list->next) {
305 struct dhcp_lease *lease = list->data;
310 g_list_free(dhcp_server->lease_list);
312 dhcp_server->lease_list = NULL;
314 static uint32_t get_interface_address(int index)
318 struct sockaddr_in *server_ip;
321 sk = socket(PF_INET, SOCK_DGRAM | SOCK_CLOEXEC, 0);
323 perror("Open socket error");
327 memset(&ifr, 0, sizeof(ifr));
328 ifr.ifr_ifindex = index;
330 err = ioctl(sk, SIOCGIFNAME, &ifr);
332 perror("Get interface name error");
336 err = ioctl(sk, SIOCGIFADDR, &ifr);
338 perror("Get ip address error");
342 server_ip = (struct sockaddr_in *) &ifr.ifr_addr;
343 ret = server_ip->sin_addr.s_addr;
351 GDHCPServer *g_dhcp_server_new(GDHCPType type,
352 int ifindex, GDHCPServerError *error)
354 GDHCPServer *dhcp_server = NULL;
357 *error = G_DHCP_SERVER_ERROR_INVALID_INDEX;
361 dhcp_server = g_try_new0(GDHCPServer, 1);
363 *error = G_DHCP_SERVER_ERROR_NOMEM;
367 dhcp_server->interface = get_interface_name(ifindex);
368 if (!dhcp_server->interface) {
369 *error = G_DHCP_SERVER_ERROR_INTERFACE_UNAVAILABLE;
373 if (!interface_is_up(ifindex)) {
374 *error = G_DHCP_SERVER_ERROR_INTERFACE_DOWN;
378 dhcp_server->server_nip = get_interface_address(ifindex);
379 if (dhcp_server->server_nip == 0) {
380 *error = G_DHCP_SERVER_ERROR_IP_ADDRESS_INVALID;
384 dhcp_server->nip_lease_hash = g_hash_table_new_full(g_direct_hash,
385 g_direct_equal, NULL, NULL);
386 dhcp_server->option_hash = g_hash_table_new_full(g_direct_hash,
387 g_direct_equal, NULL, NULL);
389 dhcp_server->started = FALSE;
391 /* All the leases have the same fixed lease time,
392 * do not support DHCP_LEASE_TIME option from client.
394 dhcp_server->lease_seconds = DEFAULT_DHCP_LEASE_SEC;
396 dhcp_server->type = type;
397 dhcp_server->ref_count = 1;
398 dhcp_server->ifindex = ifindex;
399 dhcp_server->listener_sockfd = -1;
400 dhcp_server->listener_watch = -1;
401 dhcp_server->listener_channel = NULL;
402 dhcp_server->save_lease_func = NULL;
403 dhcp_server->save_ack_lease_func = NULL;
404 dhcp_server->debug_func = NULL;
405 dhcp_server->debug_data = NULL;
407 *error = G_DHCP_SERVER_ERROR_NONE;
412 g_free(dhcp_server->interface);
418 static uint8_t check_packet_type(struct dhcp_packet *packet)
422 if (packet->hlen != ETH_ALEN)
425 if (packet->op != BOOTREQUEST)
428 type = dhcp_get_option(packet, DHCP_MESSAGE_TYPE);
433 if (*type < DHCP_MINTYPE)
436 if (*type > DHCP_MAXTYPE)
442 static void init_packet(GDHCPServer *dhcp_server, struct dhcp_packet *packet,
443 struct dhcp_packet *client_packet, char type)
445 /* Sets op, htype, hlen, cookie fields
446 * and adds DHCP_MESSAGE_TYPE option */
447 dhcp_init_header(packet, type);
449 packet->xid = client_packet->xid;
450 memcpy(packet->chaddr, client_packet->chaddr,
451 sizeof(client_packet->chaddr));
452 packet->flags = client_packet->flags;
453 packet->gateway_nip = client_packet->gateway_nip;
454 packet->ciaddr = client_packet->ciaddr;
455 dhcp_add_option_uint32(packet, DHCP_SERVER_ID,
456 ntohl(dhcp_server->server_nip));
459 static void add_option(gpointer key, gpointer value, gpointer user_data)
461 const char *option_value = value;
462 uint8_t option_code = GPOINTER_TO_INT(key);
464 struct dhcp_packet *packet = user_data;
469 switch (option_code) {
472 case G_DHCP_DNS_SERVER:
473 if (inet_aton(option_value, &nip) == 0)
476 dhcp_add_option_uint32(packet, (uint8_t) option_code,
484 static void add_server_options(GDHCPServer *dhcp_server,
485 struct dhcp_packet *packet)
487 g_hash_table_foreach(dhcp_server->option_hash,
491 static bool check_requested_nip(GDHCPServer *dhcp_server,
492 uint32_t requested_nip)
494 struct dhcp_lease *lease;
496 if (requested_nip == 0)
499 if (requested_nip < dhcp_server->start_ip)
502 if (requested_nip > dhcp_server->end_ip)
505 lease = find_lease_by_nip(dhcp_server, requested_nip);
509 if (!is_expired_lease(lease))
515 static void send_packet_to_client(GDHCPServer *dhcp_server,
516 struct dhcp_packet *dhcp_pkt)
518 const uint8_t *chaddr;
521 if ((dhcp_pkt->flags & htons(BROADCAST_FLAG))
522 || dhcp_pkt->ciaddr == 0) {
523 debug(dhcp_server, "Broadcasting packet to client");
524 ciaddr = INADDR_BROADCAST;
525 chaddr = MAC_BCAST_ADDR;
527 debug(dhcp_server, "Unicasting packet to client ciaddr");
528 ciaddr = dhcp_pkt->ciaddr;
529 chaddr = dhcp_pkt->chaddr;
532 dhcp_send_raw_packet(dhcp_pkt,
533 dhcp_server->server_nip, SERVER_PORT,
534 ciaddr, CLIENT_PORT, chaddr,
535 dhcp_server->ifindex, false);
538 static void send_offer(GDHCPServer *dhcp_server,
539 struct dhcp_packet *client_packet,
540 struct dhcp_lease *lease,
541 uint32_t requested_nip)
543 struct dhcp_packet packet;
546 init_packet(dhcp_server, &packet, client_packet, DHCPOFFER);
549 packet.yiaddr = htonl(lease->lease_nip);
550 else if (check_requested_nip(dhcp_server, requested_nip))
551 packet.yiaddr = htonl(requested_nip);
553 packet.yiaddr = htonl(find_free_or_expired_nip(
554 dhcp_server, client_packet->chaddr));
556 debug(dhcp_server, "find yiaddr %u", packet.yiaddr);
558 if (!packet.yiaddr) {
559 debug(dhcp_server, "Err: Can not found lease and send offer");
563 lease = add_lease(dhcp_server, OFFER_TIME,
564 packet.chaddr, packet.yiaddr);
567 "Err: No free IP addresses. OFFER abandoned");
571 dhcp_add_option_uint32(&packet, DHCP_LEASE_TIME,
572 dhcp_server->lease_seconds);
573 add_server_options(dhcp_server, &packet);
575 addr.s_addr = packet.yiaddr;
577 debug(dhcp_server, "Sending OFFER of %s", inet_ntoa(addr));
578 send_packet_to_client(dhcp_server, &packet);
581 static void save_lease(GDHCPServer *dhcp_server)
585 if (!dhcp_server->save_lease_func)
588 for (list = dhcp_server->lease_list; list; list = list->next) {
589 struct dhcp_lease *lease = list->data;
590 dhcp_server->save_lease_func(lease->lease_mac,
591 lease->lease_nip, lease->expire);
595 static void send_ACK(GDHCPServer *dhcp_server,
596 struct dhcp_packet *client_packet, uint32_t dest)
598 struct dhcp_packet packet;
599 uint32_t lease_time_sec;
602 init_packet(dhcp_server, &packet, client_packet, DHCPACK);
603 packet.yiaddr = htonl(dest);
605 lease_time_sec = dhcp_server->lease_seconds;
607 dhcp_add_option_uint32(&packet, DHCP_LEASE_TIME, lease_time_sec);
609 add_server_options(dhcp_server, &packet);
611 addr.s_addr = htonl(dest);
613 debug(dhcp_server, "Sending ACK to %s", inet_ntoa(addr));
615 send_packet_to_client(dhcp_server, &packet);
617 add_lease(dhcp_server, 0, packet.chaddr, packet.yiaddr);
619 if (dhcp_server->lease_added_cb)
620 dhcp_server->lease_added_cb(packet.chaddr, packet.yiaddr);
623 static void send_NAK(GDHCPServer *dhcp_server,
624 struct dhcp_packet *client_packet)
626 struct dhcp_packet packet;
628 init_packet(dhcp_server, &packet, client_packet, DHCPNAK);
630 debug(dhcp_server, "Sending NAK");
632 dhcp_send_raw_packet(&packet,
633 dhcp_server->server_nip, SERVER_PORT,
634 INADDR_BROADCAST, CLIENT_PORT, MAC_BCAST_ADDR,
635 dhcp_server->ifindex, false);
638 static void send_inform(GDHCPServer *dhcp_server,
639 struct dhcp_packet *client_packet)
641 struct dhcp_packet packet;
643 init_packet(dhcp_server, &packet, client_packet, DHCPACK);
644 add_server_options(dhcp_server, &packet);
645 send_packet_to_client(dhcp_server, &packet);
648 static gboolean listener_event(GIOChannel *channel, GIOCondition condition,
651 GDHCPServer *dhcp_server = user_data;
652 struct dhcp_packet packet;
653 struct dhcp_lease *lease;
654 uint32_t requested_nip = 0;
655 uint8_t type, *server_id_option, *request_ip_option, *host_name;
658 GDHCPOptionType option_type;
661 if (condition & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
662 dhcp_server->listener_watch = 0;
666 re = dhcp_recv_l3_packet(&packet, dhcp_server->listener_sockfd);
670 type = check_packet_type(&packet);
674 server_id_option = dhcp_get_option(&packet, DHCP_SERVER_ID);
675 if (server_id_option) {
676 uint32_t server_nid =
677 get_unaligned((const uint32_t *) server_id_option);
679 if (server_nid != dhcp_server->server_nip)
683 request_ip_option = dhcp_get_option(&packet, DHCP_REQUESTED_IP);
684 if (request_ip_option)
685 requested_nip = get_be32(request_ip_option);
687 lease = find_lease_by_mac(dhcp_server, packet.chaddr);
691 debug(dhcp_server, "Received DISCOVER");
693 send_offer(dhcp_server, &packet, lease, requested_nip);
696 debug(dhcp_server, "Received REQUEST NIP %d",
698 if (requested_nip == 0) {
699 requested_nip = packet.ciaddr;
700 if (requested_nip == 0)
704 if (lease && requested_nip == lease->lease_nip) {
705 debug(dhcp_server, "Sending ACK");
707 host_name = dhcp_get_option(&packet, DHCP_HOST_NAME);
708 option_type = dhcp_get_code_type(DHCP_HOST_NAME);
709 option_value = malloc_option_value_string(host_name,
711 send_ACK(dhcp_server, &packet,
714 if (dhcp_server->save_ack_lease_func)
715 dhcp_server->save_ack_lease_func(
719 g_free(option_value);
724 if (server_id_option || !lease) {
725 debug(dhcp_server, "Sending NAK");
726 send_NAK(dhcp_server, &packet);
731 debug(dhcp_server, "Received DECLINE");
733 if (!server_id_option)
736 if (!request_ip_option)
742 if (requested_nip == lease->lease_nip)
743 remove_lease(dhcp_server, lease);
747 debug(dhcp_server, "Received RELEASE");
749 if (!server_id_option)
755 if (packet.ciaddr == lease->lease_nip)
756 lease_set_expire(dhcp_server, lease,
760 debug(dhcp_server, "Received INFORM");
761 send_inform(dhcp_server, &packet);
768 /* Caller need to load leases before call it */
769 int g_dhcp_server_start(GDHCPServer *dhcp_server)
771 GIOChannel *listener_channel;
774 if (dhcp_server->started)
777 listener_sockfd = dhcp_l3_socket(SERVER_PORT,
778 dhcp_server->interface, AF_INET);
779 if (listener_sockfd < 0)
782 listener_channel = g_io_channel_unix_new(listener_sockfd);
783 if (!listener_channel) {
784 close(listener_sockfd);
788 dhcp_server->listener_sockfd = listener_sockfd;
789 dhcp_server->listener_channel = listener_channel;
791 g_io_channel_set_close_on_unref(listener_channel, TRUE);
792 dhcp_server->listener_watch =
793 g_io_add_watch_full(listener_channel, G_PRIORITY_HIGH,
794 G_IO_IN | G_IO_NVAL | G_IO_ERR | G_IO_HUP,
795 listener_event, dhcp_server,
797 g_io_channel_unref(dhcp_server->listener_channel);
799 dhcp_server->started = TRUE;
804 int g_dhcp_server_set_option(GDHCPServer *dhcp_server,
805 unsigned char option_code, const char *option_value)
812 debug(dhcp_server, "option_code %d option_value %s",
813 option_code, option_value);
814 switch (option_code) {
817 case G_DHCP_DNS_SERVER:
818 if (inet_aton(option_value, &nip) == 0)
825 g_hash_table_replace(dhcp_server->option_hash,
826 GINT_TO_POINTER((int) option_code),
827 (gpointer) option_value);
831 void g_dhcp_server_set_save_lease(GDHCPServer *dhcp_server,
832 GDHCPSaveLeaseFunc func, gpointer user_data)
837 dhcp_server->save_lease_func = func;
840 void g_dhcp_server_set_lease_added_cb(GDHCPServer *dhcp_server,
841 GDHCPLeaseAddedCb cb)
846 dhcp_server->lease_added_cb = cb;
849 void g_dhcp_server_set_save_ack_lease(GDHCPServer *dhcp_server,
850 GDHCPSaveACKLeaseFunc func, gpointer user_data)
852 if (dhcp_server == NULL)
855 dhcp_server->save_ack_lease_func = func;
858 GDHCPServer *g_dhcp_server_ref(GDHCPServer *dhcp_server)
863 __sync_fetch_and_add(&dhcp_server->ref_count, 1);
868 void g_dhcp_server_stop(GDHCPServer *dhcp_server)
870 /* Save leases, before stop; load them before start */
871 save_lease(dhcp_server);
873 if (dhcp_server->listener_watch > 0) {
874 g_source_remove(dhcp_server->listener_watch);
875 dhcp_server->listener_watch = 0;
878 dhcp_server->listener_channel = NULL;
880 dhcp_server->started = FALSE;
883 void g_dhcp_server_unref(GDHCPServer *dhcp_server)
888 if (__sync_fetch_and_sub(&dhcp_server->ref_count, 1) != 1)
891 g_dhcp_server_stop(dhcp_server);
893 g_hash_table_destroy(dhcp_server->option_hash);
895 destroy_lease_table(dhcp_server);
897 g_free(dhcp_server->interface);
902 int g_dhcp_server_set_ip_range(GDHCPServer *dhcp_server,
903 const char *start_ip, const char *end_ip)
905 struct in_addr _host_addr;
907 if (inet_aton(start_ip, &_host_addr) == 0)
910 dhcp_server->start_ip = ntohl(_host_addr.s_addr);
912 if (inet_aton(end_ip, &_host_addr) == 0)
915 dhcp_server->end_ip = ntohl(_host_addr.s_addr);
920 void g_dhcp_server_set_lease_time(GDHCPServer *dhcp_server,
921 unsigned int lease_time)
926 dhcp_server->lease_seconds = lease_time;
929 void g_dhcp_server_set_debug(GDHCPServer *dhcp_server,
930 GDHCPDebugFunc func, gpointer user_data)
935 dhcp_server->debug_func = func;
936 dhcp_server->debug_data = user_data;