phosphor-ldap-config/ldap_config_mgr.hpp

#pragma once

#include "config.h"

#include "ldap_config.hpp"

#include <sdbusplus/bus.hpp>
#include <xyz/openbmc_project/User/Ldap/Config/server.hpp>
#include <xyz/openbmc_project/User/Ldap/Create/server.hpp>

#include <string>

namespace phosphor
{
namespace ldap
{

static constexpr auto defaultNslcdFile = "nslcd.conf.default";
static constexpr auto nsSwitchFile = "nsswitch.conf";
static auto openLDAPDbusObjectPath = std::string(LDAP_CONFIG_ROOT) +
                                     "/openldap";
static auto adDbusObjectPath = std::string(LDAP_CONFIG_ROOT) +
                               "/active_directory";

using CreateIface = sdbusplus::server::object_t<
    sdbusplus::xyz::openbmc_project::User::Ldap::server::Create>;

// class Config;
/** @class ConfigMgr
 *  @brief Creates LDAP server configuration.
 *  @details concrete implementation of xyz.openbmc_project.User.Ldap.Create
 *  APIs, in order to create LDAP configuration.
 */
class ConfigMgr : public CreateIface
{
  public:
    ConfigMgr() = delete;
    ~ConfigMgr() = default;
    ConfigMgr(const ConfigMgr&) = delete;
    ConfigMgr& operator=(const ConfigMgr&) = delete;
    ConfigMgr(ConfigMgr&&) = delete;
    ConfigMgr& operator=(ConfigMgr&&) = delete;

    /** @brief ConfigMgr to put object onto bus at a dbus path.
     *  @param[in] bus - Bus to attach to.
     *  @param[in] path - Path to attach at.
     *  @param[in] filePath - LDAP configuration file.
     *  @param[in] dbusPersistentPath - Persistent path for LDAP D-Bus property.
     *  @param[in] caCertFile - LDAP's CA certificate file.
     */
    ConfigMgr(sdbusplus::bus_t& bus, const char* path, const char* filePath,
              const char* dbusPersistentPath, const char* caCertFile,
              const char* certFile) :
        CreateIface(bus, path, CreateIface::action::defer_emit),
        dbusPersistentPath(dbusPersistentPath), configFilePath(filePath),
        tlsCacertFile(caCertFile), tlsCertFile(certFile), bus(bus)
    {}

    /** @brief concrete implementation of the pure virtual function
            xyz.openbmc_project.User.Ldap.Create.createConfig.
     *  @param[in] ldapServerURI - LDAP URI of the server.
     *  @param[in] ldapBindDN - distinguished name with which bind to bind
            to the directory server for lookups.
     *  @param[in] ldapBaseDN -  distinguished name to use as search base.
     *  @param[in] ldapBindDNPassword - credentials with which to bind.
     *  @param[in] ldapSearchScope - the search scope.
     *  @param[in] ldapType - Specifies the LDAP server type which can be AD
            or openLDAP.
     *  @param[in] groupNameAttribute - Specifies attribute name that contains
     *             the name of the Group in the LDAP server.
     *  @param[in] usernameAttribute - Specifies attribute name that contains
     *             the username in the LDAP server.
     *  @returns the object path of the D-Bus object created.
     */
    std::string createConfig(std::string ldapServerURI, std::string ldapBindDN,
                             std::string ldapBaseDN,
                             std::string ldapBindDNPassword,
                             CreateIface::SearchScope ldapSearchScope,
                             CreateIface::Type ldapType,
                             std::string groupNameAttribute,
                             std::string userNameAttribute) override;

    /** @brief restarts given service
     *  @param[in] service - Service to be restarted.
     */
    virtual void restartService(const std::string& service);

    /** @brief stops given service
     *  @param[in] service - Service to be stopped.
     */
    virtual void stopService(const std::string& service);

    /** @brief start or stop the service depending on the given value
     *  @param[in] service - Service to be start/stop.
     *  @param[in] value - true to start the service otherwise stop.
     */
    virtual void startOrStopService(const std::string& service, bool value);

    /** @brief Populate existing config into D-Bus properties
     */
    virtual void restore();
    /** @brief enable/disable the ldap service
     *  @param[in] config - config  which needs to be enabled/disabled
     *  @param[in] value - boolean value to start/stop
     */
    bool enableService(Config& config, bool value);

    /* ldap service enabled property would be saved under
     * this path.
     */
    std::string dbusPersistentPath;

  protected:
    std::string configFilePath{};
    std::string tlsCacertFile{};
    std::string tlsCertFile{};

    /** @brief Persistent sdbusplus D-Bus bus connection. */
    sdbusplus::bus_t& bus;

    /* Below two config objects are default, which will always be there */

    /* if need arises then we can have below map for additional account
     * providers we need to create sub class of Config which will implement the
     * delete interface as the default objects will not implement the delete
     * std::map<std::string, std::unique_ptr<NewConfig>> AdditionalProviders*/

    /** @brief Pointer to a openLDAP Config D-Bus object */
    std::unique_ptr<Config> openLDAPConfigPtr = nullptr;
    /** @brief Pointer to a AD Config D-Bus object */
    std::unique_ptr<Config> ADConfigPtr = nullptr;

    /* Create the default active directory and the openldap config
     * objects. */
    virtual void createDefaultObjects();
};
} // namespace ldap
} // namespace phosphor