rbac_api.h

Go to the documentation of this file.

// Copyright (C) 2026 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 RBAC_API_H
#define RBAC_API_H
 
#include <cc/data.h>
#include <boost/shared_ptr.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <set>
#include <string>
 
namespace isc {
namespace rbac {

class Api;

typedef boost::shared_ptr<Api> ApiPtr;

class Api {
public:

    Api(const std::string& name, const std::string& access,
        const std::string& hook) : name_(name), access_(access), hook_(hook) {
    }

    virtual ~Api() = default;

    std::string getName() const {
        return (name_);
    }

    std::string getAccess() const {
        return (access_);
    }

    void setAccess(const std::string& access) {
        access_ = access;
    }

    std::string getHook() const {
        return (hook_);
    }

    void setHook(const std::string& hook) {
        hook_ = hook;
    }

    static ApiPtr getApiByName(const std::string& name);

    static void fillApiTable(const std::string& dirname);

    static void parse(data::ConstElementPtr cfg, bool others = false);
 
protected:
    std::string name_;

    std::string access_;

    std::string hook_;
};

struct ApiNameIndexTag {};

struct ApiAccessIndexTag {};

struct ApiHookIndexTag {};

typedef boost::multi_index_container<
    // Elements of shared pointer to Api objects.
    ApiPtr,
    boost::multi_index::indexed_by<
        // First index is by name.
        boost::multi_index::hashed_unique<
            boost::multi_index::tag<ApiNameIndexTag>,
            boost::multi_index::const_mem_fun<Api, std::string, &Api::getName>
        >,
        // Second index is by access.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<ApiAccessIndexTag>,
            boost::multi_index::const_mem_fun<Api, std::string, &Api::getAccess>
        >,
        // Third index is by hook.
        boost::multi_index::hashed_non_unique<
            boost::multi_index::tag<ApiHookIndexTag>,
            boost::multi_index::const_mem_fun<Api, std::string, &Api::getHook>
        >
    >
> ApiTable;

extern ApiTable apiTable;

extern std::set<std::string> apiAccesses;

extern std::set<std::string> apiHooks;
 
} // end of namespace rbac
} // end of namespace isc
#endif