diff options
author | AppaRao Puli <apparao.puli@linux.intel.com> | 2018-10-03 17:07:46 +0300 |
---|---|---|
committer | Feist, James <james.feist@intel.com> | 2019-01-14 22:00:09 +0300 |
commit | 163dfd95c3ac1a6a9fbeee710ec2a9842e7f9871 (patch) | |
tree | 7a65c292c674992f00ceb7c58549633ee3c456da /srvcfg-manager | |
parent | 02e39dd2b8f8ebc846417f4950d122f3b6da8f78 (diff) | |
download | provingground-163dfd95c3ac1a6a9fbeee710ec2a9842e7f9871.tar.xz |
Config service manager implementation.
Added new service for managing the service(RMCP+, ssh, web)
properties like state, port, channel etc. This is common
service supports both systemctl and iptables.
Example usage: Blocking specific service port and restricting
network traffic on specific channels etc.
Unit Test:
- Changed port of RMCP+ service and validated.
- Restricted network traffic on specific channel(eth0)
and cross validated functionality.
Change-Id: I835a4723bc5d5a65efb6ec329f74f3932e841522
Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
Diffstat (limited to 'srvcfg-manager')
-rw-r--r-- | srvcfg-manager/.clang-format | 84 | ||||
-rw-r--r-- | srvcfg-manager/CMakeLists.txt | 58 | ||||
-rw-r--r-- | srvcfg-manager/LICENSE | 201 | ||||
-rw-r--r-- | srvcfg-manager/inc/srvcfg_manager.hpp | 69 | ||||
-rw-r--r-- | srvcfg-manager/inc/utils.hpp | 40 | ||||
-rw-r--r-- | srvcfg-manager/src/main.cpp | 45 | ||||
-rw-r--r-- | srvcfg-manager/src/srvcfg_manager.cpp | 387 | ||||
-rw-r--r-- | srvcfg-manager/src/utils.cpp | 143 | ||||
-rw-r--r-- | srvcfg-manager/srvcfg-manager.service | 13 |
9 files changed, 1040 insertions, 0 deletions
diff --git a/srvcfg-manager/.clang-format b/srvcfg-manager/.clang-format new file mode 100644 index 0000000..37469de --- /dev/null +++ b/srvcfg-manager/.clang-format @@ -0,0 +1,84 @@ +--- +Language: Cpp +# BasedOnStyle: LLVM +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlinesLeft: false +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: false +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: true + AfterControlStatement: true + AfterEnum: true + AfterFunction: true + AfterNamespace: true + AfterObjCDeclaration: true + AfterStruct: true + AfterUnion: true + BeforeCatch: true + BeforeElse: true + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Custom +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: AfterColon +ColumnLimit: 80 +CommentPragmas: '^ IWYU pragma:' +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: true +PointerAlignment: Left +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] +IndentCaseLabels: true +IndentWidth: 4 +IndentWrappedFunctionNames: true +KeepEmptyLinesAtTheStartOfBlocks: true +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBlockIndentWidth: 2 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +ReflowComments: true +SortIncludes: false +SpaceAfterCStyleCast: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +TabWidth: 4 +UseTab: Never +... diff --git a/srvcfg-manager/CMakeLists.txt b/srvcfg-manager/CMakeLists.txt new file mode 100644 index 0000000..6dd3e29 --- /dev/null +++ b/srvcfg-manager/CMakeLists.txt @@ -0,0 +1,58 @@ +cmake_minimum_required(VERSION 3.5 FATAL_ERROR) +project(phosphor-srvcfg-manager CXX) +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-rtti") +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-rtti") + +set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) + +include(GNUInstallDirs) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/inc) +find_package(Boost REQUIRED) +include_directories(${Boost_INCLUDE_DIRS}) +add_definitions(-DBOOST_ERROR_CODE_HEADER_ONLY) +add_definitions(-DBOOST_SYSTEM_NO_DEPRECATED) +add_definitions(-DBOOST_ALL_NO_LIB) +add_definitions(-DBOOST_NO_RTTI) +add_definitions(-DBOOST_NO_TYPEID) +add_definitions(-DBOOST_ASIO_DISABLE_THREADS) + +set(SRC_FILES src/main.cpp src/srvcfg_manager.cpp src/utils.cpp) + +# import libsystemd +find_package(PkgConfig REQUIRED) +pkg_check_modules(SYSTEMD libsystemd REQUIRED) +include_directories(${SYSTEMD_INCLUDE_DIRS}) +link_directories(${SYSTEMD_LIBRARY_DIRS}) + +# import sdbusplus +find_package(PkgConfig REQUIRED) +pkg_check_modules(SDBUSPLUSPLUS sdbusplus REQUIRED) +include_directories(${SDBUSPLUSPLUS_INCLUDE_DIRS}) +link_directories(${SDBUSPLUSPLUS_LIBRARY_DIRS}) +find_program(SDBUSPLUSPLUS sdbus++) + +# phosphor-dbus-interfaces +find_package(PkgConfig REQUIRED) +pkg_check_modules(DBUSINTERFACE phosphor-dbus-interfaces REQUIRED) +include_directories(${DBUSINTERFACE_INCLUDE_DIRS}) +link_directories(${DBUSINTERFACE_LIBRARY_DIRS}) + +# import phosphor-logging +find_package(PkgConfig REQUIRED) +pkg_check_modules(LOGGING phosphor-logging REQUIRED) +include_directories(${LOGGING_INCLUDE_DIRS}) +link_directories(${LOGGING_LIBRARY_DIRS}) + +add_executable(${PROJECT_NAME} ${SRC_FILES}) +target_link_libraries(${PROJECT_NAME} systemd) +target_link_libraries(${PROJECT_NAME} "${SDBUSPLUSPLUS_LIBRARIES} -lstdc++fs") +target_link_libraries(${PROJECT_NAME} ${DBUSINTERFACE_LIBRARIES}) +target_link_libraries(${PROJECT_NAME} ${Boost_LIBRARIES}) +target_link_libraries(${PROJECT_NAME} phosphor_logging) + +set(SERVICE_FILES ${PROJECT_SOURCE_DIR}/srvcfg-manager.service) + +install(TARGETS ${PROJECT_NAME} DESTINATION sbin) +install(FILES ${SERVICE_FILES} DESTINATION /lib/systemd/system/) diff --git a/srvcfg-manager/LICENSE b/srvcfg-manager/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/srvcfg-manager/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/srvcfg-manager/inc/srvcfg_manager.hpp b/srvcfg-manager/inc/srvcfg_manager.hpp new file mode 100644 index 0000000..8979f78 --- /dev/null +++ b/srvcfg-manager/inc/srvcfg_manager.hpp @@ -0,0 +1,69 @@ +/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#pragma once
+#include <sdbusplus/timer.hpp>
+#include "utils.hpp"
+
+namespace phosphor
+{
+namespace service
+{
+
+static constexpr const char *serviceConfigSrvName =
+ "xyz.openbmc_project.Control.Service.Manager";
+static constexpr const char *serviceConfigIntfName =
+ "xyz.openbmc_project.Control.Service.Attributes";
+
+enum class UpdatedProp
+{
+ port = 1,
+ channel,
+ state
+};
+
+class ServiceConfig
+{
+ public:
+ ServiceConfig(sdbusplus::asio::object_server &srv_,
+ std::shared_ptr<sdbusplus::asio::connection> &conn_,
+ std::string objPath_, std::string unitName);
+ ~ServiceConfig() = default;
+
+ void applySystemDServiceConfig();
+ void startServiceRestartTimer();
+
+ std::shared_ptr<sdbusplus::asio::connection> conn;
+ uint8_t updatedFlag;
+
+ private:
+ sdbusplus::asio::object_server &server;
+ std::string objPath;
+
+ uint16_t portNum;
+ std::string protocol;
+ std::string stateValue;
+ std::vector<std::string> channelList;
+
+ void registerProperties();
+ std::string sysDUnitName;
+ std::string unitSocketFilePath;
+ std::string sysDSockObjPath;
+
+ void syncWithSystemD1Properties();
+};
+
+} // namespace service
+} // namespace phosphor
diff --git a/srvcfg-manager/inc/utils.hpp b/srvcfg-manager/inc/utils.hpp new file mode 100644 index 0000000..67ced4c --- /dev/null +++ b/srvcfg-manager/inc/utils.hpp @@ -0,0 +1,40 @@ +/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#pragma once
+#include <ctime>
+#include <chrono>
+#include <string>
+#include <sdbusplus/asio/object_server.hpp>
+#include <phosphor-logging/elog-errors.hpp>
+#include <xyz/openbmc_project/Common/error.hpp>
+#include <experimental/filesystem>
+#include <boost/asio.hpp>
+
+static constexpr const char *sysdActionStartUnit = "StartUnit";
+static constexpr const char *sysdActionStopUnit = "StopUnit";
+
+void systemdDaemonReload(
+ const std::shared_ptr<sdbusplus::asio::connection> &conn);
+
+void systemdUnitAction(const std::shared_ptr<sdbusplus::asio::connection> &conn,
+ const std::string &unitName,
+ const std::string &actionMethod);
+
+void systemdUnitFileStateChange(
+ const std::shared_ptr<sdbusplus::asio::connection> &conn,
+ const std::string &unitName, const std::string &unitState);
+
+bool checkSystemdUnitExist(const std::string &unitName);
diff --git a/srvcfg-manager/src/main.cpp b/srvcfg-manager/src/main.cpp new file mode 100644 index 0000000..ffb0e11 --- /dev/null +++ b/srvcfg-manager/src/main.cpp @@ -0,0 +1,45 @@ +/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#include "srvcfg_manager.hpp"
+
+std::shared_ptr<boost::asio::deadline_timer> timer = nullptr;
+std::map<std::string, std::shared_ptr<phosphor::service::ServiceConfig>>
+ srvMgrObjects;
+
+static std::map<std::string, std::string> serviceList = {
+ {"netipmid", "phosphor-ipmi-net"}, {"web", "bmcweb"}, {"ssh", "dropbear"}};
+
+int main()
+{
+ // setup connection to dbus
+ boost::asio::io_service io;
+ auto conn = std::make_shared<sdbusplus::asio::connection>(io);
+ timer = std::make_shared<boost::asio::deadline_timer>(io);
+ conn->request_name(phosphor::service::serviceConfigSrvName);
+ auto server = sdbusplus::asio::object_server(conn);
+ for (const auto &service : serviceList)
+ {
+ std::string objPath("/xyz/openbmc_project/control/service/" +
+ service.first);
+ auto srvCfgObj = std::make_unique<phosphor::service::ServiceConfig>(
+ server, conn, objPath, service.second);
+ srvMgrObjects.emplace(
+ std::make_pair(std::move(service.first), std::move(srvCfgObj)));
+ }
+ io.run();
+
+ return 0;
+}
diff --git a/srvcfg-manager/src/srvcfg_manager.cpp b/srvcfg-manager/src/srvcfg_manager.cpp new file mode 100644 index 0000000..04d41ca --- /dev/null +++ b/srvcfg-manager/src/srvcfg_manager.cpp @@ -0,0 +1,387 @@ +/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#include <fstream>
+#include <regex>
+#include "srvcfg_manager.hpp"
+
+extern std::shared_ptr<boost::asio::deadline_timer> timer;
+extern std::map<std::string, std::shared_ptr<phosphor::service::ServiceConfig>>
+ srvMgrObjects;
+
+namespace phosphor
+{
+namespace service
+{
+
+static constexpr const char *overrideConfFileName = "override.conf";
+static constexpr const size_t restartTimeout = 15; // seconds
+
+static constexpr const char *systemd1UnitBasePath =
+ "/org/freedesktop/systemd1/unit/";
+static constexpr const char *systemdOverrideUnitBasePath =
+ "/etc/systemd/system/";
+
+void ServiceConfig::syncWithSystemD1Properties()
+{
+ // Read systemd1 socket/service property and load.
+ conn->async_method_call(
+ [this](boost::system::error_code ec,
+ const sdbusplus::message::variant<
+ std::vector<std::tuple<std::string, std::string>>> &value) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to get property");
+ return;
+ }
+
+ try
+ {
+ auto listenVal = sdbusplus::message::variant_ns::get<
+ std::vector<std::tuple<std::string, std::string>>>(value);
+ protocol = std::get<0>(listenVal[0]);
+ std::string port = std::get<1>(listenVal[0]);
+ auto tmp = std::stoul(port.substr(port.find_last_of(":") + 1),
+ nullptr, 10);
+ if (tmp > std::numeric_limits<uint16_t>::max())
+ {
+ throw std::out_of_range("Out of range");
+ }
+ portNum = tmp;
+ }
+ catch (const std::exception &e)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Exception for port number",
+ phosphor::logging::entry("WHAT=%s", e.what()));
+ return;
+ }
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to set property");
+ return;
+ }
+ },
+ serviceConfigSrvName, objPath.c_str(),
+ "org.freedesktop.DBus.Properties", "Set", serviceConfigIntfName,
+ "Port", sdbusplus::message::variant<uint16_t>(portNum));
+ },
+ "org.freedesktop.systemd1", sysDSockObjPath.c_str(),
+ "org.freedesktop.DBus.Properties", "Get",
+ "org.freedesktop.systemd1.Socket", "Listen");
+
+ conn->async_method_call(
+ [this](boost::system::error_code ec,
+ const sdbusplus::message::variant<std::string> &pValue) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to get property");
+ return;
+ }
+
+ channelList.clear();
+ std::istringstream stm(
+ sdbusplus::message::variant_ns::get<std::string>(pValue));
+ std::string token;
+ while (std::getline(stm, token, ','))
+ {
+ channelList.push_back(token);
+ }
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to set property");
+ return;
+ }
+ },
+ serviceConfigSrvName, objPath.c_str(),
+ "org.freedesktop.DBus.Properties", "Set", serviceConfigIntfName,
+ "Channel",
+ sdbusplus::message::variant<std::vector<std::string>>(
+ channelList));
+ },
+ "org.freedesktop.systemd1", sysDSockObjPath.c_str(),
+ "org.freedesktop.DBus.Properties", "Get",
+ "org.freedesktop.systemd1.Socket", "BindToDevice");
+
+ std::string srvUnitName(sysDUnitName);
+ if (srvUnitName == "dropbear")
+ {
+ srvUnitName.append("@");
+ }
+ srvUnitName.append(".service");
+ conn->async_method_call(
+ [this](boost::system::error_code ec, const std::string &pValue) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to get property");
+ return;
+ }
+ stateValue = pValue;
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async_method_call error: Failed to set property");
+ return;
+ }
+ },
+ serviceConfigSrvName, objPath.c_str(),
+ "org.freedesktop.DBus.Properties", "Set", serviceConfigIntfName,
+ "State", sdbusplus::message::variant<std::string>(stateValue));
+ },
+ "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
+ "org.freedesktop.systemd1.Manager", "GetUnitFileState", srvUnitName);
+
+ return;
+}
+
+ServiceConfig::ServiceConfig(
+ sdbusplus::asio::object_server &srv_,
+ std::shared_ptr<sdbusplus::asio::connection> &conn_, std::string objPath_,
+ std::string unitName) :
+ server(srv_),
+ conn(conn_), objPath(objPath_), sysDUnitName(unitName)
+{
+ std::string socketUnitName(sysDUnitName + ".socket");
+ // .socket systemd service files are handled.
+ // Regular .service only files are ignored.
+ if (!checkSystemdUnitExist(socketUnitName))
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Unit doesn't exist.",
+ phosphor::logging::entry("UNITNAME=%s", socketUnitName.c_str()));
+ phosphor::logging::elog<
+ sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure>();
+ }
+
+ /// Check override socket directory exist, if not create it.
+ std::experimental::filesystem::path ovrUnitFileDir(
+ systemdOverrideUnitBasePath);
+ ovrUnitFileDir += socketUnitName;
+ ovrUnitFileDir += ".d";
+ if (!std::experimental::filesystem::exists(ovrUnitFileDir))
+ {
+ if (!std::experimental::filesystem::create_directories(ovrUnitFileDir))
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Unable to create the directory.",
+ phosphor::logging::entry("DIR=%s", ovrUnitFileDir.c_str()));
+ phosphor::logging::elog<sdbusplus::xyz::openbmc_project::Common::
+ Error::InternalFailure>();
+ }
+ }
+
+ /* Store require info locally */
+ unitSocketFilePath = std::string(ovrUnitFileDir);
+
+ sysDSockObjPath = systemd1UnitBasePath;
+ sysDSockObjPath.append(
+ std::regex_replace(sysDUnitName, std::regex("-"), "_2d"));
+ sysDSockObjPath.append("_2esocket");
+
+ // Adds interface, object and Properties....
+ registerProperties();
+
+ syncWithSystemD1Properties();
+
+ updatedFlag = 0;
+ return;
+}
+
+void ServiceConfig::applySystemDServiceConfig()
+{
+ phosphor::logging::log<phosphor::logging::level::INFO>(
+ "Applying new settings.",
+ phosphor::logging::entry("OBJPATH=%s", objPath.c_str()));
+ if (updatedFlag & ((1 << static_cast<uint8_t>(UpdatedProp::channel)) |
+ (1 << static_cast<uint8_t>(UpdatedProp::port))))
+ {
+ // Create override config file and write data.
+ std::string ovrCfgFile{unitSocketFilePath + "/" + overrideConfFileName};
+ std::string tmpFile{ovrCfgFile + "_tmp"};
+ std::ofstream cfgFile(tmpFile, std::ios::out);
+ if (!cfgFile.good())
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Failed to open override.conf_tmp file");
+ phosphor::logging::elog<sdbusplus::xyz::openbmc_project::Common::
+ Error::InternalFailure>();
+ }
+
+ // Write the socket header
+ cfgFile << "[Socket]\n";
+ // Listen
+ cfgFile << "Listen" << protocol << "="
+ << "\n";
+ cfgFile << "Listen" << protocol << "=" << portNum << "\n";
+ // BindToDevice
+ bool firstElement = true;
+ cfgFile << "BindToDevice=";
+ for (const auto &it : channelList)
+ {
+ if (firstElement)
+ {
+ cfgFile << it;
+ firstElement = false;
+ }
+ else
+ {
+ cfgFile << "," << it;
+ }
+ }
+ cfgFile.close();
+
+ if (std::rename(tmpFile.c_str(), ovrCfgFile.c_str()) != 0)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Failed to rename tmp file as override.conf");
+ std::remove(tmpFile.c_str());
+ phosphor::logging::elog<sdbusplus::xyz::openbmc_project::Common::
+ Error::InternalFailure>();
+ }
+
+ // Systemd forcing explicit socket stop before reload...!
+ std::string socketUnitName(sysDUnitName + ".socket");
+ systemdUnitAction(conn, socketUnitName, sysdActionStopUnit);
+
+ std::string srvUnitName(sysDUnitName + ".service");
+ systemdUnitAction(conn, srvUnitName, sysdActionStopUnit);
+
+ // Perform daemon reload to read new settings
+ systemdDaemonReload(conn);
+
+ // Restart the unit
+ systemdUnitAction(conn, socketUnitName, sysdActionStartUnit);
+ systemdUnitAction(conn, srvUnitName, sysdActionStartUnit);
+ }
+
+ if (updatedFlag & (1 << static_cast<uint8_t>(UpdatedProp::state)))
+ {
+ if ((stateValue == "enabled") || (stateValue == "disabled"))
+ {
+ systemdUnitFileStateChange(conn, sysDUnitName, stateValue);
+ }
+ }
+
+ // Reset the flag
+ updatedFlag = 0;
+
+ // All done. Lets reload the properties which are applied on systemd1.
+ // TODO: We need to capture the service restart signal and reload data
+ // inside the signal handler. So that we can update the service properties
+ // modified, outside of this service as well.
+ syncWithSystemD1Properties();
+
+ return;
+}
+
+void ServiceConfig::startServiceRestartTimer()
+{
+ timer->expires_from_now(boost::posix_time::seconds(restartTimeout));
+ timer->async_wait([this](const boost::system::error_code &ec) {
+ if (ec == boost::asio::error::operation_aborted)
+ {
+ // Timer reset.
+ return;
+ }
+ else if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async wait error.");
+ return;
+ }
+ for (auto &srvMgrObj : srvMgrObjects)
+ {
+ auto &srvObj = srvMgrObj.second;
+ if (srvObj->updatedFlag)
+ {
+ srvObj->applySystemDServiceConfig();
+ }
+ }
+ });
+}
+
+void ServiceConfig::registerProperties()
+{
+ std::shared_ptr<sdbusplus::asio::dbus_interface> iface =
+ server.add_interface(objPath, serviceConfigIntfName);
+
+ iface->register_property(
+ "Port", portNum, [this](const uint16_t &req, uint16_t &res) {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ " Inside register_property");
+ if (req == res)
+ {
+ return 1;
+ }
+ portNum = req;
+ updatedFlag |= (1 << static_cast<uint8_t>(UpdatedProp::port));
+ startServiceRestartTimer();
+ res = req;
+ return 1;
+ });
+
+ iface->register_property(
+ "Channel", channelList,
+ [this](const std::vector<std::string> &req,
+ std::vector<std::string> &res) {
+ if (req == res)
+ {
+ return 1;
+ }
+ channelList.clear();
+ std::copy(req.begin(), req.end(), back_inserter(channelList));
+
+ updatedFlag |= (1 << static_cast<uint8_t>(UpdatedProp::channel));
+ startServiceRestartTimer();
+ res = req;
+ return 1;
+ });
+
+ iface->register_property(
+ "State", stateValue, [this](const std::string &req, std::string &res) {
+ if (req == res)
+ {
+ return 1;
+ }
+ if ((req != "enabled") && (req != "disabled") && (req != "static"))
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Invalid value specified");
+ return -EINVAL;
+ }
+ stateValue = req;
+ updatedFlag |= (1 << static_cast<uint8_t>(UpdatedProp::state));
+ startServiceRestartTimer();
+ res = req;
+ return 1;
+ });
+
+ iface->initialize();
+ return;
+}
+
+} // namespace service
+} // namespace phosphor
diff --git a/srvcfg-manager/src/utils.cpp b/srvcfg-manager/src/utils.cpp new file mode 100644 index 0000000..07239e2 --- /dev/null +++ b/srvcfg-manager/src/utils.cpp @@ -0,0 +1,143 @@ +/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#include "utils.hpp"
+
+void systemdDaemonReload(
+ const std::shared_ptr<sdbusplus::asio::connection> &conn)
+{
+ try
+ {
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async error: Failed to do systemd reload.");
+ return;
+ }
+ },
+ "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
+ "org.freedesktop.systemd1.Manager", "Reload");
+ }
+ catch (const sdbusplus::exception::SdBusError &e)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "daemon-reload operation failed.");
+ phosphor::logging::elog<
+ sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure>();
+ }
+
+ return;
+}
+
+void systemdUnitAction(const std::shared_ptr<sdbusplus::asio::connection> &conn,
+ const std::string &unitName,
+ const std::string &actionMethod)
+{
+ try
+ {
+ conn->async_method_call(
+ [](boost::system::error_code ec,
+ const sdbusplus::message::object_path &res) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async error: Failed to do systemd action");
+ return;
+ }
+ },
+ "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
+ "org.freedesktop.systemd1.Manager", actionMethod, unitName,
+ "replace");
+ }
+ catch (const sdbusplus::exception::SdBusError &e)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Systemd operation failed.",
+ phosphor::logging::entry("ACTION=%s", actionMethod.c_str()));
+ phosphor::logging::elog<
+ sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure>();
+ }
+
+ return;
+}
+
+void systemdUnitFileStateChange(
+ const std::shared_ptr<sdbusplus::asio::connection> &conn,
+ const std::string &unitName, const std::string &unitState)
+{
+ try
+ {
+ // For now, we support two states(enabled & disabled). we can extend
+ // to other states (enable-runtime, mask, link etc..) if needed.
+ std::vector<std::string> unitFiles = {unitName};
+ if (unitState == "enabled")
+ {
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async error: Failed to do systemd reload.");
+ return;
+ }
+ },
+ "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
+ "org.freedesktop.systemd1.Manager", "EnableUnitFiles",
+ unitFiles, false, false);
+ }
+ else if (unitState == "disabled")
+ {
+ conn->async_method_call(
+ [](boost::system::error_code ec) {
+ if (ec)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "async error: Failed to do systemd reload.");
+ return;
+ }
+ },
+ "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
+ "org.freedesktop.systemd1.Manager", "DisableUnitFiles",
+ unitFiles, false);
+ }
+ else
+ {
+ // Not supported unit State
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "invalid Unit state",
+ phosphor::logging::entry("STATE=%s", unitState.c_str()));
+ phosphor::logging::elog<sdbusplus::xyz::openbmc_project::Common::
+ Error::InternalFailure>();
+ }
+ }
+ catch (const sdbusplus::exception::SdBusError &e)
+ {
+ phosphor::logging::log<phosphor::logging::level::ERR>(
+ "Systemd state change operation failed.");
+ phosphor::logging::elog<
+ sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure>();
+ }
+
+ return;
+}
+
+bool checkSystemdUnitExist(const std::string &unitName)
+{
+ std::experimental::filesystem::path unitFilePath(
+ std::string("/lib/systemd/system/") + unitName);
+ return std::experimental::filesystem::exists(unitFilePath);
+}
diff --git a/srvcfg-manager/srvcfg-manager.service b/srvcfg-manager/srvcfg-manager.service new file mode 100644 index 0000000..288b5f4 --- /dev/null +++ b/srvcfg-manager/srvcfg-manager.service @@ -0,0 +1,13 @@ +[Unit] +Description=Daemon to control service configuration + +[Service] +Restart=always +ExecStart={sbindir}/phosphor-srvcfg-manager +RestartSec=5 +StartLimitInterval=0 +Type=dbus +BusName=xyz.openbmc_project.Control.Service.Manager + +[Install] +WantedBy=basic.target |