PentHertz
/
OpenBTS-UMTS
mirror of https://github.com/PentHertz/OpenBTS-UMTS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenBTS-UMTS/SIP/SIPInterface.cpp

490 lines
14 KiB
C++
Raw Blame History

/*
* OpenBTS provides an open source alternative to legacy telco protocols and
* traditionally complex, proprietary hardware systems.
*
* Copyright 2008, 2009, 2010 Free Software Foundation, Inc.
* Copyright 2011, 2014 Range Networks, Inc.
*
* This software is distributed under the terms of the GNU Affero General
* Public License version 3. See the COPYING and NOTICE files in the main
* directory for licensing information.
*
* This use of this software may be subject to additional restrictions.
* See the LEGAL file in the main directory for details.
*/
#include <ortp/ortp.h>
#include <osipparser2/sdp_message.h>
#include <UMTSLogicalChannel.h>
#include <UMTSConfig.h>
#include <ControlCommon.h>
#include <TransactionTable.h>
#include <Sockets.h>
#include "SIPUtility.h"
#include "SIPInterface.h"
#include <Logger.h>
#undef WARNING
using namespace std;
using namespace SIP;
using namespace UMTS;
using namespace Control;
// SIPMessageMap method definitions.
void SIPMessageMap::write(const std::string& call_id, osip_message_t * msg)
{
LOG(DEBUG) << "call_id=" << call_id << " msg=" << msg;
OSIPMessageFIFO * fifo = mMap.readNoBlock(call_id);
if( fifo==NULL ) {
// FIXME -- If this write fails, send "call leg non-existent" response on SIP interface.
LOG(NOTICE) << "missing SIP FIFO "<<call_id;
throw SIPError();
}
LOG(DEBUG) << "write on fifo " << fifo;
fifo->write(msg);
}
osip_message_t * SIPMessageMap::read(const std::string& call_id, unsigned readTimeout)
{
LOG(DEBUG) << "call_id=" << call_id;
OSIPMessageFIFO * fifo = mMap.readNoBlock(call_id);
if (!fifo) {
LOG(NOTICE) << "missing SIP FIFO "<<call_id;
throw SIPError();
}
LOG(DEBUG) << "blocking on fifo " << fifo;
osip_message_t * msg = fifo->read(readTimeout);
if (!msg) throw SIPTimeout();
return msg;
}
bool SIPMessageMap::add(const std::string& call_id, const struct sockaddr_in* returnAddress)
{
OSIPMessageFIFO * fifo = new OSIPMessageFIFO(returnAddress);
mMap.write(call_id, fifo);
return true;
}
bool SIPMessageMap::remove(const std::string& call_id)
{
OSIPMessageFIFO * fifo = mMap.readNoBlock(call_id);
if(fifo == NULL) return false;
mMap.remove(call_id);
return true;
}
// SIPInterface method definitions.
bool SIPInterface::addCall(const string &call_id)
{
LOG(INFO) << "creating SIP message FIFO callID " << call_id;
return mSIPMap.add(call_id,mSIPSocket.source());
}
bool SIPInterface::removeCall(const string &call_id)
{
LOG(INFO) << "removing SIP message FIFO callID " << call_id;
return mSIPMap.remove(call_id);
}
int SIPInterface::fifoSize(const std::string& call_id )
{
OSIPMessageFIFO * fifo = mSIPMap.map().read(call_id,0);
if(fifo==NULL) return -1;
return fifo->size();
}
void SIP::driveLoop( SIPInterface * si){
while (true) {
si->drive();
}
}
void SIPInterface::start(){
// Start all the osip/ortp stuff.
parser_init();
ortp_init();
ortp_scheduler_init();
// FIXME -- Can we coordinate this with the global logger?
//ortp_set_log_level_mask(ORTP_MESSAGE|ORTP_WARNING|ORTP_ERROR);
mDriveThread.start((void *(*)(void*))driveLoop,this );
}
void SIPInterface::write(const struct sockaddr_in* dest, osip_message_t *msg)
{
char * str;
size_t msgSize;
osip_message_to_str(msg, &str, &msgSize);
if (!str) {
LOG(ERR) << "osip_message_to_str produced a NULL pointer.";
return;
}
char firstLine[100];
sscanf(str,"%100[^\n]",firstLine);
LOG(INFO) << "write " << firstLine;
LOG(DEBUG) << "write " << str;
mSocketLock.lock();
mSIPSocket.send((const struct sockaddr*)dest,str);
mSocketLock.unlock();
free(str);
}
void SIPInterface::drive()
{
// All inbound SIP messages go here for processing.
LOG(DEBUG) << "blocking on socket";
int numRead = mSIPSocket.read(mReadBuffer);
if (numRead<0) {
LOG(ALERT) << "cannot read SIP socket.";
return;
}
// FIXME -- Is this +1 offset correct? Check it.
mReadBuffer[numRead] = '\0';
// Get the proxy from the inbound message.
#if 0
const struct sockaddr_in* sourceAddr = mSIPSocket.source();
char msgHost[256];
const char* msgHostRet = inet_ntop(AF_INET,&(sourceAddr->sin_addr),msgHost,255);
if (!msgHostRet) {
LOG(ALERT) << "cannot translate SIP source address for " << mReadBuffer;
return;
}
unsigned msgPortNumber = sourceAddr->sin_port;
char msgPort[20];
sprintf(msgPort,"%u",msgPortNumber);
string proxy = string(msgHost) + string(":") + string(msgPort);
#endif
char firstLine[101];
sscanf(mReadBuffer,"%100[^\n]",firstLine);
LOG(INFO) << "read " << firstLine;
LOG(DEBUG) << "read " << mReadBuffer;
try {
// Parse the mesage.
osip_message_t * msg;
int i = osip_message_init(&msg);
LOG(INFO) << "osip_message_init " << i;
int j = osip_message_parse(msg, mReadBuffer, strlen(mReadBuffer));
// seems like it ought to do something more than display an error,
// but it used to not even do that.
LOG(INFO) << "osip_message_parse " << j;
// heroic efforts to get it to parse the www-authenticate header failed,
// so we'll just crowbar that sucker in.
char *p = strcasestr(mReadBuffer, "nonce");
if (p && p[-1] != 'c') { // nonce but not cnonce
p += 6;
char *q = p;
while (isalnum(*q)) { q++; }
string RAND = string(mReadBuffer, p-mReadBuffer, q-p);
LOG(INFO) << "crowbar www-authenticate " << RAND;
osip_www_authenticate_t *auth;
osip_www_authenticate_init(&auth);
string auth_type = "Digest";
osip_www_authenticate_set_auth_type(auth, osip_strdup(auth_type.c_str()));
osip_www_authenticate_set_nonce(auth, osip_strdup(RAND.c_str()));
int k = osip_list_add (&msg->www_authenticates, auth, -1);
if (k < 0) LOG(ERR) << "problem adding www_authenticate";
}
// The parser doesn't seem to be interested in authentication info either.
// Get kc from there and put it in tmsi table.
char *pp = strcasestr(mReadBuffer, "cnonce");
if (pp) {
pp += 7;
char *qq = pp;
while (isalnum(*qq)) { qq++; }
string kc = string(mReadBuffer, pp-mReadBuffer, qq-pp);
LOG(INFO) << "storing kc in TMSI table"; // mustn't display kc in log
const char *imsi = osip_uri_get_username(msg->to->url);
if (imsi && strlen(imsi) > 0) {
gTMSITable.putKc(imsi+4, kc);
} else {
LOG(ERR) << "can't find imsi to store kc";
}
}
if (msg->sip_method) LOG(DEBUG) << "read method " << msg->sip_method;
// Must check if msg is an invite.
// if it is, handle appropriatly.
// FIXME -- Check return value in case this failed.
// FIXME -- If we support USSD via SIP, we will need to check the map first.
checkInvite(msg);
// FIXME -- Need to check for early BYE or CANCEL to stop paging.
// If it's a BYE, find the corresponding transaction table entry.
// If the Q931 state is "paging", or T3113 is expired, remove it.
// Otherwise, we will keep paging even though the call has ended.
// Multiplex out the received SIP message to active calls.
// If we write to non-existent call_id.
// this is errant message so need to catch
// Internal error excatpion. and give nice
// message (instead of aborting)
// Don't free call_id_num. It points into msg->call_id.
char * call_id_num = osip_call_id_get_number(msg->call_id);
if( call_id_num == NULL ) {
LOG(WARNING) << "message with no call id";
throw SIPError();
}
LOG(DEBUG) << "got message " << msg << " with call id " << call_id_num << " and writing it to the map.";
string call_num(call_id_num);
// Don't free msg. Whoever reads the FIFO will do that.
mSIPMap.write(call_num, msg);
}
catch(SIPException) {
LOG(WARNING) << "cannot parse SIP message: " << mReadBuffer;
}
}
const char* extractIMSI(const osip_message_t *msg)
{
// Get request username (IMSI) from invite.
// Form of the name is IMSI<digits>, and it should always be 18 or 19 char.
const char * IMSI = msg->req_uri->username;
LOG(INFO) << msg->sip_method << " to "<< IMSI;
// IMSIs are 14 or 15 char + "IMSI" prefix
// FIXME -- We need better validity-checking.
unsigned namelen = strlen(IMSI);
if ((namelen>19)||(namelen<18)) {
LOG(WARNING) << "INVITE with malformed username \"" << IMSI << "\"";
return nullptr;
}
// Skip first 4 char "IMSI".
return IMSI+4;
}
const char* extractCallID(const osip_message_t* msg)
{
if (!msg->call_id) return NULL;
return osip_call_id_get_number(msg->call_id);
}
bool SIPInterface::checkInvite( osip_message_t * msg)
{
LOG(DEBUG);
// This code dispatches new transactions coming from the network-side SIP interface.
// All transactions originating here are going to be mobile-terminated.
// Yes, this method is too long and needs to be broken up into smaller steps.
// Is there even a method?
const char *method = msg->sip_method;
if (!method) return false;
// Check for INVITE or MESSAGE methods.
// Check channel availability now, too.
UMTS::ChannelTypeL3 requiredChannel;
bool channelAvailable = false;
GSM::L3CMServiceType serviceType;
string proxy;
if (strcmp(method,"INVITE") == 0) {
// INVITE is for MTC.
// Set the required channel type to match the assignment style.
if (gConfig.getBool("Control.VEA")) {
// Very early assignment.
requiredChannel = UMTS::DTCHType;
channelAvailable = gNodeB.DTCHAvailable();
} else {
// Early assignment
requiredChannel = UMTS::DCCHType;
// (pat) There is no DCCH for UMTS. If the UE is registered we can send it messages.
channelAvailable = gNodeB.DCCHAvailable() && gNodeB.DTCHAvailable();
}
serviceType = GSM::L3CMServiceType::MobileTerminatedCall;
proxy = gConfig.getStr("SIP.Proxy.Speech");
}
else if (strcmp(method,"MESSAGE") == 0) {
// MESSAGE is for MTSMS.
requiredChannel = UMTS::DCCHType;
channelAvailable = gNodeB.DCCHAvailable();
serviceType = GSM::L3CMServiceType::MobileTerminatedShortMessage;
proxy = gConfig.getStr("SIP.Proxy.SMS");
}
else {
// Not a method handled here.
LOG(DEBUG) << "non-initiating SIP method " << method;
return false;
}
// Get request username (IMSI) from invite.
const char* IMSI = extractIMSI(msg);
if (!IMSI) {
// FIXME -- Send appropriate error (404) on SIP interface.
LOG(WARNING) << "Incoming INVITE/MESSAGE with no IMSI";
return false;
}
GSM::L3MobileIdentity mobileID(IMSI);
// Get the SIP call ID.
const char * callIDNum = extractCallID(msg);
if (!callIDNum) {
// FIXME -- Send appropriate error on SIP interface.
LOG(WARNING) << "Incoming INVITE/MESSAGE with no call ID";
return false;
}
// Find any active transaction for this IMSI with an assigned DTCH or DCCH.
UMTS::LogicalChannel *chan = gTransactionTable.findChannel(mobileID);
if (chan) {
if (chan->DCCH()) chan = chan->DCCH();
}
// Check SIP map. Repeated entry? Page again.
if (mSIPMap.map().readNoBlock(callIDNum) != NULL) {
TransactionEntry* transaction= gTransactionTable.find(mobileID,callIDNum);
// There's a FIFO but no trasnaction record?
if (!transaction) {
LOG(WARNING) << "repeated INVITE/MESSAGE with no transaction record";
// Delete the bogus FIFO.
mSIPMap.remove(callIDNum);
return false;
}
// There is transaction already. Send trying.
transaction->MTCSendTrying();
// And if no channel is established yet, page again.
if (!chan) {
LOG(INFO) << "repeated SIP INVITE/MESSAGE, repaging for transaction " << *transaction;
gNodeB.pager().addID(mobileID,requiredChannel,*transaction);
}
return false;
}
// So we will need a new channel.
// Check gNodeB for channel availability.
if (!chan && !channelAvailable) {
// FIXME -- Send 503 "Service Unavailable" response on SIP interface.
// Don't forget the retry-after header.
LOG(NOTICE) << "MTC CONGESTION, no " << requiredChannel << " availble for assignment";
return false;
}
if (chan) { LOG(INFO) << "using existing channel " << chan->descriptiveString(); }
else { LOG(INFO) << "set up MTC paging for channel=" << requiredChannel; }
// Add an entry to the SIP Map to route inbound SIP messages.
addCall(callIDNum);
LOG(DEBUG) << "callIDNum " << callIDNum << " IMSI " << IMSI;
// Get the caller ID if it's available.
const char *callerID = "";
const char *callerHost = "";
osip_from_t *from = osip_message_get_from(msg);
if (from) {
osip_uri_t* url = osip_contact_get_url(from);
if (url) {
if (url->username) callerID = url->username;
if (url->host) callerHost = url->host;
}
} else {
LOG(NOTICE) << "INVITE with no From: username for " << mobileID;
}
LOG(DEBUG) << "callerID " << callerID << "@" << callerHost;
// Build the transaction table entry.
// This constructor sets TI automatically for an MT transaction.
TransactionEntry *transaction = new TransactionEntry(proxy.c_str(),mobileID,chan,serviceType,callerID);
// FIXME -- These parameters should be arguments to the constructor above.
transaction->SIPUser(callIDNum,IMSI,callerID,callerHost);
transaction->saveINVITE(msg,false);
// Tell the sender we are trying.
transaction->MTCSendTrying();
// SMS? Get the text message body to deliver.
if (serviceType == GSM::L3CMServiceType::MobileTerminatedShortMessage) {
osip_body_t *body;
osip_content_type_t *contentType;
osip_message_get_body(msg,0,&body);
contentType = osip_message_get_content_type(msg);
const char *text = NULL;
char *type = NULL;
if (body) text = body->body;
if (text) transaction->message(text, body->length);
else LOG(NOTICE) << "MTSMS incoming MESSAGE method with no message body for " << mobileID;
/* Ok, so osip does some funny stuff here. The MIME type is split into type and subType.
Basically, text/plain becomes type=text, subType=plain. We need to put those together...
*/
if (contentType) {
type = (char *)malloc(strlen(contentType->type)+strlen(contentType->subtype)+2);
}
if (type) {
strcpy(type,contentType->type);
strcat(type,"/");
strcat(type,contentType->subtype);
transaction->messageType(type);
free(type);
}
else LOG(NOTICE) << "MTSMS incoming MESSAGE method with no content type (or memory error) for " << mobileID;
}
LOG(INFO) << "MTC MTSMS make transaction and add to transaction table: "<< *transaction;
gTransactionTable.add(transaction);
// If there's an existing channel, skip the paging step.
if (!chan) {
// Add to paging list.
LOG(DEBUG) << "MTC MTSMS new SIP invite, initial paging for mobile ID " << mobileID;
gNodeB.pager().addID(mobileID,requiredChannel,*transaction);
} else {
// Add a transaction to an existing channel.
chan->addTransaction(transaction);
// FIXME -- We need to write something into the channel to trigger the new transaction.
// We need to send a message into the chan's dispatch loop,
// becasue we can't block this thread to run the transaction.
}
return true;
}
// vim: ts=4 sw=4
Reference in New Issue View Git Blame Copy Permalink