ip/ip6tunnel.c

   1 /*
   2  * Copyright (C)2006 USAGI/WIDE Project
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses>.
  16  */
  17 /*
  18  * Author:
  19  *      Masahide NAKAMURA @USAGI
  20  */
  21
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include <sys/types.h>
  27 #include <sys/socket.h>
  28 #include <arpa/inet.h>
  29 #include <sys/ioctl.h>
  30 #include <linux/ip.h>
  31 #include <linux/if.h>
  32 #include <linux/if_arp.h>
  33 #include <linux/if_tunnel.h>
  34 #include <linux/ip6_tunnel.h>
  35
  36 #include "utils.h"
  37 #include "tunnel.h"
  38 #include "ip_common.h"
  39
  40 #define IP6_FLOWINFO_TCLASS     htonl(0x0FF00000)
  41 #define IP6_FLOWINFO_FLOWLABEL  htonl(0x000FFFFF)
  42
  43 #define DEFAULT_TNL_HOP_LIMIT   (64)
  44
  45 static void usage(void) __attribute__((noreturn));
  46
  47 static void usage(void)
  48 {
  49         fprintf(stderr, "Usage: ip -f inet6 tunnel { add | change | del | show } [ NAME ]\n");
  50         fprintf(stderr, "          [ mode { ip6ip6 | ipip6 | ip6gre | vti6 | any } ]\n");
  51         fprintf(stderr, "          [ remote ADDR local ADDR ] [ dev PHYS_DEV ]\n");
  52         fprintf(stderr, "          [ encaplimit ELIM ]\n");
  53         fprintf(stderr, "          [ hoplimit TTL ] [ tclass TCLASS ] [ flowlabel FLOWLABEL ]\n");
  54         fprintf(stderr, "          [ dscp inherit ]\n");
  55         fprintf(stderr, "          [ [no]allow-localremote ]\n");
  56         fprintf(stderr, "          [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n");
  57         fprintf(stderr, "\n");
  58         fprintf(stderr, "Where: NAME      := STRING\n");
  59         fprintf(stderr, "       ADDR      := IPV6_ADDRESS\n");
  60         fprintf(stderr, "       ELIM      := { none | 0..255 }(default=%d)\n",
  61                 IPV6_DEFAULT_TNL_ENCAP_LIMIT);
  62         fprintf(stderr, "       TTL       := 0..255 (default=%d)\n",
  63                 DEFAULT_TNL_HOP_LIMIT);
  64         fprintf(stderr, "       TCLASS    := { 0x0..0xff | inherit }\n");
  65         fprintf(stderr, "       FLOWLABEL := { 0x0..0xfffff | inherit }\n");
  66         fprintf(stderr, "       KEY       := { DOTTED_QUAD | NUMBER }\n");
  67         exit(-1);
  68 }
  69
  70 static void print_tunnel(const void *t)
  71 {
  72         const struct ip6_tnl_parm2 *p = t;
  73         char s1[1024];
  74         char s2[1024];
  75
  76         /* Do not use format_host() for local addr,
  77          * symbolic name will not be useful.
  78          */
  79         printf("%s: %s/ipv6 remote %s local %s",
  80                p->name,
  81                tnl_strproto(p->proto),
  82                format_host_r(AF_INET6, 16, &p->raddr, s1, sizeof(s1)),
  83                rt_addr_n2a_r(AF_INET6, 16, &p->laddr, s2, sizeof(s2)));
  84         if (p->link) {
  85                 const char *n = ll_index_to_name(p->link);
  86
  87                 if (n)
  88                         printf(" dev %s", n);
  89         }
  90
  91         if (p->flags & IP6_TNL_F_IGN_ENCAP_LIMIT)
  92                 printf(" encaplimit none");
  93         else
  94                 printf(" encaplimit %u", p->encap_limit);
  95
  96         if (p->hop_limit)
  97                 printf(" hoplimit %u", p->hop_limit);
  98         else
  99                 printf(" hoplimit inherit");
 100
 101         if (p->flags & IP6_TNL_F_USE_ORIG_TCLASS)
 102                 printf(" tclass inherit");
 103         else {
 104                 __u32 val = ntohl(p->flowinfo & IP6_FLOWINFO_TCLASS);
 105
 106                 printf(" tclass 0x%02x", (__u8)(val >> 20));
 107         }
 108
 109         if (p->flags & IP6_TNL_F_USE_ORIG_FLOWLABEL)
 110                 printf(" flowlabel inherit");
 111         else
 112                 printf(" flowlabel 0x%05x", ntohl(p->flowinfo & IP6_FLOWINFO_FLOWLABEL));
 113
 114         printf(" (flowinfo 0x%08x)", ntohl(p->flowinfo));
 115
 116         if (p->flags & IP6_TNL_F_RCV_DSCP_COPY)
 117                 printf(" dscp inherit");
 118
 119         if (p->flags & IP6_TNL_F_ALLOW_LOCAL_REMOTE)
 120                 printf(" allow-localremote");
 121
 122         if ((p->i_flags & GRE_KEY) && (p->o_flags & GRE_KEY) &&
 123             p->o_key == p->i_key)
 124                 printf(" key %u", ntohl(p->i_key));
 125         else {
 126                 if (p->i_flags & GRE_KEY)
 127                         printf(" ikey %u", ntohl(p->i_key));
 128                 if (p->o_flags & GRE_KEY)
 129                         printf(" okey %u", ntohl(p->o_key));
 130         }
 131
 132         if (p->proto == IPPROTO_GRE) {
 133                 if (p->i_flags & GRE_SEQ)
 134                         printf("%s  Drop packets out of sequence.", _SL_);
 135                 if (p->i_flags & GRE_CSUM)
 136                         printf("%s  Checksum in received packet is required.", _SL_);
 137                 if (p->o_flags & GRE_SEQ)
 138                         printf("%s  Sequence packets on output.", _SL_);
 139                 if (p->o_flags & GRE_CSUM)
 140                         printf("%s  Checksum output packets.", _SL_);
 141         }
 142 }
 143
 144 static int parse_args(int argc, char **argv, int cmd, struct ip6_tnl_parm2 *p)
 145 {
 146         int count = 0;
 147         const char *medium = NULL;
 148
 149         while (argc > 0) {
 150                 if (strcmp(*argv, "mode") == 0) {
 151                         NEXT_ARG();
 152                         if (strcmp(*argv, "ipv6/ipv6") == 0 ||
 153                             strcmp(*argv, "ip6ip6") == 0)
 154                                 p->proto = IPPROTO_IPV6;
 155                         else if (strcmp(*argv, "vti6") == 0) {
 156                                 p->proto = IPPROTO_IPV6;
 157                                 p->i_flags |= VTI_ISVTI;
 158                         } else if (strcmp(*argv, "ip/ipv6") == 0 ||
 159                                  strcmp(*argv, "ipv4/ipv6") == 0 ||
 160                                  strcmp(*argv, "ipip6") == 0 ||
 161                                  strcmp(*argv, "ip4ip6") == 0)
 162                                 p->proto = IPPROTO_IPIP;
 163                         else if (strcmp(*argv, "ip6gre") == 0 ||
 164                                  strcmp(*argv, "gre/ipv6") == 0)
 165                                 p->proto = IPPROTO_GRE;
 166                         else if (strcmp(*argv, "any/ipv6") == 0 ||
 167                                  strcmp(*argv, "any") == 0)
 168                                 p->proto = 0;
 169                         else {
 170                                 fprintf(stderr, "Unknown tunnel mode \"%s\"\n", *argv);
 171                                 exit(-1);
 172                         }
 173                 } else if (strcmp(*argv, "remote") == 0) {
 174                         inet_prefix raddr;
 175
 176                         NEXT_ARG();
 177                         get_addr(&raddr, *argv, AF_INET6);
 178                         memcpy(&p->raddr, &raddr.data, sizeof(p->raddr));
 179                 } else if (strcmp(*argv, "local") == 0) {
 180                         inet_prefix laddr;
 181
 182                         NEXT_ARG();
 183                         get_addr(&laddr, *argv, AF_INET6);
 184                         memcpy(&p->laddr, &laddr.data, sizeof(p->laddr));
 185                 } else if (strcmp(*argv, "dev") == 0) {
 186                         NEXT_ARG();
 187                         medium = *argv;
 188                 } else if (strcmp(*argv, "encaplimit") == 0) {
 189                         NEXT_ARG();
 190                         if (strcmp(*argv, "none") == 0) {
 191                                 p->flags |= IP6_TNL_F_IGN_ENCAP_LIMIT;
 192                         } else {
 193                                 __u8 uval;
 194
 195                                 if (get_u8(&uval, *argv, 0) < -1)
 196                                         invarg("invalid ELIM", *argv);
 197                                 p->encap_limit = uval;
 198                                 p->flags &= ~IP6_TNL_F_IGN_ENCAP_LIMIT;
 199                         }
 200                 } else if (strcmp(*argv, "hoplimit") == 0 ||
 201                            strcmp(*argv, "ttl") == 0 ||
 202                            strcmp(*argv, "hlim") == 0) {
 203                         __u8 uval;
 204
 205                         NEXT_ARG();
 206                         if (get_u8(&uval, *argv, 0))
 207                                 invarg("invalid TTL", *argv);
 208                         p->hop_limit = uval;
 209                 } else if (strcmp(*argv, "tclass") == 0 ||
 210                            strcmp(*argv, "tc") == 0 ||
 211                            strcmp(*argv, "tos") == 0 ||
 212                            matches(*argv, "dsfield") == 0) {
 213                         __u8 uval;
 214
 215                         NEXT_ARG();
 216                         p->flowinfo &= ~IP6_FLOWINFO_TCLASS;
 217                         if (strcmp(*argv, "inherit") == 0)
 218                                 p->flags |= IP6_TNL_F_USE_ORIG_TCLASS;
 219                         else {
 220                                 if (get_u8(&uval, *argv, 16))
 221                                         invarg("invalid TClass", *argv);
 222                                 p->flowinfo |= htonl((__u32)uval << 20) & IP6_FLOWINFO_TCLASS;
 223                                 p->flags &= ~IP6_TNL_F_USE_ORIG_TCLASS;
 224                         }
 225                 } else if (strcmp(*argv, "flowlabel") == 0 ||
 226                            strcmp(*argv, "fl") == 0) {
 227                         __u32 uval;
 228
 229                         NEXT_ARG();
 230                         p->flowinfo &= ~IP6_FLOWINFO_FLOWLABEL;
 231                         if (strcmp(*argv, "inherit") == 0)
 232                                 p->flags |= IP6_TNL_F_USE_ORIG_FLOWLABEL;
 233                         else {
 234                                 if (get_u32(&uval, *argv, 16))
 235                                         invarg("invalid Flowlabel", *argv);
 236                                 if (uval > 0xFFFFF)
 237                                         invarg("invalid Flowlabel", *argv);
 238                                 p->flowinfo |= htonl(uval) & IP6_FLOWINFO_FLOWLABEL;
 239                                 p->flags &= ~IP6_TNL_F_USE_ORIG_FLOWLABEL;
 240                         }
 241                 } else if (strcmp(*argv, "dscp") == 0) {
 242                         NEXT_ARG();
 243                         if (strcmp(*argv, "inherit") != 0)
 244                                 invarg("not inherit", *argv);
 245                         p->flags |= IP6_TNL_F_RCV_DSCP_COPY;
 246                 } else if (strcmp(*argv, "allow-localremote") == 0) {
 247                         p->flags |= IP6_TNL_F_ALLOW_LOCAL_REMOTE;
 248                 } else if (strcmp(*argv, "noallow-localremote") == 0) {
 249                         p->flags &= ~IP6_TNL_F_ALLOW_LOCAL_REMOTE;
 250                 } else if (strcmp(*argv, "key") == 0) {
 251                         NEXT_ARG();
 252                         p->i_flags |= GRE_KEY;
 253                         p->o_flags |= GRE_KEY;
 254                         p->i_key = p->o_key = tnl_parse_key("key", *argv);
 255                 } else if (strcmp(*argv, "ikey") == 0) {
 256                         NEXT_ARG();
 257                         p->i_flags |= GRE_KEY;
 258                         p->i_key = tnl_parse_key("ikey", *argv);
 259                 } else if (strcmp(*argv, "okey") == 0) {
 260                         NEXT_ARG();
 261                         p->o_flags |= GRE_KEY;
 262                         p->o_key = tnl_parse_key("okey", *argv);
 263                 } else if (strcmp(*argv, "seq") == 0) {
 264                         p->i_flags |= GRE_SEQ;
 265                         p->o_flags |= GRE_SEQ;
 266                 } else if (strcmp(*argv, "iseq") == 0) {
 267                         p->i_flags |= GRE_SEQ;
 268                 } else if (strcmp(*argv, "oseq") == 0) {
 269                         p->o_flags |= GRE_SEQ;
 270                 } else if (strcmp(*argv, "csum") == 0) {
 271                         p->i_flags |= GRE_CSUM;
 272                         p->o_flags |= GRE_CSUM;
 273                 } else if (strcmp(*argv, "icsum") == 0) {
 274                         p->i_flags |= GRE_CSUM;
 275                 } else if (strcmp(*argv, "ocsum") == 0) {
 276                         p->o_flags |= GRE_CSUM;
 277                 } else {
 278                         if (strcmp(*argv, "name") == 0) {
 279                                 NEXT_ARG();
 280                         } else if (matches(*argv, "help") == 0)
 281                                 usage();
 282                         if (p->name[0])
 283                                 duparg2("name", *argv);
 284                         if (get_ifname(p->name, *argv))
 285                                 invarg("\"name\" not a valid ifname", *argv);
 286                         if (cmd == SIOCCHGTUNNEL && count == 0) {
 287                                 struct ip6_tnl_parm2 old_p = {};
 288
 289                                 if (tnl_get_ioctl(*argv, &old_p))
 290                                         return -1;
 291                                 *p = old_p;
 292                         }
 293                 }
 294                 count++;
 295                 argc--; argv++;
 296         }
 297         if (medium) {
 298                 p->link = ll_name_to_index(medium);
 299                 if (!p->link)
 300                         return nodev(medium);
 301         }
 302         return 0;
 303 }
 304
 305 static void ip6_tnl_parm_init(struct ip6_tnl_parm2 *p, int apply_default)
 306 {
 307         memset(p, 0, sizeof(*p));
 308         p->proto = IPPROTO_IPV6;
 309         if (apply_default) {
 310                 p->hop_limit = DEFAULT_TNL_HOP_LIMIT;
 311                 p->encap_limit = IPV6_DEFAULT_TNL_ENCAP_LIMIT;
 312         }
 313 }
 314
 315 static void ip6_tnl_parm_initialize(const struct tnl_print_nlmsg_info *info)
 316 {
 317         const struct ifinfomsg *ifi = info->ifi;
 318         const struct ip6_tnl_parm2 *p1 = info->p1;
 319         struct ip6_tnl_parm2 *p2 = info->p2;
 320
 321         ip6_tnl_parm_init(p2, 0);
 322         if (ifi->ifi_type == ARPHRD_IP6GRE)
 323                 p2->proto = IPPROTO_GRE;
 324         p2->link = ifi->ifi_index;
 325         strcpy(p2->name, p1->name);
 326 }
 327
 328 static bool ip6_tnl_parm_match(const struct tnl_print_nlmsg_info *info)
 329 {
 330         const struct ip6_tnl_parm2 *p1 = info->p1;
 331         const struct ip6_tnl_parm2 *p2 = info->p2;
 332
 333         return ((!p1->link || p1->link == p2->link) &&
 334                 (!p1->name[0] || strcmp(p1->name, p2->name) == 0) &&
 335                 (IN6_IS_ADDR_UNSPECIFIED(&p1->laddr) ||
 336                  IN6_ARE_ADDR_EQUAL(&p1->laddr, &p2->laddr)) &&
 337                 (IN6_IS_ADDR_UNSPECIFIED(&p1->raddr) ||
 338                  IN6_ARE_ADDR_EQUAL(&p1->raddr, &p2->raddr)) &&
 339                 (!p1->proto || !p2->proto || p1->proto == p2->proto) &&
 340                 (!p1->encap_limit || p1->encap_limit == p2->encap_limit) &&
 341                 (!p1->hop_limit || p1->hop_limit == p2->hop_limit) &&
 342                 (!(p1->flowinfo & IP6_FLOWINFO_TCLASS) ||
 343                  !((p1->flowinfo ^ p2->flowinfo) & IP6_FLOWINFO_TCLASS)) &&
 344                 (!(p1->flowinfo & IP6_FLOWINFO_FLOWLABEL) ||
 345                  !((p1->flowinfo ^ p2->flowinfo) & IP6_FLOWINFO_FLOWLABEL)) &&
 346                 (!p1->flags || (p1->flags & p2->flags)));
 347 }
 348
 349 static int do_show(int argc, char **argv)
 350 {
 351         struct ip6_tnl_parm2 p, p1;
 352
 353         ip6_tnl_parm_init(&p, 0);
 354         p.proto = 0;  /* default to any */
 355
 356         if (parse_args(argc, argv, SIOCGETTUNNEL, &p) < 0)
 357                 return -1;
 358
 359         if (!p.name[0] || show_stats) {
 360                 struct tnl_print_nlmsg_info info = {
 361                         .p1    = &p,
 362                         .p2    = &p1,
 363                         .init  = ip6_tnl_parm_initialize,
 364                         .match = ip6_tnl_parm_match,
 365                         .print = print_tunnel,
 366                 };
 367
 368                 return do_tunnels_list(&info);
 369         }
 370
 371         if (tnl_get_ioctl(p.name, &p))
 372                 return -1;
 373
 374         print_tunnel(&p);
 375         fputc('\n', stdout);
 376         return 0;
 377 }
 378
 379 static int do_add(int cmd, int argc, char **argv)
 380 {
 381         struct ip6_tnl_parm2 p;
 382         const char *basedev = "ip6tnl0";
 383
 384         ip6_tnl_parm_init(&p, 1);
 385
 386         if (parse_args(argc, argv, cmd, &p) < 0)
 387                 return -1;
 388
 389         if (p.proto == IPPROTO_GRE)
 390                 basedev = "ip6gre0";
 391         else if (p.i_flags & VTI_ISVTI)
 392                 basedev = "ip6_vti0";
 393
 394         return tnl_add_ioctl(cmd, basedev, p.name, &p);
 395 }
 396
 397 static int do_del(int argc, char **argv)
 398 {
 399         struct ip6_tnl_parm2 p;
 400         const char *basedev = "ip6tnl0";
 401
 402         ip6_tnl_parm_init(&p, 1);
 403
 404         if (parse_args(argc, argv, SIOCDELTUNNEL, &p) < 0)
 405                 return -1;
 406
 407         if (p.proto == IPPROTO_GRE)
 408                 basedev = "ip6gre0";
 409         else if (p.i_flags & VTI_ISVTI)
 410                 basedev = "ip6_vti0";
 411
 412         return tnl_del_ioctl(basedev, p.name, &p);
 413 }
 414
 415 int do_ip6tunnel(int argc, char **argv)
 416 {
 417         switch (preferred_family) {
 418         case AF_UNSPEC:
 419                 preferred_family = AF_INET6;
 420                 break;
 421         case AF_INET6:
 422                 break;
 423         default:
 424                 fprintf(stderr, "Unsupported protocol family: %d\n", preferred_family);
 425                 exit(-1);
 426         }
 427
 428         if (argc > 0) {
 429                 if (matches(*argv, "add") == 0)
 430                         return do_add(SIOCADDTUNNEL, argc - 1, argv + 1);
 431                 if (matches(*argv, "change") == 0)
 432                         return do_add(SIOCCHGTUNNEL, argc - 1, argv + 1);
 433                 if (matches(*argv, "delete") == 0)
 434                         return do_del(argc - 1, argv + 1);
 435                 if (matches(*argv, "show") == 0 ||
 436                     matches(*argv, "lst") == 0 ||
 437                     matches(*argv, "list") == 0)
 438                         return do_show(argc - 1, argv + 1);
 439                 if (matches(*argv, "help") == 0)
 440                         usage();
 441         } else
 442                 return do_show(0, NULL);
 443
 444         fprintf(stderr, "Command \"%s\" is unknown, try \"ip -f inet6 tunnel help\".\n", *argv);
 445         exit(-1);
 446 }