src/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 WebSocketProtocol::CloseCode
  27
  28     The close codes supported by WebSockets V13
  29
  30     \value CC_NORMAL                    Normal closure
  31     \value CC_GOING_AWAY                Going away
  32     \value CC_PROTOCOL_ERROR            Protocol error
  33     \value CC_DATATYPE_NOT_SUPPORTED    Unsupported data
  34     \value CC_RESERVED_1004             Reserved
  35     \value CC_MISSING_STATUS_CODE       No status received
  36     \value CC_ABNORMAL_DISCONNECTION    Abnormal closure
  37     \value CC_WRONG_DATATYPE            Invalid frame payload data
  38     \value CC_POLICY_VIOLATED           Policy violation
  39     \value CC_TOO_MUCH_DATA             Message too big
  40     \value CC_MISSING_EXTENSION         Mandatory extension missing
  41     \value CC_BAD_OPERATION             Internal server error
  42     \value CC_TLS_HANDSHAKE_FAILED      TLS handshake failed
  43
  44     \sa \l{QWebSocket::} {close()}
  45 */
  46 /*!
  47     \enum WebSocketProtocol::Version
  48
  49     \brief The different defined versions of the Websocket protocol.
  50
  51     For an overview of the differences between the different protocols, see
  52     <http://code.google.com/p/pywebsocket/wiki/WebSocketProtocolSpec>
  53
  54     \value V_Unknow
  55     \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.
  56                         Works with key1, key2 and a key in the payload.
  57                         Attribute: Sec-WebSocket-Draft value 0.
  58     \value V_4          hybi-04: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-04.txt.
  59                         Changed handshake: key1, key2, key3 ==> Sec-WebSocket-Key, Sec-WebSocket-Nonce, Sec-WebSocket-Accept
  60                         Sec-WebSocket-Draft renamed to Sec-WebSocket-Version
  61                         Sec-WebSocket-Version = 4
  62     \value V_5          hybi-05: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-05.txt.
  63                         Sec-WebSocket-Version = 5
  64                         Removed Sec-WebSocket-Nonce
  65                         Added Sec-WebSocket-Accept
  66     \value V_6          Sec-WebSocket-Version = 6.
  67     \value V_7          hybi-07: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07.
  68                         Sec-WebSocket-Version = 7
  69     \value V_8          hybi-8, hybi-9, hybi-10, hybi-11 and hybi-12.
  70                         Status codes 1005 and 1006 are added and all codes are now unsigned
  71                         Internal error results in 1006
  72     \value V_13         hybi-13, hybi14, hybi-15, hybi-16, hybi-17 and RFC 6455.
  73                         Sec-WebSocket-Version = 13
  74                         Status code 1004 is now reserved
  75                         Added 1008, 1009 and 1010
  76                         Must support TLS
  77                         Clarify multiple version support
  78     \value V_LATEST     Refers to the latest know version to QWebSockets.
  79 */
  80
  81 /*!
  82   \fn WebSocketProtocol::isOpCodeReserved(OpCode code)
  83   Checks if \a code is a valid OpCode
  84   \internal
  85 */
  86
  87 /*!
  88   \fn WebSocketProtocol::isCloseCodeValid(int closeCode)
  89   Checks if \a closeCode is a valid web socket close code
  90   \internal
  91 */
  92
  93 /*!
  94   \fn WebSocketProtocol::getCurrentVersion()
  95   Returns the latest version that WebSocket is supporting
  96   \internal
  97 */
  98
  99 QT_BEGIN_NAMESPACE
 100
 101 /**
 102  * @brief Contains constants related to the WebSocket standard.
 103  */
 104 namespace QWebSocketProtocol
 105 {
 106 /*!
 107         Parses the \a versionString and converts it to a Version value
 108         \internal
 109     */
 110 Version versionFromString(const QString &versionString)
 111 {
 112     bool ok = false;
 113     Version version = V_Unknow;
 114     int ver = versionString.toInt(&ok);
 115     QSet<Version> supportedVersions;
 116     supportedVersions << V_0 << V_4 << V_5 << V_6 << V_7 << V_8 << V_13;
 117     if (ok)
 118     {
 119         if (supportedVersions.contains(static_cast<Version>(ver)))
 120         {
 121             version = static_cast<Version>(ver);
 122         }
 123     }
 124     return version;
 125 }
 126
 127 /*!
 128       Mask the \a payload with the given \a maskingKey and stores the result back in \a payload.
 129       \internal
 130     */
 131 void mask(QByteArray *payload, quint32 maskingKey)
 132 {
 133     quint32 *payloadData = reinterpret_cast<quint32 *>(payload->data());
 134     quint32 numIterations = static_cast<quint32>(payload->size()) / sizeof(quint32);
 135     quint32 remainder = static_cast<quint32>(payload->size()) % sizeof(quint32);
 136     quint32 i;
 137     for (i = 0; i < numIterations; ++i)
 138     {
 139         *(payloadData + i) ^= maskingKey;
 140     }
 141     if (remainder)
 142     {
 143         const quint32 offset = i * static_cast<quint32>(sizeof(quint32));
 144         char *payloadBytes = payload->data();
 145         uchar *mask = reinterpret_cast<uchar *>(&maskingKey);
 146         for (quint32 i = 0; i < remainder; ++i)
 147         {
 148             *(payloadBytes + offset + i) ^= static_cast<char>(mask[(i + offset) % 4]);
 149         }
 150     }
 151 }
 152
 153 /*!
 154       Masks the \a payload of length \a size with the given \a maskingKey and stores the result back in \a payload.
 155       \internal
 156     */
 157 void mask(char *payload, quint64 size, quint32 maskingKey)
 158 {
 159     quint32 *payloadData = reinterpret_cast<quint32 *>(payload);
 160     quint32 numIterations = static_cast<quint32>(size / sizeof(quint32));
 161     quint32 remainder = size % sizeof(quint32);
 162     quint32 i;
 163     for (i = 0; i < numIterations; ++i)
 164     {
 165         *(payloadData + i) ^= maskingKey;
 166     }
 167     if (remainder)
 168     {
 169         const quint32 offset = i * static_cast<quint32>(sizeof(quint32));
 170         uchar *mask = reinterpret_cast<uchar *>(&maskingKey);
 171         for (quint32 i = 0; i < remainder; ++i)
 172         {
 173             *(payload + offset + i) ^= static_cast<char>(mask[(i + offset) % 4]);
 174         }
 175     }
 176 }
 177 }       //end namespace WebSocketProtocol
 178
 179 QT_END_NAMESPACE