The Tcpdump Group git mirrors - tcpdump/blob - print-openflow.c

   1 /*
   2  * This module implements printing of the very basic (version-independent)
   3  * OpenFlow header and iteration over OpenFlow messages. It is intended for
   4  * dispatching of version-specific OpenFlow message decoding.
   5  *
   6  *
   7  * Copyright (c) 2013 The TCPDUMP project
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  23  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /* \summary: version-independent OpenFlow printer */
  34
  35 #ifdef HAVE_CONFIG_H
  36 #include <config.h>
  37 #endif
  38
  39 #include "netdissect-stdinc.h"
  40
  41 #define ND_LONGJMP_FROM_TCHECK
  42 #include "netdissect.h"
  43 #include "extract.h"
  44 #include "openflow.h"
  45 #include "oui.h"
  46
  47
  48 #define OF_VER_1_0    0x01
  49
  50 const struct tok onf_exp_str[] = {
  51         { ONF_EXP_ONF,               "ONF Extensions"                                  },
  52         { ONF_EXP_BUTE,              "Budapest University of Technology and Economics" },
  53         { ONF_EXP_NOVIFLOW,          "NoviFlow"                                        },
  54         { ONF_EXP_L3,                "L3+ Extensions, Vendor Neutral"                  },
  55         { ONF_EXP_L4L7,              "L4-L7 Extensions"                                },
  56         { ONF_EXP_WMOB,              "Wireless and Mobility Extensions"                },
  57         { ONF_EXP_FABS,              "Forwarding Abstractions Extensions"              },
  58         { ONF_EXP_OTRANS,            "Optical Transport Extensions"                    },
  59         { 0, NULL }
  60 };
  61
  62 const char *
  63 of_vendor_name(const uint32_t vendor)
  64 {
  65         const struct tok *table = (vendor & 0xff000000) == 0 ? oui_values : onf_exp_str;
  66         return tok2str(table, "unknown", vendor);
  67 }
  68
  69 void
  70 of_data_print(netdissect_options *ndo,
  71               const u_char *cp, const u_int len)
  72 {
  73         if (len == 0)
  74                 return;
  75         /* data */
  76         ND_PRINT("\n\t data (%u octets)", len);
  77         if (ndo->ndo_vflag >= 2)
  78                 hex_and_ascii_print(ndo, "\n\t  ", cp, len);
  79         else
  80                 ND_TCHECK_LEN(cp, len);
  81 }
  82
  83 static void
  84 of_header_print(netdissect_options *ndo, const uint8_t version, const uint8_t type,
  85                       const uint16_t length, const uint32_t xid)
  86 {
  87         ND_PRINT("\n\tversion unknown (0x%02x), type 0x%02x, length %u, xid 0x%08x",
  88                version, type, length, xid);
  89 }
  90
  91 /* Print a TCP segment worth of OpenFlow messages presuming the segment begins
  92  * on a message boundary. */
  93 void
  94 openflow_print(netdissect_options *ndo, const u_char *cp, u_int len)
  95 {
  96         ndo->ndo_protocol = "openflow";
  97         ND_PRINT(": OpenFlow");
  98         while (len) {
  99                 /* Print a single OpenFlow message. */
 100                 uint8_t version, type;
 101                 uint16_t length;
 102                 uint32_t xid;
 103
 104                 if (len < OF_HEADER_FIXLEN)
 105                         goto invalid;
 106                 /* version */
 107                 version = GET_U_1(cp);
 108                 OF_FWD(1);
 109                 /* type */
 110                 type = GET_U_1(cp);
 111                 OF_FWD(1);
 112                 /* length */
 113                 length = GET_BE_U_2(cp);
 114                 OF_FWD(2);
 115                 /* xid */
 116                 xid = GET_BE_U_4(cp);
 117                 OF_FWD(4);
 118                 /*
 119                  * When a TCP packet can contain several protocol messages,
 120                  * and at the same time a protocol message can span several
 121                  * TCP packets, decoding an incomplete message at the end of
 122                  * a TCP packet requires attention to detail in this loop.
 123                  *
 124                  * Message length includes the header length and a message
 125                  * always includes the basic header. A message length underrun
 126                  * fails decoding of the rest of the current packet. At the
 127                  * same time, try decoding as much of the current message as
 128                  * possible even when it does not end within the current TCP
 129                  * segment.
 130                  *
 131                  * Specifically, to try to process the message body in this
 132                  * iteration do NOT require the header "length" to be small
 133                  * enough for the full declared OpenFlow message to fit into
 134                  * the remainder of the declared TCP segment, same as the full
 135                  * declared TCP segment is not required to fit into the
 136                  * captured packet buffer.
 137                  *
 138                  * But DO require the same at the end of this iteration to
 139                  * decrement "len" and to proceed to the next iteration.
 140                  * (Ideally the declared TCP payload end will be at or after
 141                  * the captured packet buffer end, but stay safe even when
 142                  * that's somehow not the case.)
 143                  */
 144                 if (length < OF_HEADER_FIXLEN) {
 145                         of_header_print(ndo, version, type, length, xid);
 146                         goto invalid;
 147                 }
 148                 /*
 149                  * Decode known protocol versions further without printing the
 150                  * header (the type decoding is version-specific).
 151                  */
 152                 switch (version) {
 153                 case OF_VER_1_0:
 154                         of10_header_body_print(ndo, cp, type,
 155                                                length - OF_HEADER_FIXLEN, xid);
 156                         break;
 157                 default:
 158                         of_header_print(ndo, version, type, length, xid);
 159                         ND_TCHECK_LEN(cp, length - OF_HEADER_FIXLEN);
 160                 }
 161                 if (length - OF_HEADER_FIXLEN > len)
 162                         break;
 163                 OF_FWD(length - OF_HEADER_FIXLEN);
 164         } /* while (len) */
 165         return;
 166
 167 invalid: /* fail the current packet */
 168         nd_print_invalid(ndo);
 169         ND_TCHECK_LEN(cp, len);
 170 }