[posix] Add posix Cli Daemon module

src/host/posix/CMakeLists.txt

@@ -27,6 +27,8 @@
 #
 
 add_library(otbr-posix
+    cli_daemon.hpp
+    cli_daemon.cpp
     dnssd.cpp
     infra_if.hpp
     infra_if.cpp

src/host/posix/cli_daemon.cpp

@@ -0,0 +1,168 @@
+/*
+ *  Copyright (c) 2025, The OpenThread Authors.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of the copyright holder nor the
+ *     names of its contributors may be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#define OTBR_LOG_TAG "CLIDAEMON"
+
+#include "cli_daemon.hpp"
+
+#include <fcntl.h>
+#include <signal.h>
+#include <stdarg.h>
+#include <string.h>
+#include <sys/file.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <sys/un.h>
+#include <unistd.h>
+
+#include <openthread/cli.h>
+
+#include "utils/socket_utils.hpp"
+
+namespace otbr {
+
+static constexpr char kDefaultNetIfName[] = "wpan0";
+static constexpr char kSocketBaseName[]   = "/run/openthread-";
+static constexpr char kSocketSuffix[]     = ".sock";
+static constexpr char kSocketLockSuffix[] = ".lock";
+
+static constexpr size_t kMaxSocketFilenameLength = sizeof(sockaddr_un::sun_path) - 1;
+
+std::string CliDaemon::GetSocketFilename(const char *aSuffix) const
+{
+    std::string fileName;
+    std::string netIfName = mNetifName.empty() ? kDefaultNetIfName : mNetifName;
+
+    fileName = kSocketBaseName + netIfName + aSuffix;
+    if (fileName.size() > kMaxSocketFilenameLength)
+    {
+        DieNow(otbrErrorString(OTBR_ERROR_INVALID_ARGS));
+    }
+
+    return fileName;
+}
+
+CliDaemon::CliDaemon()
+    : mListenSocket(-1)
+    , mDaemonLock(-1)
+{
+}
+
+void CliDaemon::createListenSocketOrDie(void)
+{
+    struct sockaddr_un sockname;
+
+    class AllowAllGuard
+    {
+    public:
+        AllowAllGuard(void)
+        {
+            const char *allowAll = getenv("OT_DAEMON_ALLOW_ALL");
+            mAllowAll            = (allowAll != nullptr && strcmp("1", allowAll) == 0);
+
+            if (mAllowAll)
+            {
+                mMode = umask(0);
+            }
+        }
+        ~AllowAllGuard(void)
+        {
+            if (mAllowAll)
+            {
+                umask(mMode);
+            }
+        }
+
+    private:
+        bool   mAllowAll = false;
+        mode_t mMode     = 0;
+    };
+
+    mListenSocket = SocketWithCloseExec(AF_UNIX, SOCK_STREAM, 0, kSocketNonBlock);
+    VerifyOrDie(mListenSocket != -1, strerror(errno));
+
+    {
+        std::string lockfile = GetSocketFilename(kSocketLockSuffix);
+
+        mDaemonLock = open(lockfile.c_str(), O_CREAT | O_RDONLY | O_CLOEXEC, 0600);
+    }
+
+    if (mDaemonLock == -1)
+    {
+        otbrLogCrit("open");
+        DieNow(otbrErrorString(OTBR_ERROR_ERRNO));
+    }
+
+    if (flock(mDaemonLock, LOCK_EX | LOCK_NB) == -1)
+    {
+        otbrLogCrit("flock");
+        DieNow(otbrErrorString(OTBR_ERROR_ERRNO));
+    }
+
+    std::string socketfile = GetSocketFilename(kSocketSuffix);
+
+    memset(&sockname, 0, sizeof(struct sockaddr_un));
+
+    sockname.sun_family = AF_UNIX;
+    strncpy(sockname.sun_path, socketfile.c_str(), sizeof(sockname.sun_path) - 1);
+    (void)unlink(sockname.sun_path);
+
+    {
+        AllowAllGuard allowAllGuard;
+
+        if (bind(mListenSocket, reinterpret_cast<const struct sockaddr *>(&sockname), sizeof(struct sockaddr_un)) == -1)
+        {
+            otbrLogCrit("bind");
+            DieNow(otbrErrorString(OTBR_ERROR_ERRNO));
+        }
+    }
+}
+
+void CliDaemon::Init(const std::string &aNetIfName)
+{
+    // This allows implementing pseudo reset.
+    VerifyOrExit(mListenSocket == -1);
+
+    mNetifName = aNetIfName;
+    createListenSocketOrDie();
+
+    //
+    // only accept 1 connection.
+    //
+    if (listen(mListenSocket, 1) == -1)
+    {
+        otbrLogCrit("listen");
+        DieNow(otbrErrorString(OTBR_ERROR_ERRNO));
+    }
+
+exit:
+    return;
+}
+
+} // namespace otbr

src/host/posix/cli_daemon.hpp

@@ -0,0 +1,65 @@
+/*
+ *  Copyright (c) 2025, The OpenThread Authors.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of the copyright holder nor the
+ *     names of its contributors may be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file
+ *   This file includes definitions of the Cli Daemon of otbr-agent.
+ */
+
+#ifndef OTBR_AGENT_POSIX_DAEMON_HPP_
+#define OTBR_AGENT_POSIX_DAEMON_HPP_
+
+#include <vector>
+
+#include "common/mainloop.hpp"
+#include "common/types.hpp"
+
+namespace otbr {
+
+class CliDaemon
+{
+public:
+    CliDaemon();
+
+    void Init(const std::string &aNetIfName);
+    void Deinit(void);
+
+private:
+    std::string GetSocketFilename(const char *aSuffix) const;
+
+    void createListenSocketOrDie(void);
+
+    int mListenSocket;
+    int mDaemonLock;
+
+    std::string mNetifName;
+};
+
+} // namespace otbr
+
+#endif // OTBR_AGENT_POSIX_DAEMON_HPP_

tests/gtest/CMakeLists.txt

@@ -75,6 +75,7 @@ if(OTBR_MDNS)
 endif()
 
 add_executable(otbr-posix-gtest-unit
+    test_cli_daemon.cpp
     test_infra_if.cpp
     test_netif.cpp
 )

tests/gtest/test_cli_daemon.cpp

@@ -0,0 +1,84 @@
+/*
+ *    Copyright (c) 2024, The OpenThread Authors.
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *    1. Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *    3. Neither the name of the copyright holder nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include <cstring>
+#include <ifaddrs.h>
+#include <iostream>
+#include <net/if.h>
+#include <netinet/in.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <string>
+#include <sys/ioctl.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <vector>
+
+#include <openthread/ip6.h>
+
+#include "common/types.hpp"
+#include "host/posix/cli_daemon.hpp"
+
+// Only Test on linux platform for now.
+#ifdef __linux__
+
+TEST(CliDaemon, InitSocketCreationWithFullNetIfName)
+{
+    const char *netif_name = "tun0";
+
+    otbr::CliDaemon cliDaemon;
+    cliDaemon.Init(netif_name);
+
+    struct stat st;
+    std::string socketFile = cliDaemon.GetSocketFilename(".sock");
+    std::string lockFile   = cliDaemon.GetSocketFilename(".lock");
+
+    EXPECT_EQ(stat(socketFile.c_str(), &st), 0);
+    EXPECT_EQ(stat(lockFile.c_str(), &st), 0);
+}
+
+TEST(CliDaemon, InitSocketCreationWithEmptyNetIfName)
+{
+    const char *default_netif_name = "wpan0";
+
+    otbr::CliDaemon cliDaemon;
+    cliDaemon.Init("");
+
+    struct stat st;
+    std::string socketFile = cliDaemon.GetSocketFilename(".sock");
+    std::string lockFile   = cliDaemon.GetSocketFilename(".lock");
+
+    EXPECT_EQ(stat(socketFile.c_str(), &st), 0);
+    EXPECT_EQ(stat(lockFile.c_str(), &st), 0);
+}
+
+#endif // __linux__