1 /* Copyright (c) 2013, The TCPDUMP project 2 * All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * 1. Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 16 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 17 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 20 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25 /* \summary: Message Transfer Part 3 (MTP3) User Adaptation Layer (M3UA) printer */ 26 27 /* RFC 4666 */ 28 29 #include <config.h> 30 31 #include "netdissect-stdinc.h" 32 33 #define ND_LONGJMP_FROM_TCHECK 34 #include "netdissect.h" 35 #include "extract.h" 36 37 38 #define M3UA_REL_1_0 1 39 40 struct m3ua_common_header { 41 nd_uint8_t v; 42 nd_uint8_t reserved; 43 nd_uint8_t msg_class; 44 nd_uint8_t msg_type; 45 nd_uint32_t len; 46 }; 47 48 struct m3ua_param_header { 49 nd_uint16_t tag; 50 nd_uint16_t len; 51 }; 52 53 /* message classes */ 54 #define M3UA_MSGC_MGMT 0 55 #define M3UA_MSGC_TRANSFER 1 56 #define M3UA_MSGC_SSNM 2 57 #define M3UA_MSGC_ASPSM 3 58 #define M3UA_MSGC_ASPTM 4 59 /* reserved values */ 60 #define M3UA_MSGC_RKM 9 61 62 static const struct tok MessageClasses[] = { 63 { M3UA_MSGC_MGMT, "Management" }, 64 { M3UA_MSGC_TRANSFER, "Transfer" }, 65 { M3UA_MSGC_SSNM, "SS7" }, 66 { M3UA_MSGC_ASPSM, "ASP" }, 67 { M3UA_MSGC_ASPTM, "ASP" }, 68 { M3UA_MSGC_RKM, "Routing Key Management"}, 69 { 0, NULL } 70 }; 71 72 /* management messages */ 73 #define M3UA_MGMT_ERROR 0 74 #define M3UA_MGMT_NOTIFY 1 75 76 static const struct tok MgmtMessages[] = { 77 { M3UA_MGMT_ERROR, "Error" }, 78 { M3UA_MGMT_NOTIFY, "Notify" }, 79 { 0, NULL } 80 }; 81 82 /* transfer messages */ 83 #define M3UA_TRANSFER_DATA 1 84 85 static const struct tok TransferMessages[] = { 86 { M3UA_TRANSFER_DATA, "Data" }, 87 { 0, NULL } 88 }; 89 90 /* SS7 Signaling Network Management messages */ 91 #define M3UA_SSNM_DUNA 1 92 #define M3UA_SSNM_DAVA 2 93 #define M3UA_SSNM_DAUD 3 94 #define M3UA_SSNM_SCON 4 95 #define M3UA_SSNM_DUPU 5 96 #define M3UA_SSNM_DRST 6 97 98 static const struct tok SS7Messages[] = { 99 { M3UA_SSNM_DUNA, "Destination Unavailable" }, 100 { M3UA_SSNM_DAVA, "Destination Available" }, 101 { M3UA_SSNM_DAUD, "Destination State Audit" }, 102 { M3UA_SSNM_SCON, "Signalling Congestion" }, 103 { M3UA_SSNM_DUPU, "Destination User Part Unavailable" }, 104 { M3UA_SSNM_DRST, "Destination Restricted" }, 105 { 0, NULL } 106 }; 107 108 /* ASP State Maintenance messages */ 109 #define M3UA_ASP_UP 1 110 #define M3UA_ASP_DN 2 111 #define M3UA_ASP_BEAT 3 112 #define M3UA_ASP_UP_ACK 4 113 #define M3UA_ASP_DN_ACK 5 114 #define M3UA_ASP_BEAT_ACK 6 115 116 static const struct tok ASPStateMessages[] = { 117 { M3UA_ASP_UP, "Up" }, 118 { M3UA_ASP_DN, "Down" }, 119 { M3UA_ASP_BEAT, "Heartbeat" }, 120 { M3UA_ASP_UP_ACK, "Up Acknowledgement" }, 121 { M3UA_ASP_DN_ACK, "Down Acknowledgement" }, 122 { M3UA_ASP_BEAT_ACK, "Heartbeat Acknowledgement" }, 123 { 0, NULL } 124 }; 125 126 /* ASP Traffic Maintenance messages */ 127 #define M3UA_ASP_AC 1 128 #define M3UA_ASP_IA 2 129 #define M3UA_ASP_AC_ACK 3 130 #define M3UA_ASP_IA_ACK 4 131 132 static const struct tok ASPTrafficMessages[] = { 133 { M3UA_ASP_AC, "Active" }, 134 { M3UA_ASP_IA, "Inactive" }, 135 { M3UA_ASP_AC_ACK, "Active Acknowledgement" }, 136 { M3UA_ASP_IA_ACK, "Inactive Acknowledgement" }, 137 { 0, NULL } 138 }; 139 140 /* Routing Key Management messages */ 141 #define M3UA_RKM_REQ 1 142 #define M3UA_RKM_RSP 2 143 #define M3UA_RKM_DEREQ 3 144 #define M3UA_RKM_DERSP 4 145 146 static const struct tok RoutingKeyMgmtMessages[] = { 147 { M3UA_RKM_REQ, "Registration Request" }, 148 { M3UA_RKM_RSP, "Registration Response" }, 149 { M3UA_RKM_DEREQ, "Deregistration Request" }, 150 { M3UA_RKM_DERSP, "Deregistration Response" }, 151 { 0, NULL } 152 }; 153 154 static const struct uint_tokary m3ua_msgc2tokary[] = { 155 { M3UA_MSGC_MGMT, MgmtMessages }, 156 { M3UA_MSGC_TRANSFER, TransferMessages }, 157 { M3UA_MSGC_SSNM, SS7Messages }, 158 { M3UA_MSGC_ASPSM, ASPStateMessages }, 159 { M3UA_MSGC_ASPTM, ASPTrafficMessages }, 160 { M3UA_MSGC_RKM, RoutingKeyMgmtMessages }, 161 /* uint2tokary() does not use array termination. */ 162 }; 163 164 /* M3UA Parameters */ 165 #define M3UA_PARAM_INFO 0x0004 166 #define M3UA_PARAM_ROUTING_CTX 0x0006 167 #define M3UA_PARAM_DIAGNOSTIC 0x0007 168 #define M3UA_PARAM_HB_DATA 0x0009 169 #define M3UA_PARAM_TRAFFIC_MODE_TYPE 0x000b 170 #define M3UA_PARAM_ERROR_CODE 0x000c 171 #define M3UA_PARAM_STATUS 0x000d 172 #define M3UA_PARAM_ASP_ID 0x0011 173 #define M3UA_PARAM_AFFECTED_POINT_CODE 0x0012 174 #define M3UA_PARAM_CORR_ID 0x0013 175 176 #define M3UA_PARAM_NETWORK_APPEARANCE 0x0200 177 #define M3UA_PARAM_USER 0x0204 178 #define M3UA_PARAM_CONGESTION_INDICATION 0x0205 179 #define M3UA_PARAM_CONCERNED_DST 0x0206 180 #define M3UA_PARAM_ROUTING_KEY 0x0207 181 #define M3UA_PARAM_REG_RESULT 0x0208 182 #define M3UA_PARAM_DEREG_RESULT 0x0209 183 #define M3UA_PARAM_LOCAL_ROUTING_KEY_ID 0x020a 184 #define M3UA_PARAM_DST_POINT_CODE 0x020b 185 #define M3UA_PARAM_SI 0x020c 186 #define M3UA_PARAM_ORIGIN_POINT_CODE_LIST 0x020e 187 #define M3UA_PARAM_PROTO_DATA 0x0210 188 #define M3UA_PARAM_REG_STATUS 0x0212 189 #define M3UA_PARAM_DEREG_STATUS 0x0213 190 191 static const struct tok ParamName[] = { 192 { M3UA_PARAM_INFO, "INFO String" }, 193 { M3UA_PARAM_ROUTING_CTX, "Routing Context" }, 194 { M3UA_PARAM_DIAGNOSTIC, "Diagnostic Info" }, 195 { M3UA_PARAM_HB_DATA, "Heartbeat Data" }, 196 { M3UA_PARAM_TRAFFIC_MODE_TYPE, "Traffic Mode Type" }, 197 { M3UA_PARAM_ERROR_CODE, "Error Code" }, 198 { M3UA_PARAM_STATUS, "Status" }, 199 { M3UA_PARAM_ASP_ID, "ASP Identifier" }, 200 { M3UA_PARAM_AFFECTED_POINT_CODE, "Affected Point Code" }, 201 { M3UA_PARAM_CORR_ID, "Correlation ID" }, 202 { M3UA_PARAM_NETWORK_APPEARANCE, "Network Appearance" }, 203 { M3UA_PARAM_USER, "User/Cause" }, 204 { M3UA_PARAM_CONGESTION_INDICATION, "Congestion Indications" }, 205 { M3UA_PARAM_CONCERNED_DST, "Concerned Destination" }, 206 { M3UA_PARAM_ROUTING_KEY, "Routing Key" }, 207 { M3UA_PARAM_REG_RESULT, "Registration Result" }, 208 { M3UA_PARAM_DEREG_RESULT, "Deregistration Result" }, 209 { M3UA_PARAM_LOCAL_ROUTING_KEY_ID, "Local Routing Key Identifier" }, 210 { M3UA_PARAM_DST_POINT_CODE, "Destination Point Code" }, 211 { M3UA_PARAM_SI, "Service Indicators" }, 212 { M3UA_PARAM_ORIGIN_POINT_CODE_LIST, "Originating Point Code List" }, 213 { M3UA_PARAM_PROTO_DATA, "Protocol Data" }, 214 { M3UA_PARAM_REG_STATUS, "Registration Status" }, 215 { M3UA_PARAM_DEREG_STATUS, "Deregistration Status" }, 216 { 0, NULL } 217 }; 218 219 static void 220 tag_value_print(netdissect_options *ndo, 221 const u_char *buf, const uint16_t tag, const uint16_t size) 222 { 223 switch (tag) { 224 case M3UA_PARAM_NETWORK_APPEARANCE: 225 case M3UA_PARAM_ROUTING_CTX: 226 case M3UA_PARAM_CORR_ID: 227 /* buf and size don't include the header */ 228 if (size < 4) 229 goto invalid; 230 ND_PRINT("0x%08x", GET_BE_U_4(buf)); 231 break; 232 /* ... */ 233 default: 234 ND_PRINT("(length %zu)", size + sizeof(struct m3ua_param_header)); 235 } 236 ND_TCHECK_LEN(buf, size); 237 return; 238 239 invalid: 240 nd_print_invalid(ndo); 241 ND_TCHECK_LEN(buf, size); 242 } 243 244 /* 245 * 0 1 2 3 246 * 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 247 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 248 * | Parameter Tag | Parameter Length | 249 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 250 * \ \ 251 * / Parameter Value / 252 * \ \ 253 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 254 */ 255 static void 256 m3ua_tags_print(netdissect_options *ndo, 257 const u_char *buf, const u_int size) 258 { 259 const u_char *p = buf; 260 int align; 261 uint16_t hdr_tag; 262 uint16_t hdr_len; 263 264 while (p < buf + size) { 265 if (p + sizeof(struct m3ua_param_header) > buf + size) 266 goto invalid; 267 /* Parameter Tag */ 268 hdr_tag = GET_BE_U_2(p); 269 ND_PRINT("\n\t\t\t%s: ", tok2str(ParamName, "Unknown Parameter (0x%04x)", hdr_tag)); 270 /* Parameter Length */ 271 hdr_len = GET_BE_U_2(p + 2); 272 if (hdr_len < sizeof(struct m3ua_param_header)) 273 goto invalid; 274 /* Parameter Value */ 275 align = (p + hdr_len - buf) % 4; 276 align = align ? 4 - align : 0; 277 ND_TCHECK_LEN(p, hdr_len + align); 278 tag_value_print(ndo, p, hdr_tag, hdr_len - sizeof(struct m3ua_param_header)); 279 p += hdr_len + align; 280 } 281 return; 282 283 invalid: 284 nd_print_invalid(ndo); 285 ND_TCHECK_LEN(buf, size); 286 } 287 288 /* 289 * 0 1 2 3 290 * 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 291 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 292 * | Version | Reserved | Message Class | Message Type | 293 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 294 * | Message Length | 295 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 296 * \ \ 297 * / / 298 */ 299 void 300 m3ua_print(netdissect_options *ndo, 301 const u_char *buf, const u_int size) 302 { 303 const struct m3ua_common_header *hdr = (const struct m3ua_common_header *) buf; 304 const struct tok *dict; 305 uint8_t msg_class; 306 307 ndo->ndo_protocol = "m3ua"; 308 /* size includes the header */ 309 if (size < sizeof(struct m3ua_common_header)) 310 goto invalid; 311 ND_TCHECK_SIZE(hdr); 312 if (GET_U_1(hdr->v) != M3UA_REL_1_0) 313 return; 314 315 msg_class = GET_U_1(hdr->msg_class); 316 dict = uint2tokary(m3ua_msgc2tokary, msg_class); 317 318 ND_PRINT("\n\t\t%s", tok2str(MessageClasses, "Unknown message class %i", msg_class)); 319 if (dict != NULL) 320 ND_PRINT(" %s Message", 321 tok2str(dict, "Unknown (0x%02x)", GET_U_1(hdr->msg_type))); 322 323 if (size != GET_BE_U_4(hdr->len)) 324 ND_PRINT("\n\t\t\t@@@@@@ Corrupted length %u of message @@@@@@", 325 GET_BE_U_4(hdr->len)); 326 else 327 m3ua_tags_print(ndo, buf + sizeof(struct m3ua_common_header), 328 GET_BE_U_4(hdr->len) - sizeof(struct m3ua_common_header)); 329 return; 330 331 invalid: 332 nd_print_invalid(ndo); 333 ND_TCHECK_LEN(buf, size); 334 } 335 336