1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 Copyright © 2013 Intel Corporation. All rights reserved.
7 #include <net/ethernet.h>
8 #include <net/if_arp.h>
11 #include <sys/ioctl.h>
12 #include <linux/if_infiniband.h>
14 #include "sd-dhcp-client.h"
16 #include "alloc-util.h"
18 #include "dhcp-identifier.h"
19 #include "dhcp-internal.h"
20 #include "dhcp-lease-internal.h"
21 #include "dhcp-protocol.h"
22 #include "dns-domain.h"
23 #include "event-util.h"
24 #include "hostname-util.h"
26 #include "memory-util.h"
27 #include "random-util.h"
28 #include "string-util.h"
32 #define MAX_CLIENT_ID_LEN (sizeof(uint32_t) + MAX_DUID_LEN) /* Arbitrary limit */
33 #define MAX_MAC_ADDR_LEN CONST_MAX(INFINIBAND_ALEN, ETH_ALEN)
35 #define RESTART_AFTER_NAK_MIN_USEC (1 * USEC_PER_SEC)
36 #define RESTART_AFTER_NAK_MAX_USEC (30 * USEC_PER_MINUTE)
38 struct sd_dhcp_client
{
44 sd_event_source
*timeout_resend
;
48 union sockaddr_union link
;
49 sd_event_source
*receive_message
;
50 bool request_broadcast
;
52 size_t req_opts_allocated
;
56 uint8_t mac_addr
[MAX_MAC_ADDR_LEN
];
63 /* 0: Generic (non-LL) (RFC 2132) */
64 uint8_t data
[MAX_CLIENT_ID_LEN
];
67 /* 1: Ethernet Link-Layer (RFC 2132) */
68 uint8_t haddr
[ETH_ALEN
];
71 /* 2 - 254: ARP/Link-Layer (RFC 2132) */
75 /* 255: Node-specific (RFC 4361) */
80 uint8_t data
[MAX_CLIENT_ID_LEN
];
86 char *vendor_class_identifier
;
93 uint64_t max_attempts
;
94 OrderedHashmap
*extra_options
;
95 OrderedHashmap
*vendor_options
;
97 sd_event_source
*timeout_t1
;
98 sd_event_source
*timeout_t2
;
99 sd_event_source
*timeout_expire
;
100 sd_dhcp_client_callback_t callback
;
102 sd_dhcp_lease
*lease
;
107 static const uint8_t default_req_opts
[] = {
108 SD_DHCP_OPTION_SUBNET_MASK
,
109 SD_DHCP_OPTION_ROUTER
,
110 SD_DHCP_OPTION_HOST_NAME
,
111 SD_DHCP_OPTION_DOMAIN_NAME
,
112 SD_DHCP_OPTION_DOMAIN_NAME_SERVER
,
115 /* RFC7844 section 3:
116 MAY contain the Parameter Request List option.
118 The client intending to protect its privacy SHOULD only request a
119 minimal number of options in the PRL and SHOULD also randomly shuffle
120 the ordering of option codes in the PRL. If this random ordering
121 cannot be implemented, the client MAY order the option codes in the
122 PRL by option code number (lowest to highest).
124 /* NOTE: using PRL options that Windows 10 RFC7844 implementation uses */
125 static const uint8_t default_req_opts_anonymize
[] = {
126 SD_DHCP_OPTION_SUBNET_MASK
, /* 1 */
127 SD_DHCP_OPTION_ROUTER
, /* 3 */
128 SD_DHCP_OPTION_DOMAIN_NAME_SERVER
, /* 6 */
129 SD_DHCP_OPTION_DOMAIN_NAME
, /* 15 */
130 SD_DHCP_OPTION_ROUTER_DISCOVER
, /* 31 */
131 SD_DHCP_OPTION_STATIC_ROUTE
, /* 33 */
132 SD_DHCP_OPTION_VENDOR_SPECIFIC
, /* 43 */
133 SD_DHCP_OPTION_NETBIOS_NAMESERVER
, /* 44 */
134 SD_DHCP_OPTION_NETBIOS_NODETYPE
, /* 46 */
135 SD_DHCP_OPTION_NETBIOS_SCOPE
, /* 47 */
136 SD_DHCP_OPTION_CLASSLESS_STATIC_ROUTE
, /* 121 */
137 SD_DHCP_OPTION_PRIVATE_CLASSLESS_STATIC_ROUTE
, /* 249 */
138 SD_DHCP_OPTION_PRIVATE_PROXY_AUTODISCOVERY
, /* 252 */
141 static int client_receive_message_raw(
146 static int client_receive_message_udp(
151 static void client_stop(sd_dhcp_client
*client
, int error
);
153 int sd_dhcp_client_set_callback(
154 sd_dhcp_client
*client
,
155 sd_dhcp_client_callback_t cb
,
158 assert_return(client
, -EINVAL
);
160 client
->callback
= cb
;
161 client
->userdata
= userdata
;
166 int sd_dhcp_client_set_request_broadcast(sd_dhcp_client
*client
, int broadcast
) {
167 assert_return(client
, -EINVAL
);
169 client
->request_broadcast
= !!broadcast
;
174 int sd_dhcp_client_set_request_option(sd_dhcp_client
*client
, uint8_t option
) {
177 assert_return(client
, -EINVAL
);
178 assert_return(IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
), -EBUSY
);
182 case SD_DHCP_OPTION_PAD
:
183 case SD_DHCP_OPTION_OVERLOAD
:
184 case SD_DHCP_OPTION_MESSAGE_TYPE
:
185 case SD_DHCP_OPTION_PARAMETER_REQUEST_LIST
:
186 case SD_DHCP_OPTION_END
:
193 for (i
= 0; i
< client
->req_opts_size
; i
++)
194 if (client
->req_opts
[i
] == option
)
197 if (!GREEDY_REALLOC(client
->req_opts
, client
->req_opts_allocated
,
198 client
->req_opts_size
+ 1))
201 client
->req_opts
[client
->req_opts_size
++] = option
;
206 int sd_dhcp_client_set_request_address(
207 sd_dhcp_client
*client
,
208 const struct in_addr
*last_addr
) {
210 assert_return(client
, -EINVAL
);
211 assert_return(IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
), -EBUSY
);
214 client
->last_addr
= last_addr
->s_addr
;
216 client
->last_addr
= INADDR_ANY
;
221 int sd_dhcp_client_set_ifindex(sd_dhcp_client
*client
, int ifindex
) {
223 assert_return(client
, -EINVAL
);
224 assert_return(IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
), -EBUSY
);
225 assert_return(ifindex
> 0, -EINVAL
);
227 client
->ifindex
= ifindex
;
231 int sd_dhcp_client_set_mac(
232 sd_dhcp_client
*client
,
237 DHCP_CLIENT_DONT_DESTROY(client
);
238 bool need_restart
= false;
241 assert_return(client
, -EINVAL
);
242 assert_return(addr
, -EINVAL
);
243 assert_return(addr_len
> 0 && addr_len
<= MAX_MAC_ADDR_LEN
, -EINVAL
);
244 assert_return(arp_type
> 0, -EINVAL
);
246 if (arp_type
== ARPHRD_ETHER
)
247 assert_return(addr_len
== ETH_ALEN
, -EINVAL
);
248 else if (arp_type
== ARPHRD_INFINIBAND
)
249 assert_return(addr_len
== INFINIBAND_ALEN
, -EINVAL
);
253 if (client
->mac_addr_len
== addr_len
&&
254 memcmp(&client
->mac_addr
, addr
, addr_len
) == 0)
257 if (!IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
)) {
258 log_dhcp_client(client
, "Changing MAC address on running DHCP client, restarting");
260 client_stop(client
, SD_DHCP_CLIENT_EVENT_STOP
);
263 memcpy(&client
->mac_addr
, addr
, addr_len
);
264 client
->mac_addr_len
= addr_len
;
265 client
->arp_type
= arp_type
;
267 if (need_restart
&& client
->state
!= DHCP_STATE_STOPPED
) {
268 r
= sd_dhcp_client_start(client
);
270 return log_dhcp_client_errno(client
, r
, "Failed to restart DHCPv4 client: %m");
276 int sd_dhcp_client_get_client_id(
277 sd_dhcp_client
*client
,
279 const uint8_t **data
,
282 assert_return(client
, -EINVAL
);
283 assert_return(type
, -EINVAL
);
284 assert_return(data
, -EINVAL
);
285 assert_return(data_len
, -EINVAL
);
290 if (client
->client_id_len
) {
291 *type
= client
->client_id
.type
;
292 *data
= client
->client_id
.raw
.data
;
293 *data_len
= client
->client_id_len
- sizeof(client
->client_id
.type
);
299 int sd_dhcp_client_set_client_id(
300 sd_dhcp_client
*client
,
305 DHCP_CLIENT_DONT_DESTROY(client
);
306 bool need_restart
= false;
309 assert_return(client
, -EINVAL
);
310 assert_return(data
, -EINVAL
);
311 assert_return(data_len
> 0 && data_len
<= MAX_CLIENT_ID_LEN
, -EINVAL
);
313 if (client
->client_id_len
== data_len
+ sizeof(client
->client_id
.type
) &&
314 client
->client_id
.type
== type
&&
315 memcmp(&client
->client_id
.raw
.data
, data
, data_len
) == 0)
318 /* For hardware types, log debug message about unexpected data length.
320 * Note that infiniband's INFINIBAND_ALEN is 20 bytes long, but only
321 * last last 8 bytes of the address are stable and suitable to put into
322 * the client-id. The caller is advised to account for that. */
323 if ((type
== ARPHRD_ETHER
&& data_len
!= ETH_ALEN
) ||
324 (type
== ARPHRD_INFINIBAND
&& data_len
!= 8))
325 log_dhcp_client(client
, "Changing client ID to hardware type %u with "
326 "unexpected address length %zu",
329 if (!IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
)) {
330 log_dhcp_client(client
, "Changing client ID on running DHCP "
331 "client, restarting");
333 client_stop(client
, SD_DHCP_CLIENT_EVENT_STOP
);
336 client
->client_id
.type
= type
;
337 memcpy(&client
->client_id
.raw
.data
, data
, data_len
);
338 client
->client_id_len
= data_len
+ sizeof (client
->client_id
.type
);
340 if (need_restart
&& client
->state
!= DHCP_STATE_STOPPED
) {
341 r
= sd_dhcp_client_start(client
);
343 return log_dhcp_client_errno(client
, r
, "Failed to restart DHCPv4 client: %m");
350 * Sets IAID and DUID. If duid is non-null, the DUID is set to duid_type + duid
351 * without further modification. Otherwise, if duid_type is supported, DUID
352 * is set based on that type. Otherwise, an error is returned.
354 static int dhcp_client_set_iaid_duid_internal(
355 sd_dhcp_client
*client
,
364 DHCP_CLIENT_DONT_DESTROY(client
);
368 assert_return(client
, -EINVAL
);
369 assert_return(duid_len
== 0 || duid
, -EINVAL
);
372 r
= dhcp_validate_duid_len(duid_type
, duid_len
, true);
374 return log_dhcp_client_errno(client
, r
, "Failed to validate length of DUID: %m");
377 zero(client
->client_id
);
378 client
->client_id
.type
= 255;
382 client
->client_id
.ns
.iaid
= htobe32(iaid
);
384 r
= dhcp_identifier_set_iaid(client
->ifindex
, client
->mac_addr
,
385 client
->mac_addr_len
,
387 &client
->client_id
.ns
.iaid
);
389 return log_dhcp_client_errno(client
, r
, "Failed to set IAID: %m");
394 client
->client_id
.ns
.duid
.type
= htobe16(duid_type
);
395 memcpy(&client
->client_id
.ns
.duid
.raw
.data
, duid
, duid_len
);
396 len
= sizeof(client
->client_id
.ns
.duid
.type
) + duid_len
;
400 if (client
->mac_addr_len
== 0)
401 return log_dhcp_client_errno(client
, SYNTHETIC_ERRNO(EOPNOTSUPP
), "Failed to set DUID-LLT, MAC address is not set.");
403 r
= dhcp_identifier_set_duid_llt(&client
->client_id
.ns
.duid
, llt_time
, client
->mac_addr
, client
->mac_addr_len
, client
->arp_type
, &len
);
405 return log_dhcp_client_errno(client
, r
, "Failed to set DUID-LLT: %m");
408 r
= dhcp_identifier_set_duid_en(&client
->client_id
.ns
.duid
, &len
);
410 return log_dhcp_client_errno(client
, r
, "Failed to set DUID-EN: %m");
413 if (client
->mac_addr_len
== 0)
414 return log_dhcp_client_errno(client
, SYNTHETIC_ERRNO(EOPNOTSUPP
), "Failed to set DUID-LL, MAC address is not set.");
416 r
= dhcp_identifier_set_duid_ll(&client
->client_id
.ns
.duid
, client
->mac_addr
, client
->mac_addr_len
, client
->arp_type
, &len
);
418 return log_dhcp_client_errno(client
, r
, "Failed to set DUID-LL: %m");
421 r
= dhcp_identifier_set_duid_uuid(&client
->client_id
.ns
.duid
, &len
);
423 return log_dhcp_client_errno(client
, r
, "Failed to set DUID-UUID: %m");
426 return log_dhcp_client_errno(client
, SYNTHETIC_ERRNO(EINVAL
), "Invalid DUID type");
429 client
->client_id_len
= sizeof(client
->client_id
.type
) + len
+
430 (iaid_append
? sizeof(client
->client_id
.ns
.iaid
) : 0);
432 if (!IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_STOPPED
)) {
433 log_dhcp_client(client
, "Configured %sDUID, restarting.", iaid_append
? "IAID+" : "");
434 client_stop(client
, SD_DHCP_CLIENT_EVENT_STOP
);
435 r
= sd_dhcp_client_start(client
);
437 return log_dhcp_client_errno(client
, r
, "Failed to restart DHCPv4 client: %m");
443 int sd_dhcp_client_set_iaid_duid(
444 sd_dhcp_client
*client
,
450 return dhcp_client_set_iaid_duid_internal(client
, true, iaid_set
, iaid
, duid_type
, duid
, duid_len
, 0);
453 int sd_dhcp_client_set_iaid_duid_llt(
454 sd_dhcp_client
*client
,
458 return dhcp_client_set_iaid_duid_internal(client
, true, iaid_set
, iaid
, DUID_TYPE_LLT
, NULL
, 0, llt_time
);
461 int sd_dhcp_client_set_duid(
462 sd_dhcp_client
*client
,
466 return dhcp_client_set_iaid_duid_internal(client
, false, false, 0, duid_type
, duid
, duid_len
, 0);
469 int sd_dhcp_client_set_duid_llt(
470 sd_dhcp_client
*client
,
472 return dhcp_client_set_iaid_duid_internal(client
, false, false, 0, DUID_TYPE_LLT
, NULL
, 0, llt_time
);
475 int sd_dhcp_client_set_hostname(
476 sd_dhcp_client
*client
,
477 const char *hostname
) {
479 assert_return(client
, -EINVAL
);
481 /* Make sure hostnames qualify as DNS and as Linux hostnames */
483 !(hostname_is_valid(hostname
, false) && dns_name_is_valid(hostname
) > 0))
486 return free_and_strdup(&client
->hostname
, hostname
);
489 int sd_dhcp_client_set_vendor_class_identifier(
490 sd_dhcp_client
*client
,
493 assert_return(client
, -EINVAL
);
495 return free_and_strdup(&client
->vendor_class_identifier
, vci
);
498 int sd_dhcp_client_set_mud_url(
499 sd_dhcp_client
*client
,
500 const char *mudurl
) {
502 assert_return(client
, -EINVAL
);
503 assert_return(mudurl
, -EINVAL
);
504 assert_return(strlen(mudurl
) <= 255, -EINVAL
);
505 assert_return(http_url_is_valid(mudurl
), -EINVAL
);
507 return free_and_strdup(&client
->mudurl
, mudurl
);
510 int sd_dhcp_client_set_user_class(
511 sd_dhcp_client
*client
,
512 const char* const* user_class
) {
514 _cleanup_strv_free_
char **s
= NULL
;
517 STRV_FOREACH(p
, (char **) user_class
)
518 if (strlen(*p
) > 255)
519 return -ENAMETOOLONG
;
521 s
= strv_copy((char **) user_class
);
525 client
->user_class
= TAKE_PTR(s
);
530 int sd_dhcp_client_set_client_port(
531 sd_dhcp_client
*client
,
534 assert_return(client
, -EINVAL
);
541 int sd_dhcp_client_set_mtu(sd_dhcp_client
*client
, uint32_t mtu
) {
542 assert_return(client
, -EINVAL
);
543 assert_return(mtu
>= DHCP_DEFAULT_MIN_SIZE
, -ERANGE
);
550 int sd_dhcp_client_set_max_attempts(sd_dhcp_client
*client
, uint64_t max_attempts
) {
551 assert_return(client
, -EINVAL
);
553 client
->max_attempts
= max_attempts
;
558 int sd_dhcp_client_add_option(sd_dhcp_client
*client
, sd_dhcp_option
*v
) {
561 assert_return(client
, -EINVAL
);
562 assert_return(v
, -EINVAL
);
564 r
= ordered_hashmap_ensure_allocated(&client
->extra_options
, &dhcp_option_hash_ops
);
568 r
= ordered_hashmap_put(client
->extra_options
, UINT_TO_PTR(v
->option
), v
);
572 sd_dhcp_option_ref(v
);
576 int sd_dhcp_client_add_vendor_option(sd_dhcp_client
*client
, sd_dhcp_option
*v
) {
579 assert_return(client
, -EINVAL
);
580 assert_return(v
, -EINVAL
);
582 r
= ordered_hashmap_ensure_allocated(&client
->vendor_options
, &dhcp_option_hash_ops
);
586 r
= ordered_hashmap_put(client
->vendor_options
, v
, v
);
590 sd_dhcp_option_ref(v
);
595 int sd_dhcp_client_get_lease(sd_dhcp_client
*client
, sd_dhcp_lease
**ret
) {
596 assert_return(client
, -EINVAL
);
598 if (!IN_SET(client
->state
, DHCP_STATE_SELECTING
, DHCP_STATE_BOUND
, DHCP_STATE_RENEWING
, DHCP_STATE_REBINDING
))
599 return -EADDRNOTAVAIL
;
602 *ret
= client
->lease
;
607 int sd_dhcp_client_set_service_type(sd_dhcp_client
*client
, int type
) {
608 assert_return(client
, -EINVAL
);
610 client
->ip_service_type
= type
;
615 static int client_notify(sd_dhcp_client
*client
, int event
) {
618 if (client
->callback
)
619 return client
->callback(client
, event
, client
->userdata
);
624 static int client_initialize(sd_dhcp_client
*client
) {
625 assert_return(client
, -EINVAL
);
627 client
->receive_message
= sd_event_source_unref(client
->receive_message
);
629 client
->fd
= asynchronous_close(client
->fd
);
631 (void) event_source_disable(client
->timeout_resend
);
632 (void) event_source_disable(client
->timeout_t1
);
633 (void) event_source_disable(client
->timeout_t2
);
634 (void) event_source_disable(client
->timeout_expire
);
638 client
->state
= DHCP_STATE_INIT
;
641 client
->lease
= sd_dhcp_lease_unref(client
->lease
);
646 static void client_stop(sd_dhcp_client
*client
, int error
) {
650 log_dhcp_client_errno(client
, error
, "STOPPED: %m");
651 else if (error
== SD_DHCP_CLIENT_EVENT_STOP
)
652 log_dhcp_client(client
, "STOPPED");
654 log_dhcp_client(client
, "STOPPED: Unknown event");
656 client_notify(client
, error
);
658 client_initialize(client
);
661 static int client_message_init(
662 sd_dhcp_client
*client
,
666 size_t *_optoffset
) {
668 _cleanup_free_ DHCPPacket
*packet
= NULL
;
669 size_t optlen
, optoffset
, size
;
676 assert(client
->start_time
);
680 assert(IN_SET(type
, DHCP_DISCOVER
, DHCP_REQUEST
, DHCP_RELEASE
, DHCP_DECLINE
));
682 optlen
= DHCP_MIN_OPTIONS_SIZE
;
683 size
= sizeof(DHCPPacket
) + optlen
;
685 packet
= malloc0(size
);
689 r
= dhcp_message_init(&packet
->dhcp
, BOOTREQUEST
, client
->xid
, type
,
690 client
->arp_type
, optlen
, &optoffset
);
694 /* Although 'secs' field is a SHOULD in RFC 2131, certain DHCP servers
695 refuse to issue an DHCP lease if 'secs' is set to zero */
696 r
= sd_event_now(client
->event
, clock_boottime_or_monotonic(), &time_now
);
699 assert(time_now
>= client
->start_time
);
701 /* seconds between sending first and last DISCOVER
702 * must always be strictly positive to deal with broken servers */
703 secs
= ((time_now
- client
->start_time
) / USEC_PER_SEC
) ? : 1;
704 packet
->dhcp
.secs
= htobe16(secs
);
706 /* RFC2132 section 4.1
707 A client that cannot receive unicast IP datagrams until its protocol
708 software has been configured with an IP address SHOULD set the
709 BROADCAST bit in the 'flags' field to 1 in any DHCPDISCOVER or
710 DHCPREQUEST messages that client sends. The BROADCAST bit will
711 provide a hint to the DHCP server and BOOTP relay agent to broadcast
712 any messages to the client on the client's subnet.
714 Note: some interfaces needs this to be enabled, but some networks
715 needs this to be disabled as broadcasts are filteretd, so this
716 needs to be configurable */
717 if (client
->request_broadcast
|| client
->arp_type
!= ARPHRD_ETHER
)
718 packet
->dhcp
.flags
= htobe16(0x8000);
720 /* RFC2132 section 4.1.1:
721 The client MUST include its hardware address in the ’chaddr’ field, if
722 necessary for delivery of DHCP reply messages. Non-Ethernet
723 interfaces will leave 'chaddr' empty and use the client identifier
724 instead (eg, RFC 4390 section 2.1).
726 if (client
->arp_type
== ARPHRD_ETHER
)
727 memcpy(&packet
->dhcp
.chaddr
, &client
->mac_addr
, ETH_ALEN
);
729 /* If no client identifier exists, construct an RFC 4361-compliant one */
730 if (client
->client_id_len
== 0) {
733 client
->client_id
.type
= 255;
735 r
= dhcp_identifier_set_iaid(client
->ifindex
, client
->mac_addr
, client
->mac_addr_len
,
736 true, &client
->client_id
.ns
.iaid
);
740 r
= dhcp_identifier_set_duid_en(&client
->client_id
.ns
.duid
, &duid_len
);
744 client
->client_id_len
= sizeof(client
->client_id
.type
) + sizeof(client
->client_id
.ns
.iaid
) + duid_len
;
747 /* Some DHCP servers will refuse to issue an DHCP lease if the Client
748 Identifier option is not set */
749 if (client
->client_id_len
) {
750 r
= dhcp_option_append(&packet
->dhcp
, optlen
, &optoffset
, 0,
751 SD_DHCP_OPTION_CLIENT_IDENTIFIER
,
752 client
->client_id_len
,
758 /* RFC2131 section 3.5:
759 in its initial DHCPDISCOVER or DHCPREQUEST message, a
760 client may provide the server with a list of specific
761 parameters the client is interested in. If the client
762 includes a list of parameters in a DHCPDISCOVER message,
763 it MUST include that list in any subsequent DHCPREQUEST
767 /* RFC7844 section 3:
768 MAY contain the Parameter Request List option. */
769 /* NOTE: in case that there would be an option to do not send
770 * any PRL at all, the size should be checked before sending */
771 if (client
->req_opts_size
> 0 && type
!= DHCP_RELEASE
) {
772 r
= dhcp_option_append(&packet
->dhcp
, optlen
, &optoffset
, 0,
773 SD_DHCP_OPTION_PARAMETER_REQUEST_LIST
,
774 client
->req_opts_size
, client
->req_opts
);
779 /* RFC2131 section 3.5:
780 The client SHOULD include the ’maximum DHCP message size’ option to
781 let the server know how large the server may make its DHCP messages.
783 Note (from ConnMan): Some DHCP servers will send bigger DHCP packets
784 than the defined default size unless the Maximum Message Size option
787 RFC3442 "Requirements to Avoid Sizing Constraints":
788 Because a full routing table can be quite large, the standard 576
789 octet maximum size for a DHCP message may be too short to contain
790 some legitimate Classless Static Route options. Because of this,
791 clients implementing the Classless Static Route option SHOULD send a
792 Maximum DHCP Message Size [4] option if the DHCP client's TCP/IP
793 stack is capable of receiving larger IP datagrams. In this case, the
794 client SHOULD set the value of this option to at least the MTU of the
795 interface that the client is configuring. The client MAY set the
796 value of this option higher, up to the size of the largest UDP packet
797 it is prepared to accept. (Note that the value specified in the
798 Maximum DHCP Message Size option is the total maximum packet size,
799 including IP and UDP headers.)
801 /* RFC7844 section 3:
802 SHOULD NOT contain any other option. */
803 if (!client
->anonymize
&& type
!= DHCP_RELEASE
) {
804 max_size
= htobe16(size
);
805 r
= dhcp_option_append(&packet
->dhcp
, client
->mtu
, &optoffset
, 0,
806 SD_DHCP_OPTION_MAXIMUM_MESSAGE_SIZE
,
813 *_optoffset
= optoffset
;
814 *ret
= TAKE_PTR(packet
);
819 static int client_append_fqdn_option(
820 DHCPMessage
*message
,
825 uint8_t buffer
[3 + DHCP_MAX_FQDN_LENGTH
];
828 buffer
[0] = DHCP_FQDN_FLAG_S
| /* Request server to perform A RR DNS updates */
829 DHCP_FQDN_FLAG_E
; /* Canonical wire format */
830 buffer
[1] = 0; /* RCODE1 (deprecated) */
831 buffer
[2] = 0; /* RCODE2 (deprecated) */
833 r
= dns_name_to_wire_format(fqdn
, buffer
+ 3, sizeof(buffer
) - 3, false);
835 r
= dhcp_option_append(message
, optlen
, optoffset
, 0,
836 SD_DHCP_OPTION_FQDN
, 3 + r
, buffer
);
841 static int dhcp_client_send_raw(
842 sd_dhcp_client
*client
,
846 dhcp_packet_append_ip_headers(packet
, INADDR_ANY
, client
->port
,
847 INADDR_BROADCAST
, DHCP_PORT_SERVER
, len
, client
->ip_service_type
);
849 return dhcp_network_send_raw_socket(client
->fd
, &client
->link
,
853 static int client_append_common_discover_request_options(sd_dhcp_client
*client
, DHCPPacket
*packet
, size_t *optoffset
, size_t optlen
) {
860 if (client
->hostname
) {
861 /* According to RFC 4702 "clients that send the Client FQDN option in
862 their messages MUST NOT also send the Host Name option". Just send
863 one of the two depending on the hostname type.
865 if (dns_name_is_single_label(client
->hostname
)) {
866 /* it is unclear from RFC 2131 if client should send hostname in
867 DHCPDISCOVER but dhclient does and so we do as well
869 r
= dhcp_option_append(&packet
->dhcp
, optlen
, optoffset
, 0,
870 SD_DHCP_OPTION_HOST_NAME
,
871 strlen(client
->hostname
), client
->hostname
);
873 r
= client_append_fqdn_option(&packet
->dhcp
, optlen
, optoffset
,
879 if (client
->vendor_class_identifier
) {
880 r
= dhcp_option_append(&packet
->dhcp
, optlen
, optoffset
, 0,
881 SD_DHCP_OPTION_VENDOR_CLASS_IDENTIFIER
,
882 strlen(client
->vendor_class_identifier
),
883 client
->vendor_class_identifier
);
888 if (client
->mudurl
) {
889 r
= dhcp_option_append(&packet
->dhcp
, optlen
, optoffset
, 0,
890 SD_DHCP_OPTION_MUD_URL
,
891 strlen(client
->mudurl
),
897 if (client
->user_class
) {
898 r
= dhcp_option_append(&packet
->dhcp
, optlen
, optoffset
, 0,
899 SD_DHCP_OPTION_USER_CLASS
,
900 strv_length(client
->user_class
),
906 ORDERED_HASHMAP_FOREACH(j
, client
->extra_options
, i
) {
907 r
= dhcp_option_append(&packet
->dhcp
, optlen
, optoffset
, 0,
908 j
->option
, j
->length
, j
->data
);
913 if (!ordered_hashmap_isempty(client
->vendor_options
)) {
914 r
= dhcp_option_append(
915 &packet
->dhcp
, optlen
, optoffset
, 0,
916 SD_DHCP_OPTION_VENDOR_SPECIFIC
,
917 ordered_hashmap_size(client
->vendor_options
), client
->vendor_options
);
926 static int client_send_discover(sd_dhcp_client
*client
) {
927 _cleanup_free_ DHCPPacket
*discover
= NULL
;
928 size_t optoffset
, optlen
;
932 assert(IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_SELECTING
));
934 r
= client_message_init(client
, &discover
, DHCP_DISCOVER
,
935 &optlen
, &optoffset
);
939 /* the client may suggest values for the network address
940 and lease time in the DHCPDISCOVER message. The client may include
941 the ’requested IP address’ option to suggest that a particular IP
942 address be assigned, and may include the ’IP address lease time’
943 option to suggest the lease time it would like.
945 /* RFC7844 section 3:
946 SHOULD NOT contain any other option. */
947 if (!client
->anonymize
&& client
->last_addr
!= INADDR_ANY
) {
948 r
= dhcp_option_append(&discover
->dhcp
, optlen
, &optoffset
, 0,
949 SD_DHCP_OPTION_REQUESTED_IP_ADDRESS
,
950 4, &client
->last_addr
);
955 r
= client_append_common_discover_request_options(client
, discover
, &optoffset
, optlen
);
959 r
= dhcp_option_append(&discover
->dhcp
, optlen
, &optoffset
, 0,
960 SD_DHCP_OPTION_END
, 0, NULL
);
964 /* We currently ignore:
965 The client SHOULD wait a random time between one and ten seconds to
966 desynchronize the use of DHCP at startup.
968 r
= dhcp_client_send_raw(client
, discover
, sizeof(DHCPPacket
) + optoffset
);
972 log_dhcp_client(client
, "DISCOVER");
977 static int client_send_request(sd_dhcp_client
*client
) {
978 _cleanup_free_ DHCPPacket
*request
= NULL
;
979 size_t optoffset
, optlen
;
984 r
= client_message_init(client
, &request
, DHCP_REQUEST
, &optlen
, &optoffset
);
988 switch (client
->state
) {
989 /* See RFC2131 section 4.3.2 (note that there is a typo in the RFC,
990 SELECTING should be REQUESTING)
993 case DHCP_STATE_REQUESTING
:
994 /* Client inserts the address of the selected server in ’server
995 identifier’, ’ciaddr’ MUST be zero, ’requested IP address’ MUST be
996 filled in with the yiaddr value from the chosen DHCPOFFER.
999 r
= dhcp_option_append(&request
->dhcp
, optlen
, &optoffset
, 0,
1000 SD_DHCP_OPTION_SERVER_IDENTIFIER
,
1001 4, &client
->lease
->server_address
);
1005 r
= dhcp_option_append(&request
->dhcp
, optlen
, &optoffset
, 0,
1006 SD_DHCP_OPTION_REQUESTED_IP_ADDRESS
,
1007 4, &client
->lease
->address
);
1013 case DHCP_STATE_INIT_REBOOT
:
1014 /* ’server identifier’ MUST NOT be filled in, ’requested IP address’
1015 option MUST be filled in with client’s notion of its previously
1016 assigned address. ’ciaddr’ MUST be zero.
1018 r
= dhcp_option_append(&request
->dhcp
, optlen
, &optoffset
, 0,
1019 SD_DHCP_OPTION_REQUESTED_IP_ADDRESS
,
1020 4, &client
->last_addr
);
1025 case DHCP_STATE_RENEWING
:
1026 /* ’server identifier’ MUST NOT be filled in, ’requested IP address’
1027 option MUST NOT be filled in, ’ciaddr’ MUST be filled in with
1028 client’s IP address.
1031 case DHCP_STATE_REBINDING
:
1032 /* ’server identifier’ MUST NOT be filled in, ’requested IP address’
1033 option MUST NOT be filled in, ’ciaddr’ MUST be filled in with
1034 client’s IP address.
1036 This message MUST be broadcast to the 0xffffffff IP broadcast address.
1038 request
->dhcp
.ciaddr
= client
->lease
->address
;
1042 case DHCP_STATE_INIT
:
1043 case DHCP_STATE_SELECTING
:
1044 case DHCP_STATE_REBOOTING
:
1045 case DHCP_STATE_BOUND
:
1046 case DHCP_STATE_STOPPED
:
1050 r
= client_append_common_discover_request_options(client
, request
, &optoffset
, optlen
);
1054 r
= dhcp_option_append(&request
->dhcp
, optlen
, &optoffset
, 0,
1055 SD_DHCP_OPTION_END
, 0, NULL
);
1059 if (client
->state
== DHCP_STATE_RENEWING
)
1060 r
= dhcp_network_send_udp_socket(client
->fd
,
1061 client
->lease
->server_address
,
1064 sizeof(DHCPMessage
) + optoffset
);
1066 r
= dhcp_client_send_raw(client
, request
, sizeof(DHCPPacket
) + optoffset
);
1070 switch (client
->state
) {
1072 case DHCP_STATE_REQUESTING
:
1073 log_dhcp_client(client
, "REQUEST (requesting)");
1076 case DHCP_STATE_INIT_REBOOT
:
1077 log_dhcp_client(client
, "REQUEST (init-reboot)");
1080 case DHCP_STATE_RENEWING
:
1081 log_dhcp_client(client
, "REQUEST (renewing)");
1084 case DHCP_STATE_REBINDING
:
1085 log_dhcp_client(client
, "REQUEST (rebinding)");
1089 log_dhcp_client(client
, "REQUEST (invalid)");
1096 static int client_start(sd_dhcp_client
*client
);
1098 static int client_timeout_resend(
1103 sd_dhcp_client
*client
= userdata
;
1104 DHCP_CLIENT_DONT_DESTROY(client
);
1105 usec_t next_timeout
= 0;
1112 assert(client
->event
);
1114 r
= sd_event_now(client
->event
, clock_boottime_or_monotonic(), &time_now
);
1118 switch (client
->state
) {
1120 case DHCP_STATE_RENEWING
:
1122 time_left
= (client
->lease
->t2
- client
->lease
->t1
) / 2;
1126 next_timeout
= time_now
+ time_left
* USEC_PER_SEC
;
1130 case DHCP_STATE_REBINDING
:
1132 time_left
= (client
->lease
->lifetime
- client
->lease
->t2
) / 2;
1136 next_timeout
= time_now
+ time_left
* USEC_PER_SEC
;
1139 case DHCP_STATE_REBOOTING
:
1140 /* start over as we did not receive a timely ack or nak */
1141 r
= client_initialize(client
);
1145 r
= client_start(client
);
1149 log_dhcp_client(client
, "REBOOTED");
1153 case DHCP_STATE_INIT
:
1154 case DHCP_STATE_INIT_REBOOT
:
1155 case DHCP_STATE_SELECTING
:
1156 case DHCP_STATE_REQUESTING
:
1157 case DHCP_STATE_BOUND
:
1159 if (client
->attempt
< client
->max_attempts
)
1164 next_timeout
= time_now
+ ((UINT64_C(1) << MIN(client
->attempt
, (uint64_t) 6)) - 1) * USEC_PER_SEC
;
1168 case DHCP_STATE_STOPPED
:
1173 next_timeout
+= (random_u32() & 0x1fffff);
1175 r
= event_reset_time(client
->event
, &client
->timeout_resend
,
1176 clock_boottime_or_monotonic(),
1177 next_timeout
, 10 * USEC_PER_MSEC
,
1178 client_timeout_resend
, client
,
1179 client
->event_priority
, "dhcp4-resend-timer", true);
1183 switch (client
->state
) {
1184 case DHCP_STATE_INIT
:
1185 r
= client_send_discover(client
);
1187 client
->state
= DHCP_STATE_SELECTING
;
1188 client
->attempt
= 0;
1189 } else if (client
->attempt
>= client
->max_attempts
)
1194 case DHCP_STATE_SELECTING
:
1195 r
= client_send_discover(client
);
1196 if (r
< 0 && client
->attempt
>= client
->max_attempts
)
1201 case DHCP_STATE_INIT_REBOOT
:
1202 case DHCP_STATE_REQUESTING
:
1203 case DHCP_STATE_RENEWING
:
1204 case DHCP_STATE_REBINDING
:
1205 r
= client_send_request(client
);
1206 if (r
< 0 && client
->attempt
>= client
->max_attempts
)
1209 if (client
->state
== DHCP_STATE_INIT_REBOOT
)
1210 client
->state
= DHCP_STATE_REBOOTING
;
1212 client
->request_sent
= time_now
;
1216 case DHCP_STATE_REBOOTING
:
1217 case DHCP_STATE_BOUND
:
1221 case DHCP_STATE_STOPPED
:
1229 client_stop(client
, r
);
1231 /* Errors were dealt with when stopping the client, don't spill
1232 errors into the event loop handler */
1236 static int client_initialize_io_events(
1237 sd_dhcp_client
*client
,
1238 sd_event_io_handler_t io_callback
) {
1243 assert(client
->event
);
1245 r
= sd_event_add_io(client
->event
, &client
->receive_message
,
1246 client
->fd
, EPOLLIN
, io_callback
,
1251 r
= sd_event_source_set_priority(client
->receive_message
,
1252 client
->event_priority
);
1256 r
= sd_event_source_set_description(client
->receive_message
, "dhcp4-receive-message");
1262 client_stop(client
, r
);
1267 static int client_initialize_time_events(sd_dhcp_client
*client
) {
1272 assert(client
->event
);
1274 if (client
->start_delay
> 0) {
1275 assert_se(sd_event_now(client
->event
, clock_boottime_or_monotonic(), &usec
) >= 0);
1276 usec
+= client
->start_delay
;
1279 r
= event_reset_time(client
->event
, &client
->timeout_resend
,
1280 clock_boottime_or_monotonic(),
1282 client_timeout_resend
, client
,
1283 client
->event_priority
, "dhcp4-resend-timer", true);
1285 client_stop(client
, r
);
1291 static int client_initialize_events(sd_dhcp_client
*client
, sd_event_io_handler_t io_callback
) {
1292 client_initialize_io_events(client
, io_callback
);
1293 client_initialize_time_events(client
);
1298 static int client_start_delayed(sd_dhcp_client
*client
) {
1301 assert_return(client
, -EINVAL
);
1302 assert_return(client
->event
, -EINVAL
);
1303 assert_return(client
->ifindex
> 0, -EINVAL
);
1304 assert_return(client
->fd
< 0, -EBUSY
);
1305 assert_return(client
->xid
== 0, -EINVAL
);
1306 assert_return(IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_INIT_REBOOT
), -EBUSY
);
1308 client
->xid
= random_u32();
1310 r
= dhcp_network_bind_raw_socket(client
->ifindex
, &client
->link
,
1311 client
->xid
, client
->mac_addr
,
1312 client
->mac_addr_len
, client
->arp_type
, client
->port
);
1314 client_stop(client
, r
);
1319 if (IN_SET(client
->state
, DHCP_STATE_INIT
, DHCP_STATE_INIT_REBOOT
))
1320 client
->start_time
= now(clock_boottime_or_monotonic());
1322 return client_initialize_events(client
, client_receive_message_raw
);
1325 static int client_start(sd_dhcp_client
*client
) {
1326 client
->start_delay
= 0;
1327 return client_start_delayed(client
);
1330 static int client_timeout_expire(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
1331 sd_dhcp_client
*client
= userdata
;
1332 DHCP_CLIENT_DONT_DESTROY(client
);
1334 log_dhcp_client(client
, "EXPIRED");
1336 client_notify(client
, SD_DHCP_CLIENT_EVENT_EXPIRED
);
1338 /* lease was lost, start over if not freed or stopped in callback */
1339 if (client
->state
!= DHCP_STATE_STOPPED
) {
1340 client_initialize(client
);
1341 client_start(client
);
1347 static int client_timeout_t2(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
1348 sd_dhcp_client
*client
= userdata
;
1349 DHCP_CLIENT_DONT_DESTROY(client
);
1354 client
->receive_message
= sd_event_source_unref(client
->receive_message
);
1355 client
->fd
= asynchronous_close(client
->fd
);
1357 client
->state
= DHCP_STATE_REBINDING
;
1358 client
->attempt
= 0;
1360 r
= dhcp_network_bind_raw_socket(client
->ifindex
, &client
->link
,
1361 client
->xid
, client
->mac_addr
,
1362 client
->mac_addr_len
, client
->arp_type
,
1365 client_stop(client
, r
);
1370 return client_initialize_events(client
, client_receive_message_raw
);
1373 static int client_timeout_t1(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
1374 sd_dhcp_client
*client
= userdata
;
1375 DHCP_CLIENT_DONT_DESTROY(client
);
1377 client
->state
= DHCP_STATE_RENEWING
;
1378 client
->attempt
= 0;
1380 return client_initialize_time_events(client
);
1383 static int client_handle_offer(sd_dhcp_client
*client
, DHCPMessage
*offer
, size_t len
) {
1384 _cleanup_(sd_dhcp_lease_unrefp
) sd_dhcp_lease
*lease
= NULL
;
1387 r
= dhcp_lease_new(&lease
);
1391 if (client
->client_id_len
) {
1392 r
= dhcp_lease_set_client_id(lease
,
1393 (uint8_t *) &client
->client_id
,
1394 client
->client_id_len
);
1399 r
= dhcp_option_parse(offer
, len
, dhcp_lease_parse_options
, lease
, NULL
);
1400 if (r
!= DHCP_OFFER
) {
1401 log_dhcp_client(client
, "received message was not an OFFER, ignoring");
1405 lease
->next_server
= offer
->siaddr
;
1406 lease
->address
= offer
->yiaddr
;
1408 if (lease
->address
== 0 ||
1409 lease
->server_address
== 0 ||
1410 lease
->lifetime
== 0) {
1411 log_dhcp_client(client
, "received lease lacks address, server address or lease lifetime, ignoring");
1415 if (!lease
->have_subnet_mask
) {
1416 r
= dhcp_lease_set_default_subnet_mask(lease
);
1418 log_dhcp_client(client
,
1419 "received lease lacks subnet mask, "
1420 "and a fallback one cannot be generated, ignoring");
1425 sd_dhcp_lease_unref(client
->lease
);
1426 client
->lease
= TAKE_PTR(lease
);
1428 if (client_notify(client
, SD_DHCP_CLIENT_EVENT_SELECTING
) < 0)
1431 log_dhcp_client(client
, "OFFER");
1436 static int client_handle_forcerenew(sd_dhcp_client
*client
, DHCPMessage
*force
, size_t len
) {
1439 r
= dhcp_option_parse(force
, len
, NULL
, NULL
, NULL
);
1440 if (r
!= DHCP_FORCERENEW
)
1443 log_dhcp_client(client
, "FORCERENEW");
1448 static bool lease_equal(const sd_dhcp_lease
*a
, const sd_dhcp_lease
*b
) {
1449 if (a
->address
!= b
->address
)
1452 if (a
->subnet_mask
!= b
->subnet_mask
)
1455 if (a
->router_size
!= b
->router_size
)
1458 for (size_t i
= 0; i
< a
->router_size
; i
++)
1459 if (a
->router
[i
].s_addr
!= b
->router
[i
].s_addr
)
1465 static int client_handle_ack(sd_dhcp_client
*client
, DHCPMessage
*ack
, size_t len
) {
1466 _cleanup_(sd_dhcp_lease_unrefp
) sd_dhcp_lease
*lease
= NULL
;
1467 _cleanup_free_
char *error_message
= NULL
;
1470 r
= dhcp_lease_new(&lease
);
1474 if (client
->client_id_len
) {
1475 r
= dhcp_lease_set_client_id(lease
,
1476 (uint8_t *) &client
->client_id
,
1477 client
->client_id_len
);
1482 r
= dhcp_option_parse(ack
, len
, dhcp_lease_parse_options
, lease
, &error_message
);
1483 if (r
== DHCP_NAK
) {
1484 log_dhcp_client(client
, "NAK: %s", strna(error_message
));
1485 return -EADDRNOTAVAIL
;
1488 if (r
!= DHCP_ACK
) {
1489 log_dhcp_client(client
, "received message was not an ACK, ignoring");
1493 lease
->next_server
= ack
->siaddr
;
1495 lease
->address
= ack
->yiaddr
;
1497 if (lease
->address
== INADDR_ANY
||
1498 lease
->server_address
== INADDR_ANY
||
1499 lease
->lifetime
== 0) {
1500 log_dhcp_client(client
, "received lease lacks address, server "
1501 "address or lease lifetime, ignoring");
1505 if (lease
->subnet_mask
== INADDR_ANY
) {
1506 r
= dhcp_lease_set_default_subnet_mask(lease
);
1508 log_dhcp_client(client
,
1509 "received lease lacks subnet mask, "
1510 "and a fallback one cannot be generated, ignoring");
1515 r
= SD_DHCP_CLIENT_EVENT_IP_ACQUIRE
;
1516 if (client
->lease
) {
1517 if (lease_equal(client
->lease
, lease
))
1518 r
= SD_DHCP_CLIENT_EVENT_RENEW
;
1520 r
= SD_DHCP_CLIENT_EVENT_IP_CHANGE
;
1522 client
->lease
= sd_dhcp_lease_unref(client
->lease
);
1525 client
->lease
= TAKE_PTR(lease
);
1527 log_dhcp_client(client
, "ACK");
1532 static uint64_t client_compute_timeout(sd_dhcp_client
*client
, uint32_t lifetime
, double factor
) {
1534 assert(client
->request_sent
);
1535 assert(lifetime
> 0);
1542 return client
->request_sent
+ (lifetime
* USEC_PER_SEC
* factor
) +
1543 + (random_u32() & 0x1fffff);
1546 static int client_set_lease_timeouts(sd_dhcp_client
*client
) {
1548 uint64_t lifetime_timeout
;
1549 uint64_t t2_timeout
;
1550 uint64_t t1_timeout
;
1551 char time_string
[FORMAT_TIMESPAN_MAX
];
1555 assert(client
->event
);
1556 assert(client
->lease
);
1557 assert(client
->lease
->lifetime
);
1559 /* don't set timers for infinite leases */
1560 if (client
->lease
->lifetime
== 0xffffffff) {
1561 (void) event_source_disable(client
->timeout_t1
);
1562 (void) event_source_disable(client
->timeout_t2
);
1563 (void) event_source_disable(client
->timeout_expire
);
1568 r
= sd_event_now(client
->event
, clock_boottime_or_monotonic(), &time_now
);
1571 assert(client
->request_sent
<= time_now
);
1573 /* convert the various timeouts from relative (secs) to absolute (usecs) */
1574 lifetime_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 1);
1575 if (client
->lease
->t1
> 0 && client
->lease
->t2
> 0) {
1576 /* both T1 and T2 are given */
1577 if (client
->lease
->t1
< client
->lease
->t2
&&
1578 client
->lease
->t2
< client
->lease
->lifetime
) {
1579 /* they are both valid */
1580 t2_timeout
= client_compute_timeout(client
, client
->lease
->t2
, 1);
1581 t1_timeout
= client_compute_timeout(client
, client
->lease
->t1
, 1);
1584 t2_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 7.0 / 8.0);
1585 client
->lease
->t2
= (client
->lease
->lifetime
* 7) / 8;
1586 t1_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 0.5);
1587 client
->lease
->t1
= client
->lease
->lifetime
/ 2;
1589 } else if (client
->lease
->t2
> 0 && client
->lease
->t2
< client
->lease
->lifetime
) {
1590 /* only T2 is given, and it is valid */
1591 t2_timeout
= client_compute_timeout(client
, client
->lease
->t2
, 1);
1592 t1_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 0.5);
1593 client
->lease
->t1
= client
->lease
->lifetime
/ 2;
1594 if (t2_timeout
<= t1_timeout
) {
1595 /* the computed T1 would be invalid, so discard T2 */
1596 t2_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 7.0 / 8.0);
1597 client
->lease
->t2
= (client
->lease
->lifetime
* 7) / 8;
1599 } else if (client
->lease
->t1
> 0 && client
->lease
->t1
< client
->lease
->lifetime
) {
1600 /* only T1 is given, and it is valid */
1601 t1_timeout
= client_compute_timeout(client
, client
->lease
->t1
, 1);
1602 t2_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 7.0 / 8.0);
1603 client
->lease
->t2
= (client
->lease
->lifetime
* 7) / 8;
1604 if (t2_timeout
<= t1_timeout
) {
1605 /* the computed T2 would be invalid, so discard T1 */
1606 t2_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 0.5);
1607 client
->lease
->t2
= client
->lease
->lifetime
/ 2;
1610 /* fall back to the default timeouts */
1611 t1_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 0.5);
1612 client
->lease
->t1
= client
->lease
->lifetime
/ 2;
1613 t2_timeout
= client_compute_timeout(client
, client
->lease
->lifetime
, 7.0 / 8.0);
1614 client
->lease
->t2
= (client
->lease
->lifetime
* 7) / 8;
1617 /* arm lifetime timeout */
1618 r
= event_reset_time(client
->event
, &client
->timeout_expire
,
1619 clock_boottime_or_monotonic(),
1620 lifetime_timeout
, 10 * USEC_PER_MSEC
,
1621 client_timeout_expire
, client
,
1622 client
->event_priority
, "dhcp4-lifetime", true);
1626 log_dhcp_client(client
, "lease expires in %s",
1627 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, lifetime_timeout
- time_now
, USEC_PER_SEC
));
1629 /* don't arm earlier timeouts if this has already expired */
1630 if (lifetime_timeout
<= time_now
)
1633 /* arm T2 timeout */
1634 r
= event_reset_time(client
->event
, &client
->timeout_t2
,
1635 clock_boottime_or_monotonic(),
1636 t2_timeout
, 10 * USEC_PER_MSEC
,
1637 client_timeout_t2
, client
,
1638 client
->event_priority
, "dhcp4-t2-timeout", true);
1642 log_dhcp_client(client
, "T2 expires in %s",
1643 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, t2_timeout
- time_now
, USEC_PER_SEC
));
1645 /* don't arm earlier timeout if this has already expired */
1646 if (t2_timeout
<= time_now
)
1649 /* arm T1 timeout */
1650 r
= event_reset_time(client
->event
, &client
->timeout_t1
,
1651 clock_boottime_or_monotonic(),
1652 t1_timeout
, 10 * USEC_PER_MSEC
,
1653 client_timeout_t1
, client
,
1654 client
->event_priority
, "dhcp4-t1-timer", true);
1658 log_dhcp_client(client
, "T1 expires in %s",
1659 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, t1_timeout
- time_now
, USEC_PER_SEC
));
1664 static int client_handle_message(sd_dhcp_client
*client
, DHCPMessage
*message
, int len
) {
1665 DHCP_CLIENT_DONT_DESTROY(client
);
1666 char time_string
[FORMAT_TIMESPAN_MAX
];
1667 int r
= 0, notify_event
= 0;
1670 assert(client
->event
);
1673 switch (client
->state
) {
1674 case DHCP_STATE_SELECTING
:
1676 r
= client_handle_offer(client
, message
, len
);
1679 client
->state
= DHCP_STATE_REQUESTING
;
1680 client
->attempt
= 0;
1682 r
= event_reset_time(client
->event
, &client
->timeout_resend
,
1683 clock_boottime_or_monotonic(),
1685 client_timeout_resend
, client
,
1686 client
->event_priority
, "dhcp4-resend-timer", true);
1689 } else if (r
== -ENOMSG
)
1690 /* invalid message, let's ignore it */
1695 case DHCP_STATE_REBOOTING
:
1696 case DHCP_STATE_REQUESTING
:
1697 case DHCP_STATE_RENEWING
:
1698 case DHCP_STATE_REBINDING
:
1700 r
= client_handle_ack(client
, message
, len
);
1702 client
->start_delay
= 0;
1703 (void) event_source_disable(client
->timeout_resend
);
1704 client
->receive_message
=
1705 sd_event_source_unref(client
->receive_message
);
1706 client
->fd
= asynchronous_close(client
->fd
);
1708 if (IN_SET(client
->state
, DHCP_STATE_REQUESTING
,
1709 DHCP_STATE_REBOOTING
))
1710 notify_event
= SD_DHCP_CLIENT_EVENT_IP_ACQUIRE
;
1711 else if (r
!= SD_DHCP_CLIENT_EVENT_IP_ACQUIRE
)
1714 client
->state
= DHCP_STATE_BOUND
;
1715 client
->attempt
= 0;
1717 client
->last_addr
= client
->lease
->address
;
1719 r
= client_set_lease_timeouts(client
);
1721 log_dhcp_client(client
, "could not set lease timeouts");
1725 r
= dhcp_network_bind_udp_socket(client
->ifindex
, client
->lease
->address
, client
->port
, client
->ip_service_type
);
1727 log_dhcp_client(client
, "could not bind UDP socket");
1733 client_initialize_io_events(client
, client_receive_message_udp
);
1736 client_notify(client
, notify_event
);
1737 if (client
->state
== DHCP_STATE_STOPPED
)
1741 } else if (r
== -EADDRNOTAVAIL
) {
1742 /* got a NAK, let's restart the client */
1743 client_notify(client
, SD_DHCP_CLIENT_EVENT_EXPIRED
);
1745 r
= client_initialize(client
);
1749 r
= client_start_delayed(client
);
1753 log_dhcp_client(client
, "REBOOT in %s", format_timespan(time_string
, FORMAT_TIMESPAN_MAX
,
1754 client
->start_delay
, USEC_PER_SEC
));
1756 client
->start_delay
= CLAMP(client
->start_delay
* 2,
1757 RESTART_AFTER_NAK_MIN_USEC
, RESTART_AFTER_NAK_MAX_USEC
);
1760 } else if (r
== -ENOMSG
)
1761 /* invalid message, let's ignore it */
1766 case DHCP_STATE_BOUND
:
1767 r
= client_handle_forcerenew(client
, message
, len
);
1769 r
= client_timeout_t1(NULL
, 0, client
);
1772 } else if (r
== -ENOMSG
)
1773 /* invalid message, let's ignore it */
1778 case DHCP_STATE_INIT
:
1779 case DHCP_STATE_INIT_REBOOT
:
1783 case DHCP_STATE_STOPPED
:
1790 client_stop(client
, r
);
1795 static int client_receive_message_udp(
1801 sd_dhcp_client
*client
= userdata
;
1802 _cleanup_free_ DHCPMessage
*message
= NULL
;
1803 const uint8_t *expected_chaddr
= NULL
;
1804 uint8_t expected_hlen
= 0;
1805 ssize_t len
, buflen
;
1810 buflen
= next_datagram_size_fd(fd
);
1811 if (buflen
== -ENETDOWN
) {
1812 /* the link is down. Don't return an error or the I/O event
1813 source will be disconnected and we won't be able to receive
1814 packets again when the link comes back. */
1820 message
= malloc0(buflen
);
1824 len
= recv(fd
, message
, buflen
, 0);
1826 /* see comment above for why we shouldn't error out on ENETDOWN. */
1827 if (IN_SET(errno
, EAGAIN
, EINTR
, ENETDOWN
))
1830 return log_dhcp_client_errno(client
, errno
,
1831 "Could not receive message from UDP socket: %m");
1833 if ((size_t) len
< sizeof(DHCPMessage
)) {
1834 log_dhcp_client(client
, "Too small to be a DHCP message: ignoring");
1838 if (be32toh(message
->magic
) != DHCP_MAGIC_COOKIE
) {
1839 log_dhcp_client(client
, "Not a DHCP message: ignoring");
1843 if (message
->op
!= BOOTREPLY
) {
1844 log_dhcp_client(client
, "Not a BOOTREPLY message: ignoring");
1848 if (message
->htype
!= client
->arp_type
) {
1849 log_dhcp_client(client
, "Packet type does not match client type");
1853 if (client
->arp_type
== ARPHRD_ETHER
) {
1854 expected_hlen
= ETH_ALEN
;
1855 expected_chaddr
= &client
->mac_addr
[0];
1858 if (message
->hlen
!= expected_hlen
) {
1859 log_dhcp_client(client
, "Unexpected packet hlen %d", message
->hlen
);
1863 if (expected_hlen
> 0 && memcmp(&message
->chaddr
[0], expected_chaddr
, expected_hlen
)) {
1864 log_dhcp_client(client
, "Received chaddr does not match expected: ignoring");
1868 if (client
->state
!= DHCP_STATE_BOUND
&&
1869 be32toh(message
->xid
) != client
->xid
) {
1870 /* in BOUND state, we may receive FORCERENEW with xid set by server,
1871 so ignore the xid in this case */
1872 log_dhcp_client(client
, "Received xid (%u) does not match expected (%u): ignoring",
1873 be32toh(message
->xid
), client
->xid
);
1877 return client_handle_message(client
, message
, len
);
1880 static int client_receive_message_raw(
1886 sd_dhcp_client
*client
= userdata
;
1887 _cleanup_free_ DHCPPacket
*packet
= NULL
;
1888 CMSG_BUFFER_TYPE(CMSG_SPACE(sizeof(struct tpacket_auxdata
))) control
;
1889 struct iovec iov
= {};
1890 struct msghdr msg
= {
1893 .msg_control
= &control
,
1894 .msg_controllen
= sizeof(control
),
1896 struct cmsghdr
*cmsg
;
1897 bool checksum
= true;
1898 ssize_t buflen
, len
;
1904 buflen
= next_datagram_size_fd(fd
);
1905 if (buflen
== -ENETDOWN
)
1910 packet
= malloc0(buflen
);
1914 iov
= IOVEC_MAKE(packet
, buflen
);
1916 len
= recvmsg_safe(fd
, &msg
, 0);
1917 if (IN_SET(len
, -EAGAIN
, -EINTR
, -ENETDOWN
))
1920 return log_dhcp_client_errno(client
, len
,
1921 "Could not receive message from raw socket: %m");
1923 if ((size_t) len
< sizeof(DHCPPacket
))
1926 cmsg
= cmsg_find(&msg
, SOL_PACKET
, PACKET_AUXDATA
, CMSG_LEN(sizeof(struct tpacket_auxdata
)));
1928 struct tpacket_auxdata
*aux
= (struct tpacket_auxdata
*) CMSG_DATA(cmsg
);
1929 checksum
= !(aux
->tp_status
& TP_STATUS_CSUMNOTREADY
);
1932 r
= dhcp_packet_verify_headers(packet
, len
, checksum
, client
->port
);
1936 len
-= DHCP_IP_UDP_SIZE
;
1938 return client_handle_message(client
, &packet
->dhcp
, len
);
1941 int sd_dhcp_client_send_renew(sd_dhcp_client
*client
) {
1942 assert_return(client
, -EINVAL
);
1943 assert_return(client
->fd
>= 0, -EINVAL
);
1945 client
->start_delay
= 0;
1946 client
->attempt
= 1;
1947 client
->state
= DHCP_STATE_RENEWING
;
1949 return client_initialize_time_events(client
);
1952 int sd_dhcp_client_start(sd_dhcp_client
*client
) {
1955 assert_return(client
, -EINVAL
);
1957 r
= client_initialize(client
);
1961 /* RFC7844 section 3.3:
1962 SHOULD perform a complete four-way handshake, starting with a
1963 DHCPDISCOVER, to obtain a new address lease. If the client can
1964 ascertain that this is exactly the same network to which it was
1965 previously connected, and if the link-layer address did not change,
1966 the client MAY issue a DHCPREQUEST to try to reclaim the current
1968 if (client
->last_addr
&& !client
->anonymize
)
1969 client
->state
= DHCP_STATE_INIT_REBOOT
;
1971 r
= client_start(client
);
1973 log_dhcp_client(client
, "STARTED on ifindex %i", client
->ifindex
);
1978 int sd_dhcp_client_send_release(sd_dhcp_client
*client
) {
1979 assert_return(client
, -EINVAL
);
1980 assert_return(client
->state
!= DHCP_STATE_STOPPED
, -ESTALE
);
1981 assert_return(client
->lease
, -EUNATCH
);
1983 _cleanup_free_ DHCPPacket
*release
= NULL
;
1984 size_t optoffset
, optlen
;
1987 r
= client_message_init(client
, &release
, DHCP_RELEASE
, &optlen
, &optoffset
);
1991 /* Fill up release IP and MAC */
1992 release
->dhcp
.ciaddr
= client
->lease
->address
;
1993 memcpy(&release
->dhcp
.chaddr
, &client
->mac_addr
, client
->mac_addr_len
);
1995 r
= dhcp_option_append(&release
->dhcp
, optlen
, &optoffset
, 0,
1996 SD_DHCP_OPTION_END
, 0, NULL
);
2000 r
= dhcp_network_send_udp_socket(client
->fd
,
2001 client
->lease
->server_address
,
2004 sizeof(DHCPMessage
) + optoffset
);
2008 log_dhcp_client(client
, "RELEASE");
2013 int sd_dhcp_client_send_decline(sd_dhcp_client
*client
) {
2014 assert_return(client
, -EINVAL
);
2015 assert_return(client
->state
!= DHCP_STATE_STOPPED
, -ESTALE
);
2016 assert_return(client
->lease
, -EUNATCH
);
2018 _cleanup_free_ DHCPPacket
*release
= NULL
;
2019 size_t optoffset
, optlen
;
2022 r
= client_message_init(client
, &release
, DHCP_DECLINE
, &optlen
, &optoffset
);
2026 release
->dhcp
.ciaddr
= client
->lease
->address
;
2027 memcpy(&release
->dhcp
.chaddr
, &client
->mac_addr
, client
->mac_addr_len
);
2029 r
= dhcp_option_append(&release
->dhcp
, optlen
, &optoffset
, 0,
2030 SD_DHCP_OPTION_END
, 0, NULL
);
2034 r
= dhcp_network_send_udp_socket(client
->fd
,
2035 client
->lease
->server_address
,
2038 sizeof(DHCPMessage
) + optoffset
);
2042 log_dhcp_client(client
, "DECLINE");
2044 client_stop(client
, SD_DHCP_CLIENT_EVENT_STOP
);
2046 if (client
->state
!= DHCP_STATE_STOPPED
) {
2047 r
= sd_dhcp_client_start(client
);
2055 int sd_dhcp_client_stop(sd_dhcp_client
*client
) {
2056 DHCP_CLIENT_DONT_DESTROY(client
);
2058 assert_return(client
, -EINVAL
);
2060 client_stop(client
, SD_DHCP_CLIENT_EVENT_STOP
);
2061 client
->state
= DHCP_STATE_STOPPED
;
2066 int sd_dhcp_client_attach_event(sd_dhcp_client
*client
, sd_event
*event
, int64_t priority
) {
2069 assert_return(client
, -EINVAL
);
2070 assert_return(!client
->event
, -EBUSY
);
2073 client
->event
= sd_event_ref(event
);
2075 r
= sd_event_default(&client
->event
);
2080 client
->event_priority
= priority
;
2085 int sd_dhcp_client_detach_event(sd_dhcp_client
*client
) {
2086 assert_return(client
, -EINVAL
);
2088 client
->event
= sd_event_unref(client
->event
);
2093 sd_event
*sd_dhcp_client_get_event(sd_dhcp_client
*client
) {
2094 assert_return(client
, NULL
);
2096 return client
->event
;
2099 static sd_dhcp_client
*dhcp_client_free(sd_dhcp_client
*client
) {
2103 log_dhcp_client(client
, "FREE");
2105 client
->timeout_resend
= sd_event_source_unref(client
->timeout_resend
);
2106 client
->timeout_t1
= sd_event_source_unref(client
->timeout_t1
);
2107 client
->timeout_t2
= sd_event_source_unref(client
->timeout_t2
);
2108 client
->timeout_expire
= sd_event_source_unref(client
->timeout_expire
);
2110 client_initialize(client
);
2112 sd_dhcp_client_detach_event(client
);
2114 sd_dhcp_lease_unref(client
->lease
);
2116 free(client
->req_opts
);
2117 free(client
->hostname
);
2118 free(client
->vendor_class_identifier
);
2119 free(client
->mudurl
);
2120 client
->user_class
= strv_free(client
->user_class
);
2121 ordered_hashmap_free(client
->extra_options
);
2122 ordered_hashmap_free(client
->vendor_options
);
2123 return mfree(client
);
2126 DEFINE_TRIVIAL_REF_UNREF_FUNC(sd_dhcp_client
, sd_dhcp_client
, dhcp_client_free
);
2128 int sd_dhcp_client_new(sd_dhcp_client
**ret
, int anonymize
) {
2129 assert_return(ret
, -EINVAL
);
2131 _cleanup_(sd_dhcp_client_unrefp
) sd_dhcp_client
*client
= new(sd_dhcp_client
, 1);
2135 *client
= (sd_dhcp_client
) {
2137 .state
= DHCP_STATE_INIT
,
2140 .mtu
= DHCP_DEFAULT_MIN_SIZE
,
2141 .port
= DHCP_PORT_CLIENT
,
2142 .anonymize
= !!anonymize
,
2143 .max_attempts
= (uint64_t) -1,
2144 .ip_service_type
= -1,
2146 /* NOTE: this could be moved to a function. */
2148 client
->req_opts_size
= ELEMENTSOF(default_req_opts_anonymize
);
2149 client
->req_opts
= memdup(default_req_opts_anonymize
, client
->req_opts_size
);
2151 client
->req_opts_size
= ELEMENTSOF(default_req_opts
);
2152 client
->req_opts
= memdup(default_req_opts
, client
->req_opts_size
);
2154 if (!client
->req_opts
)
2157 *ret
= TAKE_PTR(client
);