[556] | 1 | /****************************************************************************
|
---|
| 2 | **
|
---|
[651] | 3 | ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
---|
[556] | 4 | ** All rights reserved.
|
---|
| 5 | ** Contact: Nokia Corporation ([email protected])
|
---|
| 6 | **
|
---|
| 7 | ** This file is part of the documentation of the Qt Toolkit.
|
---|
| 8 | **
|
---|
| 9 | ** $QT_BEGIN_LICENSE:LGPL$
|
---|
| 10 | ** Commercial Usage
|
---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in
|
---|
| 14 | ** a written agreement between you and Nokia.
|
---|
| 15 | **
|
---|
| 16 | ** GNU Lesser General Public License Usage
|
---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
---|
| 18 | ** General Public License version 2.1 as published by the Free Software
|
---|
| 19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
---|
| 20 | ** packaging of this file. Please review the following information to
|
---|
| 21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
---|
| 22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
---|
| 23 | **
|
---|
| 24 | ** In addition, as a special exception, Nokia gives you certain additional
|
---|
| 25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
---|
| 26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
---|
| 27 | **
|
---|
| 28 | ** GNU General Public License Usage
|
---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
---|
| 32 | ** packaging of this file. Please review the following information to
|
---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
---|
| 35 | **
|
---|
| 36 | ** If you have questions regarding the use of this file, please contact
|
---|
| 37 | ** Nokia at [email protected].
|
---|
| 38 | ** $QT_END_LICENSE$
|
---|
| 39 | **
|
---|
| 40 | ****************************************************************************/
|
---|
| 41 |
|
---|
| 42 | /*!
|
---|
| 43 | \group ssl
|
---|
| 44 | \title Secure Sockets Layer (SSL) Classes
|
---|
| 45 | \ingroup groups
|
---|
| 46 |
|
---|
| 47 | \brief Classes for secure communication over network sockets.
|
---|
| 48 | \keyword SSL
|
---|
| 49 |
|
---|
| 50 | The classes below provide support for secure network communication using
|
---|
| 51 | the Secure Sockets Layer (SSL) protocol, using the \l{OpenSSL Toolkit} to
|
---|
| 52 | perform encryption and protocol handling.
|
---|
| 53 |
|
---|
| 54 | See the \l{General Qt Requirements} page for information about the
|
---|
| 55 | versions of OpenSSL that are known to work with Qt.
|
---|
| 56 |
|
---|
| 57 | \section1 Enabling and Disabling SSL Support
|
---|
| 58 |
|
---|
| 59 | When building Qt from source, the configuration system checks for the presence
|
---|
| 60 | of the \c{openssl/opensslv.h} header provided by source or developer packages
|
---|
| 61 | of OpenSSL.
|
---|
| 62 |
|
---|
| 63 | By default, an SSL-enabled Qt library dynamically loads any installed OpenSSL
|
---|
| 64 | library at run-time. However, it is possible to link against the library at
|
---|
| 65 | compile-time by configuring Qt with the \c{-openssl-linked} option.
|
---|
| 66 |
|
---|
| 67 | When building a version of Qt linked against OpenSSL, the build system will
|
---|
| 68 | attempt to link with libssl and libcrypt libraries located in the default
|
---|
| 69 | location on the developer's system. This location is configurable:
|
---|
| 70 | set the \c OPENSSL_LIBS environment variable to contain the linker options
|
---|
| 71 | required to link Qt against the installed library. For example, on a Unix/Linux
|
---|
| 72 | system:
|
---|
| 73 |
|
---|
| 74 | \code
|
---|
| 75 | ./configure -openssl-linked OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto'
|
---|
| 76 | \endcode
|
---|
| 77 |
|
---|
| 78 | To disable SSL support in a Qt build, configure Qt with the \c{-no-openssl}
|
---|
| 79 | option.
|
---|
| 80 |
|
---|
| 81 | \section1 Licensing Information
|
---|
| 82 |
|
---|
| 83 | \note Due to import and export restrictions in some parts of the world, we
|
---|
| 84 | are unable to supply the OpenSSL Toolkit with Qt packages. Developers wishing
|
---|
| 85 | to use SSL communication in their deployed applications should either ensure
|
---|
| 86 | that their users have the appropriate libraries installed, or they should
|
---|
| 87 | consult a suitably qualified legal professional to ensure that applications
|
---|
| 88 | using code from the OpenSSL project are correctly certified for import
|
---|
| 89 | and export in relevant regions of the world.
|
---|
| 90 |
|
---|
| 91 | When the QtNetwork module is built with SSL support, the library is linked
|
---|
| 92 | against OpenSSL in a way that requires OpenSSL license compliance.
|
---|
| |
---|