src/vnet/ip/ip6_to_ip4.h

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /**
  16  * @file
  17  * @brief IPv6 to IPv4 translation
  18  */
  19 #ifndef __included_ip6_to_ip4_h__
  20 #define __included_ip6_to_ip4_h__
  21
  22 #include <vnet/ip/ip.h>
  23
  24 /**
  25  * IPv6 to IPv4 set call back function type
  26  */
  27 typedef int (*ip6_to_ip4_set_fn_t) (ip6_header_t * ip6, ip4_header_t * ip4,
  28                                     void *ctx);
  29
  30 /* *INDENT-OFF* */
  31 static u8 icmp6_to_icmp_updater_pointer_table[] =
  32   { 0, 1, ~0, ~0,
  33     2, 2, 9, 8,
  34     12, 12, 12, 12,
  35     12, 12, 12, 12,
  36     12, 12, 12, 12,
  37     12, 12, 12, 12,
  38     24, 24, 24, 24,
  39     24, 24, 24, 24,
  40     24, 24, 24, 24,
  41     24, 24, 24, 24
  42   };
  43 /* *INDENT-ON* */
  44
  45 #define frag_id_6to4(id) ((id) ^ ((id) >> 16))
  46
  47 /**
  48  * @brief Parse some useful information from IPv6 header.
  49  *
  50  * @param ip6             IPv6 header.
  51  * @param buff_len        Buffer length.
  52  * @param l4_protocol     L4 protocol number.
  53  * @param l4_offset       L4 header offset.
  54  * @param frag_hdr_offset Fragment header offset if present, 0 otherwise.
  55  *
  56  * @returns 0 on success, non-zero value otherwise.
  57  */
  58 static_always_inline int
  59 ip6_parse (const ip6_header_t * ip6, u32 buff_len,
  60            u8 * l4_protocol, u16 * l4_offset, u16 * frag_hdr_offset)
  61 {
  62   if (ip6->protocol == IP_PROTOCOL_IPV6_FRAGMENTATION)
  63     {
  64       *l4_protocol = ((ip6_frag_hdr_t *) (ip6 + 1))->next_hdr;
  65       *frag_hdr_offset = sizeof (*ip6);
  66       *l4_offset = sizeof (*ip6) + sizeof (ip6_frag_hdr_t);
  67     }
  68   else
  69     {
  70       *l4_protocol = ip6->protocol;
  71       *frag_hdr_offset = 0;
  72       *l4_offset = sizeof (*ip6);
  73     }
  74
  75   return (buff_len < (*l4_offset + 4)) ||
  76     (clib_net_to_host_u16 (ip6->payload_length) <
  77      (*l4_offset + 4 - sizeof (*ip6)));
  78 }
  79
  80 /**
  81  * @brief Get TCP/UDP port number or ICMP id from IPv6 packet.
  82  *
  83  * @param ip6        IPv6 header.
  84  * @param sender     1 get sender port, 0 get receiver port.
  85  * @param buffer_len Buffer length.
  86  *
  87  * @returns Port number on success, 0 otherwise.
  88  */
  89 always_inline u16
  90 ip6_get_port (ip6_header_t * ip6, u8 sender, u16 buffer_len)
  91 {
  92   u8 l4_protocol;
  93   u16 l4_offset;
  94   u16 frag_offset;
  95   u8 *l4;
  96
  97   if (ip6_parse (ip6, buffer_len, &l4_protocol, &l4_offset, &frag_offset))
  98     return 0;
  99
 100   if (frag_offset &&
 101       ip6_frag_hdr_offset (((ip6_frag_hdr_t *)
 102                             u8_ptr_add (ip6, frag_offset))))
 103     return 0;                   //Can't deal with non-first fragment for now
 104
 105   l4 = u8_ptr_add (ip6, l4_offset);
 106   if (l4_protocol == IP_PROTOCOL_TCP || l4_protocol == IP_PROTOCOL_UDP)
 107     {
 108       return (sender) ? ((udp_header_t *) (l4))->src_port : ((udp_header_t
 109                                                               *)
 110                                                              (l4))->dst_port;
 111     }
 112   else if (l4_protocol == IP_PROTOCOL_ICMP6)
 113     {
 114       icmp46_header_t *icmp = (icmp46_header_t *) (l4);
 115       if (icmp->type == ICMP6_echo_request)
 116         {
 117           return (sender) ? ((u16 *) (icmp))[2] : -1;
 118         }
 119       else if (icmp->type == ICMP6_echo_reply)
 120         {
 121           return (sender) ? -1 : ((u16 *) (icmp))[2];
 122         }
 123     }
 124   return 0;
 125 }
 126
 127 /**
 128  * @brief Convert type and code value from ICMP6 to ICMP4.
 129  *
 130  * @param icmp      ICMP header.
 131  * @param inner_ip6 Inner IPv6 header if present, 0 otherwise.
 132  *
 133  * @returns 0 on success, non-zero value otherwise.
 134  */
 135 static_always_inline int
 136 icmp6_to_icmp_header (icmp46_header_t * icmp, ip6_header_t ** inner_ip6)
 137 {
 138   *inner_ip6 = NULL;
 139   switch (icmp->type)
 140     {
 141     case ICMP6_echo_request:
 142       icmp->type = ICMP4_echo_request;
 143       break;
 144     case ICMP6_echo_reply:
 145       icmp->type = ICMP4_echo_reply;
 146       break;
 147     case ICMP6_destination_unreachable:
 148       *inner_ip6 = (ip6_header_t *) u8_ptr_add (icmp, 8);
 149
 150       switch (icmp->code)
 151         {
 152         case ICMP6_destination_unreachable_no_route_to_destination:     //0
 153         case ICMP6_destination_unreachable_beyond_scope_of_source_address:      //2
 154         case ICMP6_destination_unreachable_address_unreachable: //3
 155           icmp->type = ICMP4_destination_unreachable;
 156           icmp->code =
 157             ICMP4_destination_unreachable_destination_unreachable_host;
 158           break;
 159         case ICMP6_destination_unreachable_destination_administratively_prohibited:     //1
 160           icmp->type =
 161             ICMP4_destination_unreachable;
 162           icmp->code =
 163             ICMP4_destination_unreachable_communication_administratively_prohibited;
 164           break;
 165         case ICMP6_destination_unreachable_port_unreachable:
 166           icmp->type = ICMP4_destination_unreachable;
 167           icmp->code = ICMP4_destination_unreachable_port_unreachable;
 168           break;
 169         default:
 170           return -1;
 171         }
 172       break;
 173     case ICMP6_packet_too_big:
 174       *inner_ip6 = (ip6_header_t *) u8_ptr_add (icmp, 8);
 175
 176       icmp->type = ICMP4_destination_unreachable;
 177       icmp->code = 4;
 178       {
 179         u32 advertised_mtu = clib_net_to_host_u32 (*((u32 *) (icmp + 1)));
 180         advertised_mtu -= 20;
 181         //FIXME: = minimum(advertised MTU-20, MTU_of_IPv4_nexthop, (MTU_of_IPv6_nexthop)-20)
 182         ((u16 *) (icmp))[3] = clib_host_to_net_u16 (advertised_mtu);
 183       }
 184       break;
 185
 186     case ICMP6_time_exceeded:
 187       *inner_ip6 = (ip6_header_t *) u8_ptr_add (icmp, 8);
 188
 189       icmp->type = ICMP4_time_exceeded;
 190       break;
 191
 192     case ICMP6_parameter_problem:
 193       *inner_ip6 = (ip6_header_t *) u8_ptr_add (icmp, 8);
 194
 195       switch (icmp->code)
 196         {
 197         case ICMP6_parameter_problem_erroneous_header_field:
 198           icmp->type = ICMP4_parameter_problem;
 199           icmp->code = ICMP4_parameter_problem_pointer_indicates_error;
 200           u32 pointer = clib_net_to_host_u32 (*((u32 *) (icmp + 1)));
 201           if (pointer >= 40)
 202             return -1;
 203
 204           ((u8 *) (icmp + 1))[0] =
 205             icmp6_to_icmp_updater_pointer_table[pointer];
 206           break;
 207         case ICMP6_parameter_problem_unrecognized_next_header:
 208           icmp->type = ICMP4_destination_unreachable;
 209           icmp->code = ICMP4_destination_unreachable_port_unreachable;
 210           break;
 211         case ICMP6_parameter_problem_unrecognized_option:
 212         default:
 213           return -1;
 214         }
 215       break;
 216     default:
 217       return -1;
 218       break;
 219     }
 220   return 0;
 221 }
 222
 223 /**
 224  * @brief Translate TOS value from IPv6 to IPv4.
 225  *
 226  * @param ip6 IPv6 header.
 227  *
 228  * @returns IPv4 TOS value.
 229  */
 230 static_always_inline u8
 231 ip6_translate_tos (const ip6_header_t * ip6)
 232 {
 233   return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
 234           & 0x0ff00000) >> 20;
 235 }
 236
 237 /**
 238  * @brief Translate ICMP6 packet to ICMP4.
 239  *
 240  * @param p         Buffer to translate.
 241  * @param fn        The function to translate outer header.
 242  * @param ctx       A context passed in the outer header translate function.
 243  * @param inner_fn  The function to translate inner header.
 244  * @param inner_ctx A context passed in the inner header translate function.
 245  *
 246  * @returns 0 on success, non-zero value otherwise.
 247  */
 248 always_inline int
 249 icmp6_to_icmp (vlib_buffer_t * p, ip6_to_ip4_set_fn_t fn, void *ctx,
 250                ip6_to_ip4_set_fn_t inner_fn, void *inner_ctx)
 251 {
 252   ip6_header_t *ip6, *inner_ip6;
 253   ip4_header_t *ip4, *inner_ip4;
 254   u32 ip6_pay_len;
 255   icmp46_header_t *icmp;
 256   ip_csum_t csum;
 257   int rv;
 258
 259   ip6 = vlib_buffer_get_current (p);
 260   ip6_pay_len = clib_net_to_host_u16 (ip6->payload_length);
 261   icmp = (icmp46_header_t *) (ip6 + 1);
 262   ASSERT (ip6_pay_len + sizeof (*ip6) <= p->current_length);
 263
 264   //No extensions headers allowed here
 265   if (ip6->protocol != IP_PROTOCOL_ICMP6)
 266     return -1;
 267
 268   //There are no fragmented ICMP messages, so no extension header for now
 269   if (icmp6_to_icmp_header (icmp, &inner_ip6))
 270     return -1;
 271
 272   if (inner_ip6)
 273     {
 274       u16 *inner_L4_checksum, inner_l4_offset, inner_frag_offset,
 275         inner_frag_id;
 276       u8 *inner_l4, inner_protocol;
 277
 278       //We have two headers to translate
 279       //   FROM
 280       //   [   IPv6   ]<- ext ->[IC][   IPv6   ]<- ext ->[L4 header ...
 281       // Handled cases:
 282       //                     [   IPv6   ][IC][   IPv6   ][L4 header ...
 283       //                 [   IPv6   ][IC][   IPv6   ][Fr][L4 header ...
 284       //    TO
 285       //                               [ IPv4][IC][ IPv4][L4 header ...
 286
 287       if (ip6_parse (inner_ip6, ip6_pay_len - 8,
 288                      &inner_protocol, &inner_l4_offset, &inner_frag_offset))
 289         return -1;
 290
 291       inner_l4 = u8_ptr_add (inner_ip6, inner_l4_offset);
 292       inner_ip4 =
 293         (ip4_header_t *) u8_ptr_add (inner_l4, -sizeof (*inner_ip4));
 294       if (inner_frag_offset)
 295         {
 296           ip6_frag_hdr_t *inner_frag =
 297             (ip6_frag_hdr_t *) u8_ptr_add (inner_ip6, inner_frag_offset);
 298           inner_frag_id = frag_id_6to4 (inner_frag->identification);
 299         }
 300       else
 301         {
 302           inner_frag_id = 0;
 303         }
 304
 305       //Do the translation of the inner packet
 306       if (inner_protocol == IP_PROTOCOL_TCP)
 307         {
 308           inner_L4_checksum = (u16 *) u8_ptr_add (inner_l4, 16);
 309         }
 310       else if (inner_protocol == IP_PROTOCOL_UDP)
 311         {
 312           inner_L4_checksum = (u16 *) u8_ptr_add (inner_l4, 6);
 313         }
 314       else if (inner_protocol == IP_PROTOCOL_ICMP6)
 315         {
 316           icmp46_header_t *inner_icmp = (icmp46_header_t *) inner_l4;
 317           csum = inner_icmp->checksum;
 318           csum = ip_csum_sub_even (csum, *((u16 *) inner_icmp));
 319           //It cannot be of a different type as ip6_icmp_to_icmp6_in_place succeeded
 320           inner_icmp->type = (inner_icmp->type == ICMP6_echo_request) ?
 321             ICMP4_echo_request : ICMP4_echo_reply;
 322           csum = ip_csum_add_even (csum, *((u16 *) inner_icmp));
 323           inner_icmp->checksum = ip_csum_fold (csum);
 324           inner_protocol = IP_PROTOCOL_ICMP;    //Will be copied to ip6 later
 325           inner_L4_checksum = &inner_icmp->checksum;
 326         }
 327       else
 328         {
 329           return -1;
 330         }
 331
 332       csum = *inner_L4_checksum;
 333       csum = ip_csum_sub_even (csum, inner_ip6->src_address.as_u64[0]);
 334       csum = ip_csum_sub_even (csum, inner_ip6->src_address.as_u64[1]);
 335       csum = ip_csum_sub_even (csum, inner_ip6->dst_address.as_u64[0]);
 336       csum = ip_csum_sub_even (csum, inner_ip6->dst_address.as_u64[1]);
 337
 338       if ((rv = inner_fn (inner_ip6, inner_ip4, inner_ctx)) != 0)
 339         return rv;
 340
 341       inner_ip4->ip_version_and_header_length =
 342         IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
 343       inner_ip4->tos = ip6_translate_tos (inner_ip6);
 344       inner_ip4->length =
 345         u16_net_add (inner_ip6->payload_length,
 346                      sizeof (*ip4) + sizeof (*ip6) - inner_l4_offset);
 347       inner_ip4->fragment_id = inner_frag_id;
 348       inner_ip4->flags_and_fragment_offset =
 349         clib_host_to_net_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
 350       inner_ip4->ttl = inner_ip6->hop_limit;
 351       inner_ip4->protocol = inner_protocol;
 352       inner_ip4->checksum = ip4_header_checksum (inner_ip4);
 353
 354       if (inner_ip4->protocol == IP_PROTOCOL_ICMP)
 355         {
 356           //Remove remainings of the pseudo-header in the csum
 357           csum =
 358             ip_csum_sub_even (csum, clib_host_to_net_u16 (IP_PROTOCOL_ICMP6));
 359           csum =
 360             ip_csum_sub_even (csum, inner_ip4->length - sizeof (*inner_ip4));
 361         }
 362       else
 363         {
 364           //Update to new pseudo-header
 365           csum = ip_csum_add_even (csum, inner_ip4->src_address.as_u32);
 366           csum = ip_csum_add_even (csum, inner_ip4->dst_address.as_u32);
 367         }
 368       *inner_L4_checksum = ip_csum_fold (csum);
 369
 370       //Move up icmp header
 371       ip4 = (ip4_header_t *) u8_ptr_add (inner_l4, -2 * sizeof (*ip4) - 8);
 372       clib_memcpy (u8_ptr_add (inner_l4, -sizeof (*ip4) - 8), icmp, 8);
 373       icmp = (icmp46_header_t *) u8_ptr_add (inner_l4, -sizeof (*ip4) - 8);
 374     }
 375   else
 376     {
 377       //Only one header to translate
 378       ip4 = (ip4_header_t *) u8_ptr_add (ip6, sizeof (*ip6) - sizeof (*ip4));
 379     }
 380
 381   vlib_buffer_advance (p, (u32) (((u8 *) ip4) - ((u8 *) ip6)));
 382
 383   if ((rv = fn (ip6, ip4, ctx)) != 0)
 384     return rv;
 385
 386   ip4->ip_version_and_header_length =
 387     IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
 388   ip4->tos = ip6_translate_tos (ip6);
 389   ip4->fragment_id = 0;
 390   ip4->flags_and_fragment_offset = 0;
 391   ip4->ttl = ip6->hop_limit;
 392   ip4->protocol = IP_PROTOCOL_ICMP;
 393   //TODO fix the length depending on offset length
 394   ip4->length = u16_net_add (ip6->payload_length,
 395                              (inner_ip6 ==
 396                               NULL) ? sizeof (*ip4) : (2 * sizeof (*ip4) -
 397                                                        sizeof (*ip6)));
 398   ip4->checksum = ip4_header_checksum (ip4);
 399
 400   //Recompute ICMP checksum
 401   icmp->checksum = 0;
 402   csum =
 403     ip_incremental_checksum (0, icmp,
 404                              clib_net_to_host_u16 (ip4->length) -
 405                              sizeof (*ip4));
 406   icmp->checksum = ~ip_csum_fold (csum);
 407
 408   return 0;
 409 }
 410
 411 /**
 412  * @brief Translate IPv6 fragmented packet to IPv4.
 413  *
 414  * @param p   Buffer to translate.
 415  * @param fn  The function to translate header.
 416  * @param ctx A context passed in the header translate function.
 417  *
 418  * @returns 0 on success, non-zero value otherwise.
 419  */
 420 always_inline int
 421 ip6_to_ip4_fragmented (vlib_buffer_t * p, ip6_to_ip4_set_fn_t fn, void *ctx)
 422 {
 423   ip6_header_t *ip6;
 424   ip6_frag_hdr_t *frag;
 425   ip4_header_t *ip4;
 426   u16 frag_id;
 427   u8 frag_more;
 428   u16 frag_offset;
 429   u8 l4_protocol;
 430   u16 l4_offset;
 431   int rv;
 432
 433   ip6 = vlib_buffer_get_current (p);
 434
 435   if (ip6_parse
 436       (ip6, p->current_length, &l4_protocol, &l4_offset, &frag_offset))
 437     return -1;
 438
 439   frag = (ip6_frag_hdr_t *) u8_ptr_add (ip6, frag_offset);
 440   ip4 = (ip4_header_t *) u8_ptr_add (ip6, l4_offset - sizeof (*ip4));
 441   vlib_buffer_advance (p, l4_offset - sizeof (*ip4));
 442
 443   frag_id = frag_id_6to4 (frag->identification);
 444   frag_more = ip6_frag_hdr_more (frag);
 445   frag_offset = ip6_frag_hdr_offset (frag);
 446
 447   if ((rv = fn (ip6, ip4, ctx)) != 0)
 448     return rv;
 449
 450   ip4->ip_version_and_header_length =
 451     IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
 452   ip4->tos = ip6_translate_tos (ip6);
 453   ip4->length = u16_net_add (ip6->payload_length,
 454                              sizeof (*ip4) - l4_offset + sizeof (*ip6));
 455   ip4->fragment_id = frag_id;
 456   ip4->flags_and_fragment_offset =
 457     clib_host_to_net_u16 (frag_offset |
 458                           (frag_more ? IP4_HEADER_FLAG_MORE_FRAGMENTS : 0));
 459   ip4->ttl = ip6->hop_limit;
 460   ip4->protocol =
 461     (l4_protocol == IP_PROTOCOL_ICMP6) ? IP_PROTOCOL_ICMP : l4_protocol;
 462   ip4->checksum = ip4_header_checksum (ip4);
 463
 464   return 0;
 465 }
 466
 467 /**
 468  * @brief Translate IPv6 UDP/TCP packet to IPv4.
 469  *
 470  * @param p   Buffer to translate.
 471  * @param fn  The function to translate header.
 472  * @param ctx A context passed in the header translate function.
 473  *
 474  * @returns 0 on success, non-zero value otherwise.
 475  */
 476 always_inline int
 477 ip6_to_ip4_tcp_udp (vlib_buffer_t * p, ip6_to_ip4_set_fn_t fn, void *ctx,
 478                     u8 udp_checksum)
 479 {
 480   ip6_header_t *ip6;
 481   u16 *checksum;
 482   ip_csum_t csum = 0;
 483   ip4_header_t *ip4;
 484   u16 fragment_id;
 485   u16 flags;
 486   u16 frag_offset;
 487   u8 l4_protocol;
 488   u16 l4_offset;
 489   int rv;
 490
 491   ip6 = vlib_buffer_get_current (p);
 492
 493   if (ip6_parse
 494       (ip6, p->current_length, &l4_protocol, &l4_offset, &frag_offset))
 495     return -1;
 496
 497   if (l4_protocol == IP_PROTOCOL_TCP)
 498     {
 499       tcp_header_t *tcp = ip6_next_header (ip6);
 500       checksum = &tcp->checksum;
 501     }
 502   else
 503     {
 504       udp_header_t *udp = ip6_next_header (ip6);
 505       checksum = &udp->checksum;
 506       //UDP checksum is optional over IPv4
 507       if (!udp_checksum)
 508         goto no_csum;
 509     }
 510
 511   csum = ip_csum_sub_even (*checksum, ip6->src_address.as_u64[0]);
 512   csum = ip_csum_sub_even (csum, ip6->src_address.as_u64[1]);
 513   csum = ip_csum_sub_even (csum, ip6->dst_address.as_u64[0]);
 514   csum = ip_csum_sub_even (csum, ip6->dst_address.as_u64[1]);
 515
 516 no_csum:
 517   ip4 = (ip4_header_t *) u8_ptr_add (ip6, l4_offset - sizeof (*ip4));
 518
 519   vlib_buffer_advance (p, l4_offset - sizeof (*ip4));
 520
 521   if (PREDICT_FALSE (frag_offset))
 522     {
 523       //Only the first fragment
 524       ip6_frag_hdr_t *hdr = (ip6_frag_hdr_t *) u8_ptr_add (ip6, frag_offset);
 525       fragment_id = frag_id_6to4 (hdr->identification);
 526       flags = clib_host_to_net_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
 527     }
 528   else
 529     {
 530       fragment_id = 0;
 531       flags = 0;
 532     }
 533
 534   if ((rv = fn (ip6, ip4, ctx)) != 0)
 535     return rv;
 536
 537   ip4->ip_version_and_header_length =
 538     IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
 539   ip4->tos = ip6_translate_tos (ip6);
 540   ip4->length = u16_net_add (ip6->payload_length,
 541                              sizeof (*ip4) + sizeof (*ip6) - l4_offset);
 542   ip4->fragment_id = fragment_id;
 543   ip4->flags_and_fragment_offset = flags;
 544   ip4->ttl = ip6->hop_limit;
 545   ip4->protocol = l4_protocol;
 546   ip4->checksum = ip4_header_checksum (ip4);
 547
 548   //UDP checksum is optional over IPv4
 549   if (!udp_checksum && l4_protocol == IP_PROTOCOL_UDP)
 550     {
 551       *checksum = 0;
 552     }
 553   else
 554     {
 555       csum = ip_csum_add_even (csum, ip4->dst_address.as_u32);
 556       csum = ip_csum_add_even (csum, ip4->src_address.as_u32);
 557       *checksum = ip_csum_fold (csum);
 558     }
 559
 560   return 0;
 561 }
 562
 563 #endif /* __included_ip6_to_ip4_h__ */
 564
 565 /*
 566  * fd.io coding-style-patch-verification: ON
 567  *
 568  * Local Variables:
 569  * eval: (c-set-style "gnu")
 570  * End:
 571  */