2 This file is part of systemd.
4 Copyright (C) 2014 Intel Corporation. All rights reserved.
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 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 License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 #include <netinet/icmp6.h>
21 #include <netinet/in.h>
22 #include <netinet/ip6.h>
25 #include <sys/ioctl.h>
29 #include "alloc-util.h"
31 #include "icmp6-util.h"
32 #include "in-addr-util.h"
34 #include "socket-util.h"
36 #define NDISC_ROUTER_SOLICITATION_INTERVAL 4 * USEC_PER_SEC
37 #define NDISC_MAX_ROUTER_SOLICITATIONS 3
41 NDISC_STATE_SOLICITATION_SENT
,
42 NDISC_STATE_ADVERTISMENT_LISTEN
,
44 _NDISC_STATE_INVALID
= -1,
47 #define IP6_MIN_MTU (unsigned)1280
48 #define ICMP6_RECV_SIZE (IP6_MIN_MTU - sizeof(struct ip6_hdr))
49 #define NDISC_OPT_LEN_UNITS 8
51 #define ND_RA_FLAG_PREF 0x18
52 #define ND_RA_FLAG_PREF_LOW 0x03
53 #define ND_RA_FLAG_PREF_MEDIUM 0x0
54 #define ND_RA_FLAG_PREF_HIGH 0x1
55 #define ND_RA_FLAG_PREF_INVALID 0x2
57 typedef struct NDiscPrefix NDiscPrefix
;
64 LIST_FIELDS(NDiscPrefix
, prefixes
);
74 enum NDiscState state
;
78 struct ether_addr mac_addr
;
80 LIST_HEAD(NDiscPrefix
, prefixes
);
82 sd_event_source
*recv
;
83 sd_event_source
*timeout
;
85 sd_ndisc_router_callback_t router_callback
;
86 sd_ndisc_prefix_autonomous_callback_t prefix_autonomous_callback
;
87 sd_ndisc_prefix_onlink_callback_t prefix_onlink_callback
;
88 sd_ndisc_callback_t callback
;
92 #define log_ndisc(p, fmt, ...) log_internal(LOG_DEBUG, 0, __FILE__, __LINE__, __func__, "NDisc CLIENT: " fmt, ##__VA_ARGS__)
94 static NDiscPrefix
*ndisc_prefix_unref(NDiscPrefix
*prefix
) {
99 assert(prefix
->n_ref
> 0);
102 if (prefix
->n_ref
> 0)
106 LIST_REMOVE(prefixes
, prefix
->nd
->prefixes
, prefix
);
113 static int ndisc_prefix_new(sd_ndisc
*nd
, NDiscPrefix
**ret
) {
114 _cleanup_free_ NDiscPrefix
*prefix
= NULL
;
118 prefix
= new0(NDiscPrefix
, 1);
123 LIST_INIT(prefixes
, prefix
);
132 int sd_ndisc_set_callback(sd_ndisc
*nd
,
133 sd_ndisc_router_callback_t router_callback
,
134 sd_ndisc_prefix_onlink_callback_t prefix_onlink_callback
,
135 sd_ndisc_prefix_autonomous_callback_t prefix_autonomous_callback
,
136 sd_ndisc_callback_t callback
,
140 nd
->router_callback
= router_callback
;
141 nd
->prefix_onlink_callback
= prefix_onlink_callback
;
142 nd
->prefix_autonomous_callback
= prefix_autonomous_callback
;
143 nd
->callback
= callback
;
144 nd
->userdata
= userdata
;
149 int sd_ndisc_set_index(sd_ndisc
*nd
, int interface_index
) {
151 assert(interface_index
>= -1);
153 nd
->index
= interface_index
;
158 int sd_ndisc_set_mac(sd_ndisc
*nd
, const struct ether_addr
*mac_addr
) {
162 memcpy(&nd
->mac_addr
, mac_addr
, sizeof(nd
->mac_addr
));
170 int sd_ndisc_attach_event(sd_ndisc
*nd
, sd_event
*event
, int priority
) {
173 assert_return(nd
, -EINVAL
);
174 assert_return(!nd
->event
, -EBUSY
);
177 nd
->event
= sd_event_ref(event
);
179 r
= sd_event_default(&nd
->event
);
184 nd
->event_priority
= priority
;
189 int sd_ndisc_detach_event(sd_ndisc
*nd
) {
190 assert_return(nd
, -EINVAL
);
192 nd
->event
= sd_event_unref(nd
->event
);
197 sd_event
*sd_ndisc_get_event(sd_ndisc
*nd
) {
203 sd_ndisc
*sd_ndisc_ref(sd_ndisc
*nd
) {
208 assert(nd
->n_ref
> 0);
214 static int ndisc_init(sd_ndisc
*nd
) {
217 nd
->recv
= sd_event_source_unref(nd
->recv
);
218 nd
->fd
= asynchronous_close(nd
->fd
);
219 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
224 sd_ndisc
*sd_ndisc_unref(sd_ndisc
*nd
) {
225 NDiscPrefix
*prefix
, *p
;
230 assert(nd
->n_ref
> 0);
237 sd_ndisc_detach_event(nd
);
239 LIST_FOREACH_SAFE(prefixes
, prefix
, p
, nd
->prefixes
)
240 prefix
= ndisc_prefix_unref(prefix
);
247 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_ndisc
*, sd_ndisc_unref
);
248 #define _cleanup_sd_ndisc_free_ _cleanup_(sd_ndisc_unrefp)
250 int sd_ndisc_new(sd_ndisc
**ret
) {
251 _cleanup_sd_ndisc_free_ sd_ndisc
*nd
= NULL
;
255 nd
= new0(sd_ndisc
, 1);
264 LIST_HEAD_INIT(nd
->prefixes
);
272 int sd_ndisc_get_mtu(sd_ndisc
*nd
, uint32_t *mtu
) {
273 assert_return(nd
, -EINVAL
);
274 assert_return(mtu
, -EINVAL
);
284 static int prefix_match(const struct in6_addr
*prefix
, uint8_t prefixlen
,
285 const struct in6_addr
*addr
,
286 uint8_t addr_prefixlen
) {
287 uint8_t bytes
, mask
, len
;
289 assert_return(prefix
, -EINVAL
);
290 assert_return(addr
, -EINVAL
);
292 len
= MIN(prefixlen
, addr_prefixlen
);
295 mask
= 0xff << (8 - len
% 8);
297 if (memcmp(prefix
, addr
, bytes
) != 0 ||
298 (prefix
->s6_addr
[bytes
] & mask
) != (addr
->s6_addr
[bytes
] & mask
))
299 return -EADDRNOTAVAIL
;
304 static int ndisc_prefix_match(sd_ndisc
*nd
, const struct in6_addr
*addr
,
305 uint8_t addr_len
, NDiscPrefix
**result
) {
306 NDiscPrefix
*prefix
, *p
;
312 r
= sd_event_now(nd
->event
, clock_boottime_or_monotonic(), &time_now
);
316 LIST_FOREACH_SAFE(prefixes
, prefix
, p
, nd
->prefixes
) {
317 if (prefix
->valid_until
< time_now
) {
318 prefix
= ndisc_prefix_unref(prefix
);
323 if (prefix_match(&prefix
->addr
, prefix
->len
, addr
, addr_len
) >= 0) {
329 return -EADDRNOTAVAIL
;
332 static int ndisc_prefix_update(sd_ndisc
*nd
, ssize_t len
,
333 const struct nd_opt_prefix_info
*prefix_opt
) {
335 uint32_t lifetime_valid
, lifetime_preferred
;
337 char time_string
[FORMAT_TIMESPAN_MAX
];
343 if (len
< prefix_opt
->nd_opt_pi_len
)
346 if (!(prefix_opt
->nd_opt_pi_flags_reserved
& (ND_OPT_PI_FLAG_ONLINK
| ND_OPT_PI_FLAG_AUTO
)))
349 if (in_addr_is_link_local(AF_INET6
, (const union in_addr_union
*) &prefix_opt
->nd_opt_pi_prefix
) > 0)
352 lifetime_valid
= be32toh(prefix_opt
->nd_opt_pi_valid_time
);
353 lifetime_preferred
= be32toh(prefix_opt
->nd_opt_pi_preferred_time
);
355 if (lifetime_valid
< lifetime_preferred
)
358 r
= ndisc_prefix_match(nd
, &prefix_opt
->nd_opt_pi_prefix
,
359 prefix_opt
->nd_opt_pi_prefix_len
, &prefix
);
361 if (r
< 0 && r
!= -EADDRNOTAVAIL
)
364 /* if router advertisment prefix valid timeout is zero, the timeout
365 callback will be called immediately to clean up the prefix */
367 if (r
== -EADDRNOTAVAIL
) {
368 r
= ndisc_prefix_new(nd
, &prefix
);
372 prefix
->len
= prefix_opt
->nd_opt_pi_prefix_len
;
374 memcpy(&prefix
->addr
, &prefix_opt
->nd_opt_pi_prefix
,
375 sizeof(prefix
->addr
));
377 log_ndisc(nd
, "New prefix "SD_NDISC_ADDRESS_FORMAT_STR
"/%d lifetime %d expires in %s",
378 SD_NDISC_ADDRESS_FORMAT_VAL(prefix
->addr
),
379 prefix
->len
, lifetime_valid
,
380 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, lifetime_valid
* USEC_PER_SEC
, USEC_PER_SEC
));
382 LIST_PREPEND(prefixes
, nd
->prefixes
, prefix
);
385 if (prefix
->len
!= prefix_opt
->nd_opt_pi_prefix_len
) {
388 prefixlen
= MIN(prefix
->len
, prefix_opt
->nd_opt_pi_prefix_len
);
390 log_ndisc(nd
, "Prefix length mismatch %d/%d using %d",
392 prefix_opt
->nd_opt_pi_prefix_len
,
395 prefix
->len
= prefixlen
;
398 log_ndisc(nd
, "Update prefix "SD_NDISC_ADDRESS_FORMAT_STR
"/%d lifetime %d expires in %s",
399 SD_NDISC_ADDRESS_FORMAT_VAL(prefix
->addr
),
400 prefix
->len
, lifetime_valid
,
401 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, lifetime_valid
* USEC_PER_SEC
, USEC_PER_SEC
));
404 r
= sd_event_now(nd
->event
, clock_boottime_or_monotonic(), &time_now
);
408 prefix
->valid_until
= time_now
+ lifetime_valid
* USEC_PER_SEC
;
410 if ((prefix_opt
->nd_opt_pi_flags_reserved
& ND_OPT_PI_FLAG_ONLINK
) && nd
->prefix_onlink_callback
)
411 nd
->prefix_onlink_callback(nd
, &prefix
->addr
, prefix
->len
, prefix
->valid_until
, nd
->userdata
);
413 if ((prefix_opt
->nd_opt_pi_flags_reserved
& ND_OPT_PI_FLAG_AUTO
) && nd
->prefix_autonomous_callback
)
414 nd
->prefix_autonomous_callback(nd
, &prefix
->addr
, prefix
->len
, lifetime_preferred
, lifetime_valid
,
420 static int ndisc_ra_parse(sd_ndisc
*nd
, struct nd_router_advert
*ra
,
423 struct nd_opt_hdr
*opt_hdr
;
425 assert_return(nd
, -EINVAL
);
426 assert_return(ra
, -EINVAL
);
429 if (len
< NDISC_OPT_LEN_UNITS
) {
430 log_ndisc(nd
, "Router Advertisement below minimum length");
438 while (len
!= 0 && len
>= opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
) {
439 struct nd_opt_mtu
*opt_mtu
;
441 struct nd_opt_prefix_info
*opt_prefix
;
443 if (opt_hdr
->nd_opt_len
== 0)
446 switch (opt_hdr
->nd_opt_type
) {
450 mtu
= be32toh(opt_mtu
->nd_opt_mtu_mtu
);
452 if (mtu
!= nd
->mtu
) {
453 nd
->mtu
= MAX(mtu
, IP6_MIN_MTU
);
455 log_ndisc(nd
, "Router Advertisement link MTU %d using %d",
461 case ND_OPT_PREFIX_INFORMATION
:
464 ndisc_prefix_update(nd
, len
, opt_prefix
);
469 len
-= opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
;
470 opt
= (void *)((char *)opt
+
471 opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
);
476 log_ndisc(nd
, "Router Advertisement contains %zd bytes of trailing garbage", len
);
481 static int ndisc_router_advertisment_recv(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
482 _cleanup_free_
struct nd_router_advert
*ra
= NULL
;
483 sd_ndisc
*nd
= userdata
;
484 int r
, buflen
= 0, pref
, stateful
;
485 union sockaddr_union router
= {};
486 socklen_t router_len
= sizeof(router
);
494 r
= ioctl(fd
, FIONREAD
, &buflen
);
495 if (r
< 0 || buflen
<= 0)
496 buflen
= ICMP6_RECV_SIZE
;
502 len
= recvfrom(fd
, ra
, buflen
, 0, &router
.sa
, &router_len
);
504 log_ndisc(nd
, "Could not receive message from ICMPv6 socket: %m");
506 } else if (router_len
!= sizeof(router
.in6
) && router_len
!= 0) {
507 log_ndisc(nd
, "Received invalid source address size from ICMPv6 socket: %zu bytes", (size_t)router_len
);
511 if (ra
->nd_ra_type
!= ND_ROUTER_ADVERT
)
514 if (ra
->nd_ra_code
!= 0)
517 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
519 nd
->state
= NDISC_STATE_ADVERTISMENT_LISTEN
;
521 stateful
= ra
->nd_ra_flags_reserved
& (ND_RA_FLAG_MANAGED
| ND_RA_FLAG_OTHER
);
522 pref
= ra
->nd_ra_flags_reserved
& ND_RA_FLAG_PREF
>> 3;
525 case ND_RA_FLAG_PREF_LOW
:
526 case ND_RA_FLAG_PREF_HIGH
:
529 pref
= ND_RA_FLAG_PREF_MEDIUM
;
533 lifetime
= be16toh(ra
->nd_ra_router_lifetime
);
535 log_ndisc(nd
, "Received Router Advertisement: flags %s preference %s lifetime %u sec",
536 stateful
& ND_RA_FLAG_MANAGED
? "MANAGED" : stateful
& ND_RA_FLAG_OTHER
? "OTHER" : "none",
537 pref
== ND_RA_FLAG_PREF_HIGH
? "high" : pref
== ND_RA_FLAG_PREF_LOW
? "low" : "medium",
540 r
= ndisc_ra_parse(nd
, ra
, len
);
542 log_ndisc(nd
, "Could not parse Router Advertisement: %s", strerror(-r
));
546 if (nd
->router_callback
)
547 nd
->router_callback(nd
, stateful
, router_len
!= 0 ? &router
.in6
.sin6_addr
: NULL
, lifetime
, pref
, nd
->userdata
);
552 static int ndisc_router_solicitation_timeout(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
553 sd_ndisc
*nd
= userdata
;
554 uint64_t time_now
, next_timeout
;
555 struct ether_addr unset
= { };
556 struct ether_addr
*addr
= NULL
;
563 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
565 if (nd
->nd_sent
>= NDISC_MAX_ROUTER_SOLICITATIONS
) {
567 nd
->callback(nd
, SD_NDISC_EVENT_TIMEOUT
, nd
->userdata
);
568 nd
->state
= NDISC_STATE_ADVERTISMENT_LISTEN
;
570 if (memcmp(&nd
->mac_addr
, &unset
, sizeof(struct ether_addr
)))
571 addr
= &nd
->mac_addr
;
573 r
= icmp6_send_router_solicitation(nd
->fd
, addr
);
575 log_ndisc(nd
, "Error sending Router Solicitation");
577 nd
->state
= NDISC_STATE_SOLICITATION_SENT
;
578 log_ndisc(nd
, "Sent Router Solicitation");
583 assert_se(sd_event_now(nd
->event
, clock_boottime_or_monotonic(), &time_now
) >= 0);
585 next_timeout
= time_now
+ NDISC_ROUTER_SOLICITATION_INTERVAL
;
587 r
= sd_event_add_time(nd
->event
, &nd
->timeout
, clock_boottime_or_monotonic(),
589 ndisc_router_solicitation_timeout
, nd
);
591 /* we cannot continue if we are unable to rearm the timer */
596 r
= sd_event_source_set_priority(nd
->timeout
, nd
->event_priority
);
600 r
= sd_event_source_set_description(nd
->timeout
, "ndisc-timeout");
608 int sd_ndisc_stop(sd_ndisc
*nd
) {
609 assert_return(nd
, -EINVAL
);
610 assert_return(nd
->event
, -EINVAL
);
612 log_ndisc(client
, "Stop NDisc");
616 nd
->state
= NDISC_STATE_IDLE
;
619 nd
->callback(nd
, SD_NDISC_EVENT_STOP
, nd
->userdata
);
624 int sd_ndisc_router_discovery_start(sd_ndisc
*nd
) {
630 if (nd
->state
!= NDISC_STATE_IDLE
)
636 r
= icmp6_bind_router_solicitation(nd
->index
);
642 r
= sd_event_add_io(nd
->event
, &nd
->recv
, nd
->fd
, EPOLLIN
,
643 ndisc_router_advertisment_recv
, nd
);
647 r
= sd_event_source_set_priority(nd
->recv
, nd
->event_priority
);
651 r
= sd_event_source_set_description(nd
->recv
, "ndisc-receive-message");
655 r
= sd_event_add_time(nd
->event
, &nd
->timeout
, clock_boottime_or_monotonic(),
656 0, 0, ndisc_router_solicitation_timeout
, nd
);
660 r
= sd_event_source_set_priority(nd
->timeout
, nd
->event_priority
);
664 r
= sd_event_source_set_description(nd
->timeout
, "ndisc-timeout");
669 log_ndisc(client
, "Start Router Solicitation");