src/websockets/qwebsocketprotocol.cpp

   1 /*
   2 QWebSockets implements the WebSocket protocol as defined in RFC 6455.
   3 Copyright (C) 2013 Kurt Pattyn (pattyn.kurt@gmail.com)
   4
   5 This library is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU Lesser General Public
   7 License as published by the Free Software Foundation; either
   8 version 2.1 of the License, or (at your option) any later version.
   9
  10 This library is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public
  16 License along with this library; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18 */
  19
  20 #include "qwebsocketprotocol.h"
  21 #include <QString>
  22 #include <QSet>
  23 #include <QtEndian>
  24
  25 /*!
  26     \enum QWebSocketProtocol::CloseCode
  27
  28     \inmodule QtWebSockets
  29
  30     The close codes supported by WebSockets V13
  31
  32     \value CC_NORMAL                    Normal closure
  33     \value CC_GOING_AWAY                Going away
  34     \value CC_PROTOCOL_ERROR            Protocol error
  35     \value CC_DATATYPE_NOT_SUPPORTED    Unsupported data
  36     \value CC_RESERVED_1004             Reserved
  37     \value CC_MISSING_STATUS_CODE       No status received
  38     \value CC_ABNORMAL_DISCONNECTION    Abnormal closure
  39     \value CC_WRONG_DATATYPE            Invalid frame payload data
  40     \value CC_POLICY_VIOLATED           Policy violation
  41     \value CC_TOO_MUCH_DATA             Message too big
  42     \value CC_MISSING_EXTENSION         Mandatory extension missing
  43     \value CC_BAD_OPERATION             Internal server error
  44     \value CC_TLS_HANDSHAKE_FAILED      TLS handshake failed
  45
  46     \sa \l{QWebSocket::} {close()}
  47 */
  48 /*!
  49     \enum QWebSocketProtocol::Version
  50
  51     \inmodule QtWebSockets
  52
  53     \brief The different defined versions of the Websocket protocol.
  54
  55     For an overview of the differences between the different protocols, see
  56     <http://code.google.com/p/pywebsocket/wiki/WebSocketProtocolSpec>
  57
  58     \value V_Unknow
  59     \value V_0          hixie76: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 & hybi-00: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00.
  60                         Works with key1, key2 and a key in the payload.
  61                         Attribute: Sec-WebSocket-Draft value 0.
  62     \value V_4          hybi-04: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-04.txt.
  63                         Changed handshake: key1, key2, key3 ==> Sec-WebSocket-Key, Sec-WebSocket-Nonce, Sec-WebSocket-Accept
  64                         Sec-WebSocket-Draft renamed to Sec-WebSocket-Version
  65                         Sec-WebSocket-Version = 4
  66     \value V_5          hybi-05: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-05.txt.
  67                         Sec-WebSocket-Version = 5
  68                         Removed Sec-WebSocket-Nonce
  69                         Added Sec-WebSocket-Accept
  70     \value V_6          Sec-WebSocket-Version = 6.
  71     \value V_7          hybi-07: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07.
  72                         Sec-WebSocket-Version = 7
  73     \value V_8          hybi-8, hybi-9, hybi-10, hybi-11 and hybi-12.
  74                         Status codes 1005 and 1006 are added and all codes are now unsigned
  75                         Internal error results in 1006
  76     \value V_13         hybi-13, hybi14, hybi-15, hybi-16, hybi-17 and RFC 6455.
  77                         Sec-WebSocket-Version = 13
  78                         Status code 1004 is now reserved
  79                         Added 1008, 1009 and 1010
  80                         Must support TLS
  81                         Clarify multiple version support
  82     \value V_LATEST     Refers to the latest know version to QWebSockets.
  83 */
  84
  85 /*!
  86   \fn QWebSocketProtocol::isOpCodeReserved(OpCode code)
  87   Checks if \a code is a valid OpCode
  88   \internal
  89 */
  90
  91 /*!
  92   \fn QWebSocketProtocol::isCloseCodeValid(int closeCode)
  93   Checks if \a closeCode is a valid web socket close code
  94   \internal
  95 */
  96
  97 /*!
  98   \fn QWebSocketProtocol::currentVersion()
  99   Returns the latest version that WebSocket is supporting
 100   \internal
 101 */
 102
 103 QT_BEGIN_NAMESPACE
 104
 105 /**
 106  * @brief Contains constants related to the WebSocket standard.
 107  */
 108 namespace QWebSocketProtocol
 109 {
 110 /*!
 111         Parses the \a versionString and converts it to a Version value
 112         \internal
 113     */
 114 Version versionFromString(const QString &versionString)
 115 {
 116     bool ok = false;
 117     Version version = V_Unknow;
 118     const int ver = versionString.toInt(&ok);
 119     QSet<Version> supportedVersions;
 120     supportedVersions << V_0 << V_4 << V_5 << V_6 << V_7 << V_8 << V_13;
 121     if (ok)
 122     {
 123         if (supportedVersions.contains(static_cast<Version>(ver)))
 124         {
 125             version = static_cast<Version>(ver);
 126         }
 127     }
 128     return version;
 129 }
 130
 131 /*!
 132       Mask the \a payload with the given \a maskingKey and stores the result back in \a payload.
 133       \internal
 134     */
 135 void mask(QByteArray *payload, quint32 maskingKey)
 136 {
 137     quint32 *payloadData = reinterpret_cast<quint32 *>(payload->data());
 138     const quint32 numIterations = static_cast<quint32>(payload->size()) / sizeof(quint32);
 139     const quint32 remainder = static_cast<quint32>(payload->size()) % sizeof(quint32);
 140     quint32 i;
 141     for (i = 0; i < numIterations; ++i)
 142     {
 143         *(payloadData + i) ^= maskingKey;
 144     }
 145     if (remainder)
 146     {
 147         const quint32 offset = i * static_cast<quint32>(sizeof(quint32));
 148         char *payloadBytes = payload->data();
 149         const uchar *mask = reinterpret_cast<uchar *>(&maskingKey);
 150         for (quint32 i = 0; i < remainder; ++i)
 151         {
 152             *(payloadBytes + offset + i) ^= static_cast<char>(mask[(i + offset) % 4]);
 153         }
 154     }
 155 }
 156
 157 /*!
 158       Masks the \a payload of length \a size with the given \a maskingKey and stores the result back in \a payload.
 159       \internal
 160     */
 161 void mask(char *payload, quint64 size, quint32 maskingKey)
 162 {
 163     quint32 *payloadData = reinterpret_cast<quint32 *>(payload);
 164     const quint32 numIterations = static_cast<quint32>(size / sizeof(quint32));
 165     const quint32 remainder = size % sizeof(quint32);
 166     quint32 i;
 167     for (i = 0; i < numIterations; ++i)
 168     {
 169         *(payloadData + i) ^= maskingKey;
 170     }
 171     if (remainder)
 172     {
 173         const quint32 offset = i * static_cast<quint32>(sizeof(quint32));
 174         const uchar *mask = reinterpret_cast<uchar *>(&maskingKey);
 175         for (quint32 i = 0; i < remainder; ++i)
 176         {
 177             *(payload + offset + i) ^= static_cast<char>(mask[(i + offset) % 4]);
 178         }
 179     }
 180 }
 181 }       //end namespace WebSocketProtocol
 182
 183 QT_END_NAMESPACE