summaryrefslogtreecommitdiff
path: root/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/vm/0004-Invalid-status-code-from-InsertMedia-REST-methods.patch
blob: 439b05b3c20e9f1cc07d1924400aec84815dbfb1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
From 437a2a854303ed4e05344684b1990806464268cd Mon Sep 17 00:00:00 2001
From: Krzysztof Grobelny <krzysztof.grobelny@intel.com>
Date: Thu, 1 Jul 2021 10:08:27 +0000
Subject: [PATCH] Invalid status code from InsertMedia REST methods GET,  PUT,
 DELETE, PATCH in proxy mode

Add handlers for GET, PUT, DELETE, PATCH method and function that
checks which mode is used and set suitable status code:
Not allowed for Legacy and Not found for Proxy.

Change-Id: Ib4c0a3e9a2a8853caa74c59239d9fcfed99c5e8b
Signed-off-by: Alicja Rybak <alicja.rybak@intel.com>
Signed-off-by: P Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com>
---
 redfish-core/lib/virtual_media.hpp | 137 +++++++++++++++++++++++++++++
 1 file changed, 137 insertions(+)

diff --git a/redfish-core/lib/virtual_media.hpp b/redfish-core/lib/virtual_media.hpp
index 3b9f7ef..7d77b9f 100644
--- a/redfish-core/lib/virtual_media.hpp
+++ b/redfish-core/lib/virtual_media.hpp
@@ -30,6 +30,117 @@
 
 namespace redfish
 {
+
+/**
+ * @brief Function checks if insert media request is Legacy or Proxy type
+ *        and sets suitable response code for unsupported REST method.
+ *
+ */
+void CheckProxyMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+                    const crow::Request& req, const std::string& name,
+                    const std::string& resName)
+{
+    if (name != "bmc")
+    {
+        messages::resourceNotFound(aResp->res, "VirtualMedia.Insert", resName);
+
+        return;
+    }
+
+    crow::connections::systemBus->async_method_call(
+        [aResp, req, resName](const boost::system::error_code ec,
+                              const GetObjectType& getObjectType) {
+            if (ec)
+            {
+                BMCWEB_LOG_ERROR << "ObjectMapper::GetObject call failed: "
+                                 << ec;
+                aResp->res.result(boost::beast::http::status::not_found);
+
+                return;
+            }
+
+            if (getObjectType.size() == 0)
+            {
+                BMCWEB_LOG_ERROR << "ObjectMapper : No Service found";
+                aResp->res.result(boost::beast::http::status::not_found);
+                return;
+            }
+
+            std::string service = getObjectType.begin()->first;
+            BMCWEB_LOG_DEBUG << "GetObjectType: " << service;
+
+            crow::connections::systemBus->async_method_call(
+                [service, resName, req,
+                 aResp](const boost::system::error_code ec,
+                        ManagedObjectType& subtree) {
+                    if (ec)
+                    {
+                        BMCWEB_LOG_DEBUG << "DBUS response error";
+
+                        return;
+                    }
+
+                    for (auto& item : subtree)
+                    {
+                        std::string thispath = item.first.filename();
+                        if (thispath.empty())
+                        {
+                            continue;
+                        }
+
+                        if (thispath != resName)
+                        {
+                            continue;
+                        }
+
+                        auto mode = item.first.parent_path();
+                        auto type = mode.parent_path();
+                        if (mode.filename().empty() || type.filename().empty())
+                        {
+                            continue;
+                        }
+
+                        if (type.filename() != "VirtualMedia")
+                        {
+                            continue;
+                        }
+
+                        // Check if dbus path is Legacy type
+                        if (mode.filename() == "Legacy")
+                        {
+                            BMCWEB_LOG_DEBUG << "InsertMedia only allowed "
+                                                "with POST method "
+                                                "in legacy mode";
+                            aResp->res.result(
+                                boost::beast::http::status::method_not_allowed);
+
+                            return;
+                        }
+                        // Check if dbus path is Proxy type
+                        if (mode.filename() == "Proxy")
+                        {
+                            // Not possible in proxy mode
+                            BMCWEB_LOG_DEBUG << "InsertMedia not "
+                                                "allowed in proxy mode";
+                            aResp->res.result(
+                                boost::beast::http::status::not_found);
+
+                            return;
+                        }
+                    }
+
+                    BMCWEB_LOG_DEBUG << "Parent item not found";
+                    aResp->res.result(boost::beast::http::status::not_found);
+                },
+                service, "/xyz/openbmc_project/VirtualMedia",
+                "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
+        },
+        "xyz.openbmc_project.ObjectMapper",
+        "/xyz/openbmc_project/object_mapper",
+        "xyz.openbmc_project.ObjectMapper", "GetObject",
+        "/xyz/openbmc_project/VirtualMedia", std::array<const char*, 0>());
+}
+
 /**
  * @brief Function extracts transfer protocol name from URI.
  */
@@ -844,6 +955,32 @@ inline void doVmAction(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
 
 inline void requestNBDVirtualMediaRoutes(App& app)
 {
+    BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/VirtualMedia/<str>/Actions/"
+                      "VirtualMedia.InsertMedia")
+        .privileges({{"Login"}})
+        .methods(boost::beast::http::verb::get)(
+            [](const crow::Request& req,
+               const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+               const std::string& name, const std::string& resName) {
+                CheckProxyMode(asyncResp, req, name, resName);
+            });
+
+    for (auto method :
+         {boost::beast::http::verb::patch, boost::beast::http::verb::put,
+          boost::beast::http::verb::delete_})
+    {
+        BMCWEB_ROUTE(app,
+                     "/redfish/v1/Managers/<str>/VirtualMedia/<str>/Actions/"
+                     "VirtualMedia.InsertMedia")
+            .privileges({{"ConfigureManager"}})
+            .methods(method)(
+                [](const crow::Request& req,
+                   const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+                   const std::string& name, const std::string& resName) {
+                    CheckProxyMode(asyncResp, req, name, resName);
+                });
+    }
+
     BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/VirtualMedia/<str>/Actions/"
                       "VirtualMedia.InsertMedia")
         .privileges(redfish::privileges::postVirtualMedia)
-- 
2.17.1