Qt 4.8
qsslconfiguration.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtNetwork 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 **
44 ** In addition, as a special exception, Nokia gives permission to link
45 ** the code of its release of Qt with the OpenSSL project's "OpenSSL" library
46 ** (or modified versions of the "OpenSSL" library that use the same license
47 ** as the original version), and distribute the linked executables.
48 **
49 ** You must comply with the GNU General Public License version 2 in all
50 ** respects for all of the code used other than the "OpenSSL" code. If you
51 ** modify this file, you may extend this exception to your version of the file,
52 ** but you are not obligated to do so. If you do not wish to do so, delete
53 ** this exception statement from your version of this file.
54 **
55 ****************************************************************************/
56 
57 #ifndef QSSLCONFIGURATION_H
58 #define QSSLCONFIGURATION_H
59 
60 #include <QtCore/qshareddata.h>
61 #include <QtNetwork/qsslsocket.h>
62 #include <QtNetwork/qssl.h>
63 
65 
67 
68 QT_MODULE(Network)
69 
70 #ifndef QT_NO_OPENSSL
71 
72 template<typename T> class QList;
73 class QSslCertificate;
74 class QSslCipher;
75 class QSslKey;
76 
79 {
80 public:
84  QSslConfiguration &operator=(const QSslConfiguration &other);
85 
86  bool operator==(const QSslConfiguration &other) const;
87  inline bool operator!=(const QSslConfiguration &other) const
88  { return !(*this == other); }
89 
90  bool isNull() const; // ### Qt 5: remove; who would need this?
91 
92  QSsl::SslProtocol protocol() const;
93  void setProtocol(QSsl::SslProtocol protocol);
94 
95  // Verification
96  QSslSocket::PeerVerifyMode peerVerifyMode() const;
97  void setPeerVerifyMode(QSslSocket::PeerVerifyMode mode);
98 
99  int peerVerifyDepth() const;
100  void setPeerVerifyDepth(int depth);
101 
102  // Certificate & cipher configuration
103  QSslCertificate localCertificate() const;
104  void setLocalCertificate(const QSslCertificate &certificate);
105 
106  QSslCertificate peerCertificate() const;
107  QList<QSslCertificate> peerCertificateChain() const;
108  QSslCipher sessionCipher() const;
109 
110  // Private keys, for server sockets
111  QSslKey privateKey() const;
112  void setPrivateKey(const QSslKey &key);
113 
114  // Cipher settings
115  QList<QSslCipher> ciphers() const;
116  void setCiphers(const QList<QSslCipher> &ciphers);
117 
118  // Certificate Authority (CA) settings
119  QList<QSslCertificate> caCertificates() const;
120  void setCaCertificates(const QList<QSslCertificate> &certificates);
121 
122  void setSslOption(QSsl::SslOption option, bool on);
123  bool testSslOption(QSsl::SslOption option) const;
124 
125  static QSslConfiguration defaultConfiguration();
126  static void setDefaultConfiguration(const QSslConfiguration &configuration);
127 
128 private:
129  friend class QSslSocket;
133 };
134 
135 #endif // QT_NO_OPENSSL
136 
138 
140 
141 #endif
The QSslKey class provides an interface for private and public keys.
Definition: qsslkey.h:64
QSharedDataPointer< QSslConfigurationPrivate > d
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Definition: qsslsocket.h:67
The QSslCipher class represents an SSL cryptographic cipher.
Definition: qsslcipher.h:59
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
SslProtocol
Describes the protocol of the cipher.
Definition: qssl.h:76
bool operator!=(const QSslConfiguration &other) const
Returns true if this QSslConfiguration differs from other.
SslOption
Describes the options that can be used to control the details of SSL behaviour.
Definition: qssl.h:86
#define Q_NETWORK_EXPORT
Definition: qglobal.h:1452
int key
The QSslCertificate class provides a convenient API for an X509 certificate.
The QSslConfiguration class holds the configuration and state of an SSL connection.
#define QT_END_HEADER
Definition: qglobal.h:137
bool operator==(QBool b1, bool b2)
Definition: qglobal.h:2023
static bool isNull(const QVariant::Private *d)
Definition: qvariant.cpp:300
The QList class is a template class that provides lists.
Definition: qdatastream.h:62
PeerVerifyMode
Describes the peer verification modes for QSslSocket.
Definition: qsslsocket.h:77