basic_auth_config.h

Go to the documentation of this file.

// Copyright (C) 2020-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef HTTP_BASIC_AUTH_CONFIG_H
#define HTTP_BASIC_AUTH_CONFIG_H

#include <http/auth_config.h>
#include <http/basic_auth.h>
#include <list>
#include <unordered_map>

namespace isc {
namespace http {

typedef std::unordered_map<std::string, std::string> BasicHttpAuthMap;

class BasicHttpAuthClient : public isc::data::UserContext,
                            public isc::data::CfgToElement {
public:

    BasicHttpAuthClient(const std::string& user,
                        const std::string& password,
                        const isc::data::ConstElementPtr& user_context);

    BasicHttpAuthClient(const std::string& user,
                        const std::string& user_file,
                        const std::string& password,
                        const std::string& password_file,
                        bool password_file_only,
                        const isc::data::ConstElementPtr& user_context);

    const std::string& getUser() const {
        return (user_);
    }

    const std::string& getUserFile() const {
        return (user_file_);
    }

    const std::string& getPassword() const {
        return (password_);
    }

    const std::string& getPasswordFile() const {
        return (password_file_);
    }

    bool getPasswordFileOnly() const {
        return (password_file_only_);
    }

    virtual isc::data::ElementPtr toElement() const;

private:

    std::string user_;

    std::string user_file_;

    std::string password_;

    std::string password_file_;

    bool password_file_only_;
};

typedef std::list<BasicHttpAuthClient> BasicHttpAuthClientList;

class BasicHttpAuthConfig : public HttpAuthConfig {
public:
    virtual ~BasicHttpAuthConfig() { }

    void add(const std::string& user,
             const std::string& user_file,
             const std::string& password,
             const std::string& password_file,
             bool password_file_only = false,
             const isc::data::ConstElementPtr& user_context = isc::data::ConstElementPtr());

    virtual bool empty() const;

    virtual void clear();

    std::string getFileContent(const std::string& file_name) const;

    const BasicHttpAuthClientList& getClientList() const {
        return (list_);
    }

    const BasicHttpAuthMap& getCredentialMap() const {
        return (map_);
    }

    void parse(const isc::data::ConstElementPtr& config);

    virtual isc::data::ElementPtr toElement() const;

    virtual isc::http::HttpResponseJsonPtr
    checkAuth(const isc::http::HttpResponseCreator& creator,
              const isc::http::HttpRequestPtr& request) const;

private:

    BasicHttpAuthClientList list_;

    BasicHttpAuthMap map_;
};

typedef boost::shared_ptr<BasicHttpAuthConfig> BasicHttpAuthConfigPtr;

} // end of namespace isc::http
} // end of namespace isc

#endif // endif HTTP_BASIC_AUTH_CONFIG_H