RetroShare/libretroshare/src/tcponudp/udpstunner.cc

872 lines
20 KiB
C++
Raw Normal View History

/*
* tcponudp/udpstunner.cc
*
* libretroshare.
*
* Copyright 2010 by Robert Fernie
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License Version 3 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Please report all bugs and problems to "retroshare@lunamutt.com".
*
*/
#include "udpstunner.h"
#include <iostream>
#include <sstream>
#include "util/rsprint.h"
static const int STUN_TTL = 64;
#define TOU_STUN_MIN_PEERS 5
/*
* #define DEBUG_UDP_STUNNER 1
*/
//#define DEBUG_UDP_STUNNER 1
const int32_t TOU_STUN_MAX_FAIL_COUNT = 3; /* 3 tries (could be higher?) */
const int32_t TOU_STUN_MAX_SEND_RATE = 5; /* every 5 seconds */
const int32_t TOU_STUN_MAX_RECV_RATE = 25; /* every 25 seconds */
// TIMEOUT is now tied to STUN RATE ... const int32_t TOU_STUN_ADDR_MAX_AGE = 120; /* 2 minutes */
const int32_t TOU_STUN_DEFAULT_TARGET_RATE = 15; /* 20 secs is minimum to keep a NAT UDP port open */
const double TOU_SUCCESS_LPF_FACTOR = 0.90;
UdpStunner::UdpStunner(UdpPublisher *pub)
:UdpSubReceiver(pub), eaddrKnown(false), eaddrStable(false),
mStunLastRecvResp(0), mStunLastRecvAny(0),
mStunLastSendStun(0), mStunLastSendAny(0)
{
#ifdef UDPSTUN_ALLOW_LOCALNET
mAcceptLocalNet = false;
#endif
/* these parameters determine the rate we attempt stuns */
mPassiveStunMode = false;
mSuccessRate = 0.0;
mTargetStunPeriod = TOU_STUN_DEFAULT_TARGET_RATE;
return;
}
#ifdef UDPSTUN_ALLOW_LOCALNET
// For Local Testing Only (Releases should have the #define disabled)
void UdpStunner::SetAcceptLocalNet()
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
mAcceptLocalNet = true;
}
#endif
void UdpStunner::setTargetStunPeriod(uint32_t sec_per_stun)
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
if (sec_per_stun == 0)
{
mPassiveStunMode = true;
}
else
{
mPassiveStunMode = false;
}
mTargetStunPeriod = sec_per_stun;
}
/* higher level interface */
int UdpStunner::recvPkt(void *data, int size, struct sockaddr_in &from)
{
/* print packet information */
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::recvPkt(" << size << ") from: " << from;
std::cerr << std::endl;
#endif
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
/* check for STUN packet */
if (UdpStun_isStunPacket(data, size))
{
mStunLastRecvAny = time(NULL);
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::recvPkt() is Stun Packet";
std::cerr << std::endl;
#endif
/* respond */
locked_handleStunPkt(data, size, from);
return 1;
}
return 0;
}
int UdpStunner::status(std::ostream &out)
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
out << "UdpStunner::status() TargetStunPeriod: " << mTargetStunPeriod;
out << " SuccessRate: " << mSuccessRate;
out << std::endl;
out << "UdpStunner::status()" << std::endl;
out << "UdpStunner::potentialpeers:" << std::endl;
std::list<TouStunPeer>::iterator it;
for(it = mStunList.begin(); it != mStunList.end(); it++)
{
out << "\t" << it->id << std::endl;
}
out << std::endl;
return 1;
}
int UdpStunner::tick()
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::tick()" << std::endl;
#endif
if (checkStunDesired())
{
attemptStun();
}
return 1;
}
/******************************* STUN Handling ********************************/
/* respond */
bool UdpStunner::locked_handleStunPkt(void *data, int size, struct sockaddr_in &from)
{
if (size == 20) /* request */
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::handleStunPkt() got Request from: ";
std::cerr << inet_ntoa(from.sin_addr) << ":" << ntohs(from.sin_port);
std::cerr << std::endl;
#endif
/* generate a response */
int len;
void *pkt = UdpStun_generate_stun_reply(&from, &len);
if (!pkt)
return false;
time_t now = time(NULL);
mStunLastSendAny = now;
int sentlen = sendPkt(pkt, len, from, STUN_TTL);
free(pkt);
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::handleStunPkt() sent Response size:" << sentlen;
std::cerr << std::endl;
#endif
return (len == sentlen);
}
else if (size == 28)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::handleStunPkt() got Response";
std::cerr << std::endl;
#endif
/* got response */
struct sockaddr_in eAddr;
bool good = UdpStun_response(data, size, eAddr);
if (good)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::handleStunPkt() got Ext Addr: ";
std::cerr << inet_ntoa(eAddr.sin_addr) << ":" << ntohs(eAddr.sin_port);
std::cerr << " from: " << from;
std::cerr << std::endl;
#endif
locked_recvdStun(from, eAddr);
return true;
}
}
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::handleStunPkt() Bad Packet";
std::cerr << std::endl;
#endif
return false;
}
bool UdpStunner::externalAddr(struct sockaddr_in &external, uint8_t &stable)
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
if (eaddrKnown)
{
/* address timeout */
if (time(NULL) - eaddrTime > (mTargetStunPeriod * 2))
{
std::cerr << "UdpStunner::externalAddr() eaddr expired";
std::cerr << std::endl;
return false;
}
external = eaddr;
if (eaddrStable)
stable = 1;
else
stable = 0;
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::externalAddr() eaddr:" << inet_ntoa(external.sin_addr);
std::cerr << ":" << ntohs(external.sin_port) << " stable: " << (int) stable;
std::cerr << std::endl;
#endif
return true;
}
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::externalAddr() eaddr unknown";
std::cerr << std::endl;
#endif
return false;
}
int UdpStunner::doStun(struct sockaddr_in stun_addr)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::doStun()";
std::cerr << std::endl;
#endif
/* send out a stun packet -> save in the local variable */
#define MAX_STUN_SIZE 64
char stundata[MAX_STUN_SIZE];
int tmplen = MAX_STUN_SIZE;
bool done = UdpStun_generate_stun_pkt(stundata, &tmplen);
if (!done)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::doStun() Failed";
std::cerr << std::endl;
#endif
//pqioutput(PQL_ALERT, pqistunzone, "pqistunner::stun() Failed!");
return 0;
}
/* send it off */
int sentlen = sendPkt(stundata, tmplen, stun_addr, STUN_TTL);
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
time_t now = time(NULL);
mStunLastSendStun = now;
mStunLastSendAny = now;
}
#ifdef DEBUG_UDP_STUNNER
std::ostringstream out;
out << "UdpStunner::doStun() Sent Stun Packet(" << sentlen << ") ";
out << " to:";
out << inet_ntoa(stun_addr.sin_addr) << ":" << ntohs(stun_addr.sin_port);
std::cerr << out.str() << std::endl;
//pqioutput(PQL_ALERT, pqistunzone, out.str());
#endif
return 1;
}
/******************************* STUN Handling ********************************/
/***** These next functions are generic and not dependent on class variables **/
/******************************* STUN Handling ********************************/
bool UdpStun_response(void *stun_pkt, int size, struct sockaddr_in &addr)
{
/* check what type it is */
if (size < 28)
{
return false;
}
if (htons(((uint16_t *) stun_pkt)[0]) != 0x0101)
{
/* not a response */
return false;
}
/* iterate through the packet */
/* for now assume the address follows the header directly */
/* all stay in netbyteorder! */
addr.sin_family = AF_INET;
addr.sin_addr.s_addr = ((uint32_t *) stun_pkt)[6];
addr.sin_port = ((uint16_t *) stun_pkt)[11];
#ifdef DEBUG_UDP_STUNNER
std::ostringstream out;
out << "UdpStunner::response() Recvd a Stun Response, ext_addr: ";
out << inet_ntoa(addr.sin_addr) << ":" << ntohs(addr.sin_port);
std::cerr << out.str() << std::endl;
#endif
return true;
}
bool UdpStun_generate_stun_pkt(void *stun_pkt, int *len)
{
if (*len < 20)
{
return false;
}
/* just the header */
((uint16_t *) stun_pkt)[0] = (uint16_t) htons(0x0001);
((uint16_t *) stun_pkt)[1] = (uint16_t) htons(20); /* only header */
/* transaction id - should be random */
((uint32_t *) stun_pkt)[1] = (uint32_t) htonl(0x0020);
((uint32_t *) stun_pkt)[2] = (uint32_t) htonl(0x0121);
((uint32_t *) stun_pkt)[3] = (uint32_t) htonl(0x0111);
((uint32_t *) stun_pkt)[4] = (uint32_t) htonl(0x1010);
*len = 20;
return true;
}
void *UdpStun_generate_stun_reply(struct sockaddr_in *stun_addr, int *len)
{
/* just the header */
void *stun_pkt = malloc(28);
((uint16_t *) stun_pkt)[0] = (uint16_t) htons(0x0101);
((uint16_t *) stun_pkt)[1] = (uint16_t) htons(28); /* only header + 8 byte addr */
/* transaction id - should be random */
((uint32_t *) stun_pkt)[1] = (uint32_t) htonl(0x0f20);
((uint32_t *) stun_pkt)[2] = (uint32_t) htonl(0x0f21);
((uint32_t *) stun_pkt)[3] = (uint32_t) htonl(0x0f11);
((uint32_t *) stun_pkt)[4] = (uint32_t) htonl(0x1010);
/* now add address
* 0 1 2 3
* <INET> <port>
* <inet address>
*/
/* THESE SHOULD BE NET ORDER ALREADY */
((uint16_t *) stun_pkt)[10] = AF_INET;
((uint16_t *) stun_pkt)[11] = stun_addr->sin_port;
((uint32_t *) stun_pkt)[6] = stun_addr->sin_addr.s_addr;
*len = 28;
return stun_pkt;
}
bool UdpStun_isStunPacket(void *data, int size)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::isStunPacket() ?";
std::cerr << std::endl;
#endif
if (size < 20)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::isStunPacket() (size < 20) -> false";
std::cerr << std::endl;
#endif
return false;
}
/* match size field */
uint16_t pktsize = ntohs(((uint16_t *) data)[1]);
if (size != pktsize)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::isStunPacket() (size != pktsize) -> false";
std::cerr << std::endl;
#endif
return false;
}
if ((size == 20) && (0x0001 == ntohs(((uint16_t *) data)[0])))
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::isStunPacket() (size=20 & data[0]=0x0001) -> true";
std::cerr << std::endl;
#endif
/* request */
return true;
}
if ((size == 28) && (0x0101 == ntohs(((uint16_t *) data)[0])))
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::isStunPacket() (size=28 & data[0]=0x0101) -> true";
std::cerr << std::endl;
#endif
/* response */
return true;
}
return false;
}
/******************************* STUN Handling ********************************
* KeepAlive has been replaced by a targetStunRate. Set this to zero to disable.
*/
/******************************* STUN Handling ********************************/
bool UdpStunner::addStunPeer(const struct sockaddr_in &remote, const char *peerid)
{
/* add to the list */
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::addStunPeer()";
std::cerr << std::endl;
#endif
bool toStore = true;
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
/* only store if we're active */
toStore = !mPassiveStunMode;
}
if (toStore)
{
storeStunPeer(remote, peerid, 0);
}
return true;
}
bool UdpStunner::storeStunPeer(const struct sockaddr_in &remote, const char *peerid, bool sent)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::storeStunPeer()";
std::cerr << std::endl;
#endif
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
std::list<TouStunPeer>::iterator it;
for(it = mStunList.begin(); it != mStunList.end(); it++)
{
if ((remote.sin_addr.s_addr == it->remote.sin_addr.s_addr) &&
(remote.sin_port == it->remote.sin_port))
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::storeStunPeer() Peer Already There!";
std::cerr << std::endl;
#endif
/* already there */
if (sent)
{
it->failCount += 1;
it->lastsend = time(NULL);
}
return false;
}
}
TouStunPeer peer(std::string(peerid), remote);
if (sent)
{
peer.failCount += 1;
peer.lastsend = time(NULL);
}
mStunList.push_back(peer);
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::storeStunPeer() Added Peer";
std::cerr << std::endl;
#endif
return true;
}
bool UdpStunner::checkStunDesired()
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired()";
std::cerr << std::endl;
#endif
time_t now;
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
if (mPassiveStunMode)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired() In Passive Mode";
std::cerr << std::endl;
#endif
return false; /* all good */
}
if (!eaddrKnown)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired() YES, we don't have extAddr Yet";
std::cerr << std::endl;
#endif
return true; /* want our external address */
}
/* check if we need to send one now */
now = time(NULL);
/* based on SuccessRate & TargetStunRate, we work out if we should send one
*
* if we have 100% success rate, then we can delay until exactly TARGET RATE.
* if we have 0% success rate, then try at double TARGET RATE.
*
*/
double stunPeriod = (mTargetStunPeriod / 2.0) * (1.0 + mSuccessRate);
time_t nextStun = mStunLastRecvResp + (int) stunPeriod;
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired() TargetStunPeriod: " << mTargetStunPeriod;
std::cerr << " SuccessRate: " << mSuccessRate;
std::cerr << " DesiredStunPeriod: " << stunPeriod;
std::cerr << " NextStun: " << nextStun - now << " secs";
std::cerr << std::endl;
#endif
if (now >= nextStun)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired() Stun is Desired";
std::cerr << std::endl;
#endif
return true;
}
else
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::checkStunDesired() Stun is Not Needed";
std::cerr << std::endl;
#endif
return false;
}
}
}
bool UdpStunner::attemptStun()
{
bool found = false;
TouStunPeer peer;
time_t now = time(NULL);
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::attemptStun()";
std::cerr << std::endl;
#endif
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
int i;
for(i = 0; ((i < mStunList.size()) && (mStunList.size() > 0) && (!found)); i++)
{
/* extract entry */
peer = mStunList.front();
mStunList.pop_front();
/* check if expired */
if (peer.failCount > TOU_STUN_MAX_FAIL_COUNT)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::attemptStun() Peer has expired, dropping";
std::cerr << std::endl;
#endif
}
else
{
// Peer Okay, check last send time.
if (now - peer.lastsend < TOU_STUN_MAX_SEND_RATE)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::attemptStun() Peer was sent to Too Recently, pushing back";
std::cerr << std::endl;
#endif
mStunList.push_back(peer);
}
else
{
/* we have found a peer! */
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::attemptStun() Found Peer to Stun.";
std::cerr << std::endl;
#endif
peer.failCount++;
peer.lastsend = now;
mStunList.push_back(peer);
mSuccessRate *= TOU_SUCCESS_LPF_FACTOR;
found = true;
}
}
} // END OF WHILE LOOP.
if (mStunList.size() < 1)
{
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::attemptStun() No Peers in List. FAILED";
std::cerr << std::endl;
#endif
return false;
}
#ifdef DEBUG_UDP_STUNNER
locked_printStunList();
#endif
} // END OF MUTEX LOCKING.
if (found)
{
doStun(peer.remote);
return true;
}
return false;
}
bool UdpStunner::locked_recvdStun(const struct sockaddr_in &remote, const struct sockaddr_in &extaddr)
{
#ifdef DEBUG_UDP_STUNNER
std::ostringstream out;
out << "UdpStunner::locked_recvdStun() from:";
out << inet_ntoa(remote.sin_addr) << ":" << ntohs(remote.sin_port);
out << " claiming ExtAddr is:";
out << inet_ntoa(extaddr.sin_addr) << ":" << ntohs(extaddr.sin_port);
std::cerr << out.str() << std::endl;
#endif
bool found = true;
std::list<TouStunPeer>::iterator it;
for(it = mStunList.begin(); it != mStunList.end(); it++)
{
if ((remote.sin_addr.s_addr == it->remote.sin_addr.s_addr) &&
(remote.sin_port == it->remote.sin_port))
{
it->failCount = 0;
it->eaddr = extaddr;
it->response = true;
found = true;
break;
}
}
/* if not found.. should we add it back in? */
/* How do we calculate the success rate?
* Don't want to count all the stuns?
* Low Pass filter won't work either...
* at send...
* mSuccessRate = 0.95 * mSuccessRate.
* at recv...
* mSuccessRate = 0.95 * mSuccessRate + 0.05;
*
* But if we split into a two stage eqn. it'll work!
* a
* mSuccessRate = 0.95 * mSuccessRate.
* at recv...
* mSuccessRate += 0.05;
*/
mSuccessRate += (1.0-TOU_SUCCESS_LPF_FACTOR);
time_t now = time(NULL);
mStunLastRecvResp = now;
mStunLastRecvAny = now;
#ifdef DEBUG_UDP_STUNNER
locked_printStunList();
#endif
locked_checkExternalAddress();
return found;
}
bool UdpStunner::locked_checkExternalAddress()
{
#ifdef DEBUG_UDP_STUNNER
std::ostringstream out;
out << "UdpStunner::locked_checkExternalAddress()";
std::cerr << out.str() << std::endl;
#endif
bool found1 = false;
bool found2 = false;
time_t now = time(NULL);
/* iterator backwards - as these are the most recent */
std::list<TouStunPeer>::reverse_iterator it;
std::list<TouStunPeer>::reverse_iterator p1;
std::list<TouStunPeer>::reverse_iterator p2;
for(it = mStunList.rbegin(); it != mStunList.rend(); it++)
{
/* check:
1) have response.
2) have eaddr.
3) no fails.
4) recent age.
*/
time_t age = (now - it->lastsend);
if (it->response &&
#ifdef UDPSTUN_ALLOW_LOCALNET
( mAcceptLocalNet || isExternalNet(&(it->eaddr.sin_addr))) &&
#else
(isExternalNet(&(it->eaddr.sin_addr))) &&
#endif
(it->failCount == 0) && (age < (mTargetStunPeriod * 2)))
{
if (!found1)
{
p1 = it;
found1 = true;
}
else
{
p2 = it;
found2 = true;
break;
}
}
}
if (found1 && found2)
{
if ((p1->eaddr.sin_addr.s_addr == p2->eaddr.sin_addr.s_addr) &&
(p1->eaddr.sin_port == p2->eaddr.sin_port))
{
eaddrStable = true;
}
else
{
eaddrStable = false;
}
eaddrKnown = true;
eaddr = p1->eaddr;
eaddrTime = now;
#ifdef DEBUG_UDP_STUNNER
std::cerr << "UdpStunner::locked_checkExternalAddress() Found State:";
if (eaddrStable)
std::cerr << " Stable NAT translation (GOOD!) ";
else
std::cerr << " unStable (symmetric NAT translation (BAD!) ";
std::cerr << std::endl;
#endif
return true;
}
return false;
}
bool UdpStunner::locked_printStunList()
{
#ifdef DEBUG_UDP_STUNNER
std::ostringstream out;
time_t now = time(NULL);
out << "locked_printStunList()" << std::endl;
out << "\tLastSendStun: " << now - mStunLastSendStun << std::endl;
out << "\tLastSendAny: " << now - mStunLastSendAny << std::endl;
out << "\tLastRecvResp: " << now - mStunLastRecvResp << std::endl;
out << "\tLastRecvAny: " << now - mStunLastRecvAny << std::endl;
std::list<TouStunPeer>::iterator it;
for(it = mStunList.begin(); it != mStunList.end(); it++)
{
out << "id:" << RsUtil::BinToHex(it->id) << " addr: " << inet_ntoa(it->remote.sin_addr);
out << ":" << htons(it->remote.sin_port);
out << " eaddr: " << inet_ntoa(it->eaddr.sin_addr);
out << ":" << htons(it->eaddr.sin_port);
out << " failCount: " << it->failCount;
out << " lastSend: " << now - it->lastsend;
out << std::endl;
}
std::cerr << out.str();
#endif
return true;
}
bool UdpStunner::getStunPeer(int idx, std::string &id,
struct sockaddr_in &remote, struct sockaddr_in &eaddr,
uint32_t &failCount, time_t &lastSend)
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
std::list<TouStunPeer>::iterator it;
int i;
for(i=0, it=mStunList.begin(); (i<idx) && (it!=mStunList.end()); it++, i++) ;
if (it != mStunList.end())
{
id = RsUtil::BinToHex(it->id);
remote = it->remote;
eaddr = it->eaddr;
failCount = it->failCount;
lastSend = it->lastsend;
return true;
}
return false;
}
bool UdpStunner::needStunPeers()
{
RsStackMutex stack(stunMtx); /********** LOCK MUTEX *********/
return (mStunList.size() < TOU_STUN_MIN_PEERS);
}