source: trunk/src/network/ssl/qsslsocket.h@ 22

Last change on this file since 22 was 2, checked in by Dmitry A. Kuminov, 17 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 7.5 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** 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 are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42
43#ifndef QSSLSOCKET_H
44#define QSSLSOCKET_H
45
46#include <QtCore/qlist.h>
47#include <QtCore/qregexp.h>
48#ifndef QT_NO_OPENSSL
49# include <QtNetwork/qtcpsocket.h>
50# include <QtNetwork/qsslerror.h>
51#endif
52
53QT_BEGIN_HEADER
54
55QT_BEGIN_NAMESPACE
56
57QT_MODULE(Network)
58
59#ifndef QT_NO_OPENSSL
60
61class QDir;
62class QSslCipher;
63class QSslCertificate;
64class QSslConfiguration;
65
66class QSslSocketPrivate;
67class Q_NETWORK_EXPORT QSslSocket : public QTcpSocket
68{
69 Q_OBJECT
70public:
71 enum SslMode {
72 UnencryptedMode,
73 SslClientMode,
74 SslServerMode
75 };
76
77 enum PeerVerifyMode {
78 VerifyNone,
79 QueryPeer,
80 VerifyPeer,
81 AutoVerifyPeer
82 };
83
84 QSslSocket(QObject *parent = 0);
85 ~QSslSocket();
86
87 // Autostarting the SSL client handshake.
88 void connectToHostEncrypted(const QString &hostName, quint16 port, OpenMode mode = ReadWrite);
89 bool setSocketDescriptor(int socketDescriptor, SocketState state = ConnectedState,
90 OpenMode openMode = ReadWrite);
91
92 SslMode mode() const;
93 bool isEncrypted() const;
94
95 QSsl::SslProtocol protocol() const;
96 void setProtocol(QSsl::SslProtocol protocol);
97
98 QSslSocket::PeerVerifyMode peerVerifyMode() const;
99 void setPeerVerifyMode(QSslSocket::PeerVerifyMode mode);
100
101 int peerVerifyDepth() const;
102 void setPeerVerifyDepth(int depth);
103
104 // From QIODevice
105 qint64 bytesAvailable() const;
106 qint64 bytesToWrite() const;
107 bool canReadLine() const;
108 void close();
109 bool atEnd() const;
110 bool flush();
111 void abort();
112
113 // From QAbstractSocket:
114 void setReadBufferSize(qint64 size);
115
116 // Similar to QIODevice's:
117 qint64 encryptedBytesAvailable() const;
118 qint64 encryptedBytesToWrite() const;
119
120 // SSL configuration
121 QSslConfiguration sslConfiguration() const;
122 void setSslConfiguration(const QSslConfiguration &config);
123
124 // Certificate & cipher accessors.
125 void setLocalCertificate(const QSslCertificate &certificate);
126 void setLocalCertificate(const QString &fileName, QSsl::EncodingFormat format = QSsl::Pem);
127 QSslCertificate localCertificate() const;
128 QSslCertificate peerCertificate() const;
129 QList<QSslCertificate> peerCertificateChain() const;
130 QSslCipher sessionCipher() const;
131
132 // Private keys, for server sockets.
133 void setPrivateKey(const QSslKey &key);
134 void setPrivateKey(const QString &fileName, QSsl::KeyAlgorithm algorithm = QSsl::Rsa,
135 QSsl::EncodingFormat format = QSsl::Pem,
136 const QByteArray &passPhrase = QByteArray());
137 QSslKey privateKey() const;
138
139 // Cipher settings.
140 QList<QSslCipher> ciphers() const;
141 void setCiphers(const QList<QSslCipher> &ciphers);
142 void setCiphers(const QString &ciphers);
143 static void setDefaultCiphers(const QList<QSslCipher> &ciphers);
144 static QList<QSslCipher> defaultCiphers();
145 static QList<QSslCipher> supportedCiphers();
146
147 // CA settings.
148 bool addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
149 QRegExp::PatternSyntax syntax = QRegExp::FixedString);
150 void addCaCertificate(const QSslCertificate &certificate);
151 void addCaCertificates(const QList<QSslCertificate> &certificates);
152 void setCaCertificates(const QList<QSslCertificate> &certificates);
153 QList<QSslCertificate> caCertificates() const;
154 static bool addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
155 QRegExp::PatternSyntax syntax = QRegExp::FixedString);
156 static void addDefaultCaCertificate(const QSslCertificate &certificate);
157 static void addDefaultCaCertificates(const QList<QSslCertificate> &certificates);
158 static void setDefaultCaCertificates(const QList<QSslCertificate> &certificates);
159 static QList<QSslCertificate> defaultCaCertificates();
160 static QList<QSslCertificate> systemCaCertificates();
161
162 bool waitForConnected(int msecs = 30000);
163 bool waitForEncrypted(int msecs = 30000);
164 bool waitForReadyRead(int msecs = 30000);
165 bool waitForBytesWritten(int msecs = 30000);
166 bool waitForDisconnected(int msecs = 30000);
167
168 QList<QSslError> sslErrors() const;
169
170 static bool supportsSsl();
171
172public Q_SLOTS:
173 void startClientEncryption();
174 void startServerEncryption();
175 void ignoreSslErrors();
176
177Q_SIGNALS:
178 void encrypted();
179 void peerVerifyError(const QSslError &error);
180 void sslErrors(const QList<QSslError> &errors);
181 void modeChanged(QSslSocket::SslMode newMode);
182 void encryptedBytesWritten(qint64 totalBytes);
183
184protected Q_SLOTS:
185 void connectToHostImplementation(const QString &hostName, quint16 port,
186 OpenMode openMode);
187 void disconnectFromHostImplementation();
188
189protected:
190 qint64 readData(char *data, qint64 maxlen);
191 qint64 writeData(const char *data, qint64 len);
192
193private:
194 Q_DECLARE_PRIVATE(QSslSocket)
195 Q_DISABLE_COPY(QSslSocket)
196 Q_PRIVATE_SLOT(d_func(), void _q_connectedSlot())
197 Q_PRIVATE_SLOT(d_func(), void _q_hostFoundSlot())
198 Q_PRIVATE_SLOT(d_func(), void _q_disconnectedSlot())
199 Q_PRIVATE_SLOT(d_func(), void _q_stateChangedSlot(QAbstractSocket::SocketState))
200 Q_PRIVATE_SLOT(d_func(), void _q_errorSlot(QAbstractSocket::SocketError))
201 Q_PRIVATE_SLOT(d_func(), void _q_readyReadSlot())
202 Q_PRIVATE_SLOT(d_func(), void _q_bytesWrittenSlot(qint64))
203 Q_PRIVATE_SLOT(d_func(), void _q_flushWriteBuffer())
204 friend class QSslSocketBackendPrivate;
205};
206
207#endif // QT_NO_OPENSSL
208
209QT_END_NAMESPACE
210
211#ifndef QT_NO_OPENSSL
212Q_DECLARE_METATYPE(QList<QSslError>)
213#endif
214
215QT_END_HEADER
216
217#endif
Note: See TracBrowser for help on using the repository browser.