commit 453fed064da5751d4de325357ead2b4e1c5a3757
author Ratan Gupta <ratagupt@linux.vnet.ibm.com> Sat Dec 14 09:39:47 2019 +0530
committer Ratan Gupta <ratagupt@linux.vnet.ibm.com> Wed Apr 08 18:29:00 2020 +0000
tree eba35e2ee0c59f2f0791396c1fd9a485036702ed
parent cb6cb49df6778d48ef3a90d181169abfb4e4354e

Rest service root implementation

This commit introduces the following
=> Service root implementation
=> compiler option for the IBM management console specific functionalities

TestedBy:
curl -k -H "X-Auth-Token: $bmc_token" -X GET https://${bmc}/ibm/v1

Signed-off-by: Ratan Gupta <ratagupt@linux.vnet.ibm.com>
Change-Id: I2dcb8eee0b69b1723e0cc3d980a5846b3519e7d9

CMakeLists.txt

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4bf1673..9d4e4e9 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -88,6 +88,13 @@
     The BMCWEB_INSECURE_DISABLE_SSL must be OFF for this option to take effect."
     ON
 )
+option (
+    BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE
+    "Enable the IBM management console specific functionality. Paths are under
+    '/ibm/v1/'."
+    OFF
+)
+
 
 # Insecure options.  Every option that starts with a BMCWEB_INSECURE flag should
 # not be enabled by default for any platform, unless the author fully
@@ -407,6 +414,8 @@
     -DBMCWEB_ENABLE_VALIDATION_UNSECURE_FEATURE>
     $<$<BOOL:${BMCWEB_INSECURE_UNRESTRICTED_SENSOR_OVERRIDE}>:
     -DBMCWEB_INSECURE_UNRESTRICTED_SENSOR_OVERRIDE>
+    $<$<BOOL:${BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE}>:
+    -DBMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE>
 )
 
 # configure and install systemd unit files

include/ibm/management_console_rest.hpp

diff --git a/include/ibm/management_console_rest.hpp b/include/ibm/management_console_rest.hpp
new file mode 100644
index 0000000..01771b3
--- /dev/null
+++ b/include/ibm/management_console_rest.hpp
@@ -0,0 +1,34 @@
+#pragma once
+#include <app.h>
+#include <tinyxml2.h>
+
+#include <async_resp.hpp>
+
+namespace crow
+{
+namespace ibm_mc
+{
+
+template <typename... Middlewares> void requestRoutes(Crow<Middlewares...> &app)
+{
+
+    // allowed only for admin
+    BMCWEB_ROUTE(app, "/ibm/v1/")
+        .requires({"ConfigureComponents", "ConfigureManager"})
+        .methods("GET"_method)(
+            [](const crow::Request &req, crow::Response &res) {
+                res.jsonValue["@odata.type"] =
+                    "#ibmServiceRoot.v1_0_0.ibmServiceRoot";
+                res.jsonValue["@odata.id"] = "/ibm/v1/";
+                res.jsonValue["Id"] = "IBM Rest RootService";
+                res.jsonValue["Name"] = "IBM Service Root";
+                res.jsonValue["ConfigFiles"] = {
+                    {"@odata.id", "/ibm/v1/Host/ConfigFiles"}};
+                res.jsonValue["LockService"] = {
+                    {"@odata.id", "/ibm/v1/HMC/LockService"}};
+                res.end();
+            });
+}
+
+} // namespace ibm_mc
+} // namespace crow

src/webserver_main.cpp

diff --git a/src/webserver_main.cpp b/src/webserver_main.cpp
index 901c180..4bdf880 100644
--- a/src/webserver_main.cpp
+++ b/src/webserver_main.cpp
@@ -9,6 +9,9 @@
 #include <memory>
 #include <obmc_console.hpp>
 #include <openbmc_dbus_rest.hpp>
+#ifdef BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE
+#include <ibm/management_console_rest.hpp>
+#endif
 #include <persistent_data_middleware.hpp>
 #include <redfish.hpp>
 #include <redfish_v1.hpp>
@@ -94,6 +97,10 @@
     crow::obmc_vm::requestRoutes(app);
 #endif
 
+#ifdef BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE
+    crow::ibm_mc::requestRoutes(app);
+#endif
+
     crow::token_authorization::requestRoutes(app);
 
     BMCWEB_LOG_INFO << "bmcweb (" << __DATE__ << ": " << __TIME__ << ')';