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/ip6.h>
24 #include <netinet/in.h>
25 #include <sys/ioctl.h>
29 #include "socket-util.h"
31 #include "icmp6-util.h"
34 #define NDISC_ROUTER_SOLICITATION_INTERVAL 4 * USEC_PER_SEC
35 #define NDISC_MAX_ROUTER_SOLICITATIONS 3
39 NDISC_STATE_SOLICITATION_SENT
,
40 NDISC_STATE_ADVERTISMENT_LISTEN
,
42 _NDISC_STATE_INVALID
= -1,
45 #define IP6_MIN_MTU (unsigned)1280
46 #define ICMP6_RECV_SIZE (IP6_MIN_MTU - sizeof(struct ip6_hdr))
47 #define NDISC_OPT_LEN_UNITS 8
49 typedef struct NDiscPrefix NDiscPrefix
;
54 LIST_FIELDS(NDiscPrefix
, prefixes
);
57 sd_event_source
*timeout_valid
;
64 enum NDiscState state
;
68 struct ether_addr mac_addr
;
70 LIST_HEAD(NDiscPrefix
, prefixes
);
72 sd_event_source
*recv
;
73 sd_event_source
*timeout
;
75 sd_ndisc_callback_t callback
;
79 #define log_ndisc(p, fmt, ...) log_internal(LOG_DEBUG, 0, __FILE__, __LINE__, __func__, "NDisc CLIENT: " fmt, ##__VA_ARGS__)
81 static NDiscPrefix
*ndisc_prefix_unref(NDiscPrefix
*prefix
) {
86 assert(prefix
->n_ref
> 0);
89 if (prefix
->n_ref
> 0)
92 prefix
->timeout_valid
= sd_event_source_unref(prefix
->timeout_valid
);
97 static int ndisc_prefix_new(NDiscPrefix
**ret
) {
98 _cleanup_free_ NDiscPrefix
*prefix
= NULL
;
102 prefix
= new0(NDiscPrefix
, 1);
107 LIST_INIT(prefixes
, prefix
);
115 static void ndisc_notify(sd_ndisc
*nd
, int event
) {
117 nd
->callback(nd
, event
, nd
->userdata
);
120 int sd_ndisc_set_callback(sd_ndisc
*nd
, sd_ndisc_callback_t callback
,
124 nd
->callback
= callback
;
125 nd
->userdata
= userdata
;
130 int sd_ndisc_set_index(sd_ndisc
*nd
, int interface_index
) {
132 assert(interface_index
>= -1);
134 nd
->index
= interface_index
;
139 int sd_ndisc_set_mac(sd_ndisc
*nd
, const struct ether_addr
*mac_addr
) {
143 memcpy(&nd
->mac_addr
, mac_addr
, sizeof(nd
->mac_addr
));
151 int sd_ndisc_attach_event(sd_ndisc
*nd
, sd_event
*event
, int priority
) {
154 assert_return(nd
, -EINVAL
);
155 assert_return(!nd
->event
, -EBUSY
);
158 nd
->event
= sd_event_ref(event
);
160 r
= sd_event_default(&nd
->event
);
165 nd
->event_priority
= priority
;
170 int sd_ndisc_detach_event(sd_ndisc
*nd
) {
171 assert_return(nd
, -EINVAL
);
173 nd
->event
= sd_event_unref(nd
->event
);
178 sd_event
*sd_ndisc_get_event(sd_ndisc
*nd
) {
184 sd_ndisc
*sd_ndisc_ref(sd_ndisc
*nd
) {
189 assert(nd
->n_ref
> 0);
195 static int ndisc_init(sd_ndisc
*nd
) {
198 nd
->recv
= sd_event_source_unref(nd
->recv
);
199 nd
->fd
= asynchronous_close(nd
->fd
);
200 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
205 sd_ndisc
*sd_ndisc_unref(sd_ndisc
*nd
) {
206 NDiscPrefix
*prefix
, *p
;
211 assert(nd
->n_ref
> 0);
218 sd_ndisc_detach_event(nd
);
220 LIST_FOREACH_SAFE(prefixes
, prefix
, p
, nd
->prefixes
) {
221 LIST_REMOVE(prefixes
, nd
->prefixes
, prefix
);
223 prefix
= ndisc_prefix_unref(prefix
);
231 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_ndisc
*, sd_ndisc_unref
);
232 #define _cleanup_sd_ndisc_free_ _cleanup_(sd_ndisc_unrefp)
234 int sd_ndisc_new(sd_ndisc
**ret
) {
235 _cleanup_sd_ndisc_free_ sd_ndisc
*nd
= NULL
;
239 nd
= new0(sd_ndisc
, 1);
248 LIST_HEAD_INIT(nd
->prefixes
);
256 int sd_ndisc_get_mtu(sd_ndisc
*nd
, uint32_t *mtu
) {
257 assert_return(nd
, -EINVAL
);
258 assert_return(mtu
, -EINVAL
);
268 static int ndisc_prefix_timeout(sd_event_source
*s
, uint64_t usec
,
270 sd_ndisc
*nd
= userdata
;
271 NDiscPrefix
*prefix
, *p
;
275 LIST_FOREACH_SAFE(prefixes
, prefix
, p
, nd
->prefixes
) {
276 if (prefix
->timeout_valid
!= s
)
279 log_ndisc(nd
, "Prefix expired "SD_NDISC_ADDRESS_FORMAT_STR
"/%d",
280 SD_NDISC_ADDRESS_FORMAT_VAL(prefix
->addr
),
283 LIST_REMOVE(prefixes
, nd
->prefixes
, prefix
);
285 prefix
= ndisc_prefix_unref(prefix
);
293 static int ndisc_prefix_set_timeout(sd_ndisc
*nd
,
299 assert_return(prefix
, -EINVAL
);
301 r
= sd_event_now(nd
->event
, clock_boottime_or_monotonic(), &time_now
);
305 prefix
->timeout_valid
= sd_event_source_unref(prefix
->timeout_valid
);
307 r
= sd_event_add_time(nd
->event
, &prefix
->timeout_valid
,
308 clock_boottime_or_monotonic(), time_now
+ valid
,
309 USEC_PER_SEC
, ndisc_prefix_timeout
, nd
);
313 r
= sd_event_source_set_priority(prefix
->timeout_valid
,
318 r
= sd_event_source_set_description(prefix
->timeout_valid
,
319 "ndisc-prefix-timeout");
323 prefix
->timeout_valid
=
324 sd_event_source_unref(prefix
->timeout_valid
);
329 static int prefix_match(const struct in6_addr
*prefix
, uint8_t prefixlen
,
330 const struct in6_addr
*addr
,
331 uint8_t addr_prefixlen
) {
332 uint8_t bytes
, mask
, len
;
334 assert_return(prefix
, -EINVAL
);
335 assert_return(addr
, -EINVAL
);
337 len
= MIN(prefixlen
, addr_prefixlen
);
340 mask
= 0xff << (8 - len
% 8);
342 if (memcmp(prefix
, addr
, bytes
) != 0 ||
343 (prefix
->s6_addr
[bytes
] & mask
) != (addr
->s6_addr
[bytes
] & mask
))
344 return -EADDRNOTAVAIL
;
349 static int ndisc_prefix_match(NDiscPrefix
*head
, const struct in6_addr
*addr
,
350 uint8_t addr_len
, NDiscPrefix
**result
) {
353 LIST_FOREACH(prefixes
, prefix
, head
) {
354 if (prefix_match(&prefix
->addr
, prefix
->len
, addr
, addr_len
) >= 0) {
360 return -EADDRNOTAVAIL
;
363 int sd_ndisc_prefix_match(struct in6_addr
*prefix
, uint8_t prefixlen
,
364 struct in6_addr
*addr
) {
365 return prefix_match(prefix
, prefixlen
, addr
, sizeof(addr
->s6_addr
) * 8);
368 int sd_ndisc_get_prefixlen(sd_ndisc
*nd
, const struct in6_addr
*addr
,
369 uint8_t *prefixlen
) {
373 assert_return(nd
, -EINVAL
);
374 assert_return(addr
, -EINVAL
);
375 assert_return(prefixlen
, -EINVAL
);
377 r
= ndisc_prefix_match(nd
->prefixes
, addr
,
378 sizeof(addr
->s6_addr
) * 8, &prefix
);
382 *prefixlen
= prefix
->len
;
387 static int ndisc_prefix_update(sd_ndisc
*nd
, ssize_t len
,
388 const struct nd_opt_prefix_info
*prefix_opt
) {
392 char time_string
[FORMAT_TIMESPAN_MAX
];
394 assert_return(nd
, -EINVAL
);
395 assert_return(prefix_opt
, -EINVAL
);
397 if (len
< prefix_opt
->nd_opt_pi_len
)
400 if (!(prefix_opt
->nd_opt_pi_flags_reserved
& ND_OPT_PI_FLAG_ONLINK
))
403 lifetime
= be32toh(prefix_opt
->nd_opt_pi_valid_time
);
405 r
= ndisc_prefix_match(nd
->prefixes
,
406 &prefix_opt
->nd_opt_pi_prefix
,
407 prefix_opt
->nd_opt_pi_prefix_len
, &prefix
);
409 if (r
< 0 && r
!= -EADDRNOTAVAIL
)
412 /* if router advertisment prefix valid timeout is zero, the timeout
413 callback will be called immediately to clean up the prefix */
415 if (r
== -EADDRNOTAVAIL
) {
416 r
= ndisc_prefix_new(&prefix
);
420 prefix
->len
= prefix_opt
->nd_opt_pi_prefix_len
;
422 memcpy(&prefix
->addr
, &prefix_opt
->nd_opt_pi_prefix
,
423 sizeof(prefix
->addr
));
425 log_ndisc(nd
, "New prefix "SD_NDISC_ADDRESS_FORMAT_STR
"/%d lifetime %d expires in %s",
426 SD_NDISC_ADDRESS_FORMAT_VAL(prefix
->addr
),
427 prefix
->len
, lifetime
,
428 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, lifetime
* USEC_PER_SEC
, USEC_PER_SEC
));
430 LIST_PREPEND(prefixes
, nd
->prefixes
, prefix
);
433 if (prefix
->len
!= prefix_opt
->nd_opt_pi_prefix_len
) {
436 prefixlen
= MIN(prefix
->len
, prefix_opt
->nd_opt_pi_prefix_len
);
438 log_ndisc(nd
, "Prefix length mismatch %d/%d using %d",
440 prefix_opt
->nd_opt_pi_prefix_len
,
443 prefix
->len
= prefixlen
;
446 log_ndisc(nd
, "Update prefix "SD_NDISC_ADDRESS_FORMAT_STR
"/%d lifetime %d expires in %s",
447 SD_NDISC_ADDRESS_FORMAT_VAL(prefix
->addr
),
448 prefix
->len
, lifetime
,
449 format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, lifetime
* USEC_PER_SEC
, USEC_PER_SEC
));
452 r
= ndisc_prefix_set_timeout(nd
, prefix
, lifetime
* USEC_PER_SEC
);
457 static int ndisc_ra_parse(sd_ndisc
*nd
, struct nd_router_advert
*ra
,
460 struct nd_opt_hdr
*opt_hdr
;
462 assert_return(nd
, -EINVAL
);
463 assert_return(ra
, -EINVAL
);
466 if (len
< NDISC_OPT_LEN_UNITS
) {
467 log_ndisc(nd
, "Router Advertisement below minimum length");
475 while (len
!= 0 && len
>= opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
) {
476 struct nd_opt_mtu
*opt_mtu
;
478 struct nd_opt_prefix_info
*opt_prefix
;
480 if (opt_hdr
->nd_opt_len
== 0)
483 switch (opt_hdr
->nd_opt_type
) {
487 mtu
= be32toh(opt_mtu
->nd_opt_mtu_mtu
);
489 if (mtu
!= nd
->mtu
) {
490 nd
->mtu
= MAX(mtu
, IP6_MIN_MTU
);
492 log_ndisc(nd
, "Router Advertisement link MTU %d using %d",
498 case ND_OPT_PREFIX_INFORMATION
:
501 ndisc_prefix_update(nd
, len
, opt_prefix
);
506 len
-= opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
;
507 opt
= (void *)((char *)opt
+
508 opt_hdr
->nd_opt_len
* NDISC_OPT_LEN_UNITS
);
513 log_ndisc(nd
, "Router Advertisement contains %zd bytes of trailing garbage", len
);
518 static int ndisc_router_advertisment_recv(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
519 sd_ndisc
*nd
= userdata
;
522 _cleanup_free_
struct nd_router_advert
*ra
= NULL
;
523 int event
= SD_NDISC_EVENT_ROUTER_ADVERTISMENT_NONE
;
529 r
= ioctl(fd
, FIONREAD
, &buflen
);
530 if (r
< 0 || buflen
<= 0)
531 buflen
= ICMP6_RECV_SIZE
;
537 len
= read(fd
, ra
, buflen
);
539 log_ndisc(nd
, "Could not receive message from UDP socket: %m");
543 if (ra
->nd_ra_type
!= ND_ROUTER_ADVERT
)
546 if (ra
->nd_ra_code
!= 0)
549 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
551 nd
->state
= NDISC_STATE_ADVERTISMENT_LISTEN
;
553 if (ra
->nd_ra_flags_reserved
& ND_RA_FLAG_OTHER
)
554 event
= SD_NDISC_EVENT_ROUTER_ADVERTISMENT_OTHER
;
556 if (ra
->nd_ra_flags_reserved
& ND_RA_FLAG_MANAGED
)
557 event
= SD_NDISC_EVENT_ROUTER_ADVERTISMENT_MANAGED
;
559 log_ndisc(nd
, "Received Router Advertisement flags %s/%s",
560 ra
->nd_ra_flags_reserved
& ND_RA_FLAG_MANAGED
? "MANAGED": "none",
561 ra
->nd_ra_flags_reserved
& ND_RA_FLAG_OTHER
? "OTHER": "none");
563 if (event
!= SD_NDISC_EVENT_ROUTER_ADVERTISMENT_NONE
) {
564 r
= ndisc_ra_parse(nd
, ra
, len
);
566 log_ndisc(nd
, "Could not parse Router Advertisement: %s",
572 ndisc_notify(nd
, event
);
577 static int ndisc_router_solicitation_timeout(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
578 sd_ndisc
*nd
= userdata
;
579 uint64_t time_now
, next_timeout
;
580 struct ether_addr unset
= { };
581 struct ether_addr
*addr
= NULL
;
588 nd
->timeout
= sd_event_source_unref(nd
->timeout
);
590 if (nd
->nd_sent
>= NDISC_MAX_ROUTER_SOLICITATIONS
) {
591 ndisc_notify(nd
, SD_NDISC_EVENT_ROUTER_ADVERTISMENT_TIMEOUT
);
592 nd
->state
= NDISC_STATE_ADVERTISMENT_LISTEN
;
594 if (memcmp(&nd
->mac_addr
, &unset
, sizeof(struct ether_addr
)))
595 addr
= &nd
->mac_addr
;
597 r
= icmp6_send_router_solicitation(nd
->fd
, addr
);
599 log_ndisc(nd
, "Error sending Router Solicitation");
601 nd
->state
= NDISC_STATE_SOLICITATION_SENT
;
602 log_ndisc(nd
, "Sent Router Solicitation");
607 r
= sd_event_now(nd
->event
, clock_boottime_or_monotonic(), &time_now
);
613 next_timeout
= time_now
+ NDISC_ROUTER_SOLICITATION_INTERVAL
;
615 r
= sd_event_add_time(nd
->event
, &nd
->timeout
, clock_boottime_or_monotonic(),
617 ndisc_router_solicitation_timeout
, nd
);
623 r
= sd_event_source_set_priority(nd
->timeout
,
630 r
= sd_event_source_set_description(nd
->timeout
, "ndisc-timeout");
640 int sd_ndisc_stop(sd_ndisc
*nd
) {
641 assert_return(nd
, -EINVAL
);
642 assert_return(nd
->event
, -EINVAL
);
644 log_ndisc(client
, "Stop NDisc");
648 nd
->state
= NDISC_STATE_IDLE
;
653 int sd_ndisc_router_discovery_start(sd_ndisc
*nd
) {
659 if (nd
->state
!= NDISC_STATE_IDLE
)
665 r
= icmp6_bind_router_solicitation(nd
->index
);
671 r
= sd_event_add_io(nd
->event
, &nd
->recv
, nd
->fd
, EPOLLIN
,
672 ndisc_router_advertisment_recv
, nd
);
676 r
= sd_event_source_set_priority(nd
->recv
, nd
->event_priority
);
680 r
= sd_event_source_set_description(nd
->recv
, "ndisc-receive-message");
684 r
= sd_event_add_time(nd
->event
, &nd
->timeout
, clock_boottime_or_monotonic(),
685 0, 0, ndisc_router_solicitation_timeout
, nd
);
689 r
= sd_event_source_set_priority(nd
->timeout
, nd
->event_priority
);
693 r
= sd_event_source_set_description(nd
->timeout
, "ndisc-timeout");
698 log_ndisc(client
, "Start Router Solicitation");