docs: Move SQL schema to README.md, add more help
[quassel.git] / src / core / sslserver.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #ifndef SSLSERVER_H
22 #define SSLSERVER_H
23
24 #ifdef HAVE_SSL
25
26 #include <QSslCertificate>
27 #include <QSslKey>
28 #include <QTcpServer>
29 #include <QLinkedList>
30 #include <QFile>
31
32 class SslServer : public QTcpServer
33 {
34     Q_OBJECT
35
36 public:
37     SslServer(QObject *parent = 0);
38
39     virtual inline bool hasPendingConnections() const { return !_pendingConnections.isEmpty(); }
40     virtual QTcpSocket *nextPendingConnection();
41
42     virtual inline const QSslCertificate &certificate() const { return _cert; }
43     virtual inline const QSslKey &key() const { return _key; }
44     virtual inline bool isCertValid() const { return _isCertValid; }
45
46     /**
47      * Reloads SSL certificates used for connections
48      *
49      * If this command fails, it will try to maintain the most recent working certificate.  Error
50      * conditions are automatically written to the log.
51      *
52      * @return True if certificates reloaded successfully, otherwise false.
53      */
54     bool reloadCerts();
55
56 protected:
57 #if QT_VERSION >= 0x050000
58     virtual void incomingConnection(qintptr socketDescriptor);
59 #else
60     virtual void incomingConnection(int socketDescriptor);
61 #endif
62
63     virtual bool setCertificate(const QString &path, const QString &keyPath);
64
65 private:
66     /**
67      * Loads SSL certificates used for connections
68      *
69      * If this command fails, it will try to maintain the most recent working certificate.  Will log
70      * specific failure points, but does not offer verbose guidance.
71      *
72      * @return True if certificates loaded successfully, otherwise false.
73      */
74     bool loadCerts();
75     QSslKey loadKey(QFile *keyFile);
76
77     QLinkedList<QTcpSocket *> _pendingConnections;
78     QSslCertificate _cert;
79     QSslKey _key;
80     QList<QSslCertificate> _ca;
81     bool _isCertValid;
82
83     // Used when reloading certificates later
84     QString _sslCertPath; /// Path to the certificate file
85     QString _sslKeyPath;  /// Path to the private key file (may be in same file as above)
86 };
87
88
89 #endif //HAVE_SSL
90
91 #endif //SSLSERVER_H