HttpConnection.cxx

Go to the documentation of this file.

#include "rutil/ResipAssert.h"
 
#include "rutil/Data.hxx"
#include "rutil/DataStream.hxx"
#include "rutil/Socket.hxx"
#include "resip/stack/Symbols.hxx"
#include "rutil/TransportType.hxx"
#include "rutil/Logger.hxx"
#include "resip/stack/Tuple.hxx"
#include "rutil/DnsUtil.hxx"
#include "rutil/ParseBuffer.hxx"
 
#include "repro/ReproVersion.hxx"
#include "repro/HttpBase.hxx"
#include "repro/HttpConnection.hxx"
 
 
using namespace resip;
using namespace repro;
using namespace std;
 
#define RESIPROCATE_SUBSYSTEM Subsystem::REPRO
 
int HttpConnection::nextPageNumber=1;
 
namespace
{
// Canned HTTP status page, styled to match the admin pages (see
// repro/webadmin/pageOutlinePre.html for the palette these colours come from).
Data
statusPage(const char* code, const char* title, const char* detail)
{
   Data page;
   {
      DataStream s(page);
      s << "<!DOCTYPE html>"
           "<html lang=\"en\"><head><meta charset=\"utf-8\" />"
           "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />"
           "<title>" << code << " " << title << "</title><style>"
           "*,*::before,*::after{box-sizing:border-box;margin:0;padding:0}"
           "body{background:#0a0c0f;color:#c8d0da;"
           "font-family:'IBM Plex Mono',ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;"
           "font-size:13px;line-height:1.55;min-height:100vh;display:flex;align-items:center;"
           "justify-content:center;padding:24px}"
           ".card{background:#10141a;border:1px solid #1e2730;border-radius:3px;"
           "padding:26px 28px;max-width:460px;width:100%}"
           ".code{font-size:11px;font-weight:600;letter-spacing:.18em;color:#ffab00;"
           "text-transform:uppercase;margin-bottom:8px}"
           ".title{font-size:17px;font-weight:600;letter-spacing:.04em}"
           "p{color:#7a8899;font-size:12px;margin-top:14px}"
           "a{color:#40c4ff;text-decoration:none}a:hover{text-decoration:underline}"
           "</style></head><body><div class=\"card\">"
           "<div class=\"code\">HTTP " << code << "</div>"
           "<div class=\"title\">" << title << "</div>"
           "<p>" << detail << "</p>"
           "<p><a href=\"/index.html\">&larr; Back to Repro</a></p>"
           "</div></body></html>";
      s.flush();
   }
   return page;
}
}
 
 
 
 
HttpConnection::HttpConnection( HttpBase& base, Socket pSock ):
   mHttpBase( base ),
   mPageNumber(nextPageNumber++),
   mSock(pSock),
   mParsedRequest(false)
{
    resip_assert( mSock > 0 );
}
 
 
HttpConnection::~HttpConnection()
{
   resip_assert( mSock > 0 );
#ifdef WIN32
   closesocket(mSock); mSock=0;
#else
   close(mSock); mSock=0;
#endif
}
 
      
void 
HttpConnection::buildFdSet(FdSet& fdset)
{
   if ( !mTxBuffer.empty() )
   {
      fdset.setWrite(mSock);
   }
   fdset.setRead(mSock);
}
 
 
bool 
HttpConnection::process(FdSet& fdset)
{
   if ( fdset.hasException(mSock) )
   {
      int errNum = 0;
      int errNumSize = sizeof(errNum);
      getsockopt(mSock,SOL_SOCKET,SO_ERROR,(char *)&errNum,(socklen_t *)&errNumSize);
      InfoLog (<< "Exception reading from socket " 
               << (int)mSock << " code: " << errNum << "; closing connection");
      return false;
   }
   
   if ( fdset.readyToRead( mSock ) )
   {
      bool ok = processSomeReads();
      if ( !ok )
      {
         return false;
      }
   }
   if ( (!mTxBuffer.empty()) && fdset.readyToWrite( mSock ) )
   {
      bool ok = processSomeWrites();
      if ( !ok )
      {
         return false;
      }
   }
 
   return true;
}
 
 
void 
HttpConnection::setPage(const Data& pPage,int response,const Mime& pType)
{
   Data page(pPage);
 
   // For REST responses (application/json), callers supply the body and we
   // must not substitute a canned HTML body.
   const bool isJson = (pType.type() == "application" && pType.subType() == "json");
 
   switch (response)
   {
      case 401:
      {  
         mTxBuffer += "HTTP/1.0 401 Unauthorized"; mTxBuffer += Symbols::CRLF;
 
         if (!isJson)
         {
            page = statusPage("401", "Unauthorized",
                              "Valid administrator credentials are required to view this page.");
         }
      }
      break;
 
      case 404:
      {  
         mTxBuffer += "HTTP/1.0 404 Not Found"; mTxBuffer += Symbols::CRLF;
 
         if (!isJson)
         {
            page = statusPage("404", "Not Found",
                              "The requested page does not exist on this server.");
         }
      }
      break;
      
      case 301:
      {
         mTxBuffer += "HTTP/1.0 301 Moved Permanently"; mTxBuffer += Symbols::CRLF;
         mTxBuffer += "Location: /index.html"; mTxBuffer += Symbols::CRLF;
         
         page = statusPage("301", "Moved Permanently",
                           "This page has moved.  Redirecting to the Repro home page.");
      }
      break;
      
      case 200:
      {
         mTxBuffer += "HTTP/1.0 200 OK" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 400:
      {
         mTxBuffer += "HTTP/1.0 400 Bad Request" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 405:
      {
         mTxBuffer += "HTTP/1.0 405 Method Not Allowed" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 500:
      {
         mTxBuffer += "HTTP/1.0 500 Server failure" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 501:
      {
         mTxBuffer += "HTTP/1.0 501 Not Implemented" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 503:
      {
         mTxBuffer += "HTTP/1.0 503 Service Unavailable" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      case 504:
      {
         mTxBuffer += "HTTP/1.0 504 Gateway Timeout" ; mTxBuffer += Symbols::CRLF;
      }
      break;
 
      default:
      {
         resip_assert(0);  
 
         Data resp;
         { 
            DataStream s(resp);
            s << response;
            s.flush();
         }
         
         mTxBuffer += "HTTP/1.0 ";
         mTxBuffer += resp;
         mTxBuffer += "OK" ; mTxBuffer += Symbols::CRLF;
      }
      break;
   }
   
   Data len;
   {
      DataStream s(len);
      s << page.size();
      s.flush();
   }
    
   mTxBuffer += "WWW-Authenticate: Basic realm=\"";
   if ( mHttpBase.mRealm.empty() )
   {
      mTxBuffer += resip::DnsUtil::getLocalHostName();
   }
   else
   {
      mTxBuffer += mHttpBase.mRealm;
   }
   mTxBuffer += "\" ";
   mTxBuffer += Symbols::CRLF;
 
   mTxBuffer += "Server: Repro Proxy " ; 
   mTxBuffer += Data(VersionUtils::instance().displayVersion());
   mTxBuffer += Symbols::CRLF;
   mTxBuffer += "Mime-version: 1.0 " ; mTxBuffer += Symbols::CRLF;
   mTxBuffer += "Pragma: no-cache " ; mTxBuffer += Symbols::CRLF;
   mTxBuffer += "Content-Length: "; mTxBuffer += len; mTxBuffer += Symbols::CRLF;
 
   mTxBuffer += "Content-Type: "  ;
   mTxBuffer += pType.type() ;
   mTxBuffer +="/"  ;
   mTxBuffer += pType.subType() ; mTxBuffer += Symbols::CRLF;
   
   mTxBuffer += Symbols::CRLF;
   
   mTxBuffer += page;
}
 
 
bool
HttpConnection::processSomeReads()
{
   const int bufSize = 8000;
   char buf[bufSize];
   
 
#if defined(WIN32)
   int bytesRead = ::recv(mSock, buf, bufSize, 0);
#else
   int bytesRead = ::read(mSock, buf, bufSize);
#endif
 
   if (bytesRead == INVALID_SOCKET)
   {
      int e = getErrno();
      switch (e)
      {
         case EAGAIN:
#if EAGAIN != EWOULDBLOCK
         case EWOULDBLOCK:  // Treat EGAIN and EWOULDBLOCK as the same: http://stackoverflow.com/questions/7003234/which-systems-define-eagain-and-ewouldblock-as-different-values
#endif
            InfoLog (<< "No data ready to read");
            return true;
         case EINTR:
            InfoLog (<< "The call was interrupted by a signal before any data was read.");
            break;
         case EIO:
            InfoLog (<< "I/O error");
            break;
         case EBADF:
            InfoLog (<< "fd is not a valid file descriptor or is not open for reading.");
            break;
         case EINVAL:
            InfoLog (<< "fd is attached to an object which is unsuitable for reading.");
            break;
         case EFAULT:
            InfoLog (<< "buf is outside your accessible address space.");
            break;
         default:
            InfoLog (<< "Some other error");
            break;
      }
      InfoLog (<< "Failed read on " << (int)mSock << " " << strError(e));
      return false;
   }
   else if (bytesRead == 0)
   {
      InfoLog (<< "Connection closed by remote " );
      return false;
   }
 
   //DebugLog (<< "HttpConnection::processSomeReads() " 
   //          << " read=" << bytesRead);            
 
   mRxBuffer += Data( buf, bytesRead );
   
   tryParse();
   
   return true;
}
 
 
void 
HttpConnection::tryParse()
{
   //DebugLog (<< "parse " << mRxBuffer );
   
   ParseBuffer pb(mRxBuffer);
   
   // See if we have the entire message
   pb.skipToChars(Symbols::CRLFCRLF);
   if(pb.eof())
   {
      // End of message not found - keep reading
      return;
   }
   pb.reset(pb.start());
 
   // Capture the HTTP method (first token) so that the subclass can
   // dispatch based on GET/POST/PUT/DELETE for REST endpoints.
   const char* methodStart = pb.position();
   pb.skipToChar(Symbols::SPACE[0]);
 
   if (pb.eof())
   {
      // parse failed - just return
      return;
   }
 
   Data method;
   pb.data(method, methodStart);
 
   const char* start = pb.skipWhitespace();
   pb.skipToChar(Symbols::SPACE[0]);
   
   if (pb.eof())
   {
      // parse failed - just return 
      return;
   }
   
   Data uri;
   pb.data( uri, start );
 
   DebugLog (<< "parse found method " << method << " URI " << uri );
   mParsedRequest = true;
     
   
   Data user;
   Data password;
 
   try
   {
      pb.skipToChars("Authorization");
      if (!pb.eof())
      {
         if ( pb.eof() ) DebugLog( << "Did not find Authorization header" );
         pb.skipToChars( "Basic" ); pb.skipN(6);
         if ( pb.eof() ) DebugLog( << "Did not find Authorization basic " );
         pb.skipWhitespace();
         if ( pb.eof() ) DebugLog( << "Something weird in Auhtorization header " );
         if ( !pb.eof() )
         {
            const char* a = pb.position();
            pb.skipNonWhitespace();
            Data buf = pb.data(a);
            
            DebugLog (<< "parse found basic base64 auth data of " << buf );
            Data auth = buf.base64decode();
            
            //DebugLog (<< "parse found basic auth data of " << auth );
            
            ParseBuffer p(auth);
            const char* a1 = p.position();
            p.skipToChar(':');
            user = p.data(a1);
            const char* a2 = p.skipChar(':');
            p.skipToEnd();
            password = p.data(a2);
            
            //DebugLog (<< "parse found basic auth data with user=" << user
            //          << " password=" << password );
         }
      }
   }
   catch ( ... )
   { 
      ErrLog (<< "Some problem finding Authorization header in HTTP request" );
   }
   
   mHttpBase.buildPage(method,uri,mPageNumber,user,password);
}
 
 
bool
HttpConnection::processSomeWrites()
{
   if ( mTxBuffer.empty() )
   {
      return true;
   }
   
   //DebugLog (<< "Writing " << mTxBuffer );
 
#if defined(WIN32)
   int bytesWritten = ::send( mSock, mTxBuffer.data(), (int)mTxBuffer.size(), 0);
#else
   int bytesWritten = ::write(mSock, mTxBuffer.data(), (int)mTxBuffer.size() );
#endif
 
   if (bytesWritten == INVALID_SOCKET)
   {
      int e = getErrno();
      InfoLog (<< "HttpConnection failed write on " << mSock << " " << strError(e));
 
      return false;
   }
   
   if (bytesWritten == (int)mTxBuffer.size() )
   {
      DebugLog (<< "Wrote it all" );
      mTxBuffer = Data::Empty;
 
      return false; // return false causes connection to close and clean up
   }
   else
   {
      Data rest = mTxBuffer.substr(bytesWritten);
      mTxBuffer = rest;
      DebugLog( << "Wrote " << bytesWritten << " bytes - still need to do " << mTxBuffer );
   }
   
   return true;
}
 
 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2026 SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */