qsslsocket.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:8k
- /****************************************************************************
- **
- ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
- ** Contact: Qt Software Information (qt-info@nokia.com)
- **
- ** This file is part of the QtNetwork module of the Qt Toolkit.
- **
- ** Commercial Usage
- ** Licensees holding valid Qt Commercial licenses may use this file in
- ** accordance with the Qt Commercial License Agreement provided with the
- ** Software or, alternatively, in accordance with the terms contained in
- ** a written agreement between you and Nokia.
- **
- **
- ** GNU General Public License Usage
- ** Alternatively, this file may be used under the terms of the GNU
- ** General Public License versions 2.0 or 3.0 as published by the Free
- ** Software Foundation and appearing in the file LICENSE.GPL included in
- ** the packaging of this file. Please review the following information
- ** to ensure GNU General Public Licensing requirements will be met:
- ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
- ** http://www.gnu.org/copyleft/gpl.html. In addition, as a special
- ** exception, Nokia gives you certain additional rights. These rights
- ** are described in the Nokia Qt GPL Exception version 1.3, included in
- ** the file GPL_EXCEPTION.txt in this package.
- **
- ** In addition, as a special exception, Nokia gives permission to link
- ** the code of its release of Qt with the OpenSSL project's "OpenSSL"
- ** library (or modified versions of it that use the same license as the
- ** "OpenSSL" library), and distribute the linked executables. You must
- ** comply with the GNU General Public License versions 2.0 or 3.0 in all
- ** respects for all of the code used other than the "OpenSSL" code. If
- ** you modify this file, you may extend this exception to your version
- ** of the file, but you are not obligated to do so. If you do not wish
- ** to do so, delete this exception statement from your version of this
- ** file.
- **
- ** Qt for Windows(R) Licensees
- ** As a special exception, Nokia, as the sole copyright holder for Qt
- ** Designer, grants users of the Qt/Eclipse Integration plug-in the
- ** right for the Qt/Eclipse Integration to link to functionality
- ** provided by Qt Designer and its related libraries.
- **
- ** If you are unsure which license is appropriate for your use, please
- ** contact the sales department at qt-sales@nokia.com.
- **
- ****************************************************************************/
- #ifndef QSSLSOCKET_H
- #define QSSLSOCKET_H
- #include <QtCore/qlist.h>
- #include <QtCore/qregexp.h>
- #ifndef QT_NO_OPENSSL
- # include <QtNetwork/qtcpsocket.h>
- # include <QtNetwork/qsslerror.h>
- #endif
- QT_BEGIN_HEADER
- QT_BEGIN_NAMESPACE
- QT_MODULE(Network)
- #ifndef QT_NO_OPENSSL
- class QDir;
- class QSslCipher;
- class QSslCertificate;
- class QSslConfiguration;
- class QSslSocketPrivate;
- class Q_NETWORK_EXPORT QSslSocket : public QTcpSocket
- {
- Q_OBJECT
- public:
- enum SslMode {
- UnencryptedMode,
- SslClientMode,
- SslServerMode
- };
- enum PeerVerifyMode {
- VerifyNone,
- QueryPeer,
- VerifyPeer,
- AutoVerifyPeer
- };
- QSslSocket(QObject *parent = 0);
- ~QSslSocket();
- // Autostarting the SSL client handshake.
- void connectToHostEncrypted(const QString &hostName, quint16 port, OpenMode mode = ReadWrite);
- bool setSocketDescriptor(int socketDescriptor, SocketState state = ConnectedState,
- OpenMode openMode = ReadWrite);
- SslMode mode() const;
- bool isEncrypted() const;
- QSsl::SslProtocol protocol() const;
- void setProtocol(QSsl::SslProtocol protocol);
- QSslSocket::PeerVerifyMode peerVerifyMode() const;
- void setPeerVerifyMode(QSslSocket::PeerVerifyMode mode);
- int peerVerifyDepth() const;
- void setPeerVerifyDepth(int depth);
- // From QIODevice
- qint64 bytesAvailable() const;
- qint64 bytesToWrite() const;
- bool canReadLine() const;
- void close();
- bool atEnd() const;
- bool flush();
- void abort();
- // From QAbstractSocket:
- void setReadBufferSize(qint64 size);
- // Similar to QIODevice's:
- qint64 encryptedBytesAvailable() const;
- qint64 encryptedBytesToWrite() const;
- // SSL configuration
- QSslConfiguration sslConfiguration() const;
- void setSslConfiguration(const QSslConfiguration &config);
- // Certificate & cipher accessors.
- void setLocalCertificate(const QSslCertificate &certificate);
- void setLocalCertificate(const QString &fileName, QSsl::EncodingFormat format = QSsl::Pem);
- QSslCertificate localCertificate() const;
- QSslCertificate peerCertificate() const;
- QList<QSslCertificate> peerCertificateChain() const;
- QSslCipher sessionCipher() const;
- // Private keys, for server sockets.
- void setPrivateKey(const QSslKey &key);
- void setPrivateKey(const QString &fileName, QSsl::KeyAlgorithm algorithm = QSsl::Rsa,
- QSsl::EncodingFormat format = QSsl::Pem,
- const QByteArray &passPhrase = QByteArray());
- QSslKey privateKey() const;
- // Cipher settings.
- QList<QSslCipher> ciphers() const;
- void setCiphers(const QList<QSslCipher> &ciphers);
- void setCiphers(const QString &ciphers);
- static void setDefaultCiphers(const QList<QSslCipher> &ciphers);
- static QList<QSslCipher> defaultCiphers();
- static QList<QSslCipher> supportedCiphers();
- // CA settings.
- bool addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
- QRegExp::PatternSyntax syntax = QRegExp::FixedString);
- void addCaCertificate(const QSslCertificate &certificate);
- void addCaCertificates(const QList<QSslCertificate> &certificates);
- void setCaCertificates(const QList<QSslCertificate> &certificates);
- QList<QSslCertificate> caCertificates() const;
- static bool addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
- QRegExp::PatternSyntax syntax = QRegExp::FixedString);
- static void addDefaultCaCertificate(const QSslCertificate &certificate);
- static void addDefaultCaCertificates(const QList<QSslCertificate> &certificates);
- static void setDefaultCaCertificates(const QList<QSslCertificate> &certificates);
- static QList<QSslCertificate> defaultCaCertificates();
- static QList<QSslCertificate> systemCaCertificates();
- bool waitForConnected(int msecs = 30000);
- bool waitForEncrypted(int msecs = 30000);
- bool waitForReadyRead(int msecs = 30000);
- bool waitForBytesWritten(int msecs = 30000);
- bool waitForDisconnected(int msecs = 30000);
- QList<QSslError> sslErrors() const;
- static bool supportsSsl();
- public Q_SLOTS:
- void startClientEncryption();
- void startServerEncryption();
- void ignoreSslErrors();
- Q_SIGNALS:
- void encrypted();
- void peerVerifyError(const QSslError &error);
- void sslErrors(const QList<QSslError> &errors);
- void modeChanged(QSslSocket::SslMode newMode);
- void encryptedBytesWritten(qint64 totalBytes);
- protected Q_SLOTS:
- void connectToHostImplementation(const QString &hostName, quint16 port,
- OpenMode openMode);
- void disconnectFromHostImplementation();
- protected:
- qint64 readData(char *data, qint64 maxlen);
- qint64 writeData(const char *data, qint64 len);
- private:
- Q_DECLARE_PRIVATE(QSslSocket)
- Q_DISABLE_COPY(QSslSocket)
- Q_PRIVATE_SLOT(d_func(), void _q_connectedSlot())
- Q_PRIVATE_SLOT(d_func(), void _q_hostFoundSlot())
- Q_PRIVATE_SLOT(d_func(), void _q_disconnectedSlot())
- Q_PRIVATE_SLOT(d_func(), void _q_stateChangedSlot(QAbstractSocket::SocketState))
- Q_PRIVATE_SLOT(d_func(), void _q_errorSlot(QAbstractSocket::SocketError))
- Q_PRIVATE_SLOT(d_func(), void _q_readyReadSlot())
- Q_PRIVATE_SLOT(d_func(), void _q_bytesWrittenSlot(qint64))
- Q_PRIVATE_SLOT(d_func(), void _q_flushWriteBuffer())
- friend class QSslSocketBackendPrivate;
- };
- #endif // QT_NO_OPENSSL
- QT_END_NAMESPACE
- #ifndef QT_NO_OPENSSL
- Q_DECLARE_METATYPE(QList<QSslError>)
- #endif
- QT_END_HEADER
- #endif