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: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 /*!
  43     \class QMaskGenerator
  44
  45     \inmodule QtWebSockets
  46
  47     \brief The QMaskGenerator class provides an abstract base for custom 32-bit mask generators.
  48
  49     The WebSockets specification as outlined in {http://tools.ietf.org/html/rfc6455}{RFC 6455}
  50     requires that all communication from client to server must be masked. This is to prevent
  51     malicious scripts to attack bad behaving proxies.
  52     For more information about the importance of good masking,
  53     see \l {http://w2spconf.com/2011/papers/websocket.pdf}.
  54     By default QWebSocket uses the cryptographically insecure qrand() function.
  55     The best measure against attacks mentioned in the document above,
  56     is to use QWebSocket over a secure connection (\e wss://).
  57     In general, always be careful to not have 3rd party script access to
  58     a QWebSocket in your application.
  59 */
  60
  61 /*!
  62     \fn bool QMaskGenerator::seed()
  63
  64     Initializes the QMaskGenerator by seeding the randomizer.
  65     When seed() is not called, it depends on the specific implementation of a subclass if
  66     a default seed is used or no seed is used at all.
  67     Returns \e true if seeding succeeds, otherwise false.
  68 */
  69
  70 /*!
  71     \fn quint32 QMaskGenerator::nextMask()
  72
  73     Returns a new random 32-bit mask. The randomness depends on the RNG used to created the
  74     mask.
  75 */
  76
  77 #include "qmaskgenerator.h"
  78
  79 QT_BEGIN_NAMESPACE
  80
  81 /*!
  82     Creates a new QMaskGenerator object with the given optional QObject \a parent.
  83  */
  84 QMaskGenerator::QMaskGenerator(QObject *parent) :
  85     QObject(parent)
  86 {
  87 }
  88
  89 /*!
  90     Destroys the QMaskGenerator object.
  91  */
  92 QMaskGenerator::~QMaskGenerator()
  93 {}
  94
  95 QT_END_NAMESPACE