1411677aeSAaron LI /*
2411677aeSAaron LI * This module implements printing of the very basic (version-independent)
3411677aeSAaron LI * OpenFlow header and iteration over OpenFlow messages. It is intended for
4411677aeSAaron LI * dispatching of version-specific OpenFlow message decoding.
5411677aeSAaron LI *
6411677aeSAaron LI *
7411677aeSAaron LI * Copyright (c) 2013 The TCPDUMP project
8411677aeSAaron LI * All rights reserved.
9411677aeSAaron LI *
10411677aeSAaron LI * Redistribution and use in source and binary forms, with or without
11411677aeSAaron LI * modification, are permitted provided that the following conditions
12411677aeSAaron LI * are met:
13411677aeSAaron LI * 1. Redistributions of source code must retain the above copyright
14411677aeSAaron LI * notice, this list of conditions and the following disclaimer.
15411677aeSAaron LI * 2. Redistributions in binary form must reproduce the above copyright
16411677aeSAaron LI * notice, this list of conditions and the following disclaimer in the
17411677aeSAaron LI * documentation and/or other materials provided with the distribution.
18411677aeSAaron LI *
19411677aeSAaron LI * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20411677aeSAaron LI * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21411677aeSAaron LI * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22411677aeSAaron LI * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23411677aeSAaron LI * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24411677aeSAaron LI * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25411677aeSAaron LI * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26411677aeSAaron LI * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27411677aeSAaron LI * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28411677aeSAaron LI * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29411677aeSAaron LI * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30411677aeSAaron LI * POSSIBILITY OF SUCH DAMAGE.
31411677aeSAaron LI */
32411677aeSAaron LI
33411677aeSAaron LI /* \summary: version-independent OpenFlow printer */
34411677aeSAaron LI
35411677aeSAaron LI #ifdef HAVE_CONFIG_H
36*ed775ee7SAntonio Huete Jimenez #include <config.h>
37411677aeSAaron LI #endif
38411677aeSAaron LI
39*ed775ee7SAntonio Huete Jimenez #include "netdissect-stdinc.h"
40411677aeSAaron LI
41*ed775ee7SAntonio Huete Jimenez #define ND_LONGJMP_FROM_TCHECK
42411677aeSAaron LI #include "netdissect.h"
43411677aeSAaron LI #include "extract.h"
44411677aeSAaron LI #include "openflow.h"
45411677aeSAaron LI #include "oui.h"
46411677aeSAaron LI
47411677aeSAaron LI
48*ed775ee7SAntonio Huete Jimenez static const struct tok ofver_str[] = {
49*ed775ee7SAntonio Huete Jimenez { OF_VER_1_0, "1.0" },
50*ed775ee7SAntonio Huete Jimenez { OF_VER_1_1, "1.1" },
51*ed775ee7SAntonio Huete Jimenez { OF_VER_1_2, "1.2" },
52*ed775ee7SAntonio Huete Jimenez { OF_VER_1_3, "1.3" },
53*ed775ee7SAntonio Huete Jimenez { OF_VER_1_4, "1.4" },
54*ed775ee7SAntonio Huete Jimenez { OF_VER_1_5, "1.5" },
55*ed775ee7SAntonio Huete Jimenez { 0, NULL }
56*ed775ee7SAntonio Huete Jimenez };
57411677aeSAaron LI
58411677aeSAaron LI const struct tok onf_exp_str[] = {
59411677aeSAaron LI { ONF_EXP_ONF, "ONF Extensions" },
60411677aeSAaron LI { ONF_EXP_BUTE, "Budapest University of Technology and Economics" },
61411677aeSAaron LI { ONF_EXP_NOVIFLOW, "NoviFlow" },
62411677aeSAaron LI { ONF_EXP_L3, "L3+ Extensions, Vendor Neutral" },
63411677aeSAaron LI { ONF_EXP_L4L7, "L4-L7 Extensions" },
64411677aeSAaron LI { ONF_EXP_WMOB, "Wireless and Mobility Extensions" },
65411677aeSAaron LI { ONF_EXP_FABS, "Forwarding Abstractions Extensions" },
66411677aeSAaron LI { ONF_EXP_OTRANS, "Optical Transport Extensions" },
67*ed775ee7SAntonio Huete Jimenez { ONF_EXP_NBLNCTU, "Network Benchmarking Lab, NCTU" },
68*ed775ee7SAntonio Huete Jimenez { ONF_EXP_MPCE, "Mobile Packet Core Extensions" },
69*ed775ee7SAntonio Huete Jimenez { ONF_EXP_MPLSTPSPTN, "MPLS-TP OpenFlow Extensions for SPTN" },
70411677aeSAaron LI { 0, NULL }
71411677aeSAaron LI };
72411677aeSAaron LI
73411677aeSAaron LI const char *
of_vendor_name(const uint32_t vendor)74411677aeSAaron LI of_vendor_name(const uint32_t vendor)
75411677aeSAaron LI {
76411677aeSAaron LI const struct tok *table = (vendor & 0xff000000) == 0 ? oui_values : onf_exp_str;
77411677aeSAaron LI return tok2str(table, "unknown", vendor);
78411677aeSAaron LI }
79411677aeSAaron LI
80*ed775ee7SAntonio Huete Jimenez void
of_bitmap_print(netdissect_options * ndo,const struct tok * t,const uint32_t v,const uint32_t u)81*ed775ee7SAntonio Huete Jimenez of_bitmap_print(netdissect_options *ndo,
82*ed775ee7SAntonio Huete Jimenez const struct tok *t, const uint32_t v, const uint32_t u)
83*ed775ee7SAntonio Huete Jimenez {
84*ed775ee7SAntonio Huete Jimenez /* Assigned bits? */
85*ed775ee7SAntonio Huete Jimenez if (v & ~u)
86*ed775ee7SAntonio Huete Jimenez ND_PRINT(" (%s)", bittok2str(t, "", v));
87*ed775ee7SAntonio Huete Jimenez /* Unassigned bits? */
88*ed775ee7SAntonio Huete Jimenez if (v & u)
89*ed775ee7SAntonio Huete Jimenez ND_PRINT(" (bogus)");
90*ed775ee7SAntonio Huete Jimenez }
91*ed775ee7SAntonio Huete Jimenez
92*ed775ee7SAntonio Huete Jimenez void
of_data_print(netdissect_options * ndo,const u_char * cp,const u_int len)93*ed775ee7SAntonio Huete Jimenez of_data_print(netdissect_options *ndo,
94*ed775ee7SAntonio Huete Jimenez const u_char *cp, const u_int len)
95*ed775ee7SAntonio Huete Jimenez {
96*ed775ee7SAntonio Huete Jimenez if (len == 0)
97*ed775ee7SAntonio Huete Jimenez return;
98*ed775ee7SAntonio Huete Jimenez /* data */
99*ed775ee7SAntonio Huete Jimenez ND_PRINT("\n\t data (%u octets)", len);
100*ed775ee7SAntonio Huete Jimenez if (ndo->ndo_vflag >= 2)
101*ed775ee7SAntonio Huete Jimenez hex_and_ascii_print(ndo, "\n\t ", cp, len);
102*ed775ee7SAntonio Huete Jimenez else
103*ed775ee7SAntonio Huete Jimenez ND_TCHECK_LEN(cp, len);
104*ed775ee7SAntonio Huete Jimenez }
105*ed775ee7SAntonio Huete Jimenez
106411677aeSAaron LI static void
of_message_print(netdissect_options * ndo,const u_char * cp,uint16_t len,const struct of_msgtypeinfo * mti)107*ed775ee7SAntonio Huete Jimenez of_message_print(netdissect_options *ndo,
108*ed775ee7SAntonio Huete Jimenez const u_char *cp, uint16_t len,
109*ed775ee7SAntonio Huete Jimenez const struct of_msgtypeinfo *mti)
110411677aeSAaron LI {
111*ed775ee7SAntonio Huete Jimenez /*
112*ed775ee7SAntonio Huete Jimenez * Here "cp" and "len" stand for the message part beyond the common
113*ed775ee7SAntonio Huete Jimenez * OpenFlow 1.0 header, if any.
114*ed775ee7SAntonio Huete Jimenez *
115*ed775ee7SAntonio Huete Jimenez * Most message types are longer than just the header, and the length
116*ed775ee7SAntonio Huete Jimenez * constraints may be complex. When possible, validate the constraint
117*ed775ee7SAntonio Huete Jimenez * completely here (REQ_FIXLEN), otherwise check that the message is
118*ed775ee7SAntonio Huete Jimenez * long enough to begin the decoding (REQ_MINLEN) and have the
119*ed775ee7SAntonio Huete Jimenez * type-specific function do any remaining validation.
120*ed775ee7SAntonio Huete Jimenez */
121411677aeSAaron LI
122*ed775ee7SAntonio Huete Jimenez if (!mti)
123*ed775ee7SAntonio Huete Jimenez goto tcheck_remainder;
124411677aeSAaron LI
125*ed775ee7SAntonio Huete Jimenez if ((mti->req_what == REQ_FIXLEN && len != mti->req_value) ||
126*ed775ee7SAntonio Huete Jimenez (mti->req_what == REQ_MINLEN && len < mti->req_value))
127411677aeSAaron LI goto invalid;
128411677aeSAaron LI
129*ed775ee7SAntonio Huete Jimenez if (!ndo->ndo_vflag || !mti->decoder)
130*ed775ee7SAntonio Huete Jimenez goto tcheck_remainder;
131*ed775ee7SAntonio Huete Jimenez
132*ed775ee7SAntonio Huete Jimenez mti->decoder(ndo, cp, len);
133*ed775ee7SAntonio Huete Jimenez return;
134*ed775ee7SAntonio Huete Jimenez
135*ed775ee7SAntonio Huete Jimenez invalid:
136*ed775ee7SAntonio Huete Jimenez nd_print_invalid(ndo);
137*ed775ee7SAntonio Huete Jimenez tcheck_remainder:
138*ed775ee7SAntonio Huete Jimenez ND_TCHECK_LEN(cp, len);
139411677aeSAaron LI }
140411677aeSAaron LI
141411677aeSAaron LI /* Print a TCP segment worth of OpenFlow messages presuming the segment begins
142411677aeSAaron LI * on a message boundary. */
143411677aeSAaron LI void
openflow_print(netdissect_options * ndo,const u_char * cp,u_int len)144*ed775ee7SAntonio Huete Jimenez openflow_print(netdissect_options *ndo, const u_char *cp, u_int len)
145411677aeSAaron LI {
146*ed775ee7SAntonio Huete Jimenez ndo->ndo_protocol = "openflow";
147*ed775ee7SAntonio Huete Jimenez ND_PRINT(": OpenFlow");
148*ed775ee7SAntonio Huete Jimenez while (len) {
149*ed775ee7SAntonio Huete Jimenez /* Print a single OpenFlow message. */
150*ed775ee7SAntonio Huete Jimenez uint8_t version, type;
151*ed775ee7SAntonio Huete Jimenez uint16_t length;
152*ed775ee7SAntonio Huete Jimenez const struct of_msgtypeinfo *mti;
153*ed775ee7SAntonio Huete Jimenez
154*ed775ee7SAntonio Huete Jimenez /* version */
155*ed775ee7SAntonio Huete Jimenez version = GET_U_1(cp);
156*ed775ee7SAntonio Huete Jimenez OF_FWD(1);
157*ed775ee7SAntonio Huete Jimenez ND_PRINT("\n\tversion %s",
158*ed775ee7SAntonio Huete Jimenez tok2str(ofver_str, "unknown (0x%02x)", version));
159*ed775ee7SAntonio Huete Jimenez /* type */
160*ed775ee7SAntonio Huete Jimenez if (len < 1)
161*ed775ee7SAntonio Huete Jimenez goto partial_header;
162*ed775ee7SAntonio Huete Jimenez type = GET_U_1(cp);
163*ed775ee7SAntonio Huete Jimenez OF_FWD(1);
164*ed775ee7SAntonio Huete Jimenez mti =
165*ed775ee7SAntonio Huete Jimenez version == OF_VER_1_0 ? of10_identify_msgtype(type) :
166*ed775ee7SAntonio Huete Jimenez version == OF_VER_1_3 ? of13_identify_msgtype(type) :
167*ed775ee7SAntonio Huete Jimenez NULL;
168*ed775ee7SAntonio Huete Jimenez if (mti && mti->name)
169*ed775ee7SAntonio Huete Jimenez ND_PRINT(", type %s", mti->name);
170*ed775ee7SAntonio Huete Jimenez else
171*ed775ee7SAntonio Huete Jimenez ND_PRINT(", type unknown (0x%02x)", type);
172*ed775ee7SAntonio Huete Jimenez /* length */
173*ed775ee7SAntonio Huete Jimenez if (len < 2)
174*ed775ee7SAntonio Huete Jimenez goto partial_header;
175*ed775ee7SAntonio Huete Jimenez length = GET_BE_U_2(cp);
176*ed775ee7SAntonio Huete Jimenez OF_FWD(2);
177*ed775ee7SAntonio Huete Jimenez ND_PRINT(", length %u%s", length,
178*ed775ee7SAntonio Huete Jimenez length < OF_HEADER_FIXLEN ? " (too short!)" : "");
179*ed775ee7SAntonio Huete Jimenez /* xid */
180*ed775ee7SAntonio Huete Jimenez if (len < 4)
181*ed775ee7SAntonio Huete Jimenez goto partial_header;
182*ed775ee7SAntonio Huete Jimenez ND_PRINT(", xid 0x%08x", GET_BE_U_4(cp));
183*ed775ee7SAntonio Huete Jimenez OF_FWD(4);
184*ed775ee7SAntonio Huete Jimenez
185*ed775ee7SAntonio Huete Jimenez /*
186*ed775ee7SAntonio Huete Jimenez * When a TCP packet can contain several protocol messages,
187*ed775ee7SAntonio Huete Jimenez * and at the same time a protocol message can span several
188*ed775ee7SAntonio Huete Jimenez * TCP packets, decoding an incomplete message at the end of
189*ed775ee7SAntonio Huete Jimenez * a TCP packet requires attention to detail in this loop.
190*ed775ee7SAntonio Huete Jimenez *
191*ed775ee7SAntonio Huete Jimenez * Message length includes the header length and a message
192*ed775ee7SAntonio Huete Jimenez * always includes the basic header. A message length underrun
193*ed775ee7SAntonio Huete Jimenez * fails decoding of the rest of the current packet. At the
194*ed775ee7SAntonio Huete Jimenez * same time, try decoding as much of the current message as
195*ed775ee7SAntonio Huete Jimenez * possible even when it does not end within the current TCP
196*ed775ee7SAntonio Huete Jimenez * segment.
197*ed775ee7SAntonio Huete Jimenez *
198*ed775ee7SAntonio Huete Jimenez * Specifically, to try to process the message body in this
199*ed775ee7SAntonio Huete Jimenez * iteration do NOT require the header "length" to be small
200*ed775ee7SAntonio Huete Jimenez * enough for the full declared OpenFlow message to fit into
201*ed775ee7SAntonio Huete Jimenez * the remainder of the declared TCP segment, same as the full
202*ed775ee7SAntonio Huete Jimenez * declared TCP segment is not required to fit into the
203*ed775ee7SAntonio Huete Jimenez * captured packet buffer.
204*ed775ee7SAntonio Huete Jimenez *
205*ed775ee7SAntonio Huete Jimenez * But DO require the same at the end of this iteration to
206*ed775ee7SAntonio Huete Jimenez * decrement "len" and to proceed to the next iteration.
207*ed775ee7SAntonio Huete Jimenez * (Ideally the declared TCP payload end will be at or after
208*ed775ee7SAntonio Huete Jimenez * the captured packet buffer end, but stay safe even when
209*ed775ee7SAntonio Huete Jimenez * that's somehow not the case.)
210*ed775ee7SAntonio Huete Jimenez */
211*ed775ee7SAntonio Huete Jimenez if (length < OF_HEADER_FIXLEN)
212*ed775ee7SAntonio Huete Jimenez goto invalid;
213*ed775ee7SAntonio Huete Jimenez
214*ed775ee7SAntonio Huete Jimenez of_message_print(ndo, cp, length - OF_HEADER_FIXLEN, mti);
215*ed775ee7SAntonio Huete Jimenez if (length - OF_HEADER_FIXLEN > len)
216*ed775ee7SAntonio Huete Jimenez break;
217*ed775ee7SAntonio Huete Jimenez OF_FWD(length - OF_HEADER_FIXLEN);
218*ed775ee7SAntonio Huete Jimenez } /* while (len) */
219*ed775ee7SAntonio Huete Jimenez return;
220*ed775ee7SAntonio Huete Jimenez
221*ed775ee7SAntonio Huete Jimenez partial_header:
222*ed775ee7SAntonio Huete Jimenez ND_PRINT(" (end of TCP payload)");
223*ed775ee7SAntonio Huete Jimenez ND_TCHECK_LEN(cp, len);
224*ed775ee7SAntonio Huete Jimenez return;
225*ed775ee7SAntonio Huete Jimenez invalid: /* fail the current packet */
226*ed775ee7SAntonio Huete Jimenez nd_print_invalid(ndo);
227*ed775ee7SAntonio Huete Jimenez ND_TCHECK_LEN(cp, len);
228411677aeSAaron LI }
229