SimpleLoginManager.h

Go to the documentation of this file.

/*****************************************************************************
 * vim:tw=78
 *
 * Copyright (C) 2021 Richard Hacker (lerichi at gmx dot net),
 *                    Florian Pose (fp at igh dot de),
 *                    Bjarne von Horn (vh at igh dot de).
 *
 * This file is part of the PdCom library.
 *
 * The PdCom library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The PdCom library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the PdCom library. If not, see <http://www.gnu.org/licenses/>.
 *
 *****************************************************************************/

 
#ifndef PDCOM5_SIMPLELOGINMANAGER_H
#define PDCOM5_SIMPLELOGINMANAGER_H
 
#include "pdcom5-sasl_export.h"
 
#include <memory>
#include <pdcom5/Sasl.h>
#include <stdexcept>
#include <vector>
 
extern "C" struct sasl_callback;
 
namespace PdCom {
namespace impl {
class SimpleLoginManager;
}  // namespace impl

 
class PDCOM5_SASL_EXPORT SimpleLoginManager : public Sasl
{
    friend class impl::SimpleLoginManager;
    std::unique_ptr<impl::SimpleLoginManager> impl_;
    void loginReply(const char *mechlist, const char *serverData, int finished)
            override;
 
  public:
    static void InitLibrary(const char *plugin_path = nullptr);
    static void FinalizeLibrary();

    SimpleLoginManager(
            const char *remote_host,
            sasl_callback *additional_callbacks = nullptr);
    SimpleLoginManager(SimpleLoginManager &&) noexcept;
    SimpleLoginManager &operator=(SimpleLoginManager &&) noexcept;
 

    struct Cancel : std::exception
    {};

    enum class LoginResult {
        Success,
        Error,
        Canceled,
        NoSaslMechanism, 
    };
 
  protected:
    virtual ~SimpleLoginManager();

    bool login();

    using Sasl::logout;
    virtual std::string getAuthname() { throw Cancel(); }
    virtual std::string getPassword() { throw Cancel(); }
    virtual std::string
    getRealm(const std::vector<const char *> & /* available realms */)
    {
        throw Cancel();
    }

    virtual std::string
    getOption(const char * /*plugin_name*/, const char * /*option*/)
    {
        throw Cancel();
    }

    virtual std::string interact(
            unsigned long /*id*/,
            const char * /*challenge*/,
            const char * /*prompt*/,
            const char * /*default result*/)
    {
        throw Cancel();
    }

    virtual void completed(LoginResult result) = 0;

    virtual void log(int level, const char *message);
};
 
}  // namespace PdCom
 
#endif  // PDCOM5_SIMPLELOGINMANAGER_H