qsslsocket.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:8k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
  4. ** Contact: Qt Software Information (qt-info@nokia.com)
  5. **
  6. ** This file is part of the QtNetwork module of the Qt Toolkit.
  7. **
  8. ** Commercial Usage
  9. ** Licensees holding valid Qt Commercial licenses may use this file in
  10. ** accordance with the Qt Commercial License Agreement provided with the
  11. ** Software or, alternatively, in accordance with the terms contained in
  12. ** a written agreement between you and Nokia.
  13. **
  14. **
  15. ** GNU General Public License Usage
  16. ** Alternatively, this file may be used under the terms of the GNU
  17. ** General Public License versions 2.0 or 3.0 as published by the Free
  18. ** Software Foundation and appearing in the file LICENSE.GPL included in
  19. ** the packaging of this file.  Please review the following information
  20. ** to ensure GNU General Public Licensing requirements will be met:
  21. ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22. ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23. ** exception, Nokia gives you certain additional rights. These rights
  24. ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25. ** the file GPL_EXCEPTION.txt in this package.
  26. **
  27. ** In addition, as a special exception, Nokia gives permission to link
  28. ** the code of its release of Qt with the OpenSSL project's "OpenSSL"
  29. ** library (or modified versions of it that use the same license as the
  30. ** "OpenSSL" library), and distribute the linked executables.  You must
  31. ** comply with the GNU General Public License versions 2.0 or 3.0 in all
  32. ** respects for all of the code used other than the "OpenSSL" code.  If
  33. ** you modify this file, you may extend this exception to your version
  34. ** of the file, but you are not obligated to do so.  If you do not wish
  35. ** to do so, delete this exception statement from your version of this
  36. ** file.
  37. **
  38. ** Qt for Windows(R) Licensees
  39. ** As a special exception, Nokia, as the sole copyright holder for Qt
  40. ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  41. ** right for the Qt/Eclipse Integration to link to functionality
  42. ** provided by Qt Designer and its related libraries.
  43. **
  44. ** If you are unsure which license is appropriate for your use, please
  45. ** contact the sales department at qt-sales@nokia.com.
  46. **
  47. ****************************************************************************/
  48. #ifndef QSSLSOCKET_H
  49. #define QSSLSOCKET_H
  50. #include <QtCore/qlist.h>
  51. #include <QtCore/qregexp.h>
  52. #ifndef QT_NO_OPENSSL
  53. #   include <QtNetwork/qtcpsocket.h>
  54. #   include <QtNetwork/qsslerror.h>
  55. #endif
  56. QT_BEGIN_HEADER
  57. QT_BEGIN_NAMESPACE
  58. QT_MODULE(Network)
  59. #ifndef QT_NO_OPENSSL
  60. class QDir;
  61. class QSslCipher;
  62. class QSslCertificate;
  63. class QSslConfiguration;
  64. class QSslSocketPrivate;
  65. class Q_NETWORK_EXPORT QSslSocket : public QTcpSocket
  66. {
  67.     Q_OBJECT
  68. public:
  69.     enum SslMode {
  70.         UnencryptedMode,
  71.         SslClientMode,
  72.         SslServerMode
  73.     };
  74.     enum PeerVerifyMode {
  75.         VerifyNone,
  76.         QueryPeer,
  77.         VerifyPeer,
  78.         AutoVerifyPeer
  79.     };
  80.     QSslSocket(QObject *parent = 0);
  81.     ~QSslSocket();
  82.     // Autostarting the SSL client handshake.
  83.     void connectToHostEncrypted(const QString &hostName, quint16 port, OpenMode mode = ReadWrite);
  84.     bool setSocketDescriptor(int socketDescriptor, SocketState state = ConnectedState,
  85.                              OpenMode openMode = ReadWrite);
  86.     SslMode mode() const;
  87.     bool isEncrypted() const;
  88.     QSsl::SslProtocol protocol() const;
  89.     void setProtocol(QSsl::SslProtocol protocol);
  90.     QSslSocket::PeerVerifyMode peerVerifyMode() const;
  91.     void setPeerVerifyMode(QSslSocket::PeerVerifyMode mode);
  92.     int peerVerifyDepth() const;
  93.     void setPeerVerifyDepth(int depth);
  94.     // From QIODevice
  95.     qint64 bytesAvailable() const;
  96.     qint64 bytesToWrite() const;
  97.     bool canReadLine() const;
  98.     void close();
  99.     bool atEnd() const;
  100.     bool flush();
  101.     void abort();
  102.     // From QAbstractSocket:
  103.     void setReadBufferSize(qint64 size);
  104.     // Similar to QIODevice's:
  105.     qint64 encryptedBytesAvailable() const;
  106.     qint64 encryptedBytesToWrite() const;
  107.     // SSL configuration
  108.     QSslConfiguration sslConfiguration() const;
  109.     void setSslConfiguration(const QSslConfiguration &config);
  110.     // Certificate & cipher accessors.
  111.     void setLocalCertificate(const QSslCertificate &certificate);
  112.     void setLocalCertificate(const QString &fileName, QSsl::EncodingFormat format = QSsl::Pem);
  113.     QSslCertificate localCertificate() const;
  114.     QSslCertificate peerCertificate() const;
  115.     QList<QSslCertificate> peerCertificateChain() const;
  116.     QSslCipher sessionCipher() const;
  117.     // Private keys, for server sockets.
  118.     void setPrivateKey(const QSslKey &key);
  119.     void setPrivateKey(const QString &fileName, QSsl::KeyAlgorithm algorithm = QSsl::Rsa,
  120.                        QSsl::EncodingFormat format = QSsl::Pem,
  121.                        const QByteArray &passPhrase = QByteArray());
  122.     QSslKey privateKey() const;
  123.     // Cipher settings.
  124.     QList<QSslCipher> ciphers() const;
  125.     void setCiphers(const QList<QSslCipher> &ciphers);
  126.     void setCiphers(const QString &ciphers);
  127.     static void setDefaultCiphers(const QList<QSslCipher> &ciphers);
  128.     static QList<QSslCipher> defaultCiphers();
  129.     static QList<QSslCipher> supportedCiphers();
  130.     // CA settings.
  131.     bool addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
  132.                            QRegExp::PatternSyntax syntax = QRegExp::FixedString);
  133.     void addCaCertificate(const QSslCertificate &certificate);
  134.     void addCaCertificates(const QList<QSslCertificate> &certificates);
  135.     void setCaCertificates(const QList<QSslCertificate> &certificates);
  136.     QList<QSslCertificate> caCertificates() const;
  137.     static bool addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
  138.                                          QRegExp::PatternSyntax syntax = QRegExp::FixedString);
  139.     static void addDefaultCaCertificate(const QSslCertificate &certificate);
  140.     static void addDefaultCaCertificates(const QList<QSslCertificate> &certificates);
  141.     static void setDefaultCaCertificates(const QList<QSslCertificate> &certificates);
  142.     static QList<QSslCertificate> defaultCaCertificates();
  143.     static QList<QSslCertificate> systemCaCertificates();
  144.     bool waitForConnected(int msecs = 30000);
  145.     bool waitForEncrypted(int msecs = 30000);
  146.     bool waitForReadyRead(int msecs = 30000);
  147.     bool waitForBytesWritten(int msecs = 30000);
  148.     bool waitForDisconnected(int msecs = 30000);
  149.     QList<QSslError> sslErrors() const;
  150.     static bool supportsSsl();
  151. public Q_SLOTS:
  152.     void startClientEncryption();
  153.     void startServerEncryption();
  154.     void ignoreSslErrors();
  155. Q_SIGNALS:
  156.     void encrypted();
  157.     void peerVerifyError(const QSslError &error);
  158.     void sslErrors(const QList<QSslError> &errors);
  159.     void modeChanged(QSslSocket::SslMode newMode);
  160.     void encryptedBytesWritten(qint64 totalBytes);
  161. protected Q_SLOTS:
  162.     void connectToHostImplementation(const QString &hostName, quint16 port,
  163.                                      OpenMode openMode);
  164.     void disconnectFromHostImplementation();
  165. protected:
  166.     qint64 readData(char *data, qint64 maxlen);
  167.     qint64 writeData(const char *data, qint64 len);
  168. private:
  169.     Q_DECLARE_PRIVATE(QSslSocket)
  170.     Q_DISABLE_COPY(QSslSocket)
  171.     Q_PRIVATE_SLOT(d_func(), void _q_connectedSlot())
  172.     Q_PRIVATE_SLOT(d_func(), void _q_hostFoundSlot())
  173.     Q_PRIVATE_SLOT(d_func(), void _q_disconnectedSlot())
  174.     Q_PRIVATE_SLOT(d_func(), void _q_stateChangedSlot(QAbstractSocket::SocketState))
  175.     Q_PRIVATE_SLOT(d_func(), void _q_errorSlot(QAbstractSocket::SocketError))
  176.     Q_PRIVATE_SLOT(d_func(), void _q_readyReadSlot())
  177.     Q_PRIVATE_SLOT(d_func(), void _q_bytesWrittenSlot(qint64))
  178.     Q_PRIVATE_SLOT(d_func(), void _q_flushWriteBuffer())
  179.     friend class QSslSocketBackendPrivate;
  180. };
  181. #endif // QT_NO_OPENSSL
  182. QT_END_NAMESPACE
  183. #ifndef QT_NO_OPENSSL
  184. Q_DECLARE_METATYPE(QList<QSslError>)
  185. #endif
  186. QT_END_HEADER
  187. #endif