]> git.proxmox.com Git - mirror_frr.git/blob - lib/sockunion.c
zebra, lib: fix the ZEBRA_INTERFACE_VRF_UPDATE zapi message
[mirror_frr.git] / lib / sockunion.c
1 /* Socket union related function.
2 * Copyright (c) 1997, 98 Kunihiro Ishiguro
3 *
4 * This file is part of GNU Zebra.
5 *
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
9 * later version.
10 *
11 * GNU Zebra 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 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #include <zebra.h>
22
23 #include "prefix.h"
24 #include "vty.h"
25 #include "sockunion.h"
26 #include "memory.h"
27 #include "log.h"
28 #include "jhash.h"
29 #include "lib_errors.h"
30
31 DEFINE_MTYPE_STATIC(LIB, SOCKUNION, "Socket union")
32
33 const char *inet_sutop(const union sockunion *su, char *str)
34 {
35 switch (su->sa.sa_family) {
36 case AF_INET:
37 inet_ntop(AF_INET, &su->sin.sin_addr, str, INET_ADDRSTRLEN);
38 break;
39 case AF_INET6:
40 inet_ntop(AF_INET6, &su->sin6.sin6_addr, str, INET6_ADDRSTRLEN);
41 break;
42 }
43 return str;
44 }
45
46 int str2sockunion(const char *str, union sockunion *su)
47 {
48 int ret;
49
50 if (str == NULL)
51 return -1;
52
53 memset(su, 0, sizeof(union sockunion));
54
55 ret = inet_pton(AF_INET, str, &su->sin.sin_addr);
56 if (ret > 0) /* Valid IPv4 address format. */
57 {
58 su->sin.sin_family = AF_INET;
59 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
60 su->sin.sin_len = sizeof(struct sockaddr_in);
61 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
62 return 0;
63 }
64 ret = inet_pton(AF_INET6, str, &su->sin6.sin6_addr);
65 if (ret > 0) /* Valid IPv6 address format. */
66 {
67 su->sin6.sin6_family = AF_INET6;
68 #ifdef SIN6_LEN
69 su->sin6.sin6_len = sizeof(struct sockaddr_in6);
70 #endif /* SIN6_LEN */
71 return 0;
72 }
73 return -1;
74 }
75
76 const char *sockunion2str(const union sockunion *su, char *buf, size_t len)
77 {
78 switch (sockunion_family(su)) {
79 case AF_UNSPEC:
80 snprintf(buf, len, "(unspec)");
81 return buf;
82 case AF_INET:
83 return inet_ntop(AF_INET, &su->sin.sin_addr, buf, len);
84 case AF_INET6:
85 return inet_ntop(AF_INET6, &su->sin6.sin6_addr, buf, len);
86 }
87 snprintf(buf, len, "(af %d)", sockunion_family(su));
88 return buf;
89 }
90
91 union sockunion *sockunion_str2su(const char *str)
92 {
93 union sockunion *su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
94
95 if (!str2sockunion(str, su))
96 return su;
97
98 XFREE(MTYPE_SOCKUNION, su);
99 return NULL;
100 }
101
102 /* Convert IPv4 compatible IPv6 address to IPv4 address. */
103 static void sockunion_normalise_mapped(union sockunion *su)
104 {
105 struct sockaddr_in sin;
106
107 if (su->sa.sa_family == AF_INET6
108 && IN6_IS_ADDR_V4MAPPED(&su->sin6.sin6_addr)) {
109 memset(&sin, 0, sizeof(struct sockaddr_in));
110 sin.sin_family = AF_INET;
111 sin.sin_port = su->sin6.sin6_port;
112 memcpy(&sin.sin_addr, ((char *)&su->sin6.sin6_addr) + 12, 4);
113 memcpy(su, &sin, sizeof(struct sockaddr_in));
114 }
115 }
116
117 /* return sockunion structure : this function should be revised. */
118 static const char *sockunion_log(const union sockunion *su, char *buf,
119 size_t len)
120 {
121 switch (su->sa.sa_family) {
122 case AF_INET:
123 return inet_ntop(AF_INET, &su->sin.sin_addr, buf, len);
124
125 case AF_INET6:
126 return inet_ntop(AF_INET6, &(su->sin6.sin6_addr), buf, len);
127 break;
128
129 default:
130 snprintf(buf, len, "af_unknown %d ", su->sa.sa_family);
131 return buf;
132 }
133 }
134
135 /* Return socket of sockunion. */
136 int sockunion_socket(const union sockunion *su)
137 {
138 int sock;
139
140 sock = socket(su->sa.sa_family, SOCK_STREAM, 0);
141 if (sock < 0) {
142 char buf[SU_ADDRSTRLEN];
143 flog_err(EC_LIB_SOCKET, "Can't make socket for %s : %s",
144 sockunion_log(su, buf, SU_ADDRSTRLEN),
145 safe_strerror(errno));
146 return -1;
147 }
148
149 return sock;
150 }
151
152 /* Return accepted new socket file descriptor. */
153 int sockunion_accept(int sock, union sockunion *su)
154 {
155 socklen_t len;
156 int client_sock;
157
158 len = sizeof(union sockunion);
159 client_sock = accept(sock, (struct sockaddr *)su, &len);
160
161 sockunion_normalise_mapped(su);
162 return client_sock;
163 }
164
165 /* Return sizeof union sockunion. */
166 static int sockunion_sizeof(const union sockunion *su)
167 {
168 int ret;
169
170 ret = 0;
171 switch (su->sa.sa_family) {
172 case AF_INET:
173 ret = sizeof(struct sockaddr_in);
174 break;
175 case AF_INET6:
176 ret = sizeof(struct sockaddr_in6);
177 break;
178 }
179 return ret;
180 }
181
182 /* Performs a non-blocking connect(). */
183 enum connect_result sockunion_connect(int fd, const union sockunion *peersu,
184 unsigned short port, ifindex_t ifindex)
185 {
186 int ret;
187 union sockunion su;
188
189 memcpy(&su, peersu, sizeof(union sockunion));
190
191 switch (su.sa.sa_family) {
192 case AF_INET:
193 su.sin.sin_port = port;
194 break;
195 case AF_INET6:
196 su.sin6.sin6_port = port;
197 #ifdef KAME
198 if (IN6_IS_ADDR_LINKLOCAL(&su.sin6.sin6_addr) && ifindex) {
199 su.sin6.sin6_scope_id = ifindex;
200 SET_IN6_LINKLOCAL_IFINDEX(su.sin6.sin6_addr, ifindex);
201 }
202 #endif /* KAME */
203 break;
204 }
205
206 /* Call connect function. */
207 ret = connect(fd, (struct sockaddr *)&su, sockunion_sizeof(&su));
208
209 /* Immediate success */
210 if (ret == 0)
211 return connect_success;
212
213 /* If connect is in progress then return 1 else it's real error. */
214 if (ret < 0) {
215 if (errno != EINPROGRESS) {
216 char str[SU_ADDRSTRLEN];
217 zlog_info("can't connect to %s fd %d : %s",
218 sockunion_log(&su, str, sizeof str), fd,
219 safe_strerror(errno));
220 return connect_error;
221 }
222 }
223
224 return connect_in_progress;
225 }
226
227 /* Make socket from sockunion union. */
228 int sockunion_stream_socket(union sockunion *su)
229 {
230 int sock;
231
232 if (su->sa.sa_family == 0)
233 su->sa.sa_family = AF_INET_UNION;
234
235 sock = socket(su->sa.sa_family, SOCK_STREAM, 0);
236
237 if (sock < 0)
238 flog_err(EC_LIB_SOCKET,
239 "can't make socket sockunion_stream_socket");
240
241 return sock;
242 }
243
244 /* Bind socket to specified address. */
245 int sockunion_bind(int sock, union sockunion *su, unsigned short port,
246 union sockunion *su_addr)
247 {
248 int size = 0;
249 int ret;
250
251 if (su->sa.sa_family == AF_INET) {
252 size = sizeof(struct sockaddr_in);
253 su->sin.sin_port = htons(port);
254 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
255 su->sin.sin_len = size;
256 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
257 if (su_addr == NULL)
258 sockunion2ip(su) = htonl(INADDR_ANY);
259 } else if (su->sa.sa_family == AF_INET6) {
260 size = sizeof(struct sockaddr_in6);
261 su->sin6.sin6_port = htons(port);
262 #ifdef SIN6_LEN
263 su->sin6.sin6_len = size;
264 #endif /* SIN6_LEN */
265 if (su_addr == NULL) {
266 #ifdef LINUX_IPV6
267 memset(&su->sin6.sin6_addr, 0, sizeof(struct in6_addr));
268 #else
269 su->sin6.sin6_addr = in6addr_any;
270 #endif /* LINUX_IPV6 */
271 }
272 }
273
274 ret = bind(sock, (struct sockaddr *)su, size);
275 if (ret < 0) {
276 char buf[SU_ADDRSTRLEN];
277 flog_err(EC_LIB_SOCKET, "can't bind socket for %s : %s",
278 sockunion_log(su, buf, SU_ADDRSTRLEN),
279 safe_strerror(errno));
280 }
281
282 return ret;
283 }
284
285 int sockopt_reuseaddr(int sock)
286 {
287 int ret;
288 int on = 1;
289
290 ret = setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (void *)&on,
291 sizeof(on));
292 if (ret < 0) {
293 flog_err(EC_LIB_SOCKET,
294 "can't set sockopt SO_REUSEADDR to socket %d", sock);
295 return -1;
296 }
297 return 0;
298 }
299
300 #ifdef SO_REUSEPORT
301 int sockopt_reuseport(int sock)
302 {
303 int ret;
304 int on = 1;
305
306 ret = setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, (void *)&on,
307 sizeof(on));
308 if (ret < 0) {
309 flog_err(EC_LIB_SOCKET,
310 "can't set sockopt SO_REUSEPORT to socket %d", sock);
311 return -1;
312 }
313 return 0;
314 }
315 #else
316 int sockopt_reuseport(int sock)
317 {
318 return 0;
319 }
320 #endif /* 0 */
321
322 int sockopt_ttl(int family, int sock, int ttl)
323 {
324 int ret;
325
326 #ifdef IP_TTL
327 if (family == AF_INET) {
328 ret = setsockopt(sock, IPPROTO_IP, IP_TTL, (void *)&ttl,
329 sizeof(int));
330 if (ret < 0) {
331 flog_err(EC_LIB_SOCKET,
332 "can't set sockopt IP_TTL %d to socket %d",
333 ttl, sock);
334 return -1;
335 }
336 return 0;
337 }
338 #endif /* IP_TTL */
339 if (family == AF_INET6) {
340 ret = setsockopt(sock, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
341 (void *)&ttl, sizeof(int));
342 if (ret < 0) {
343 flog_err(
344 EC_LIB_SOCKET,
345 "can't set sockopt IPV6_UNICAST_HOPS %d to socket %d",
346 ttl, sock);
347 return -1;
348 }
349 return 0;
350 }
351 return 0;
352 }
353
354 /*
355 * This function called setsockopt(.., TCP_CORK,...)
356 * Which on linux is a no-op since it is enabled by
357 * default and on BSD it uses TCP_NOPUSH to do
358 * the same thing( which it was not configured to
359 * use). This cleanup of the api occurred on 8/1/17
360 * I imagine if after more than 1 year of no-one
361 * complaining, and a major upgrade release we
362 * can deprecate and remove this function call
363 */
364 int sockopt_cork(int sock, int onoff)
365 {
366 return 0;
367 }
368
369 int sockopt_mark_default(int sock, int mark, struct zebra_privs_t *cap)
370 {
371 #ifdef SO_MARK
372 int ret;
373
374 frr_elevate_privs(cap) {
375 ret = setsockopt(sock, SOL_SOCKET, SO_MARK, &mark,
376 sizeof(mark));
377 }
378 return ret;
379 #else
380 return 0;
381 #endif
382 }
383
384 int sockopt_minttl(int family, int sock, int minttl)
385 {
386 #ifdef IP_MINTTL
387 if (family == AF_INET) {
388 int ret = setsockopt(sock, IPPROTO_IP, IP_MINTTL, &minttl,
389 sizeof(minttl));
390 if (ret < 0)
391 flog_err(
392 EC_LIB_SOCKET,
393 "can't set sockopt IP_MINTTL to %d on socket %d: %s",
394 minttl, sock, safe_strerror(errno));
395 return ret;
396 }
397 #endif /* IP_MINTTL */
398 #ifdef IPV6_MINHOPCOUNT
399 if (family == AF_INET6) {
400 int ret = setsockopt(sock, IPPROTO_IPV6, IPV6_MINHOPCOUNT,
401 &minttl, sizeof(minttl));
402 if (ret < 0)
403 flog_err(
404 EC_LIB_SOCKET,
405 "can't set sockopt IPV6_MINHOPCOUNT to %d on socket %d: %s",
406 minttl, sock, safe_strerror(errno));
407 return ret;
408 }
409 #endif
410
411 errno = EOPNOTSUPP;
412 return -1;
413 }
414
415 int sockopt_v6only(int family, int sock)
416 {
417 int ret, on = 1;
418
419 #ifdef IPV6_V6ONLY
420 if (family == AF_INET6) {
421 ret = setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, (void *)&on,
422 sizeof(int));
423 if (ret < 0) {
424 flog_err(EC_LIB_SOCKET,
425 "can't set sockopt IPV6_V6ONLY "
426 "to socket %d",
427 sock);
428 return -1;
429 }
430 return 0;
431 }
432 #endif /* IPV6_V6ONLY */
433 return 0;
434 }
435
436 /* If same family and same prefix return 1. */
437 int sockunion_same(const union sockunion *su1, const union sockunion *su2)
438 {
439 int ret = 0;
440
441 if (su1->sa.sa_family != su2->sa.sa_family)
442 return 0;
443
444 switch (su1->sa.sa_family) {
445 case AF_INET:
446 ret = memcmp(&su1->sin.sin_addr, &su2->sin.sin_addr,
447 sizeof(struct in_addr));
448 break;
449 case AF_INET6:
450 ret = memcmp(&su1->sin6.sin6_addr, &su2->sin6.sin6_addr,
451 sizeof(struct in6_addr));
452 if ((ret == 0) && IN6_IS_ADDR_LINKLOCAL(&su1->sin6.sin6_addr)) {
453 /* compare interface indices */
454 if (su1->sin6.sin6_scope_id && su2->sin6.sin6_scope_id)
455 ret = (su1->sin6.sin6_scope_id
456 == su2->sin6.sin6_scope_id)
457 ? 0
458 : 1;
459 }
460 break;
461 }
462 if (ret == 0)
463 return 1;
464 else
465 return 0;
466 }
467
468 unsigned int sockunion_hash(const union sockunion *su)
469 {
470 switch (sockunion_family(su)) {
471 case AF_INET:
472 return jhash_1word(su->sin.sin_addr.s_addr, 0);
473 case AF_INET6:
474 return jhash2(su->sin6.sin6_addr.s6_addr32,
475 ZEBRA_NUM_OF(su->sin6.sin6_addr.s6_addr32), 0);
476 }
477 return 0;
478 }
479
480 size_t family2addrsize(int family)
481 {
482 switch (family) {
483 case AF_INET:
484 return sizeof(struct in_addr);
485 case AF_INET6:
486 return sizeof(struct in6_addr);
487 }
488 return 0;
489 }
490
491 size_t sockunion_get_addrlen(const union sockunion *su)
492 {
493 return family2addrsize(sockunion_family(su));
494 }
495
496 const uint8_t *sockunion_get_addr(const union sockunion *su)
497 {
498 switch (sockunion_family(su)) {
499 case AF_INET:
500 return (const uint8_t *)&su->sin.sin_addr.s_addr;
501 case AF_INET6:
502 return (const uint8_t *)&su->sin6.sin6_addr;
503 }
504 return NULL;
505 }
506
507 void sockunion_set(union sockunion *su, int family, const uint8_t *addr,
508 size_t bytes)
509 {
510 if (family2addrsize(family) != bytes)
511 return;
512
513 sockunion_family(su) = family;
514 switch (family) {
515 case AF_INET:
516 memcpy(&su->sin.sin_addr.s_addr, addr, bytes);
517 break;
518 case AF_INET6:
519 memcpy(&su->sin6.sin6_addr, addr, bytes);
520 break;
521 }
522 }
523
524 /* After TCP connection is established. Get local address and port. */
525 union sockunion *sockunion_getsockname(int fd)
526 {
527 int ret;
528 socklen_t len;
529 union {
530 struct sockaddr sa;
531 struct sockaddr_in sin;
532 struct sockaddr_in6 sin6;
533 char tmp_buffer[128];
534 } name;
535 union sockunion *su;
536
537 memset(&name, 0, sizeof name);
538 len = sizeof name;
539
540 ret = getsockname(fd, (struct sockaddr *)&name, &len);
541 if (ret < 0) {
542 flog_err(EC_LIB_SOCKET,
543 "Can't get local address and port by getsockname: %s",
544 safe_strerror(errno));
545 return NULL;
546 }
547
548 if (name.sa.sa_family == AF_INET) {
549 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
550 memcpy(su, &name, sizeof(struct sockaddr_in));
551 return su;
552 }
553 if (name.sa.sa_family == AF_INET6) {
554 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
555 memcpy(su, &name, sizeof(struct sockaddr_in6));
556 sockunion_normalise_mapped(su);
557 return su;
558 }
559 return NULL;
560 }
561
562 /* After TCP connection is established. Get remote address and port. */
563 union sockunion *sockunion_getpeername(int fd)
564 {
565 int ret;
566 socklen_t len;
567 union {
568 struct sockaddr sa;
569 struct sockaddr_in sin;
570 struct sockaddr_in6 sin6;
571 char tmp_buffer[128];
572 } name;
573 union sockunion *su;
574
575 memset(&name, 0, sizeof name);
576 len = sizeof name;
577 ret = getpeername(fd, (struct sockaddr *)&name, &len);
578 if (ret < 0) {
579 flog_err(EC_LIB_SOCKET, "Can't get remote address and port: %s",
580 safe_strerror(errno));
581 return NULL;
582 }
583
584 if (name.sa.sa_family == AF_INET) {
585 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
586 memcpy(su, &name, sizeof(struct sockaddr_in));
587 return su;
588 }
589 if (name.sa.sa_family == AF_INET6) {
590 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
591 memcpy(su, &name, sizeof(struct sockaddr_in6));
592 sockunion_normalise_mapped(su);
593 return su;
594 }
595 return NULL;
596 }
597
598 /* Print sockunion structure */
599 static void __attribute__((unused)) sockunion_print(const union sockunion *su)
600 {
601 if (su == NULL)
602 return;
603
604 switch (su->sa.sa_family) {
605 case AF_INET:
606 printf("%s\n", inet_ntoa(su->sin.sin_addr));
607 break;
608 case AF_INET6: {
609 char buf[SU_ADDRSTRLEN];
610
611 printf("%s\n", inet_ntop(AF_INET6, &(su->sin6.sin6_addr), buf,
612 sizeof(buf)));
613 } break;
614
615 #ifdef AF_LINK
616 case AF_LINK: {
617 struct sockaddr_dl *sdl;
618
619 sdl = (struct sockaddr_dl *)&(su->sa);
620 printf("link#%d\n", sdl->sdl_index);
621 } break;
622 #endif /* AF_LINK */
623 default:
624 printf("af_unknown %d\n", su->sa.sa_family);
625 break;
626 }
627 }
628
629 static int in6addr_cmp(const struct in6_addr *addr1,
630 const struct in6_addr *addr2)
631 {
632 unsigned int i;
633 const uint8_t *p1, *p2;
634
635 p1 = (const uint8_t *)addr1;
636 p2 = (const uint8_t *)addr2;
637
638 for (i = 0; i < sizeof(struct in6_addr); i++) {
639 if (p1[i] > p2[i])
640 return 1;
641 else if (p1[i] < p2[i])
642 return -1;
643 }
644 return 0;
645 }
646
647 int sockunion_cmp(const union sockunion *su1, const union sockunion *su2)
648 {
649 if (su1->sa.sa_family > su2->sa.sa_family)
650 return 1;
651 if (su1->sa.sa_family < su2->sa.sa_family)
652 return -1;
653
654 if (su1->sa.sa_family == AF_INET) {
655 if (ntohl(sockunion2ip(su1)) == ntohl(sockunion2ip(su2)))
656 return 0;
657 if (ntohl(sockunion2ip(su1)) > ntohl(sockunion2ip(su2)))
658 return 1;
659 else
660 return -1;
661 }
662 if (su1->sa.sa_family == AF_INET6)
663 return in6addr_cmp(&su1->sin6.sin6_addr, &su2->sin6.sin6_addr);
664 return 0;
665 }
666
667 /* Duplicate sockunion. */
668 union sockunion *sockunion_dup(const union sockunion *su)
669 {
670 union sockunion *dup =
671 XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
672 memcpy(dup, su, sizeof(union sockunion));
673 return dup;
674 }
675
676 void sockunion_free(union sockunion *su)
677 {
678 XFREE(MTYPE_SOCKUNION, su);
679 }
680
681 void sockunion_init(union sockunion *su)
682 {
683 memset(su, 0, sizeof(union sockunion));
684 }