WsFrameExtractor.hxx

Go to the documentation of this file.

#ifndef RESIP_WsFrameExtractor_hxx
#define RESIP_WsFrameExtractor_hxx
 
#include <memory>
#include <queue>
 
#include "rutil/compat.hxx"
#include "rutil/Data.hxx"
 
namespace resip
{
 
class WsFrameExtractor
{
   public:
 
      // frame opcodes (RFC 6455 section 5.2)
      static const uint8_t OpContinuation = 0x0;
      static const uint8_t OpText = 0x1;
      static const uint8_t OpBinary = 0x2;
      static const uint8_t OpClose = 0x8;
      static const uint8_t OpPing = 0x9;
      static const uint8_t OpPong = 0xA;
 
      // A Close, Ping or Pong frame.  These are never returned by processBytes():
      // a peer may send one at any time, even between the fragments of a message,
      // and its payload is not SIP.
      struct ControlFrame
      {
         uint8_t opcode;
         Data payload;
      };
 
      WsFrameExtractor(Data::size_type maxMessage);
      ~WsFrameExtractor();
      std::unique_ptr<Data> processBytes(uint8_t *input, Data::size_type len, bool& dropConnection);
      // the control frames received so far, in the order they arrived
      bool popControlFrame(ControlFrame& frame);
 
   private:
 
      static const int mMaxHeaderLen;
      // an upper bound on the number of frames a single message may be
      // fragmented into, to stop a peer consuming unbounded memory by
      // sending an endless run of tiny (or empty) continuation frames
      static const size_t mMaxFrames;
 
      Data::size_type mMaxMessage;
 
      std::queue<Data*> mFrames;
      std::queue<Data*> mMessages;
      // for tracking the cumulative size of all full frames
      // not yet assembled into a message:
      Data::size_type mMessageSize;
 
      bool mHaveHeader;
      int mHeaderLen;
      uint8_t *mWsHeader;
 
      std::queue<ControlFrame> mControlFrames;
      // set once a Close frame has arrived: nothing the peer sends after it is processed
      bool mClosed;
 
      bool mFinalFrame;
      bool mMasked;
      uint8_t mOpcode;
      uint8_t mWsMaskKey[4];
      // the payload length as it appears on the wire: it is a 64 bit
      // field, so it must be validated against mMaxMessage before it is
      // used for anything (see processBytes)
      uint64_t mPayloadLength;
 
      uint8_t *mPayload;
      Data::size_type mPayloadPos;
 
      int parseHeader();
      bool isControlFrame() const;
      void joinFrames();
 
};
 
}
 
#endif
 
/* ====================================================================
 *
 * Copyright (c) 2026 SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright 2013 Daniel Pocock.  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. Neither the name of the author(s) nor the names of any contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, 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.
 *
 * ====================================================================
 *
 *
 */