2015-01-06 19:03:11 +00:00
|
|
|
/*
|
|
|
|
* This module implements printing of the very basic (version-independent)
|
|
|
|
* OpenFlow header and iteration over OpenFlow messages. It is intended for
|
|
|
|
* dispatching of version-specific OpenFlow message decoding.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013 The TCPDUMP project
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
|
|
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
2017-01-31 19:17:06 +00:00
|
|
|
/* \summary: version-independent OpenFlow printer */
|
|
|
|
|
2015-01-06 19:03:11 +00:00
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
#include "config.h"
|
|
|
|
#endif
|
|
|
|
|
2017-01-31 19:17:06 +00:00
|
|
|
#include <netdissect-stdinc.h>
|
2015-01-06 19:03:11 +00:00
|
|
|
|
2017-01-31 19:17:06 +00:00
|
|
|
#include "netdissect.h"
|
2015-01-06 19:03:11 +00:00
|
|
|
#include "extract.h"
|
|
|
|
#include "openflow.h"
|
2015-07-06 02:16:08 +00:00
|
|
|
#include "oui.h"
|
2015-01-06 19:03:11 +00:00
|
|
|
|
|
|
|
static const char tstr[] = " [|openflow]";
|
|
|
|
|
|
|
|
#define OF_VER_1_0 0x01
|
|
|
|
|
2015-07-06 02:16:08 +00:00
|
|
|
const struct tok onf_exp_str[] = {
|
|
|
|
{ ONF_EXP_ONF, "ONF Extensions" },
|
|
|
|
{ ONF_EXP_BUTE, "Budapest University of Technology and Economics" },
|
|
|
|
{ ONF_EXP_NOVIFLOW, "NoviFlow" },
|
|
|
|
{ ONF_EXP_L3, "L3+ Extensions, Vendor Neutral" },
|
|
|
|
{ ONF_EXP_L4L7, "L4-L7 Extensions" },
|
|
|
|
{ ONF_EXP_WMOB, "Wireless and Mobility Extensions" },
|
|
|
|
{ ONF_EXP_FABS, "Forwarding Abstractions Extensions" },
|
|
|
|
{ ONF_EXP_OTRANS, "Optical Transport Extensions" },
|
|
|
|
{ 0, NULL }
|
|
|
|
};
|
|
|
|
|
|
|
|
const char *
|
|
|
|
of_vendor_name(const uint32_t vendor)
|
|
|
|
{
|
|
|
|
const struct tok *table = (vendor & 0xff000000) == 0 ? oui_values : onf_exp_str;
|
|
|
|
return tok2str(table, "unknown", vendor);
|
|
|
|
}
|
|
|
|
|
2015-01-06 19:03:11 +00:00
|
|
|
static void
|
|
|
|
of_header_print(netdissect_options *ndo, const uint8_t version, const uint8_t type,
|
2015-07-06 02:16:08 +00:00
|
|
|
const uint16_t length, const uint32_t xid)
|
|
|
|
{
|
2015-01-06 19:03:11 +00:00
|
|
|
ND_PRINT((ndo, "\n\tversion unknown (0x%02x), type 0x%02x, length %u, xid 0x%08x",
|
|
|
|
version, type, length, xid));
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Print a single OpenFlow message. */
|
|
|
|
static const u_char *
|
2015-07-06 02:16:08 +00:00
|
|
|
of_header_body_print(netdissect_options *ndo, const u_char *cp, const u_char *ep)
|
|
|
|
{
|
2015-01-06 19:03:11 +00:00
|
|
|
uint8_t version, type;
|
|
|
|
uint16_t length;
|
|
|
|
uint32_t xid;
|
|
|
|
|
|
|
|
if (ep < cp + OF_HEADER_LEN)
|
2017-01-31 19:17:06 +00:00
|
|
|
goto invalid;
|
2015-01-06 19:03:11 +00:00
|
|
|
/* version */
|
|
|
|
ND_TCHECK2(*cp, 1);
|
|
|
|
version = *cp;
|
|
|
|
cp += 1;
|
|
|
|
/* type */
|
|
|
|
ND_TCHECK2(*cp, 1);
|
|
|
|
type = *cp;
|
|
|
|
cp += 1;
|
|
|
|
/* length */
|
|
|
|
ND_TCHECK2(*cp, 2);
|
|
|
|
length = EXTRACT_16BITS(cp);
|
|
|
|
cp += 2;
|
|
|
|
/* xid */
|
|
|
|
ND_TCHECK2(*cp, 4);
|
|
|
|
xid = EXTRACT_32BITS(cp);
|
|
|
|
cp += 4;
|
|
|
|
/* Message length includes the header length and a message always includes
|
|
|
|
* the basic header. A message length underrun fails decoding of the rest of
|
|
|
|
* the current packet. At the same time, try decoding as much of the current
|
|
|
|
* message as possible even when it does not end within the current TCP
|
|
|
|
* segment. */
|
|
|
|
if (length < OF_HEADER_LEN) {
|
|
|
|
of_header_print(ndo, version, type, length, xid);
|
2017-01-31 19:17:06 +00:00
|
|
|
goto invalid;
|
2015-01-06 19:03:11 +00:00
|
|
|
}
|
|
|
|
/* Decode known protocol versions further without printing the header (the
|
|
|
|
* type decoding is version-specific. */
|
|
|
|
switch (version) {
|
|
|
|
case OF_VER_1_0:
|
|
|
|
return of10_header_body_print(ndo, cp, ep, type, length, xid);
|
|
|
|
default:
|
|
|
|
of_header_print(ndo, version, type, length, xid);
|
|
|
|
ND_TCHECK2(*cp, length - OF_HEADER_LEN);
|
|
|
|
return cp + length - OF_HEADER_LEN; /* done with current message */
|
|
|
|
}
|
|
|
|
|
2017-01-31 19:17:06 +00:00
|
|
|
invalid: /* fail current packet */
|
|
|
|
ND_PRINT((ndo, "%s", istr));
|
2015-01-06 19:03:11 +00:00
|
|
|
ND_TCHECK2(*cp, ep - cp);
|
|
|
|
return ep;
|
|
|
|
trunc:
|
|
|
|
ND_PRINT((ndo, "%s", tstr));
|
|
|
|
return ep;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Print a TCP segment worth of OpenFlow messages presuming the segment begins
|
|
|
|
* on a message boundary. */
|
|
|
|
void
|
2015-07-06 02:16:08 +00:00
|
|
|
openflow_print(netdissect_options *ndo, const u_char *cp, const u_int len)
|
|
|
|
{
|
2015-01-06 19:03:11 +00:00
|
|
|
const u_char *ep = cp + len;
|
|
|
|
|
|
|
|
ND_PRINT((ndo, ": OpenFlow"));
|
|
|
|
while (cp < ep)
|
|
|
|
cp = of_header_body_print(ndo, cp, ep);
|
|
|
|
}
|