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 GDHCPDebugFunc debug_func;
76 uint8_t lease_mac[ETH_ALEN];
79 static inline void debug(GDHCPServer *server, const char *format, ...)
84 if (!server->debug_func)
89 if (vsnprintf(str, sizeof(str), format, ap) > 0)
90 server->debug_func(str, server->debug_data);
95 static struct dhcp_lease *find_lease_by_mac(GDHCPServer *dhcp_server,
100 for (list = dhcp_server->lease_list; list; list = list->next) {
101 struct dhcp_lease *lease = list->data;
103 if (memcmp(lease->lease_mac, mac, ETH_ALEN) == 0)
110 static void remove_lease(GDHCPServer *dhcp_server, struct dhcp_lease *lease)
112 dhcp_server->lease_list =
113 g_list_remove(dhcp_server->lease_list, lease);
115 g_hash_table_remove(dhcp_server->nip_lease_hash,
116 GINT_TO_POINTER((int) lease->lease_nip));
120 /* Clear the old lease and create the new one */
121 static int get_lease(GDHCPServer *dhcp_server, uint32_t yiaddr,
122 const uint8_t *mac, struct dhcp_lease **lease)
124 struct dhcp_lease *lease_nip, *lease_mac;
129 if (ntohl(yiaddr) < dhcp_server->start_ip)
132 if (ntohl(yiaddr) > dhcp_server->end_ip)
135 if (memcmp(mac, MAC_BCAST_ADDR, ETH_ALEN) == 0)
138 if (memcmp(mac, MAC_ANY_ADDR, ETH_ALEN) == 0)
141 lease_mac = find_lease_by_mac(dhcp_server, mac);
143 lease_nip = g_hash_table_lookup(dhcp_server->nip_lease_hash,
144 GINT_TO_POINTER((int) ntohl(yiaddr)));
145 debug(dhcp_server, "lease_mac %p lease_nip %p", lease_mac, lease_nip);
148 dhcp_server->lease_list =
149 g_list_remove(dhcp_server->lease_list,
151 g_hash_table_remove(dhcp_server->nip_lease_hash,
152 GINT_TO_POINTER((int) ntohl(yiaddr)));
156 else if (lease_nip != lease_mac) {
157 remove_lease(dhcp_server, lease_mac);
166 dhcp_server->lease_list =
167 g_list_remove(dhcp_server->lease_list,
169 g_hash_table_remove(dhcp_server->nip_lease_hash,
170 GINT_TO_POINTER((int) lease_mac->lease_nip));
176 *lease = g_try_new0(struct dhcp_lease, 1);
183 static gint compare_expire(gconstpointer a, gconstpointer b)
185 const struct dhcp_lease *lease1 = a;
186 const struct dhcp_lease *lease2 = b;
188 return lease2->expire - lease1->expire;
191 static struct dhcp_lease *add_lease(GDHCPServer *dhcp_server, uint32_t expire,
192 const uint8_t *chaddr, uint32_t yiaddr)
194 struct dhcp_lease *lease = NULL;
197 ret = get_lease(dhcp_server, yiaddr, chaddr, &lease);
201 memset(lease, 0, sizeof(*lease));
203 memcpy(lease->lease_mac, chaddr, ETH_ALEN);
204 lease->lease_nip = ntohl(yiaddr);
207 lease->expire = time(NULL) + dhcp_server->lease_seconds;
209 lease->expire = expire;
211 dhcp_server->lease_list = g_list_insert_sorted(dhcp_server->lease_list,
212 lease, compare_expire);
214 g_hash_table_insert(dhcp_server->nip_lease_hash,
215 GINT_TO_POINTER((int) lease->lease_nip), lease);
217 if (dhcp_server->lease_added_cb)
218 dhcp_server->lease_added_cb(lease->lease_mac, yiaddr);
223 static struct dhcp_lease *find_lease_by_nip(GDHCPServer *dhcp_server,
226 return g_hash_table_lookup(dhcp_server->nip_lease_hash,
227 GINT_TO_POINTER((int) nip));
230 /* Check if the IP is taken; if it is, add it to the lease table */
231 static bool arp_check(uint32_t nip, const uint8_t *safe_mac)
233 /* TODO: Add ARP checking */
237 static bool is_expired_lease(struct dhcp_lease *lease)
239 if (lease->expire < time(NULL))
245 static uint32_t find_free_or_expired_nip(GDHCPServer *dhcp_server,
246 const uint8_t *safe_mac)
249 struct dhcp_lease *lease;
251 ip_addr = dhcp_server->start_ip;
252 for (; ip_addr <= dhcp_server->end_ip; ip_addr++) {
253 /* e.g. 192.168.55.0 */
254 if ((ip_addr & 0xff) == 0)
257 /* e.g. 192.168.55.255 */
258 if ((ip_addr & 0xff) == 0xff)
261 lease = find_lease_by_nip(dhcp_server, ip_addr);
265 if (arp_check(htonl(ip_addr), safe_mac))
269 /* The last lease is the oldest one */
270 list = g_list_last(dhcp_server->lease_list);
278 if (!is_expired_lease(lease))
281 if (!arp_check(lease->lease_nip, safe_mac))
284 return lease->lease_nip;
287 static void lease_set_expire(GDHCPServer *dhcp_server,
288 struct dhcp_lease *lease, uint32_t expire)
290 dhcp_server->lease_list = g_list_remove(dhcp_server->lease_list, lease);
292 lease->expire = expire;
294 dhcp_server->lease_list = g_list_insert_sorted(dhcp_server->lease_list,
295 lease, compare_expire);
298 static void destroy_lease_table(GDHCPServer *dhcp_server)
302 g_hash_table_destroy(dhcp_server->nip_lease_hash);
304 dhcp_server->nip_lease_hash = NULL;
306 for (list = dhcp_server->lease_list; list; list = list->next) {
307 struct dhcp_lease *lease = list->data;
312 g_list_free(dhcp_server->lease_list);
314 dhcp_server->lease_list = NULL;
316 static uint32_t get_interface_address(int index)
320 struct sockaddr_in *server_ip;
323 sk = socket(PF_INET, SOCK_DGRAM | SOCK_CLOEXEC, 0);
325 perror("Open socket error");
329 memset(&ifr, 0, sizeof(ifr));
330 ifr.ifr_ifindex = index;
332 err = ioctl(sk, SIOCGIFNAME, &ifr);
334 perror("Get interface name error");
338 err = ioctl(sk, SIOCGIFADDR, &ifr);
340 perror("Get ip address error");
344 server_ip = (struct sockaddr_in *) &ifr.ifr_addr;
345 ret = server_ip->sin_addr.s_addr;
353 GDHCPServer *g_dhcp_server_new(GDHCPType type,
354 int ifindex, GDHCPServerError *error)
356 GDHCPServer *dhcp_server = NULL;
359 *error = G_DHCP_SERVER_ERROR_INVALID_INDEX;
363 dhcp_server = g_try_new0(GDHCPServer, 1);
365 *error = G_DHCP_SERVER_ERROR_NOMEM;
369 dhcp_server->interface = get_interface_name(ifindex);
370 if (!dhcp_server->interface) {
371 *error = G_DHCP_SERVER_ERROR_INTERFACE_UNAVAILABLE;
375 if (!interface_is_up(ifindex)) {
376 *error = G_DHCP_SERVER_ERROR_INTERFACE_DOWN;
380 dhcp_server->server_nip = get_interface_address(ifindex);
381 if (dhcp_server->server_nip == 0) {
382 *error = G_DHCP_SERVER_ERROR_IP_ADDRESS_INVALID;
386 dhcp_server->nip_lease_hash = g_hash_table_new_full(g_direct_hash,
387 g_direct_equal, NULL, NULL);
388 dhcp_server->option_hash = g_hash_table_new_full(g_direct_hash,
389 g_direct_equal, NULL, NULL);
391 dhcp_server->started = FALSE;
393 /* All the leases have the same fixed lease time,
394 * do not support DHCP_LEASE_TIME option from client.
396 dhcp_server->lease_seconds = DEFAULT_DHCP_LEASE_SEC;
398 dhcp_server->type = type;
399 dhcp_server->ref_count = 1;
400 dhcp_server->ifindex = ifindex;
401 dhcp_server->listener_sockfd = -1;
402 dhcp_server->listener_watch = -1;
403 dhcp_server->listener_channel = NULL;
404 dhcp_server->save_lease_func = NULL;
405 dhcp_server->debug_func = NULL;
406 dhcp_server->debug_data = NULL;
408 *error = G_DHCP_SERVER_ERROR_NONE;
413 g_free(dhcp_server->interface);
419 static uint8_t check_packet_type(struct dhcp_packet *packet)
423 if (packet->hlen != ETH_ALEN)
426 if (packet->op != BOOTREQUEST)
429 type = dhcp_get_option(packet, DHCP_MESSAGE_TYPE);
434 if (*type < DHCP_MINTYPE)
437 if (*type > DHCP_MAXTYPE)
443 static void init_packet(GDHCPServer *dhcp_server, struct dhcp_packet *packet,
444 struct dhcp_packet *client_packet, char type)
446 /* Sets op, htype, hlen, cookie fields
447 * and adds DHCP_MESSAGE_TYPE option */
448 dhcp_init_header(packet, type);
450 packet->xid = client_packet->xid;
451 memcpy(packet->chaddr, client_packet->chaddr,
452 sizeof(client_packet->chaddr));
453 packet->flags = client_packet->flags;
454 packet->gateway_nip = client_packet->gateway_nip;
455 packet->ciaddr = client_packet->ciaddr;
456 dhcp_add_option_uint32(packet, DHCP_SERVER_ID,
457 ntohl(dhcp_server->server_nip));
460 static void add_option(gpointer key, gpointer value, gpointer user_data)
462 const char *option_value = value;
463 uint8_t option_code = GPOINTER_TO_INT(key);
465 struct dhcp_packet *packet = user_data;
470 switch (option_code) {
473 case G_DHCP_DNS_SERVER:
474 if (inet_aton(option_value, &nip) == 0)
477 dhcp_add_option_uint32(packet, (uint8_t) option_code,
485 static void add_server_options(GDHCPServer *dhcp_server,
486 struct dhcp_packet *packet)
488 g_hash_table_foreach(dhcp_server->option_hash,
492 static bool check_requested_nip(GDHCPServer *dhcp_server,
493 uint32_t requested_nip)
495 struct dhcp_lease *lease;
497 if (requested_nip == 0)
500 if (requested_nip < dhcp_server->start_ip)
503 if (requested_nip > dhcp_server->end_ip)
506 lease = find_lease_by_nip(dhcp_server, requested_nip);
510 if (!is_expired_lease(lease))
516 static void send_packet_to_client(GDHCPServer *dhcp_server,
517 struct dhcp_packet *dhcp_pkt)
519 const uint8_t *chaddr;
522 if ((dhcp_pkt->flags & htons(BROADCAST_FLAG))
523 || dhcp_pkt->ciaddr == 0) {
524 debug(dhcp_server, "Broadcasting packet to client");
525 ciaddr = INADDR_BROADCAST;
526 chaddr = MAC_BCAST_ADDR;
528 debug(dhcp_server, "Unicasting packet to client ciaddr");
529 ciaddr = dhcp_pkt->ciaddr;
530 chaddr = dhcp_pkt->chaddr;
533 dhcp_send_raw_packet(dhcp_pkt,
534 dhcp_server->server_nip, SERVER_PORT,
535 ciaddr, CLIENT_PORT, chaddr,
536 dhcp_server->ifindex, false);
539 static void send_offer(GDHCPServer *dhcp_server,
540 struct dhcp_packet *client_packet,
541 struct dhcp_lease *lease,
542 uint32_t requested_nip)
544 struct dhcp_packet packet;
547 init_packet(dhcp_server, &packet, client_packet, DHCPOFFER);
550 packet.yiaddr = htonl(lease->lease_nip);
551 else if (check_requested_nip(dhcp_server, requested_nip))
552 packet.yiaddr = htonl(requested_nip);
554 packet.yiaddr = htonl(find_free_or_expired_nip(
555 dhcp_server, client_packet->chaddr));
557 debug(dhcp_server, "find yiaddr %u", packet.yiaddr);
559 if (!packet.yiaddr) {
560 debug(dhcp_server, "Err: Can not found lease and send offer");
564 lease = add_lease(dhcp_server, OFFER_TIME,
565 packet.chaddr, packet.yiaddr);
568 "Err: No free IP addresses. OFFER abandoned");
572 dhcp_add_option_uint32(&packet, DHCP_LEASE_TIME,
573 dhcp_server->lease_seconds);
574 add_server_options(dhcp_server, &packet);
576 addr.s_addr = packet.yiaddr;
578 debug(dhcp_server, "Sending OFFER of %s", inet_ntoa(addr));
579 send_packet_to_client(dhcp_server, &packet);
582 static void save_lease(GDHCPServer *dhcp_server)
586 if (!dhcp_server->save_lease_func)
589 for (list = dhcp_server->lease_list; list; list = list->next) {
590 struct dhcp_lease *lease = list->data;
591 dhcp_server->save_lease_func(lease->lease_mac,
592 lease->lease_nip, lease->expire);
596 static void send_ACK(GDHCPServer *dhcp_server,
597 struct dhcp_packet *client_packet, uint32_t dest)
599 struct dhcp_packet packet;
600 uint32_t lease_time_sec;
603 init_packet(dhcp_server, &packet, client_packet, DHCPACK);
604 packet.yiaddr = htonl(dest);
606 lease_time_sec = dhcp_server->lease_seconds;
608 dhcp_add_option_uint32(&packet, DHCP_LEASE_TIME, lease_time_sec);
610 add_server_options(dhcp_server, &packet);
612 addr.s_addr = htonl(dest);
614 debug(dhcp_server, "Sending ACK to %s", inet_ntoa(addr));
616 send_packet_to_client(dhcp_server, &packet);
618 add_lease(dhcp_server, 0, packet.chaddr, packet.yiaddr);
621 static void send_NAK(GDHCPServer *dhcp_server,
622 struct dhcp_packet *client_packet)
624 struct dhcp_packet packet;
626 init_packet(dhcp_server, &packet, client_packet, DHCPNAK);
628 debug(dhcp_server, "Sending NAK");
630 dhcp_send_raw_packet(&packet,
631 dhcp_server->server_nip, SERVER_PORT,
632 INADDR_BROADCAST, CLIENT_PORT, MAC_BCAST_ADDR,
633 dhcp_server->ifindex, false);
636 static void send_inform(GDHCPServer *dhcp_server,
637 struct dhcp_packet *client_packet)
639 struct dhcp_packet packet;
641 init_packet(dhcp_server, &packet, client_packet, DHCPACK);
642 add_server_options(dhcp_server, &packet);
643 send_packet_to_client(dhcp_server, &packet);
646 static gboolean listener_event(GIOChannel *channel, GIOCondition condition,
649 GDHCPServer *dhcp_server = user_data;
650 struct dhcp_packet packet;
651 struct dhcp_lease *lease;
652 uint32_t requested_nip = 0;
653 uint8_t type, *server_id_option, *request_ip_option;
656 if (condition & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
657 dhcp_server->listener_watch = 0;
661 re = dhcp_recv_l3_packet(&packet, dhcp_server->listener_sockfd);
665 type = check_packet_type(&packet);
669 server_id_option = dhcp_get_option(&packet, DHCP_SERVER_ID);
670 if (server_id_option) {
671 uint32_t server_nid =
672 get_unaligned((const uint32_t *) server_id_option);
674 if (server_nid != dhcp_server->server_nip)
678 request_ip_option = dhcp_get_option(&packet, DHCP_REQUESTED_IP);
679 if (request_ip_option)
680 requested_nip = get_be32(request_ip_option);
682 lease = find_lease_by_mac(dhcp_server, packet.chaddr);
686 debug(dhcp_server, "Received DISCOVER");
688 send_offer(dhcp_server, &packet, lease, requested_nip);
691 debug(dhcp_server, "Received REQUEST NIP %d",
693 if (requested_nip == 0) {
694 requested_nip = packet.ciaddr;
695 if (requested_nip == 0)
699 if (lease && requested_nip == lease->lease_nip) {
700 debug(dhcp_server, "Sending ACK");
701 send_ACK(dhcp_server, &packet,
706 if (server_id_option || !lease) {
707 debug(dhcp_server, "Sending NAK");
708 send_NAK(dhcp_server, &packet);
713 debug(dhcp_server, "Received DECLINE");
715 if (!server_id_option)
718 if (!request_ip_option)
724 if (requested_nip == lease->lease_nip)
725 remove_lease(dhcp_server, lease);
729 debug(dhcp_server, "Received RELEASE");
731 if (!server_id_option)
737 if (packet.ciaddr == lease->lease_nip)
738 lease_set_expire(dhcp_server, lease,
742 debug(dhcp_server, "Received INFORM");
743 send_inform(dhcp_server, &packet);
750 /* Caller need to load leases before call it */
751 int g_dhcp_server_start(GDHCPServer *dhcp_server)
753 GIOChannel *listener_channel;
756 if (dhcp_server->started)
759 listener_sockfd = dhcp_l3_socket(SERVER_PORT,
760 dhcp_server->interface, AF_INET);
761 if (listener_sockfd < 0)
764 listener_channel = g_io_channel_unix_new(listener_sockfd);
765 if (!listener_channel) {
766 close(listener_sockfd);
770 dhcp_server->listener_sockfd = listener_sockfd;
771 dhcp_server->listener_channel = listener_channel;
773 g_io_channel_set_close_on_unref(listener_channel, TRUE);
774 dhcp_server->listener_watch =
775 g_io_add_watch_full(listener_channel, G_PRIORITY_HIGH,
776 G_IO_IN | G_IO_NVAL | G_IO_ERR | G_IO_HUP,
777 listener_event, dhcp_server,
779 g_io_channel_unref(dhcp_server->listener_channel);
781 dhcp_server->started = TRUE;
786 int g_dhcp_server_set_option(GDHCPServer *dhcp_server,
787 unsigned char option_code, const char *option_value)
794 debug(dhcp_server, "option_code %d option_value %s",
795 option_code, option_value);
796 switch (option_code) {
799 case G_DHCP_DNS_SERVER:
800 if (inet_aton(option_value, &nip) == 0)
807 g_hash_table_replace(dhcp_server->option_hash,
808 GINT_TO_POINTER((int) option_code),
809 (gpointer) option_value);
813 void g_dhcp_server_set_save_lease(GDHCPServer *dhcp_server,
814 GDHCPSaveLeaseFunc func, gpointer user_data)
819 dhcp_server->save_lease_func = func;
822 void g_dhcp_server_set_lease_added_cb(GDHCPServer *dhcp_server,
823 GDHCPLeaseAddedCb cb)
828 dhcp_server->lease_added_cb = cb;
831 GDHCPServer *g_dhcp_server_ref(GDHCPServer *dhcp_server)
836 __sync_fetch_and_add(&dhcp_server->ref_count, 1);
841 void g_dhcp_server_stop(GDHCPServer *dhcp_server)
843 /* Save leases, before stop; load them before start */
844 save_lease(dhcp_server);
846 if (dhcp_server->listener_watch > 0) {
847 g_source_remove(dhcp_server->listener_watch);
848 dhcp_server->listener_watch = 0;
851 dhcp_server->listener_channel = NULL;
853 dhcp_server->started = FALSE;
856 void g_dhcp_server_unref(GDHCPServer *dhcp_server)
861 if (__sync_fetch_and_sub(&dhcp_server->ref_count, 1) != 1)
864 g_dhcp_server_stop(dhcp_server);
866 g_hash_table_destroy(dhcp_server->option_hash);
868 destroy_lease_table(dhcp_server);
870 g_free(dhcp_server->interface);
875 int g_dhcp_server_set_ip_range(GDHCPServer *dhcp_server,
876 const char *start_ip, const char *end_ip)
878 struct in_addr _host_addr;
880 if (inet_aton(start_ip, &_host_addr) == 0)
883 dhcp_server->start_ip = ntohl(_host_addr.s_addr);
885 if (inet_aton(end_ip, &_host_addr) == 0)
888 dhcp_server->end_ip = ntohl(_host_addr.s_addr);
893 void g_dhcp_server_set_lease_time(GDHCPServer *dhcp_server,
894 unsigned int lease_time)
899 dhcp_server->lease_seconds = lease_time;
902 void g_dhcp_server_set_debug(GDHCPServer *dhcp_server,
903 GDHCPDebugFunc func, gpointer user_data)
908 dhcp_server->debug_func = func;
909 dhcp_server->debug_data = user_data;