1 /*- 2 * alias_skinny.c 3 * 4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 5 * 6 * Copyright (c) 2002, 2003 MarcusCom, Inc. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * Author: Joe Marcus Clarke <marcus@FreeBSD.org> 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifdef _KERNEL 36 #include <sys/param.h> 37 #include <sys/kernel.h> 38 #include <sys/module.h> 39 #else 40 #include <errno.h> 41 #include <stdio.h> 42 #include <unistd.h> 43 #endif 44 45 #include <netinet/in_systm.h> 46 #include <netinet/in.h> 47 #include <netinet/ip.h> 48 #include <netinet/tcp.h> 49 50 #ifdef _KERNEL 51 #include <netinet/libalias/alias_local.h> 52 #include <netinet/libalias/alias_mod.h> 53 #else 54 #include "alias_local.h" 55 #include "alias_mod.h" 56 #endif 57 58 static void 59 AliasHandleSkinny(struct libalias *, struct ip *, struct alias_link *); 60 61 static int 62 fingerprint(struct libalias *la, struct alias_data *ah) 63 { 64 65 if (ah->dport == NULL || ah->sport == NULL || ah->lnk == NULL) 66 return (-1); 67 if (la->skinnyPort != 0 && (ntohs(*ah->sport) == la->skinnyPort || 68 ntohs(*ah->dport) == la->skinnyPort)) 69 return (0); 70 return (-1); 71 } 72 73 static int 74 protohandler(struct libalias *la, struct ip *pip, struct alias_data *ah) 75 { 76 77 AliasHandleSkinny(la, pip, ah->lnk); 78 return (0); 79 } 80 81 struct proto_handler handlers[] = { 82 { 83 .pri = 110, 84 .dir = IN|OUT, 85 .proto = TCP, 86 .fingerprint = &fingerprint, 87 .protohandler = &protohandler 88 }, 89 { EOH } 90 }; 91 92 static int 93 mod_handler(module_t mod, int type, void *data) 94 { 95 int error; 96 97 switch (type) { 98 case MOD_LOAD: 99 error = 0; 100 LibAliasAttachHandlers(handlers); 101 break; 102 case MOD_UNLOAD: 103 error = 0; 104 LibAliasDetachHandlers(handlers); 105 break; 106 default: 107 error = EINVAL; 108 } 109 return (error); 110 } 111 112 #ifdef _KERNEL 113 static 114 #endif 115 moduledata_t alias_mod = { 116 "alias_skinny", mod_handler, NULL 117 }; 118 119 #ifdef _KERNEL 120 DECLARE_MODULE(alias_skinny, alias_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND); 121 MODULE_VERSION(alias_skinny, 1); 122 MODULE_DEPEND(alias_skinny, libalias, 1, 1, 1); 123 #endif 124 125 /* 126 * alias_skinny.c handles the translation for the Cisco Skinny Station 127 * protocol. Skinny typically uses TCP port 2000 to set up calls between 128 * a Cisco Call Manager and a Cisco IP phone. When a phone comes on line, 129 * it first needs to register with the Call Manager. To do this it sends 130 * a registration message. This message contains the IP address of the 131 * IP phone. This message must then be translated to reflect our global 132 * IP address. Along with the registration message (and usually in the 133 * same packet), the phone sends an IP port message. This message indicates 134 * the TCP port over which it will communicate. 135 * 136 * When a call is placed from the phone, the Call Manager will send an 137 * Open Receive Channel message to the phone to let the caller know someone 138 * has answered. The phone then sends back an Open Receive Channel 139 * Acknowledgement. In this packet, the phone sends its IP address again, 140 * and the UDP port over which the voice traffic should flow. These values 141 * need translation. Right after the Open Receive Channel Acknowledgement, 142 * the Call Manager sends a Start Media Transmission message indicating the 143 * call is connected. This message contains the IP address and UDP port 144 * number of the remote (called) party. Once this message is translated, the 145 * call can commence. The called part sends the first UDP packet to the 146 * calling phone at the pre-arranged UDP port in the Open Receive Channel 147 * Acknowledgement. 148 * 149 * Skinny is a Cisco-proprietary protocol and is a trademark of Cisco Systems, 150 * Inc. All rights reserved. 151 */ 152 153 /* #define LIBALIAS_DEBUG 1 */ 154 155 /* Message types that need translating */ 156 #define REG_MSG 0x00000001 157 #define IP_PORT_MSG 0x00000002 158 #define OPNRCVCH_ACK 0x00000022 159 #define START_MEDIATX 0x0000008a 160 161 struct skinny_header { 162 u_int32_t len; 163 u_int32_t reserved; 164 u_int32_t msgId; 165 }; 166 167 struct RegisterMessage { 168 u_int32_t msgId; 169 char devName [16]; 170 u_int32_t uid; 171 u_int32_t instance; 172 u_int32_t ipAddr; 173 u_char devType; 174 u_int32_t maxStreams; 175 }; 176 177 struct IpPortMessage { 178 u_int32_t msgId; 179 u_int32_t stationIpPort; /* Note: Skinny uses 32-bit port 180 * numbers */ 181 }; 182 183 struct OpenReceiveChannelAck { 184 u_int32_t msgId; 185 u_int32_t status; 186 u_int32_t ipAddr; 187 u_int32_t port; 188 u_int32_t passThruPartyID; 189 }; 190 191 struct StartMediaTransmission { 192 u_int32_t msgId; 193 u_int32_t conferenceID; 194 u_int32_t passThruPartyID; 195 u_int32_t remoteIpAddr; 196 u_int32_t remotePort; 197 u_int32_t MSPacket; 198 u_int32_t payloadCap; 199 u_int32_t precedence; 200 u_int32_t silenceSuppression; 201 u_short maxFramesPerPacket; 202 u_int32_t G723BitRate; 203 }; 204 205 typedef enum { 206 ClientToServer = 0, 207 ServerToClient = 1 208 } ConvDirection; 209 210 static int 211 alias_skinny_reg_msg(struct RegisterMessage *reg_msg, struct ip *pip, 212 struct tcphdr *tc, struct alias_link *lnk, 213 ConvDirection direction) 214 { 215 (void)direction; 216 217 reg_msg->ipAddr = (u_int32_t) GetAliasAddress(lnk).s_addr; 218 219 tc->th_sum = 0; 220 #ifdef _KERNEL 221 tc->th_x2 = 1; 222 #else 223 tc->th_sum = TcpChecksum(pip); 224 #endif 225 226 return (0); 227 } 228 229 static int 230 alias_skinny_startmedia(struct StartMediaTransmission *start_media, 231 struct ip *pip, struct tcphdr *tc, 232 struct alias_link *lnk, u_int32_t localIpAddr, 233 ConvDirection direction) 234 { 235 struct in_addr dst, src; 236 237 (void)pip; 238 (void)tc; 239 (void)lnk; 240 (void)direction; 241 242 dst.s_addr = start_media->remoteIpAddr; 243 src.s_addr = localIpAddr; 244 245 /* 246 * XXX I should probably handle in bound global translations as 247 * well. 248 */ 249 250 return (0); 251 } 252 253 static int 254 alias_skinny_port_msg(struct IpPortMessage *port_msg, struct ip *pip, 255 struct tcphdr *tc, struct alias_link *lnk, 256 ConvDirection direction) 257 { 258 (void)direction; 259 260 port_msg->stationIpPort = (u_int32_t) ntohs(GetAliasPort(lnk)); 261 262 tc->th_sum = 0; 263 #ifdef _KERNEL 264 tc->th_x2 = 1; 265 #else 266 tc->th_sum = TcpChecksum(pip); 267 #endif 268 return (0); 269 } 270 271 static int 272 alias_skinny_opnrcvch_ack(struct libalias *la, struct OpenReceiveChannelAck *opnrcvch_ack, 273 struct ip *pip, struct tcphdr *tc, 274 struct alias_link *lnk, u_int32_t * localIpAddr, 275 ConvDirection direction) 276 { 277 struct in_addr null_addr; 278 struct alias_link *opnrcv_lnk; 279 u_int32_t localPort; 280 281 (void)lnk; 282 (void)direction; 283 284 *localIpAddr = (u_int32_t) opnrcvch_ack->ipAddr; 285 localPort = opnrcvch_ack->port; 286 287 null_addr.s_addr = INADDR_ANY; 288 opnrcv_lnk = FindUdpTcpOut(la, pip->ip_src, null_addr, 289 htons((u_short) opnrcvch_ack->port), 0, 290 IPPROTO_UDP, 1); 291 opnrcvch_ack->ipAddr = (u_int32_t) GetAliasAddress(opnrcv_lnk).s_addr; 292 opnrcvch_ack->port = (u_int32_t) ntohs(GetAliasPort(opnrcv_lnk)); 293 294 tc->th_sum = 0; 295 #ifdef _KERNEL 296 tc->th_x2 = 1; 297 #else 298 tc->th_sum = TcpChecksum(pip); 299 #endif 300 return (0); 301 } 302 303 static void 304 AliasHandleSkinny(struct libalias *la, struct ip *pip, struct alias_link *lnk) 305 { 306 size_t hlen, tlen, dlen; 307 struct tcphdr *tc; 308 u_int32_t msgId, t, len, lip; 309 struct skinny_header *sd; 310 size_t orig_len, skinny_hdr_len = sizeof(struct skinny_header); 311 ConvDirection direction; 312 313 lip = -1; 314 tc = (struct tcphdr *)ip_next(pip); 315 hlen = (pip->ip_hl + tc->th_off) << 2; 316 tlen = ntohs(pip->ip_len); 317 dlen = tlen - hlen; 318 319 sd = (struct skinny_header *)tcp_next(tc); 320 321 /* 322 * XXX This direction is reserved for future use. I still need to 323 * handle the scenario where the call manager is on the inside, and 324 * the calling phone is on the global outside. 325 */ 326 if (ntohs(tc->th_dport) == la->skinnyPort) { 327 direction = ClientToServer; 328 } else if (ntohs(tc->th_sport) == la->skinnyPort) { 329 direction = ServerToClient; 330 } else { 331 #ifdef LIBALIAS_DEBUG 332 fprintf(stderr, 333 "PacketAlias/Skinny: Invalid port number, not a Skinny packet\n"); 334 #endif 335 return; 336 } 337 338 orig_len = dlen; 339 /* 340 * Skinny packets can contain many messages. We need to loop 341 * through the packet using len to determine message boundaries. 342 * This comes into play big time with port messages being in the 343 * same packet as register messages. Also, open receive channel 344 * acks are usually buried in a packet some 400 bytes long. 345 */ 346 while (dlen >= skinny_hdr_len) { 347 len = (sd->len); 348 msgId = (sd->msgId); 349 t = len; 350 351 if (t > orig_len || t > dlen) { 352 #ifdef LIBALIAS_DEBUG 353 fprintf(stderr, 354 "PacketAlias/Skinny: Not a skinny packet, invalid length \n"); 355 #endif 356 return; 357 } 358 switch (msgId) { 359 case REG_MSG: { 360 struct RegisterMessage *reg_mesg; 361 362 if (len < (int)sizeof(struct RegisterMessage)) { 363 #ifdef LIBALIAS_DEBUG 364 fprintf(stderr, 365 "PacketAlias/Skinny: Not a skinny packet, bad registration message\n"); 366 #endif 367 return; 368 } 369 reg_mesg = (struct RegisterMessage *)&sd->msgId; 370 #ifdef LIBALIAS_DEBUG 371 fprintf(stderr, 372 "PacketAlias/Skinny: Received a register message"); 373 #endif 374 alias_skinny_reg_msg(reg_mesg, pip, tc, lnk, direction); 375 break; 376 } 377 case IP_PORT_MSG: { 378 struct IpPortMessage *port_mesg; 379 380 if (len < (int)sizeof(struct IpPortMessage)) { 381 #ifdef LIBALIAS_DEBUG 382 fprintf(stderr, 383 "PacketAlias/Skinny: Not a skinny packet, port message\n"); 384 #endif 385 return; 386 } 387 #ifdef LIBALIAS_DEBUG 388 fprintf(stderr, 389 "PacketAlias/Skinny: Received ipport message\n"); 390 #endif 391 port_mesg = (struct IpPortMessage *)&sd->msgId; 392 alias_skinny_port_msg(port_mesg, pip, tc, lnk, direction); 393 break; 394 } 395 case OPNRCVCH_ACK: { 396 struct OpenReceiveChannelAck *opnrcvchn_ack; 397 398 if (len < (int)sizeof(struct OpenReceiveChannelAck)) { 399 #ifdef LIBALIAS_DEBUG 400 fprintf(stderr, 401 "PacketAlias/Skinny: Not a skinny packet, packet,OpnRcvChnAckMsg\n"); 402 #endif 403 return; 404 } 405 #ifdef LIBALIAS_DEBUG 406 fprintf(stderr, 407 "PacketAlias/Skinny: Received open rcv channel msg\n"); 408 #endif 409 opnrcvchn_ack = (struct OpenReceiveChannelAck *)&sd->msgId; 410 alias_skinny_opnrcvch_ack(la, opnrcvchn_ack, pip, tc, lnk, &lip, direction); 411 break; 412 } 413 case START_MEDIATX: { 414 struct StartMediaTransmission *startmedia_tx; 415 416 if (len < (int)sizeof(struct StartMediaTransmission)) { 417 #ifdef LIBALIAS_DEBUG 418 fprintf(stderr, 419 "PacketAlias/Skinny: Not a skinny packet,StartMediaTx Message\n"); 420 #endif 421 return; 422 } 423 if (lip == -1) { 424 #ifdef LIBALIAS_DEBUG 425 fprintf(stderr, 426 "PacketAlias/Skinny: received a" 427 " packet,StartMediaTx Message before" 428 " packet,OpnRcvChnAckMsg\n" 429 #endif 430 return; 431 } 432 433 #ifdef LIBALIAS_DEBUG 434 fprintf(stderr, 435 "PacketAlias/Skinny: Received start media trans msg\n"); 436 #endif 437 startmedia_tx = (struct StartMediaTransmission *)&sd->msgId; 438 alias_skinny_startmedia(startmedia_tx, pip, tc, lnk, lip, direction); 439 break; 440 } 441 default: 442 break; 443 } 444 /* Place the pointer at the next message in the packet. */ 445 dlen -= len + (skinny_hdr_len - sizeof(msgId)); 446 sd = (struct skinny_header *)(((char *)&sd->msgId) + len); 447 } 448 } 449