src/websockets/qdefaultmaskgenerator_p.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtWebSockets module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 /*!
  42     \class QDefaultMaskGenerator
  43
  44     \inmodule QtWebSockets
  45
  46     \brief The QDefaultMaskGenerator class provides the default mask generator for QtWebSockets.
  47
  48     The WebSockets specification as outlined in {http://tools.ietf.org/html/rfc6455}{RFC 6455}
  49     requires that all communication from client to server must be masked. This is to prevent
  50     malicious scripts to attack bad behaving proxies.
  51     For more information about the importance of good masking,
  52     see \l {http://w2spconf.com/2011/papers/websocket.pdf}.
  53     The default mask generator uses the cryptographically insecure qrand() function.
  54     The best measure against attacks mentioned in the document above,
  55     is to use QWebSocket over a secure connection (\e wss://).
  56     In general, always be careful to not have 3rd party script access to
  57     a QWebSocket in your application.
  58
  59     \internal
  60 */
  61
  62 #include "qdefaultmaskgenerator_p.h"
  63 #include <QDateTime>
  64 #include <limits>
  65
  66 QT_BEGIN_NAMESPACE
  67
  68 /*!
  69     Constructs a new QDefaultMaskGenerator with the given \a parent.
  70
  71     \internal
  72 */
  73 QDefaultMaskGenerator::QDefaultMaskGenerator(QObject *parent) :
  74     QMaskGenerator(parent)
  75 {
  76 }
  77
  78 /*!
  79     Destroys the QDefaultMaskGenerator object.
  80
  81     \internal
  82 */
  83 QDefaultMaskGenerator::~QDefaultMaskGenerator()
  84 {
  85 }
  86
  87 /*!
  88     Seeds the QDefaultMaskGenerator using qsrand().
  89     When seed() is not called, no seed is used at all.
  90
  91     \internal
  92 */
  93 bool QDefaultMaskGenerator::seed() Q_DECL_NOEXCEPT
  94 {
  95     qsrand(static_cast<uint>(QDateTime::currentMSecsSinceEpoch()));
  96     return true;
  97 }
  98
  99 /*!
 100     Generates a new random mask using the insecure qrand() method.
 101
 102     \internal
 103 */
 104 quint32 QDefaultMaskGenerator::nextMask() Q_DECL_NOEXCEPT
 105 {
 106     return quint32((double(qrand()) / RAND_MAX) * std::numeric_limits<quint32>::max());
 107 }
 108
 109 QT_END_NAMESPACE