| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 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:FDL$
|
|---|
| 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 a
|
|---|
| 14 | ** written agreement between you and Nokia.
|
|---|
| 15 | **
|
|---|
| 16 | ** GNU Free Documentation License
|
|---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Free
|
|---|
| 18 | ** Documentation License version 1.3 as published by the Free Software
|
|---|
| 19 | ** Foundation and appearing in the file included in the packaging of this
|
|---|
| 20 | ** file.
|
|---|
| 21 | **
|
|---|
| 22 | ** If you have questions regarding the use of this file, please contact
|
|---|
| 23 | ** Nokia at [email protected].
|
|---|
| 24 | ** $QT_END_LICENSE$
|
|---|
| 25 | **
|
|---|
| 26 | ****************************************************************************/
|
|---|
| 27 |
|
|---|
| 28 | /*!
|
|---|
| 29 | \page ssl.html
|
|---|
| 30 | \title Secure Sockets Layer (SSL) Classes
|
|---|
| 31 | \brief Classes for secure communication over network sockets.
|
|---|
| 32 | \ingroup qt-network
|
|---|
| 33 |
|
|---|
| 34 | \keyword SSL
|
|---|
| 35 |
|
|---|
| 36 | The classes below provide support for secure network communication using
|
|---|
| 37 | the Secure Sockets Layer (SSL) protocol, using the \l{OpenSSL Toolkit} to
|
|---|
| 38 | perform encryption and protocol handling.
|
|---|
| 39 |
|
|---|
| 40 | See the \l{General Qt Requirements} page for information about the
|
|---|
| 41 | versions of OpenSSL that are known to work with Qt.
|
|---|
| 42 |
|
|---|
| 43 | \section1 Enabling and Disabling SSL Support
|
|---|
| 44 |
|
|---|
| 45 | When building Qt from source, the configuration system checks for the presence
|
|---|
| 46 | of the \c{openssl/opensslv.h} header provided by source or developer packages
|
|---|
| 47 | of OpenSSL.
|
|---|
| 48 |
|
|---|
| 49 | By default, an SSL-enabled Qt library dynamically loads any installed OpenSSL
|
|---|
| 50 | library at run-time. However, it is possible to link against the library at
|
|---|
| 51 | compile-time by configuring Qt with the \c{-openssl-linked} option.
|
|---|
| 52 |
|
|---|
| 53 | When building a version of Qt linked against OpenSSL, the build system will
|
|---|
| 54 | attempt to link with libssl and libcrypt libraries located in the default
|
|---|
| 55 | location on the developer's system. This location is configurable:
|
|---|
| 56 | set the \c OPENSSL_LIBS environment variable to contain the linker options
|
|---|
| 57 | required to link Qt against the installed library. For example, on a Unix/Linux
|
|---|
| 58 | system:
|
|---|
| 59 |
|
|---|
| 60 | \code
|
|---|
| 61 | ./configure -openssl-linked OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto'
|
|---|
| 62 | \endcode
|
|---|
| 63 |
|
|---|
| 64 | To disable SSL support in a Qt build, configure Qt with the \c{-no-openssl}
|
|---|
| 65 | option.
|
|---|
| 66 |
|
|---|
| 67 | \section1 Licensing Information
|
|---|
| 68 |
|
|---|
| 69 | \note Due to import and export restrictions in some parts of the world, we
|
|---|
| 70 | are unable to supply the OpenSSL Toolkit with Qt packages. Developers wishing
|
|---|
|
|---|
