unix_command_config.h

Go to the documentation of this file.

// Copyright (C) 2024-2025 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 UNIX_COMMAND_CONFIG_H
#define UNIX_COMMAND_CONFIG_H
 
#include <asiolink/asiolink.h>
#include <asiolink/asio_wrapper.h>
#include <asiolink/unix_domain_socket.h>
#include <asiolink/unix_domain_socket_acceptor.h>
#include <cc/cfg_to_element.h>
#include <cc/user_context.h>
#include <util/filesystem.h>
 
namespace isc {
namespace config {

class UnixCommandConfig : public isc::data::UserContext,
                          public isc::data::CfgToElement {
public:
    static const mode_t DEFAULT_SOCKET_PATH_PERMS;

    static mode_t socket_path_perms_;

    UnixCommandConfig(isc::data::ConstElementPtr config);

    ~UnixCommandConfig() = default;

    static std::string getSocketPath(bool reset = false,
                                     const std::string explicit_path = "");

    static std::string validatePath(const std::string socket_path);

    static mode_t getSocketPathPerms();

    static void setSocketPathPerms(mode_t perms = DEFAULT_SOCKET_PATH_PERMS);

    std::string getSocketType() const {
        return (socket_type_);
    }

    void setSocketType(const std::string& socket_type) {
        socket_type_ = socket_type;
    }

    std::string getSocketName() const {
        return (socket_name_);
    }

    void setSocketName(const std::string& socket_name) {
        socket_name_ = socket_name;
    }

    std::string getLockName() {
        return (std::string(socket_name_ + ".lock"));
    }

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

    std::string socket_type_;

    std::string socket_name_;
};

typedef boost::shared_ptr<UnixCommandConfig> UnixCommandConfigPtr;

struct UnixSocketInfo {
    bool usable_;

    int lock_fd_;

    boost::shared_ptr<isc::asiolink::UnixDomainSocketAcceptor> acceptor_;

    boost::shared_ptr<isc::asiolink::UnixDomainSocket> socket_;

    UnixCommandConfigPtr config_;

    UnixSocketInfo() : usable_(true), lock_fd_(-1) {
    }

    ~UnixSocketInfo() = default;
};

typedef boost::shared_ptr<UnixSocketInfo> UnixSocketInfoPtr;
 
} // end of isc::config namespace
} // end of isc namespace
#endif