xref: /netbsd/external/bsd/tcpdump/dist/print-lwapp.c (revision 6550d01e)
1 /*
2  * Copyright (c) 1998-2007 The TCPDUMP project
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that: (1) source code
6  * distributions retain the above copyright notice and this paragraph
7  * in its entirety, and (2) distributions including binary code include
8  * the above copyright notice and this paragraph in its entirety in
9  * the documentation or other materials provided with the distribution.
10  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
11  * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
12  * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
13  * FOR A PARTICULAR PURPOSE.
14  *
15  * Support for the Light Weight Access Point Protocol as per draft-ohara-capwap-lwapp-04
16  *
17  * Original code by Carles Kishimoto <carles.kishimoto@gmail.com>
18  */
19 
20 #include <sys/cdefs.h>
21 #ifndef lint
22 #if 0
23 static const char rcsid[] _U_ =
24 "@(#) Header: /tcpdump/master/tcpdump/print-lwapp.c,v 1.1 2007-07-24 16:07:30 hannes Exp";
25 #else
26 __RCSID("$NetBSD: print-lwapp.c,v 1.2 2010/12/05 05:11:30 christos Exp $");
27 #endif
28 #endif
29 
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33 
34 #include <tcpdump-stdinc.h>
35 
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <string.h>
39 
40 #include "interface.h"
41 #include "extract.h"
42 #include "addrtoname.h"
43 
44 /*
45  * LWAPP transport (common) header
46  *      0                   1                   2                   3
47  *     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
48  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49  *    |VER| RID |C|F|L|    Frag ID    |            Length             |
50  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51  *    |          Status/WLANs         |   Payload...  |
52  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53  *
54  */
55 
56 struct lwapp_transport_header {
57     u_int8_t  version;
58     u_int8_t  frag_id;
59     u_int8_t  length[2];
60     u_int16_t status;
61 };
62 
63 /*
64  * LWAPP control header
65  *      0                   1                   2                   3
66  *      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
67  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
68  *     |  Message Type |    Seq Num    |      Msg Element Length       |
69  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
70  *     |                           Session ID                          |
71  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
72  *     |      Msg Element [0..N]       |
73  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
74  */
75 
76 struct lwapp_control_header {
77     u_int8_t  msg_type;
78     u_int8_t  seq_num;
79     u_int8_t  len[2];
80     u_int8_t  session_id[4];
81 };
82 
83 #define LWAPP_VERSION 0
84 #define	LWAPP_EXTRACT_VERSION(x) (((x)&0xC0)>>6)
85 #define	LWAPP_EXTRACT_RID(x) (((x)&0x38)>>3)
86 #define LWAPP_EXTRACT_CONTROL_BIT(x) (((x)&0x04)>>2)
87 
88 static const struct tok lwapp_header_bits_values[] = {
89     { 0x01, "Last Fragment Bit"},
90     { 0x02, "Fragment Bit"},
91     { 0x04, "Control Bit"},
92     { 0, NULL}
93 };
94 
95 #define	LWAPP_MSGTYPE_DISCOVERY_REQUEST			1
96 #define	LWAPP_MSGTYPE_DISCOVERY_RESPONSE		2
97 #define	LWAPP_MSGTYPE_JOIN_REQUEST			3
98 #define LWAPP_MSGTYPE_JOIN_RESPONSE			4
99 #define LWAPP_MSGTYPE_JOIN_ACK				5
100 #define LWAPP_MSGTYPE_JOIN_CONFIRM			6
101 #define LWAPP_MSGTYPE_CONFIGURE_REQUEST			10
102 #define LWAPP_MSGTYPE_CONFIGURE_RESPONSE		11
103 #define LWAPP_MSGTYPE_CONF_UPDATE_REQUEST		12
104 #define LWAPP_MSGTYPE_CONF_UPDATE_RESPONSE		13
105 #define LWAPP_MSGTYPE_WTP_EVENT_REQUEST			14
106 #define LWAPP_MSGTYPE_WTP_EVENT_RESPONSE		15
107 #define LWAPP_MSGTYPE_CHANGE_STATE_EVENT_REQUEST	16
108 #define LWAPP_MSGTYPE_CHANGE_STATE_EVENT_RESPONSE	17
109 #define LWAPP_MSGTYPE_ECHO_REQUEST			22
110 #define LWAPP_MSGTYPE_ECHO_RESPONSE			23
111 #define LWAPP_MSGTYPE_IMAGE_DATA_REQUEST		24
112 #define LWAPP_MSGTYPE_IMAGE_DATA_RESPONSE		25
113 #define LWAPP_MSGTYPE_RESET_REQUEST			26
114 #define LWAPP_MSGTYPE_RESET_RESPONSE			27
115 #define LWAPP_MSGTYPE_KEY_UPDATE_REQUEST		30
116 #define LWAPP_MSGTYPE_KEY_UPDATE_RESPONSE		31
117 #define LWAPP_MSGTYPE_PRIMARY_DISCOVERY_REQUEST		32
118 #define LWAPP_MSGTYPE_PRIMARY_DISCOVERY_RESPONSE	33
119 #define LWAPP_MSGTYPE_DATA_TRANSFER_REQUEST		34
120 #define LWAPP_MSGTYPE_DATA_TRANSFER_RESPONSE		35
121 #define LWAPP_MSGTYPE_CLEAR_CONFIG_INDICATION		36
122 #define LWAPP_MSGTYPE_WLAN_CONFIG_REQUEST		37
123 #define LWAPP_MSGTYPE_WLAN_CONFIG_RESPONSE		38
124 #define LWAPP_MSGTYPE_MOBILE_CONFIG_REQUEST		39
125 #define LWAPP_MSGTYPE_MOBILE_CONFIG_RESPONSE		40
126 
127 static const struct tok lwapp_msg_type_values[] = {
128     { LWAPP_MSGTYPE_DISCOVERY_REQUEST, "Discovery req"},
129     { LWAPP_MSGTYPE_DISCOVERY_RESPONSE, "Discovery resp"},
130     { LWAPP_MSGTYPE_JOIN_REQUEST, "Join req"},
131     { LWAPP_MSGTYPE_JOIN_RESPONSE, "Join resp"},
132     { LWAPP_MSGTYPE_JOIN_ACK, "Join ack"},
133     { LWAPP_MSGTYPE_JOIN_CONFIRM, "Join confirm"},
134     { LWAPP_MSGTYPE_CONFIGURE_REQUEST, "Configure req"},
135     { LWAPP_MSGTYPE_CONFIGURE_RESPONSE, "Configure resp"},
136     { LWAPP_MSGTYPE_CONF_UPDATE_REQUEST, "Update req"},
137     { LWAPP_MSGTYPE_CONF_UPDATE_RESPONSE, "Update resp"},
138     { LWAPP_MSGTYPE_WTP_EVENT_REQUEST, "WTP event req"},
139     { LWAPP_MSGTYPE_WTP_EVENT_RESPONSE, "WTP event resp"},
140     { LWAPP_MSGTYPE_CHANGE_STATE_EVENT_REQUEST, "Change state event req"},
141     { LWAPP_MSGTYPE_CHANGE_STATE_EVENT_RESPONSE, "Change state event resp"},
142     { LWAPP_MSGTYPE_ECHO_REQUEST, "Echo req"},
143     { LWAPP_MSGTYPE_ECHO_RESPONSE, "Echo resp"},
144     { LWAPP_MSGTYPE_IMAGE_DATA_REQUEST, "Image data req"},
145     { LWAPP_MSGTYPE_IMAGE_DATA_RESPONSE, "Image data resp"},
146     { LWAPP_MSGTYPE_RESET_REQUEST, "Channel status req"},
147     { LWAPP_MSGTYPE_RESET_RESPONSE, "Channel status resp"},
148     { LWAPP_MSGTYPE_KEY_UPDATE_REQUEST, "Key update req"},
149     { LWAPP_MSGTYPE_KEY_UPDATE_RESPONSE, "Key update resp"},
150     { LWAPP_MSGTYPE_PRIMARY_DISCOVERY_REQUEST, "Primary discovery req"},
151     { LWAPP_MSGTYPE_PRIMARY_DISCOVERY_RESPONSE, "Primary discovery resp"},
152     { LWAPP_MSGTYPE_DATA_TRANSFER_REQUEST, "Data transfer req"},
153     { LWAPP_MSGTYPE_DATA_TRANSFER_RESPONSE, "Data transfer resp"},
154     { LWAPP_MSGTYPE_CLEAR_CONFIG_INDICATION, "Clear config ind"},
155     { LWAPP_MSGTYPE_WLAN_CONFIG_REQUEST, "Wlan config req"},
156     { LWAPP_MSGTYPE_WLAN_CONFIG_RESPONSE, "Wlan config resp"},
157     { LWAPP_MSGTYPE_MOBILE_CONFIG_REQUEST, "Mobile config req"},
158     { LWAPP_MSGTYPE_MOBILE_CONFIG_RESPONSE, "Mobile config resp"},
159     { 0, NULL}
160 };
161 
162 /*
163  * LWAPP message elements
164  *
165  * 0                   1                   2                   3
166  * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
167  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
168  * |      Type     |             Length            |   Value ...   |
169  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
170  */
171 struct lwapp_message_header {
172     u_int8_t type;
173     u_int8_t length[2];
174 };
175 
176 void
177 lwapp_control_print(const u_char *pptr, u_int len, int has_ap_ident) {
178 
179     const struct lwapp_transport_header *lwapp_trans_header;
180     const struct lwapp_control_header *lwapp_control_header;
181     const u_char *tptr;
182     int hexdump,tlen;
183     int  msg_tlen;
184 
185     tptr=pptr;
186 
187     if (has_ap_ident) {
188         /* check if enough bytes for AP identity */
189         if (!TTEST2(*tptr, 6))
190             goto trunc;
191         lwapp_trans_header = (const struct lwapp_transport_header *)(pptr+6);
192     } else {
193         lwapp_trans_header = (const struct lwapp_transport_header *)pptr;
194     }
195     TCHECK(*lwapp_trans_header);
196 
197     /*
198      * Sanity checking of the header.
199      */
200     if (LWAPP_EXTRACT_VERSION(lwapp_trans_header->version) != LWAPP_VERSION) {
201 	printf("LWAPP version %u packet not supported",
202                LWAPP_EXTRACT_VERSION(lwapp_trans_header->version));
203 	return;
204     }
205 
206     /* non-verbose */
207     if (vflag < 1) {
208         printf("LWAPPv%u, %s frame, Flags [%s], length %u",
209                LWAPP_EXTRACT_VERSION(lwapp_trans_header->version),
210                LWAPP_EXTRACT_CONTROL_BIT(lwapp_trans_header->version) ? "Control" : "Data",
211                bittok2str(lwapp_header_bits_values,"none",(lwapp_trans_header->version)&0x07),
212                len);
213         return;
214     }
215 
216     /* ok they seem to want to know everything - lets fully decode it */
217     tlen=EXTRACT_16BITS(lwapp_trans_header->length);
218 
219     printf("LWAPPv%u, %s frame, Radio-id %u, Flags [%s], Frag-id %u, length %u",
220            LWAPP_EXTRACT_VERSION(lwapp_trans_header->version),
221            LWAPP_EXTRACT_CONTROL_BIT(lwapp_trans_header->version) ? "Control" : "Data",
222            LWAPP_EXTRACT_RID(lwapp_trans_header->version),
223            bittok2str(lwapp_header_bits_values,"none",(lwapp_trans_header->version)&0x07),
224 	   lwapp_trans_header->frag_id,
225 	   tlen);
226 
227     if (has_ap_ident) {
228         printf("\n\tAP identity: %s",
229                etheraddr_string(tptr));
230         tptr+=sizeof(const struct lwapp_transport_header)+6;
231     } else {
232         tptr+=sizeof(const struct lwapp_transport_header);
233     }
234 
235     while(tlen>0) {
236 
237         /* did we capture enough for fully decoding the object header ? */
238         if (!TTEST2(*tptr, sizeof(struct lwapp_control_header)))
239             goto trunc;
240 
241         lwapp_control_header = (const struct lwapp_control_header *)tptr;
242 	msg_tlen = EXTRACT_16BITS(lwapp_control_header->len);
243 
244 	/* print message header */
245         printf("\n\t  Msg type: %s (%u), Seqnum: %u, Msg len: %d, Session: 0x%08x",
246                tok2str(lwapp_msg_type_values,"Unknown",lwapp_control_header->msg_type),
247                lwapp_control_header->msg_type,
248                lwapp_control_header->seq_num,
249                msg_tlen,
250                EXTRACT_32BITS(lwapp_control_header->session_id));
251 
252         /* did we capture enough for fully decoding the message */
253         if (!TTEST2(*tptr, msg_tlen))
254             goto trunc;
255         hexdump=FALSE;
256 
257 	/* XXX - Decode sub messages for each message */
258         switch(lwapp_control_header->msg_type) {
259         case LWAPP_MSGTYPE_DISCOVERY_REQUEST:
260         case LWAPP_MSGTYPE_DISCOVERY_RESPONSE:
261         case LWAPP_MSGTYPE_JOIN_REQUEST:
262         case LWAPP_MSGTYPE_JOIN_RESPONSE:
263         case LWAPP_MSGTYPE_JOIN_ACK:
264         case LWAPP_MSGTYPE_JOIN_CONFIRM:
265         case LWAPP_MSGTYPE_CONFIGURE_REQUEST:
266         case LWAPP_MSGTYPE_CONFIGURE_RESPONSE:
267         case LWAPP_MSGTYPE_CONF_UPDATE_REQUEST:
268         case LWAPP_MSGTYPE_CONF_UPDATE_RESPONSE:
269         case LWAPP_MSGTYPE_WTP_EVENT_REQUEST:
270         case LWAPP_MSGTYPE_WTP_EVENT_RESPONSE:
271         case LWAPP_MSGTYPE_CHANGE_STATE_EVENT_REQUEST:
272         case LWAPP_MSGTYPE_CHANGE_STATE_EVENT_RESPONSE:
273         case LWAPP_MSGTYPE_ECHO_REQUEST:
274         case LWAPP_MSGTYPE_ECHO_RESPONSE:
275         case LWAPP_MSGTYPE_IMAGE_DATA_REQUEST:
276         case LWAPP_MSGTYPE_IMAGE_DATA_RESPONSE:
277         case LWAPP_MSGTYPE_RESET_REQUEST:
278         case LWAPP_MSGTYPE_RESET_RESPONSE:
279         case LWAPP_MSGTYPE_KEY_UPDATE_REQUEST:
280         case LWAPP_MSGTYPE_KEY_UPDATE_RESPONSE:
281         case LWAPP_MSGTYPE_PRIMARY_DISCOVERY_REQUEST:
282         case LWAPP_MSGTYPE_PRIMARY_DISCOVERY_RESPONSE:
283         case LWAPP_MSGTYPE_DATA_TRANSFER_REQUEST:
284         case LWAPP_MSGTYPE_DATA_TRANSFER_RESPONSE:
285         case LWAPP_MSGTYPE_CLEAR_CONFIG_INDICATION:
286         case LWAPP_MSGTYPE_WLAN_CONFIG_REQUEST:
287         case LWAPP_MSGTYPE_WLAN_CONFIG_RESPONSE:
288         case LWAPP_MSGTYPE_MOBILE_CONFIG_REQUEST:
289         case LWAPP_MSGTYPE_MOBILE_CONFIG_RESPONSE:
290         default:
291             break;
292         }
293 
294         tptr += sizeof(struct lwapp_control_header) + msg_tlen;
295         tlen -= sizeof(struct lwapp_control_header) + msg_tlen;
296     }
297     return;
298 
299  trunc:
300     printf("\n\t\t packet exceeded snapshot");
301 }
302 
303 void
304 lwapp_data_print(const u_char *pptr, u_int len) {
305 
306     const struct lwapp_transport_header *lwapp_trans_header;
307     const u_char *tptr;
308     int tlen;
309 
310     tptr=pptr;
311 
312     /* check if enough bytes for AP identity */
313     if (!TTEST2(*tptr, 6))
314         goto trunc;
315     lwapp_trans_header = (const struct lwapp_transport_header *)pptr;
316     TCHECK(*lwapp_trans_header);
317 
318     /*
319      * Sanity checking of the header.
320      */
321     if (LWAPP_EXTRACT_VERSION(lwapp_trans_header->version) != LWAPP_VERSION) {
322         printf("LWAPP version %u packet not supported",
323                LWAPP_EXTRACT_VERSION(lwapp_trans_header->version));
324         return;
325     }
326 
327     /* non-verbose */
328     if (vflag < 1) {
329         printf("LWAPPv%u, %s frame, Flags [%s], length %u",
330                LWAPP_EXTRACT_VERSION(lwapp_trans_header->version),
331                LWAPP_EXTRACT_CONTROL_BIT(lwapp_trans_header->version) ? "Control" : "Data",
332                bittok2str(lwapp_header_bits_values,"none",(lwapp_trans_header->version)&0x07),
333                len);
334         return;
335     }
336 
337     /* ok they seem to want to know everything - lets fully decode it */
338     tlen=EXTRACT_16BITS(lwapp_trans_header->length);
339 
340     printf("LWAPPv%u, %s frame, Radio-id  %u, Flags [%s], Frag-id  %u, length %u",
341            LWAPP_EXTRACT_VERSION(lwapp_trans_header->version),
342            LWAPP_EXTRACT_CONTROL_BIT(lwapp_trans_header->version) ? "Control" : "Data",
343            LWAPP_EXTRACT_RID(lwapp_trans_header->version),
344            bittok2str(lwapp_header_bits_values,"none",(lwapp_trans_header->version)&0x07),
345            lwapp_trans_header->frag_id,
346            tlen);
347 
348     tptr+=sizeof(const struct lwapp_transport_header);
349     tlen-=sizeof(const struct lwapp_transport_header);
350 
351     /* FIX - An IEEE 802.11 frame follows - hexdump for now */
352     print_unknown_data(tptr, "\n\t", tlen);
353 
354     return;
355 
356  trunc:
357     printf("\n\t\t packet exceeded snapshot");
358 }
359 
360 /*
361  * Local Variables:
362  * c-style: whitesmith
363  * c-basic-offset: 8
364  * End:
365  */
366