src/websockets/qmaskgenerator.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:LGPL21$
   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 or version 3 as published by the Free
  20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
  21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
  22 ** following information to ensure the GNU Lesser General Public License
  23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
  24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  25 **
  26 ** In addition, as a special exception, Digia gives you certain additional
  27 ** rights. These rights are described in the Digia Qt LGPL Exception
  28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  29 **
  30 ** $QT_END_LICENSE$
  31 **
  32 ****************************************************************************/
  33
  34 /*!
  35     \class QMaskGenerator
  36
  37     \inmodule QtWebSockets
  38
  39     \brief The QMaskGenerator class provides an abstract base for custom 32-bit mask generators.
  40
  41     The WebSockets specification as outlined in \l {http://tools.ietf.org/html/rfc6455}{RFC 6455}
  42     requires that all communication from client to server be masked. This is to prevent
  43     malicious scripts from attacking badly behaving proxies.
  44     For more information about the importance of good masking,
  45     see \l {http://w2spconf.com/2011/papers/websocket.pdf}.
  46     By default QWebSocket uses the cryptographically insecure qrand() function.
  47     The best measure against attacks mentioned in the document above,
  48     is to use QWebSocket over a secure connection (\e wss://).
  49     In general, always be careful to not have 3rd party script access to
  50     a QWebSocket in your application.
  51 */
  52
  53 /*!
  54     \fn bool QMaskGenerator::seed()
  55
  56     Initializes the QMaskGenerator by seeding the randomizer.
  57     When seed() is not called, it depends on the specific implementation of a subclass if
  58     a default seed is used or no seed is used at all.
  59     Returns \e true if seeding succeeds, otherwise false.
  60 */
  61
  62 /*!
  63     \fn quint32 QMaskGenerator::nextMask()
  64
  65     Returns a new random 32-bit mask. The randomness depends on the RNG used to created the
  66     mask.
  67 */
  68
  69 #include "qmaskgenerator.h"
  70
  71 QT_BEGIN_NAMESPACE
  72
  73 /*!
  74     Creates a new QMaskGenerator object with the given optional QObject \a parent.
  75  */
  76 QMaskGenerator::QMaskGenerator(QObject *parent) :
  77     QObject(parent)
  78 {
  79 }
  80
  81 /*!
  82     Destroys the QMaskGenerator object.
  83  */
  84 QMaskGenerator::~QMaskGenerator()
  85 {}
  86
  87 QT_END_NAMESPACE