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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
|
/* $Id: upnpstun.c,v 1.7 2020/11/04 21:01:44 nanard Exp $ */
/* vim: tabstop=4 shiftwidth=4 noexpandtab
* MiniUPnP project
* http://miniupnp.free.fr/ or https://miniupnp.tuxfamily.org/
* (c) 2020 Thomas Bernard
* (c) 2018 Pali Rohár
* This software is subject to the conditions detailed
* in the LICENCE file provided within the distribution */
#include <sys/select.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <unistd.h>
#include <netdb.h>
#include <stdlib.h>
#include <stdio.h>
#include <syslog.h>
#include <string.h>
#include <errno.h>
#ifndef TEST_LINUX_DEBUG_APP
#include "config.h"
#endif
#include "upnputils.h"
#include "upnpstun.h"
#if defined(USE_NETFILTER)
#include "netfilter/iptcrdr.h"
#endif
#if defined(USE_PF)
#include "pf/obsdrdr.h"
#endif
#if defined(USE_IPF)
#include "ipf/ipfrdr.h"
#endif
#if defined(USE_IPFW)
#include "ipfw/ipfwrdr.h"
#endif
#ifdef TEST_LINUX_DEBUG_APP
static int add_filter_rule2(const char *ifname, const char *rhost, const char *iaddr, unsigned short eport, unsigned short iport, int proto, const char *desc);
static int delete_filter_rule(const char * ifname, unsigned short port, int proto);
#define syslog(priority, format, ...) do { switch(priority) { case LOG_ERR: printf("Error: "); break; case LOG_WARNING: printf("Warning: "); } printf(format, ##__VA_ARGS__); putchar('\n'); } while (0)
#endif
/* Generate random STUN Transaction Id */
static void generate_transaction_id(unsigned char transaction_id[12])
{
size_t i;
for (i = 0; i < 12; i++)
transaction_id[i] = random() & 255;
}
/* Create and fill STUN Binding Request */
static void fill_request(unsigned char buffer[28], int change_ip, int change_port)
{
/* Type: Binding Request */
buffer[0] = 0x00;
buffer[1] = 0x01;
/* Length: One 8-byte attribute */
buffer[2] = 0x00;
buffer[3] = 0x08;
/* RFC5389 Magic Cookie: 0x2120A442 */
buffer[4] = 0x21;
buffer[5] = 0x12;
buffer[6] = 0xA4;
buffer[7] = 0x42;
/* Transaction Id */
generate_transaction_id(buffer+8);
/* Attribute Type: Change Request */
buffer[20] = 0x00;
buffer[21] = 0x03;
/* Attribute Length: 4 bytes */
buffer[22] = 0x00;
buffer[23] = 0x04;
buffer[24] = 0x00;
buffer[25] = 0x00;
buffer[26] = 0x00;
buffer[27] = 0x00;
/* Change IP */
buffer[27] |= change_ip ? 0x4 : 0x00;
/* Change Port */
buffer[27] |= change_port ? 0x2 : 0x00;
}
/* Resolve STUN host+port and return sockaddr_in structure */
/* When port is 0 then use default STUN port */
static int resolve_stun_host(const char *stun_host, unsigned short stun_port, struct sockaddr_in *sock_addr)
{
int have_sock;
struct addrinfo hints;
struct addrinfo *result, *rp;
char service[6];
int r;
if (stun_port == 0)
stun_port = (unsigned short)3478;
snprintf(service, sizeof(service), "%hu", stun_port);
memset(&hints, 0, sizeof(hints));
hints.ai_family = AF_INET;
hints.ai_socktype = SOCK_DGRAM;
hints.ai_protocol = IPPROTO_UDP;
hints.ai_flags = AI_NUMERICSERV;
r = getaddrinfo(stun_host, service, &hints, &result);
if (r != 0) {
syslog(LOG_ERR, "%s: getaddrinfo(%s, %s, ...) failed : %s",
"resolve_stun_host", stun_host, service, gai_strerror(r));
errno = EHOSTUNREACH;
return -1;
}
have_sock = 0;
for (rp = result; rp != NULL; rp = rp->ai_next) {
if (rp->ai_addrlen > sizeof(*sock_addr) || rp->ai_addr->sa_family != AF_INET)
continue;
memcpy(sock_addr, rp->ai_addr, rp->ai_addrlen);
have_sock = 1;
break;
}
freeaddrinfo(result);
if (!have_sock) {
syslog(LOG_WARNING, "%s: failed to resolve IPv4 address for %s:%s",
"resolve_stun_host", stun_host, service);
errno = EHOSTUNREACH;
return -1;
} else {
char addr_str[48];
if (sockaddr_to_string((struct sockaddr *)sock_addr, addr_str, sizeof(addr_str)) > 0) {
syslog(LOG_DEBUG, "%s: %s:%s => %s",
"resolve_stun_host", stun_host, service, addr_str);
}
}
return 0;
}
/* Create a new UDP socket for STUN connection and return file descriptor and local UDP port */
static int stun_socket(unsigned short *local_port)
{
int fd;
socklen_t addr_len;
struct sockaddr_in local_addr;
fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
if (fd < 0) {
syslog(LOG_ERR, "%s: socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP): %m",
"stun_socket");
return -1;
}
memset(&local_addr, 0, sizeof(local_addr));
local_addr.sin_family = AF_INET;
local_addr.sin_addr.s_addr = htonl(INADDR_ANY);
local_addr.sin_port = 0;
if (bind(fd, (struct sockaddr *)&local_addr, sizeof(local_addr)) != 0) {
syslog(LOG_ERR, "%s: bind(): %m",
"stun_socket");
close(fd);
return -1;
}
addr_len = sizeof(local_addr);
if (getsockname(fd, (struct sockaddr *)&local_addr, &addr_len) != 0) {
syslog(LOG_ERR, "%s: getsockname(): %m",
"stun_socket");
close(fd);
return -1;
}
*local_port = ntohs(local_addr.sin_port);
return fd;
}
/* Receive STUN response message for specified Transaction Id and returns message and peer address */
static size_t receive_stun_response(int fd, unsigned char *buffer, unsigned char transaction_id[12], size_t buffer_len, struct sockaddr_in *peer_addr)
{
ssize_t len;
socklen_t peer_addr_len = sizeof(*peer_addr);
len = recvfrom(fd, buffer, buffer_len, 0, (struct sockaddr *)peer_addr, &peer_addr_len);
if (len < 0) {
syslog(LOG_ERR, "%s: recvfrom(): %m", "receive_stun_response");
return 0;
}
if (peer_addr_len != sizeof(*peer_addr)) {
syslog(LOG_ERR, "%s: recvfrom(): peer_addr_len mismatch",
"receive_stun_response");
return 0;
}
if (len < 20) {
syslog(LOG_WARNING, "%s: response too short : %ld",
"receive_stun_response", (long)len);
return 0;
}
/* Check that buffer is STUN message with class Response
* and Binding method with transaction id */
if ((buffer[0] & 0xFF) != 0x01 || (buffer[1] & 0xEF) != 0x01) {
syslog(LOG_WARNING, "%s: STUN message type is 0x%02x%02x",
"receive_stun_response", buffer[0], buffer[1]);
return 0;
}
if (memcmp(buffer+8, transaction_id, 12) != 0) {
syslog(LOG_WARNING, "%s: transaction id mismatch",
"receive_stun_response");
return 0;
}
return len;
}
/* Wait for STUN response messages and try to receive them */
static int wait_for_stun_responses(int fds[4], unsigned char *transaction_ids[4], unsigned char *buffers[4], size_t buffers_lens[4], struct sockaddr_in peer_addrs[4], size_t lens[4])
{
fd_set fdset;
struct timeval timeout;
int max_fd;
int ret;
int i;
max_fd = fds[0];
for (i = 1; i < 4; i++) {
if (fds[i] > max_fd)
max_fd = fds[i];
}
timeout.tv_sec = 3;
timeout.tv_usec = 0;
while (timeout.tv_sec > 0 || timeout.tv_usec > 0) {
FD_ZERO(&fdset);
for (i = 0; i < 4; i++) {
FD_SET(fds[i], &fdset);
}
syslog(LOG_DEBUG, "%s: waiting %ld secs and %ld usecs", "wait_for_stun_responses", (long)timeout.tv_sec, (long)timeout.tv_usec);
ret = select(max_fd+1, &fdset, NULL, NULL, &timeout);
if (ret < 0) {
if (errno == EINTR)
continue;
syslog(LOG_ERR, "%s: select(): %m", "wait_for_stun_responses");
return -1;
}
if (ret == 0) {
syslog(LOG_DEBUG, "%s: select(): no more responses", "wait_for_stun_responses");
return 0;
}
for (i = 0; i < 4; ++i)
if (FD_ISSET(fds[i], &fdset))
lens[i] = receive_stun_response(fds[i], buffers[i], transaction_ids[i], buffers_lens[i], &peer_addrs[i]);
syslog(LOG_DEBUG, "%s: received responses: %u", "wait_for_stun_responses", (unsigned)(!!lens[0] + !!lens[1] + !!lens[2] + !!lens[3]));
if (lens[0] && lens[1] && lens[2] && lens[3])
return 0;
}
return 0;
}
/* Parse Mapped Address (with port) from STUN response message */
static int parse_stun_response(unsigned char *buffer, size_t len, struct sockaddr_in *mapped_addr)
{
unsigned char *ptr, *end;
uint16_t attr_type;
uint16_t attr_len;
int have_address;
int have_xor_mapped_address;
if (len < 20)
return -1;
syslog(LOG_DEBUG, "%s: Type 0x%04x, Length %hu, Magic Cookie %02x%02x%02x%02x",
"parse_stun_response", ((uint16_t)buffer[0] << 8) + buffer[1],
(uint16_t)((buffer[2] << 8) + buffer[3]),
buffer[4], buffer[5], buffer[6], buffer[7]);
/* Check that buffer is STUN message with class Response and Binding method */
if (buffer[0] != 0x01 || (buffer[1] & 0xEF) != 0x01)
return -1;
/* Check that STUN message is not longer as buffer length */
if (((size_t)buffer[2] << 8) + buffer[3] + 20 > len) {
syslog(LOG_ERR, "%s: truncated STUN response", "parse_stun_response");
return -1;
}
ptr = buffer + 20;
end = buffer + len;
have_address = 0;
have_xor_mapped_address = 0;
while (ptr + 4 <= end) {
attr_type = ((uint16_t)ptr[0] << 8) + ptr[1];
attr_len = ((uint16_t)ptr[2] << 8) + ptr[3];
ptr += 4;
if (ptr + attr_len > end) {
syslog(LOG_WARNING, "%s: truncated attribute", "parse_stun_response");
break;
}
switch (attr_type) {
case 0x0001: /* MAPPED-ADDRESS */
case 0x0020: /* XOR-MAPPED-ADDRESS (RFC 5389) */
case 0x8020: /* XOR-MAPPED-ADDRESS (2005 draft) */
/* Mapped Address or XOR Mapped Address */
if (attr_len == 8 && ptr[1] == 1) {
/* IPv4 address */
if ((attr_type & 0x7fff) == 0x0020) {
/* Restore XOR Mapped Address */
ptr[2] ^= buffer[4];
ptr[3] ^= buffer[5];
ptr[4] ^= buffer[4];
ptr[5] ^= buffer[5];
ptr[6] ^= buffer[6];
ptr[7] ^= buffer[7];
}
syslog(LOG_DEBUG, "%s: %s %hhu.%hhu.%hhu.%hhu:%hu",
"parse_stun_response",
((attr_type & 0x7fff) == 0x0020) ? "XOR-MAPPED-ADDRESS" : "MAPPED-ADDRESS",
ptr[4], ptr[5], ptr[6], ptr[7],
(uint16_t)((ptr[2] << 8) + ptr[3]));
/* Prefer XOR Mapped Address, some NATs change IP addresses in UDP packets */
if (!have_xor_mapped_address) {
mapped_addr->sin_family = AF_INET;
mapped_addr->sin_port = htons(((uint16_t)ptr[2] << 8) + ptr[3]);
mapped_addr->sin_addr.s_addr = htonl(((uint32_t)ptr[4] << 24) + (ptr[5] << 16) + (ptr[6] << 8) + ptr[7]);
}
if ((attr_type & 0x7fff) == 0x0020)
have_xor_mapped_address = 1;
have_address = 1;
}
break;
case 0x0009: /* ERROR-CODE */
if (attr_len >= 4) {
syslog(LOG_WARNING, "%s: ERROR-CODE %u %.*s",
"parse_stun_response", (unsigned)ptr[2] * 100 + ptr[3],
attr_len - 4, ptr + 4);
}
break;
case 0x0004: /* SOURCE-ADDRESS (RFC 3489) */
case 0x0005: /* CHANGED-ADDRESS (RFC 3489) */
case 0x802b: /* RESPONSE-ORIGIN (RFC 5780) */
case 0x802c: /* OTHER-ADDRESS (RFC 5780) */
if (attr_len == 8 && ptr[1] == 1) {
syslog(LOG_DEBUG, "%s: %s %hhu.%hhu.%hhu.%hhu:%hu",
"parse_stun_response",
(attr_type == 0x0004) ? "SOURCE-ADDRESS" :
(attr_type == 0x0005) ? "CHANGED-ADDRESS" :
(attr_type == 0x802b) ? "RESPONSE-ORIGIN" : "OTHER-ADDRESS",
ptr[4], ptr[5], ptr[6], ptr[7],
(uint16_t)((ptr[2] << 8) + ptr[3]));
}
break;
case 0x8022: /* SOFTWARE (RFC 5780) */
syslog(LOG_DEBUG, "%s: SOFTWARE %.*s", "parse_stun_response", attr_len, ptr);
break;
default:
syslog(LOG_WARNING, "%s: unknown attribute type 0x%04x (len=%hu)",
"parse_stun_response", attr_type, attr_len);
}
ptr += attr_len;
}
return have_address ? 0 : -1;
}
/* Perform main STUN operation, return external IP address and check
* if host is behind restrictive NAT.
* Restrictive NAT means any NAT which do some filtering and
* which is not static 1:1, basically NAT which is not usable
* for port forwarding */
int perform_stun(const char *if_name, const char *if_addr, const char *stun_host, unsigned short stun_port, struct in_addr *ext_addr, int *restrictive_nat)
{
int fds[4];
size_t responses_lens[4];
unsigned char responses_bufs[4][1024];
unsigned char *responses[4];
size_t responses_sizes[4];
unsigned char requests[4][28];
unsigned char *transaction_ids[4];
int have_mapped_addr, mapped_addrs_count;
struct sockaddr_in remote_addr, peer_addrs[4], mapped_addrs[4];
unsigned short local_ports[4];
int have_ext_addr;
int i, j;
if (resolve_stun_host(stun_host, stun_port, &remote_addr) != 0)
return -1;
/* Prepare four different STUN requests */
for (i = 0; i < 4; ++i) {
responses_lens[i] = 0;
responses[i] = responses_bufs[i];
responses_sizes[i] = sizeof(responses_bufs[i]);
fds[i] = stun_socket(&local_ports[i]);
if (fds[i] < 0) {
for (j = 0; j < i; ++j)
close(fds[j]);
return -1;
}
fill_request(requests[i], i/2, i%2);
transaction_ids[i] = requests[i]+8;
}
syslog(LOG_INFO, "%s: local ports %hu %hu %hu %hu",
"perform_stun", local_ports[0], local_ports[1],
local_ports[2], local_ports[3]);
/* Unblock local ports */
for (i = 0; i < 4; ++i) {
if (add_filter_rule2(if_name, NULL, if_addr, local_ports[i], local_ports[i], IPPROTO_UDP, "stun test") < 0) {
syslog(LOG_ERR, "%s: add_filter_rule2(..., %hu, ...) FAILED",
"perform_stun", local_ports[i]);
}
}
/* Send STUN requests and wait for responses */
for (j = 0; j < 3; ++j) {
for (i = 0; i < 4; ++i) {
ssize_t n;
if (responses_lens[i])
continue;
n = sendto(fds[i], requests[i], sizeof(requests[i]), 0, (struct sockaddr *)&remote_addr, sizeof(remote_addr));
if (n != sizeof(requests[i])) {
syslog(LOG_ERR, "%s: #%d,%d sendto(): %m", "perform_stun", j, i);
break;
}
}
if (wait_for_stun_responses(fds, transaction_ids, responses, responses_sizes, peer_addrs, responses_lens) != 0)
break;
if (responses_lens[0] && responses_lens[1] && responses_lens[2] && responses_lens[3])
break;
}
/* Remove unblock for local ports */
for (i = 0; i < 4; ++i) {
delete_filter_rule(if_name, local_ports[i], IPPROTO_UDP);
close(fds[i]);
}
/* Parse received STUN messages */
have_ext_addr = 0;
have_mapped_addr = 0;
mapped_addrs_count = 0;
for (i = 0; i < 4; ++i) {
if (parse_stun_response(responses[i], responses_lens[i], &mapped_addrs[i]) == 0) {
mapped_addrs_count++;
have_mapped_addr |= (1 << i);
if (!have_ext_addr) {
memcpy(ext_addr, &mapped_addrs[i].sin_addr, sizeof(*ext_addr));
have_ext_addr = 1;
}
}
}
/* We have no external address */
if (!have_ext_addr) {
errno = ENXIO;
return -1;
}
*restrictive_nat = 0;
if (mapped_addrs_count < 4) {
/* We have not received all four responses,
* therefore NAT or firewall is doing some filtering */
syslog(LOG_NOTICE, "%s: %d response out of 4 received",
"perform_stun", mapped_addrs_count);
*restrictive_nat = 1;
}
if (memcmp(&remote_addr, &peer_addrs[0], sizeof(peer_addrs[0])) != 0) {
/* We received STUN response from different address
* even we did not asked for it, so some strange NAT is active */
syslog(LOG_NOTICE, "%s: address changed",
"perform_stun");
*restrictive_nat = 1;
}
for (i = 0; i < 4; ++i) {
if (!(have_mapped_addr & (1 << i)))
continue;
if (ntohs(mapped_addrs[i].sin_port) != local_ports[i] || memcmp(&mapped_addrs[i].sin_addr, ext_addr, sizeof(*ext_addr)) != 0) {
/* External IP address or port was changed,
* therefore symmetric NAT is active */
syslog(LOG_NOTICE, "%s: #%d external address or port changed",
"perform_stun", i);
*restrictive_nat = 1;
}
}
/* Otherwise we are either directly connected or behind unrestricted NAT 1:1 */
/* There is no filtering, so port forwarding would work fine */
return 0;
}
#ifdef TEST_LINUX_DEBUG_APP
/* This linux test application for debugging purposes can be compiled as: */
/* gcc upnpstun.c upnputils.o -o upnpstun -g3 -W -Wall -O2 -DTEST_LINUX_DEBUG_APP */
#include <arpa/inet.h>
#include <time.h>
#include "upnpglobalvars.h"
struct lan_addr_list lan_addrs;
int runtime_flags = 0;
time_t startup_time = 0;
static int add_filter_rule2(const char *ifname, const char *rhost, const char *iaddr, unsigned short eport, unsigned short iport, int proto, const char *desc)
{
char buffer[100];
ifname = ifname;
rhost = rhost;
iaddr = iaddr;
iport = iport;
desc = desc;
snprintf(buffer, sizeof(buffer), "/sbin/iptables -t filter -I INPUT -p %d --dport %hu -j ACCEPT", proto, eport);
printf("Executing: %s\n", buffer);
return system(buffer);
}
static int delete_filter_rule(const char * ifname, unsigned short port, int proto)
{
char buffer[100];
ifname = ifname;
snprintf(buffer, sizeof(buffer), "/sbin/iptables -t filter -D INPUT -p %d --dport %hu -j ACCEPT", proto, port);
printf("Executing: %s\n", buffer);
return system(buffer);
}
int main(int argc, char *argv[])
{
struct in_addr ext_addr;
int restrictive_nat;
int ret;
char str[INET_ADDRSTRLEN];
if (argc != 3 && argc != 2) {
printf("Usage: %s stun_host [stun_port]\n", argv[0]);
return 1;
}
if (geteuid() != 0) {
printf("You need to run this application as root\n");
return 1;
}
if (argc == 2)
argv[2] = "0";
srandom(time(NULL) * getpid());
ret = perform_stun(NULL, NULL, argv[1], atoi(argv[2]), &ext_addr, &restrictive_nat);
if (ret != 0) {
printf("STUN Failed: %s\n", strerror(errno));
return 1;
}
if (!inet_ntop(AF_INET, &ext_addr, str, INET_ADDRSTRLEN))
str[0] = 0;
printf("External IP address: %s\n", str);
printf("Restrictive NAT: %s\n", restrictive_nat ? "active (port forwarding impossible)" : "not used (ready for port forwarding)");
return 0;
}
#endif
|