src/common/authhandler.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2020 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 #pragma once
  22
  23 #include "common-export.h"
  24
  25 #include <QSslSocket>
  26
  27 #include "protocol.h"
  28
  29 class Peer;
  30
  31 class COMMON_EXPORT AuthHandler : public QObject
  32 {
  33     Q_OBJECT
  34
  35 public:
  36     AuthHandler(QObject* parent = nullptr);
  37
  38     QSslSocket* socket() const;
  39
  40     virtual bool isLocal() const;
  41
  42     virtual void handle(const Protocol::RegisterClient&) { invalidMessage(); }
  43     virtual void handle(const Protocol::ClientDenied&) { invalidMessage(); }
  44     virtual void handle(const Protocol::ClientRegistered&) { invalidMessage(); }
  45     virtual void handle(const Protocol::SetupData&) { invalidMessage(); }
  46     virtual void handle(const Protocol::SetupFailed&) { invalidMessage(); }
  47     virtual void handle(const Protocol::SetupDone&) { invalidMessage(); }
  48     virtual void handle(const Protocol::Login&) { invalidMessage(); }
  49     virtual void handle(const Protocol::LoginFailed&) { invalidMessage(); }
  50     virtual void handle(const Protocol::LoginSuccess&) { invalidMessage(); }
  51     virtual void handle(const Protocol::SessionState&) { invalidMessage(); }
  52
  53     // fallback for unknown types, will trigger an error
  54     template<class T>
  55     void handle(const T&)
  56     {
  57         invalidMessage();
  58     }
  59
  60 public slots:
  61     void close();
  62
  63 signals:
  64     void disconnected();
  65     void socketError(QAbstractSocket::SocketError error, const QString& errorString);
  66
  67 protected:
  68     void setSocket(QSslSocket* socket);
  69
  70 protected slots:
  71     virtual void onSocketError(QAbstractSocket::SocketError error);
  72     virtual void onSocketDisconnected();
  73
  74 private:
  75     void invalidMessage();
  76
  77     QSslSocket* _socket{nullptr};  // FIXME: should be a QSharedPointer? -> premature disconnect before the peer has taken over
  78     bool _disconnectedSent{false};
  79 };