doc/src/network-programming/ssl.qdoc
branchRCL_3
changeset 7 3f74d0d4af4c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/network-programming/ssl.qdoc	Thu Apr 08 14:19:33 2010 +0300
@@ -0,0 +1,93 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \group ssl
+    \title Secure Sockets Layer (SSL) Classes
+    \ingroup groups
+
+    \brief Classes for secure communication over network sockets.
+    \keyword SSL
+
+    The classes below provide support for secure network communication using
+    the Secure Sockets Layer (SSL) protocol, using the \l{OpenSSL Toolkit} to
+    perform encryption and protocol handling.
+
+    See the \l{General Qt Requirements} page for information about the
+    versions of OpenSSL that are known to work with Qt.
+
+    \section1 Enabling and Disabling SSL Support
+
+    When building Qt from source, the configuration system checks for the presence
+    of the \c{openssl/opensslv.h} header provided by source or developer packages
+    of OpenSSL.
+
+    By default, an SSL-enabled Qt library dynamically loads any installed OpenSSL
+    library at run-time. However, it is possible to link against the library at
+    compile-time by configuring Qt with the \c{-openssl-linked} option.
+
+    When building a version of Qt linked against OpenSSL, the build system will
+    attempt to link with libssl and libcrypt libraries located in the default
+    location on the developer's system. This location is configurable:
+    set the \c OPENSSL_LIBS environment variable to contain the linker options
+    required to link Qt against the installed library. For example, on a Unix/Linux
+    system:
+
+    \code
+        ./configure -openssl-linked OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto'
+    \endcode
+
+    To disable SSL support in a Qt build, configure Qt with the \c{-no-openssl}
+    option.
+
+    \section1 Licensing Information
+
+    \note Due to import and export restrictions in some parts of the world, we
+    are unable to supply the OpenSSL Toolkit with Qt packages. Developers wishing
+    to use SSL communication in their deployed applications should either ensure
+    that their users have the appropriate libraries installed, or they should
+    consult a suitably qualified legal professional to ensure that applications
+    using code from the OpenSSL project are correctly certified for import
+    and export in relevant regions of the world.
+
+    When the QtNetwork module is built with SSL support, the library is linked
+    against OpenSSL in a way that requires OpenSSL license compliance.
+*/