1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/* packet-xnap.c
* Routines for dissecting NG-RAN Xn application protocol (XnAP)
* 3GPP TS 38.423 packet dissection
* Copyright 2018-2019, Pascal Quantin <pascal@wireshark.org>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* Ref:
* 3GPP TS 38.423 V15.4.0 (2019-07)
*/
#include "config.h"
#include <epan/packet.h>
#include <epan/asn1.h>
#include <epan/prefs.h>
#include <epan/sctpppids.h>
#include <epan/proto_data.h>
#include <epan/conversation.h>
#include "packet-per.h"
#include "packet-lte-rrc.h"
#include "packet-nr-rrc.h"
#include "packet-e212.h"
#include "packet-ngap.h"
#include "packet-s1ap.h"
#include "packet-ranap.h"
#include "packet-ntp.h"
#ifdef _MSC_VER
/* disable: "warning C4146: unary minus operator applied to unsigned type, result still unsigned" */
#pragma warning(disable:4146)
#endif
#define PNAME "NG-RAN Xn Application Protocol (XnAP)"
#define PSNAME "XnAP"
#define PFNAME "xnap"
/* Dissector will use SCTP PPID 61 or SCTP port. IANA assigned port = 38422 */
#define SCTP_PORT_XnAP 38422
#include "packet-xnap-val.h"
/* Initialize the protocol and registered fields */
static int proto_xnap = -1;
static int hf_xnap_transportLayerAddressIPv4 = -1;
static int hf_xnap_transportLayerAddressIPv6 = -1;
static int hf_xnap_ng_ran_TraceID_TraceID = -1;
static int hf_xnap_ng_ran_TraceID_TraceRecordingSessionReference = -1;
#include "packet-xnap-hf.c"
/* Initialize the subtree pointers */
static gint ett_xnap = -1;
static gint ett_xnap_RRC_Context = -1;
static gint ett_nxap_container = -1;
static gint ett_xnap_PLMN_Identity = -1;
static gint ett_xnap_measurementTimingConfiguration = -1;
static gint ett_xnap_TransportLayerAddress = -1;
static gint ett_xnap_ng_ran_TraceID = -1;
static gint ett_xnap_LastVisitedEUTRANCellInformation = -1;
static gint ett_xnap_LastVisitedNGRANCellInformation = -1;
static gint ett_xnap_LastVisitedUTRANCellInformation = -1;
static gint ett_xnap_LastVisitedGERANCellInformation = -1;
static gint ett_xnap_UERadioCapabilityForPagingOfNR = -1;
static gint ett_xnap_UERadioCapabilityForPagingOfEUTRA = -1;
#include "packet-xnap-ett.c"
enum {
XNAP_NG_RAN_CONTAINER_AUTOMATIC,
XNAP_NG_RAN_CONTAINER_GNB,
XNAP_NG_RAN_CONTAINER_NG_ENB
};
static const enum_val_t xnap_target_ng_ran_container_vals[] = {
{"automatic", "automatic", XNAP_NG_RAN_CONTAINER_AUTOMATIC},
{"gnb", "gNB", XNAP_NG_RAN_CONTAINER_GNB},
{"ng-enb","ng-eNB", XNAP_NG_RAN_CONTAINER_NG_ENB},
{NULL, NULL, -1}
};
/* Global variables */
static guint xnap_sctp_port = SCTP_PORT_XnAP;
static gint xnap_dissect_target_ng_ran_container_as = XNAP_NG_RAN_CONTAINER_AUTOMATIC;
/* Dissector tables */
static dissector_table_t xnap_ies_dissector_table;
static dissector_table_t xnap_extension_dissector_table;
static dissector_table_t xnap_proc_imsg_dissector_table;
static dissector_table_t xnap_proc_sout_dissector_table;
static dissector_table_t xnap_proc_uout_dissector_table;
void proto_register_xnap(void);
void proto_reg_handoff_xnap(void);
static int dissect_ProtocolIEFieldValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
static int dissect_ProtocolExtensionFieldExtensionValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
static int dissect_InitiatingMessageValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
static int dissect_SuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
static int dissect_UnsuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
static int dissect_XnAP_PDU_PDU(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void *data _U_);
static dissector_handle_t xnap_handle;
static void
xnap_PacketLossRate_fmt(gchar *s, guint32 v)
{
g_snprintf(s, ITEM_LABEL_LENGTH, "%.1f%% (%u)", (float)v/10, v);
}
static void
xnap_PacketDelayBudget_fmt(gchar *s, guint32 v)
{
g_snprintf(s, ITEM_LABEL_LENGTH, "%.1fms (%u)", (float)v/2, v);
}
typedef enum {
INITIATING_MESSAGE,
SUCCESSFUL_OUTCOME,
UNSUCCESSFUL_OUTCOME
} xnap_message_type;
struct xnap_conv_info {
address addr_a;
guint32 port_a;
GlobalNG_RANNode_ID_enum ranmode_id_a;
address addr_b;
guint32 port_b;
GlobalNG_RANNode_ID_enum ranmode_id_b;
};
struct xnap_private_data {
struct xnap_conv_info *xnap_conv;
xnap_message_type message_type;
guint32 procedure_code;
guint32 protocol_ie_id;
};
static struct xnap_private_data*
xnap_get_private_data(packet_info *pinfo)
{
struct xnap_private_data *xnap_data = (struct xnap_private_data*)p_get_proto_data(pinfo->pool, pinfo, proto_xnap, 0);
if (!xnap_data) {
xnap_data = wmem_new0(pinfo->pool, struct xnap_private_data);
p_add_proto_data(pinfo->pool, pinfo, proto_xnap, 0, xnap_data);
}
return xnap_data;
}
static GlobalNG_RANNode_ID_enum
xnap_get_ranmode_id(address *addr, guint32 port, packet_info *pinfo)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
GlobalNG_RANNode_ID_enum ranmode_id = (GlobalNG_RANNode_ID_enum)-1;
if (xnap_data->xnap_conv) {
if (addresses_equal(addr, &xnap_data->xnap_conv->addr_a) && port == xnap_data->xnap_conv->port_a) {
ranmode_id = xnap_data->xnap_conv->ranmode_id_a;
} else if (addresses_equal(addr, &xnap_data->xnap_conv->addr_b) && port == xnap_data->xnap_conv->port_b) {
ranmode_id = xnap_data->xnap_conv->ranmode_id_b;
}
}
return ranmode_id;
}
#include "packet-xnap-fn.c"
static int dissect_ProtocolIEFieldValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
return (dissector_try_uint_new(xnap_ies_dissector_table, xnap_data->protocol_ie_id, tvb, pinfo, tree, FALSE, NULL)) ? tvb_captured_length(tvb) : 0;
}
static int dissect_ProtocolExtensionFieldExtensionValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
return (dissector_try_uint_new(xnap_extension_dissector_table, xnap_data->protocol_ie_id, tvb, pinfo, tree, FALSE, NULL)) ? tvb_captured_length(tvb) : 0;
}
static int dissect_InitiatingMessageValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
return (dissector_try_uint_new(xnap_proc_imsg_dissector_table, xnap_data->procedure_code, tvb, pinfo, tree, FALSE, NULL)) ? tvb_captured_length(tvb) : 0;
}
static int dissect_SuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
return (dissector_try_uint_new(xnap_proc_sout_dissector_table, xnap_data->procedure_code, tvb, pinfo, tree, FALSE, NULL)) ? tvb_captured_length(tvb) : 0;
}
static int dissect_UnsuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
struct xnap_private_data *xnap_data = xnap_get_private_data(pinfo);
return (dissector_try_uint_new(xnap_proc_uout_dissector_table, xnap_data->procedure_code, tvb, pinfo, tree, FALSE, NULL)) ? tvb_captured_length(tvb) : 0;
}
static int
dissect_xnap(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)
{
proto_item *xnap_item;
proto_tree *xnap_tree;
conversation_t *conversation;
struct xnap_private_data* xnap_data;
col_set_str(pinfo->cinfo, COL_PROTOCOL, "XnAP");
col_clear_fence(pinfo->cinfo, COL_INFO);
col_clear(pinfo->cinfo, COL_INFO);
xnap_item = proto_tree_add_item(tree, proto_xnap, tvb, 0, -1, ENC_NA);
xnap_tree = proto_item_add_subtree(xnap_item, ett_xnap);
xnap_data = xnap_get_private_data(pinfo);
conversation = find_or_create_conversation(pinfo);
xnap_data->xnap_conv = (struct xnap_conv_info *)conversation_get_proto_data(conversation, proto_xnap);
if (!xnap_data->xnap_conv) {
xnap_data->xnap_conv = wmem_new0(wmem_file_scope(), struct xnap_conv_info);
copy_address_wmem(wmem_file_scope(), &xnap_data->xnap_conv->addr_a, &pinfo->src);
xnap_data->xnap_conv->port_a = pinfo->srcport;
xnap_data->xnap_conv->ranmode_id_a = (GlobalNG_RANNode_ID_enum)-1;
copy_address_wmem(wmem_file_scope(), &xnap_data->xnap_conv->addr_b, &pinfo->dst);
xnap_data->xnap_conv->port_b = pinfo->destport;
xnap_data->xnap_conv->ranmode_id_b = (GlobalNG_RANNode_ID_enum)-1;
conversation_add_proto_data(conversation, proto_xnap, xnap_data->xnap_conv);
}
return dissect_XnAP_PDU_PDU(tvb, pinfo, xnap_tree, data);
}
void proto_register_xnap(void) {
/* List of fields */
static hf_register_info hf[] = {
{ &hf_xnap_transportLayerAddressIPv4,
{ "TransportLayerAddress (IPv4)", "xnap.TransportLayerAddressIPv4",
FT_IPv4, BASE_NONE, NULL, 0,
NULL, HFILL }},
{ &hf_xnap_transportLayerAddressIPv6,
{ "TransportLayerAddress (IPv6)", "xnap.TransportLayerAddressIPv6",
FT_IPv6, BASE_NONE, NULL, 0,
NULL, HFILL }},
{ &hf_xnap_ng_ran_TraceID_TraceID,
{ "TraceID", "xnap.ng_ran_TraceID.TraceID",
FT_UINT24, BASE_HEX, NULL, 0,
NULL, HFILL }},
{ &hf_xnap_ng_ran_TraceID_TraceRecordingSessionReference,
{ "TraceRecordingSessionReference", "xnap.ng_ran_TraceID.TraceRecordingSessionReference",
FT_UINT16, BASE_HEX, NULL, 0,
NULL, HFILL }},
#include "packet-xnap-hfarr.c"
};
/* List of subtrees */
static gint *ett[] = {
&ett_xnap,
&ett_xnap_RRC_Context,
&ett_nxap_container,
&ett_xnap_PLMN_Identity,
&ett_xnap_measurementTimingConfiguration,
&ett_xnap_TransportLayerAddress,
&ett_xnap_ng_ran_TraceID,
&ett_xnap_LastVisitedEUTRANCellInformation,
&ett_xnap_LastVisitedNGRANCellInformation,
&ett_xnap_LastVisitedUTRANCellInformation,
&ett_xnap_LastVisitedGERANCellInformation,
&ett_xnap_UERadioCapabilityForPagingOfNR,
&ett_xnap_UERadioCapabilityForPagingOfEUTRA,
#include "packet-xnap-ettarr.c"
};
module_t *xnap_module;
proto_xnap = proto_register_protocol(PNAME, PSNAME, PFNAME);
proto_register_field_array(proto_xnap, hf, array_length(hf));
proto_register_subtree_array(ett, array_length(ett));
xnap_handle = register_dissector("xnap", dissect_xnap, proto_xnap);
xnap_ies_dissector_table = register_dissector_table("xnap.ies", "XNAP-PROTOCOL-IES", proto_xnap, FT_UINT32, BASE_DEC);
xnap_extension_dissector_table = register_dissector_table("xnap.extension", "XNAP-PROTOCOL-EXTENSION", proto_xnap, FT_UINT32, BASE_DEC);
xnap_proc_imsg_dissector_table = register_dissector_table("xnap.proc.imsg", "XNAP-ELEMENTARY-PROCEDURE InitiatingMessage", proto_xnap, FT_UINT32, BASE_DEC);
xnap_proc_sout_dissector_table = register_dissector_table("xnap.proc.sout", "XNAP-ELEMENTARY-PROCEDURE SuccessfulOutcome", proto_xnap, FT_UINT32, BASE_DEC);
xnap_proc_uout_dissector_table = register_dissector_table("xnap.proc.uout", "XNAP-ELEMENTARY-PROCEDURE UnsuccessfulOutcome", proto_xnap, FT_UINT32, BASE_DEC);
xnap_module = prefs_register_protocol(proto_xnap, proto_reg_handoff_xnap);
prefs_register_uint_preference(xnap_module, "sctp.port",
"XnAP SCTP Port",
"Set the SCTP port for XnAP messages",
10,
&xnap_sctp_port);
prefs_register_enum_preference(xnap_module, "dissect_target_ng_ran_container_as", "Dissect target NG-RAN container as",
"Select whether target NG-RAN container should be decoded automatically"
" (based on Xn Setup procedure) or manually",
&xnap_dissect_target_ng_ran_container_as, xnap_target_ng_ran_container_vals, FALSE);
}
void
proto_reg_handoff_xnap(void)
{
static gboolean initialized = FALSE;
static guint sctp_port;
if (!initialized) {
dissector_add_for_decode_as("sctp.port", xnap_handle);
dissector_add_uint("sctp.ppi", XNAP_PROTOCOL_ID, xnap_handle);
initialized = TRUE;
#include "packet-xnap-dis-tab.c"
} else {
if (sctp_port != 0) {
dissector_delete_uint("sctp.port", sctp_port, xnap_handle);
}
}
sctp_port = xnap_sctp_port;
if (sctp_port != 0) {
dissector_add_uint("sctp.port", sctp_port, xnap_handle);
}
}
|
