xref: /openbmc/bmcweb/features/redfish/lib/account_service.hpp (revision e7b1b62b39ba31ba368c42cb6f4fa7af43c65961)
188d16c9aSLewanczyk, Dawid /*
288d16c9aSLewanczyk, Dawid // Copyright (c) 2018 Intel Corporation
388d16c9aSLewanczyk, Dawid //
488d16c9aSLewanczyk, Dawid // Licensed under the Apache License, Version 2.0 (the "License");
588d16c9aSLewanczyk, Dawid // you may not use this file except in compliance with the License.
688d16c9aSLewanczyk, Dawid // You may obtain a copy of the License at
788d16c9aSLewanczyk, Dawid //
888d16c9aSLewanczyk, Dawid //      http://www.apache.org/licenses/LICENSE-2.0
988d16c9aSLewanczyk, Dawid //
1088d16c9aSLewanczyk, Dawid // Unless required by applicable law or agreed to in writing, software
1188d16c9aSLewanczyk, Dawid // distributed under the License is distributed on an "AS IS" BASIS,
1288d16c9aSLewanczyk, Dawid // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1388d16c9aSLewanczyk, Dawid // See the License for the specific language governing permissions and
1488d16c9aSLewanczyk, Dawid // limitations under the License.
1588d16c9aSLewanczyk, Dawid */
1688d16c9aSLewanczyk, Dawid #pragma once
1788d16c9aSLewanczyk, Dawid 
187e860f15SJohn Edward Broadbent #include <app.hpp>
1924c8542dSRatan Gupta #include <dbus_utility.hpp>
2065b0dc32SEd Tanous #include <error_messages.hpp>
21b9b2e0b2SEd Tanous #include <openbmc_dbus_rest.hpp>
2252cc112dSEd Tanous #include <persistent_data.hpp>
23ed398213SEd Tanous #include <registries/privilege_registry.hpp>
241e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp>
25a840879dSEd Tanous #include <utils/json_utils.hpp>
261214b7e7SGunnar Mills 
271abe55efSEd Tanous namespace redfish
281abe55efSEd Tanous {
2988d16c9aSLewanczyk, Dawid 
3023a21a1cSEd Tanous constexpr const char* ldapConfigObjectName =
316973a582SRatan Gupta     "/xyz/openbmc_project/user/ldap/openldap";
322c70f800SEd Tanous constexpr const char* adConfigObject =
33ab828d7cSRatan Gupta     "/xyz/openbmc_project/user/ldap/active_directory";
34ab828d7cSRatan Gupta 
35b477fd44SP Dheeraj Srujan Kumar constexpr const char* rootUserDbusPath = "/xyz/openbmc_project/user/";
366973a582SRatan Gupta constexpr const char* ldapRootObject = "/xyz/openbmc_project/user/ldap";
376973a582SRatan Gupta constexpr const char* ldapDbusService = "xyz.openbmc_project.Ldap.Config";
386973a582SRatan Gupta constexpr const char* ldapConfigInterface =
396973a582SRatan Gupta     "xyz.openbmc_project.User.Ldap.Config";
406973a582SRatan Gupta constexpr const char* ldapCreateInterface =
416973a582SRatan Gupta     "xyz.openbmc_project.User.Ldap.Create";
426973a582SRatan Gupta constexpr const char* ldapEnableInterface = "xyz.openbmc_project.Object.Enable";
4306785244SRatan Gupta constexpr const char* ldapPrivMapperInterface =
4406785244SRatan Gupta     "xyz.openbmc_project.User.PrivilegeMapper";
456973a582SRatan Gupta constexpr const char* dbusObjManagerIntf = "org.freedesktop.DBus.ObjectManager";
466973a582SRatan Gupta constexpr const char* propertyInterface = "org.freedesktop.DBus.Properties";
476973a582SRatan Gupta constexpr const char* mapperBusName = "xyz.openbmc_project.ObjectMapper";
486973a582SRatan Gupta constexpr const char* mapperObjectPath = "/xyz/openbmc_project/object_mapper";
496973a582SRatan Gupta constexpr const char* mapperIntf = "xyz.openbmc_project.ObjectMapper";
506973a582SRatan Gupta 
5154fc587aSNagaraju Goruganti struct LDAPRoleMapData
5254fc587aSNagaraju Goruganti {
5354fc587aSNagaraju Goruganti     std::string groupName;
5454fc587aSNagaraju Goruganti     std::string privilege;
5554fc587aSNagaraju Goruganti };
5654fc587aSNagaraju Goruganti 
576973a582SRatan Gupta struct LDAPConfigData
586973a582SRatan Gupta {
596973a582SRatan Gupta     std::string uri{};
606973a582SRatan Gupta     std::string bindDN{};
616973a582SRatan Gupta     std::string baseDN{};
626973a582SRatan Gupta     std::string searchScope{};
636973a582SRatan Gupta     std::string serverType{};
646973a582SRatan Gupta     bool serviceEnabled = false;
656973a582SRatan Gupta     std::string userNameAttribute{};
666973a582SRatan Gupta     std::string groupAttribute{};
6754fc587aSNagaraju Goruganti     std::vector<std::pair<std::string, LDAPRoleMapData>> groupRoleList;
686973a582SRatan Gupta };
696973a582SRatan Gupta 
7054fc587aSNagaraju Goruganti inline std::string getRoleIdFromPrivilege(std::string_view role)
7184e12cb7SAppaRao Puli {
7284e12cb7SAppaRao Puli     if (role == "priv-admin")
7384e12cb7SAppaRao Puli     {
7484e12cb7SAppaRao Puli         return "Administrator";
7584e12cb7SAppaRao Puli     }
763174e4dfSEd Tanous     if (role == "priv-user")
7784e12cb7SAppaRao Puli     {
78c80fee55SAppaRao Puli         return "ReadOnly";
7984e12cb7SAppaRao Puli     }
803174e4dfSEd Tanous     if (role == "priv-operator")
8184e12cb7SAppaRao Puli     {
8284e12cb7SAppaRao Puli         return "Operator";
8384e12cb7SAppaRao Puli     }
8426f6976fSEd Tanous     if (role.empty() || (role == "priv-noaccess"))
85e9e6d240Sjayaprakash Mutyala     {
86e9e6d240Sjayaprakash Mutyala         return "NoAccess";
87e9e6d240Sjayaprakash Mutyala     }
8884e12cb7SAppaRao Puli     return "";
8984e12cb7SAppaRao Puli }
9054fc587aSNagaraju Goruganti inline std::string getPrivilegeFromRoleId(std::string_view role)
9184e12cb7SAppaRao Puli {
9284e12cb7SAppaRao Puli     if (role == "Administrator")
9384e12cb7SAppaRao Puli     {
9484e12cb7SAppaRao Puli         return "priv-admin";
9584e12cb7SAppaRao Puli     }
963174e4dfSEd Tanous     if (role == "ReadOnly")
9784e12cb7SAppaRao Puli     {
9884e12cb7SAppaRao Puli         return "priv-user";
9984e12cb7SAppaRao Puli     }
1003174e4dfSEd Tanous     if (role == "Operator")
10184e12cb7SAppaRao Puli     {
10284e12cb7SAppaRao Puli         return "priv-operator";
10384e12cb7SAppaRao Puli     }
10426f6976fSEd Tanous     if ((role == "NoAccess") || (role.empty()))
105e9e6d240Sjayaprakash Mutyala     {
106e9e6d240Sjayaprakash Mutyala         return "priv-noaccess";
107e9e6d240Sjayaprakash Mutyala     }
10884e12cb7SAppaRao Puli     return "";
10984e12cb7SAppaRao Puli }
110b9b2e0b2SEd Tanous 
1118d1b46d7Szhanghch05 inline void userErrorMessageHandler(
1128d1b46d7Szhanghch05     const sd_bus_error* e, const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1138d1b46d7Szhanghch05     const std::string& newUser, const std::string& username)
11466b5ca76Sjayaprakash Mutyala {
11566b5ca76Sjayaprakash Mutyala     if (e == nullptr)
11666b5ca76Sjayaprakash Mutyala     {
11766b5ca76Sjayaprakash Mutyala         messages::internalError(asyncResp->res);
11866b5ca76Sjayaprakash Mutyala         return;
11966b5ca76Sjayaprakash Mutyala     }
12066b5ca76Sjayaprakash Mutyala 
121055806b3SManojkiran Eda     const char* errorMessage = e->name;
12266b5ca76Sjayaprakash Mutyala     if (strcmp(errorMessage,
12366b5ca76Sjayaprakash Mutyala                "xyz.openbmc_project.User.Common.Error.UserNameExists") == 0)
12466b5ca76Sjayaprakash Mutyala     {
12566b5ca76Sjayaprakash Mutyala         messages::resourceAlreadyExists(asyncResp->res,
1268114bd4dSGunnar Mills                                         "#ManagerAccount.v1_4_0.ManagerAccount",
12766b5ca76Sjayaprakash Mutyala                                         "UserName", newUser);
12866b5ca76Sjayaprakash Mutyala     }
12966b5ca76Sjayaprakash Mutyala     else if (strcmp(errorMessage, "xyz.openbmc_project.User.Common.Error."
13066b5ca76Sjayaprakash Mutyala                                   "UserNameDoesNotExist") == 0)
13166b5ca76Sjayaprakash Mutyala     {
13266b5ca76Sjayaprakash Mutyala         messages::resourceNotFound(
1338114bd4dSGunnar Mills             asyncResp->res, "#ManagerAccount.v1_4_0.ManagerAccount", username);
13466b5ca76Sjayaprakash Mutyala     }
135d4d25793SEd Tanous     else if ((strcmp(errorMessage,
136d4d25793SEd Tanous                      "xyz.openbmc_project.Common.Error.InvalidArgument") ==
137d4d25793SEd Tanous               0) ||
1380fda0f12SGeorge Liu              (strcmp(
1390fda0f12SGeorge Liu                   errorMessage,
1400fda0f12SGeorge Liu                   "xyz.openbmc_project.User.Common.Error.UserNameGroupFail") ==
1410fda0f12SGeorge Liu               0))
14266b5ca76Sjayaprakash Mutyala     {
14366b5ca76Sjayaprakash Mutyala         messages::propertyValueFormatError(asyncResp->res, newUser, "UserName");
14466b5ca76Sjayaprakash Mutyala     }
14566b5ca76Sjayaprakash Mutyala     else if (strcmp(errorMessage,
14666b5ca76Sjayaprakash Mutyala                     "xyz.openbmc_project.User.Common.Error.NoResource") == 0)
14766b5ca76Sjayaprakash Mutyala     {
14866b5ca76Sjayaprakash Mutyala         messages::createLimitReachedForResource(asyncResp->res);
14966b5ca76Sjayaprakash Mutyala     }
15066b5ca76Sjayaprakash Mutyala     else
15166b5ca76Sjayaprakash Mutyala     {
15266b5ca76Sjayaprakash Mutyala         messages::internalError(asyncResp->res);
15366b5ca76Sjayaprakash Mutyala     }
15466b5ca76Sjayaprakash Mutyala }
15566b5ca76Sjayaprakash Mutyala 
15681ce609eSEd Tanous inline void parseLDAPConfigData(nlohmann::json& jsonResponse,
157ab828d7cSRatan Gupta                                 const LDAPConfigData& confData,
158ab828d7cSRatan Gupta                                 const std::string& ldapType)
1596973a582SRatan Gupta {
160ab828d7cSRatan Gupta     std::string service =
161ab828d7cSRatan Gupta         (ldapType == "LDAP") ? "LDAPService" : "ActiveDirectoryService";
16237cce918SMarri Devender Rao     nlohmann::json ldap = {
1636973a582SRatan Gupta         {"ServiceEnabled", confData.serviceEnabled},
1646973a582SRatan Gupta         {"ServiceAddresses", nlohmann::json::array({confData.uri})},
1656973a582SRatan Gupta         {"Authentication",
1666973a582SRatan Gupta          {{"AuthenticationType", "UsernameAndPassword"},
1676973a582SRatan Gupta           {"Username", confData.bindDN},
1686973a582SRatan Gupta           {"Password", nullptr}}},
1696973a582SRatan Gupta         {"LDAPService",
1706973a582SRatan Gupta          {{"SearchSettings",
1716973a582SRatan Gupta            {{"BaseDistinguishedNames",
1726973a582SRatan Gupta              nlohmann::json::array({confData.baseDN})},
1736973a582SRatan Gupta             {"UsernameAttribute", confData.userNameAttribute},
1746973a582SRatan Gupta             {"GroupsAttribute", confData.groupAttribute}}}}},
1756973a582SRatan Gupta     };
17654fc587aSNagaraju Goruganti 
17781ce609eSEd Tanous     jsonResponse[ldapType].update(ldap);
17854fc587aSNagaraju Goruganti 
17981ce609eSEd Tanous     nlohmann::json& roleMapArray = jsonResponse[ldapType]["RemoteRoleMapping"];
18054fc587aSNagaraju Goruganti     roleMapArray = nlohmann::json::array();
1819eb808c1SEd Tanous     for (const auto& obj : confData.groupRoleList)
18254fc587aSNagaraju Goruganti     {
18354fc587aSNagaraju Goruganti         BMCWEB_LOG_DEBUG << "Pushing the data groupName="
18454fc587aSNagaraju Goruganti                          << obj.second.groupName << "\n";
18554fc587aSNagaraju Goruganti         roleMapArray.push_back(
18654fc587aSNagaraju Goruganti             {nlohmann::json::array({"RemoteGroup", obj.second.groupName}),
18754fc587aSNagaraju Goruganti              nlohmann::json::array(
18854fc587aSNagaraju Goruganti                  {"LocalRole", getRoleIdFromPrivilege(obj.second.privilege)})});
18954fc587aSNagaraju Goruganti     }
1906973a582SRatan Gupta }
1916973a582SRatan Gupta 
1926973a582SRatan Gupta /**
19306785244SRatan Gupta  *  @brief validates given JSON input and then calls appropriate method to
19406785244SRatan Gupta  * create, to delete or to set Rolemapping object based on the given input.
19506785244SRatan Gupta  *
19606785244SRatan Gupta  */
19723a21a1cSEd Tanous inline void handleRoleMapPatch(
1988d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
19906785244SRatan Gupta     const std::vector<std::pair<std::string, LDAPRoleMapData>>& roleMapObjData,
200f23b7296SEd Tanous     const std::string& serverType, const std::vector<nlohmann::json>& input)
20106785244SRatan Gupta {
20206785244SRatan Gupta     for (size_t index = 0; index < input.size(); index++)
20306785244SRatan Gupta     {
204f23b7296SEd Tanous         const nlohmann::json& thisJson = input[index];
20506785244SRatan Gupta 
20606785244SRatan Gupta         if (thisJson.is_null())
20706785244SRatan Gupta         {
20806785244SRatan Gupta             // delete the existing object
20906785244SRatan Gupta             if (index < roleMapObjData.size())
21006785244SRatan Gupta             {
21106785244SRatan Gupta                 crow::connections::systemBus->async_method_call(
21206785244SRatan Gupta                     [asyncResp, roleMapObjData, serverType,
21306785244SRatan Gupta                      index](const boost::system::error_code ec) {
21406785244SRatan Gupta                         if (ec)
21506785244SRatan Gupta                         {
21606785244SRatan Gupta                             BMCWEB_LOG_ERROR << "DBUS response error: " << ec;
21706785244SRatan Gupta                             messages::internalError(asyncResp->res);
21806785244SRatan Gupta                             return;
21906785244SRatan Gupta                         }
22006785244SRatan Gupta                         asyncResp->res
22106785244SRatan Gupta                             .jsonValue[serverType]["RemoteRoleMapping"][index] =
22206785244SRatan Gupta                             nullptr;
22306785244SRatan Gupta                     },
22406785244SRatan Gupta                     ldapDbusService, roleMapObjData[index].first,
22506785244SRatan Gupta                     "xyz.openbmc_project.Object.Delete", "Delete");
22606785244SRatan Gupta             }
22706785244SRatan Gupta             else
22806785244SRatan Gupta             {
22906785244SRatan Gupta                 BMCWEB_LOG_ERROR << "Can't delete the object";
23006785244SRatan Gupta                 messages::propertyValueTypeError(
23171f52d96SEd Tanous                     asyncResp->res,
23271f52d96SEd Tanous                     thisJson.dump(2, ' ', true,
23371f52d96SEd Tanous                                   nlohmann::json::error_handler_t::replace),
23406785244SRatan Gupta                     "RemoteRoleMapping/" + std::to_string(index));
23506785244SRatan Gupta                 return;
23606785244SRatan Gupta             }
23706785244SRatan Gupta         }
23806785244SRatan Gupta         else if (thisJson.empty())
23906785244SRatan Gupta         {
24006785244SRatan Gupta             // Don't do anything for the empty objects,parse next json
24106785244SRatan Gupta             // eg {"RemoteRoleMapping",[{}]}
24206785244SRatan Gupta         }
24306785244SRatan Gupta         else
24406785244SRatan Gupta         {
24506785244SRatan Gupta             // update/create the object
24606785244SRatan Gupta             std::optional<std::string> remoteGroup;
24706785244SRatan Gupta             std::optional<std::string> localRole;
24806785244SRatan Gupta 
249f23b7296SEd Tanous             // This is a copy, but it's required in this case because of how
250f23b7296SEd Tanous             // readJson is structured
251f23b7296SEd Tanous             nlohmann::json thisJsonCopy = thisJson;
252f23b7296SEd Tanous             if (!json_util::readJson(thisJsonCopy, asyncResp->res,
253f23b7296SEd Tanous                                      "RemoteGroup", remoteGroup, "LocalRole",
254f23b7296SEd Tanous                                      localRole))
25506785244SRatan Gupta             {
25606785244SRatan Gupta                 continue;
25706785244SRatan Gupta             }
25806785244SRatan Gupta 
25906785244SRatan Gupta             // Update existing RoleMapping Object
26006785244SRatan Gupta             if (index < roleMapObjData.size())
26106785244SRatan Gupta             {
26206785244SRatan Gupta                 BMCWEB_LOG_DEBUG << "Update Role Map Object";
26306785244SRatan Gupta                 // If "RemoteGroup" info is provided
26406785244SRatan Gupta                 if (remoteGroup)
26506785244SRatan Gupta                 {
26606785244SRatan Gupta                     crow::connections::systemBus->async_method_call(
26706785244SRatan Gupta                         [asyncResp, roleMapObjData, serverType, index,
26806785244SRatan Gupta                          remoteGroup](const boost::system::error_code ec) {
26906785244SRatan Gupta                             if (ec)
27006785244SRatan Gupta                             {
27106785244SRatan Gupta                                 BMCWEB_LOG_ERROR << "DBUS response error: "
27206785244SRatan Gupta                                                  << ec;
27306785244SRatan Gupta                                 messages::internalError(asyncResp->res);
27406785244SRatan Gupta                                 return;
27506785244SRatan Gupta                             }
27606785244SRatan Gupta                             asyncResp->res
27706785244SRatan Gupta                                 .jsonValue[serverType]["RemoteRoleMapping"]
27806785244SRatan Gupta                                           [index]["RemoteGroup"] = *remoteGroup;
27906785244SRatan Gupta                         },
28006785244SRatan Gupta                         ldapDbusService, roleMapObjData[index].first,
28106785244SRatan Gupta                         propertyInterface, "Set",
28206785244SRatan Gupta                         "xyz.openbmc_project.User.PrivilegeMapperEntry",
28306785244SRatan Gupta                         "GroupName",
284168e20c1SEd Tanous                         dbus::utility::DbusVariantType(
285168e20c1SEd Tanous                             std::move(*remoteGroup)));
28606785244SRatan Gupta                 }
28706785244SRatan Gupta 
28806785244SRatan Gupta                 // If "LocalRole" info is provided
28906785244SRatan Gupta                 if (localRole)
29006785244SRatan Gupta                 {
29106785244SRatan Gupta                     crow::connections::systemBus->async_method_call(
29206785244SRatan Gupta                         [asyncResp, roleMapObjData, serverType, index,
29306785244SRatan Gupta                          localRole](const boost::system::error_code ec) {
29406785244SRatan Gupta                             if (ec)
29506785244SRatan Gupta                             {
29606785244SRatan Gupta                                 BMCWEB_LOG_ERROR << "DBUS response error: "
29706785244SRatan Gupta                                                  << ec;
29806785244SRatan Gupta                                 messages::internalError(asyncResp->res);
29906785244SRatan Gupta                                 return;
30006785244SRatan Gupta                             }
30106785244SRatan Gupta                             asyncResp->res
30206785244SRatan Gupta                                 .jsonValue[serverType]["RemoteRoleMapping"]
30306785244SRatan Gupta                                           [index]["LocalRole"] = *localRole;
30406785244SRatan Gupta                         },
30506785244SRatan Gupta                         ldapDbusService, roleMapObjData[index].first,
30606785244SRatan Gupta                         propertyInterface, "Set",
30706785244SRatan Gupta                         "xyz.openbmc_project.User.PrivilegeMapperEntry",
30806785244SRatan Gupta                         "Privilege",
309168e20c1SEd Tanous                         dbus::utility::DbusVariantType(
31006785244SRatan Gupta                             getPrivilegeFromRoleId(std::move(*localRole))));
31106785244SRatan Gupta                 }
31206785244SRatan Gupta             }
31306785244SRatan Gupta             // Create a new RoleMapping Object.
31406785244SRatan Gupta             else
31506785244SRatan Gupta             {
31606785244SRatan Gupta                 BMCWEB_LOG_DEBUG
31706785244SRatan Gupta                     << "setRoleMappingProperties: Creating new Object";
31806785244SRatan Gupta                 std::string pathString =
31906785244SRatan Gupta                     "RemoteRoleMapping/" + std::to_string(index);
32006785244SRatan Gupta 
32106785244SRatan Gupta                 if (!localRole)
32206785244SRatan Gupta                 {
32306785244SRatan Gupta                     messages::propertyMissing(asyncResp->res,
32406785244SRatan Gupta                                               pathString + "/LocalRole");
32506785244SRatan Gupta                     continue;
32606785244SRatan Gupta                 }
32706785244SRatan Gupta                 if (!remoteGroup)
32806785244SRatan Gupta                 {
32906785244SRatan Gupta                     messages::propertyMissing(asyncResp->res,
33006785244SRatan Gupta                                               pathString + "/RemoteGroup");
33106785244SRatan Gupta                     continue;
33206785244SRatan Gupta                 }
33306785244SRatan Gupta 
33406785244SRatan Gupta                 std::string dbusObjectPath;
33506785244SRatan Gupta                 if (serverType == "ActiveDirectory")
33606785244SRatan Gupta                 {
3372c70f800SEd Tanous                     dbusObjectPath = adConfigObject;
33806785244SRatan Gupta                 }
33906785244SRatan Gupta                 else if (serverType == "LDAP")
34006785244SRatan Gupta                 {
34123a21a1cSEd Tanous                     dbusObjectPath = ldapConfigObjectName;
34206785244SRatan Gupta                 }
34306785244SRatan Gupta 
34406785244SRatan Gupta                 BMCWEB_LOG_DEBUG << "Remote Group=" << *remoteGroup
34506785244SRatan Gupta                                  << ",LocalRole=" << *localRole;
34606785244SRatan Gupta 
34706785244SRatan Gupta                 crow::connections::systemBus->async_method_call(
348271584abSEd Tanous                     [asyncResp, serverType, localRole,
34906785244SRatan Gupta                      remoteGroup](const boost::system::error_code ec) {
35006785244SRatan Gupta                         if (ec)
35106785244SRatan Gupta                         {
35206785244SRatan Gupta                             BMCWEB_LOG_ERROR << "DBUS response error: " << ec;
35306785244SRatan Gupta                             messages::internalError(asyncResp->res);
35406785244SRatan Gupta                             return;
35506785244SRatan Gupta                         }
35606785244SRatan Gupta                         nlohmann::json& remoteRoleJson =
35706785244SRatan Gupta                             asyncResp->res
35806785244SRatan Gupta                                 .jsonValue[serverType]["RemoteRoleMapping"];
35906785244SRatan Gupta                         remoteRoleJson.push_back(
36006785244SRatan Gupta                             {{"LocalRole", *localRole},
36106785244SRatan Gupta                              {"RemoteGroup", *remoteGroup}});
36206785244SRatan Gupta                     },
36306785244SRatan Gupta                     ldapDbusService, dbusObjectPath, ldapPrivMapperInterface,
3643174e4dfSEd Tanous                     "Create", *remoteGroup,
36506785244SRatan Gupta                     getPrivilegeFromRoleId(std::move(*localRole)));
36606785244SRatan Gupta             }
36706785244SRatan Gupta         }
36806785244SRatan Gupta     }
36906785244SRatan Gupta }
37006785244SRatan Gupta 
37106785244SRatan Gupta /**
3726973a582SRatan Gupta  * Function that retrieves all properties for LDAP config object
3736973a582SRatan Gupta  * into JSON
3746973a582SRatan Gupta  */
3756973a582SRatan Gupta template <typename CallbackFunc>
3766973a582SRatan Gupta inline void getLDAPConfigData(const std::string& ldapType,
3776973a582SRatan Gupta                               CallbackFunc&& callback)
3786973a582SRatan Gupta {
37954fc587aSNagaraju Goruganti 
38054fc587aSNagaraju Goruganti     const std::array<const char*, 2> interfaces = {ldapEnableInterface,
38154fc587aSNagaraju Goruganti                                                    ldapConfigInterface};
38254fc587aSNagaraju Goruganti 
38354fc587aSNagaraju Goruganti     crow::connections::systemBus->async_method_call(
38454fc587aSNagaraju Goruganti         [callback, ldapType](const boost::system::error_code ec,
385b9d36b47SEd Tanous                              const dbus::utility::MapperGetObject& resp) {
38654fc587aSNagaraju Goruganti             if (ec || resp.empty())
38754fc587aSNagaraju Goruganti             {
3880fda0f12SGeorge Liu                 BMCWEB_LOG_ERROR
3890fda0f12SGeorge Liu                     << "DBUS response error during getting of service name: "
39054fc587aSNagaraju Goruganti                     << ec;
39123a21a1cSEd Tanous                 LDAPConfigData empty{};
39223a21a1cSEd Tanous                 callback(false, empty, ldapType);
39354fc587aSNagaraju Goruganti                 return;
39454fc587aSNagaraju Goruganti             }
39554fc587aSNagaraju Goruganti             std::string service = resp.begin()->first;
39654fc587aSNagaraju Goruganti             crow::connections::systemBus->async_method_call(
397711ac7a9SEd Tanous                 [callback, ldapType](
398711ac7a9SEd Tanous                     const boost::system::error_code errorCode,
399711ac7a9SEd Tanous                     const dbus::utility::ManagedObjectType& ldapObjects) {
4006973a582SRatan Gupta                     LDAPConfigData confData{};
40181ce609eSEd Tanous                     if (errorCode)
4026973a582SRatan Gupta                     {
403ab828d7cSRatan Gupta                         callback(false, confData, ldapType);
40454fc587aSNagaraju Goruganti                         BMCWEB_LOG_ERROR << "D-Bus responses error: "
40581ce609eSEd Tanous                                          << errorCode;
4066973a582SRatan Gupta                         return;
4076973a582SRatan Gupta                     }
408ab828d7cSRatan Gupta 
409ab828d7cSRatan Gupta                     std::string ldapDbusType;
41054fc587aSNagaraju Goruganti                     std::string searchString;
41154fc587aSNagaraju Goruganti 
412ab828d7cSRatan Gupta                     if (ldapType == "LDAP")
413ab828d7cSRatan Gupta                     {
4140fda0f12SGeorge Liu                         ldapDbusType =
4150fda0f12SGeorge Liu                             "xyz.openbmc_project.User.Ldap.Config.Type.OpenLdap";
41654fc587aSNagaraju Goruganti                         searchString = "openldap";
417ab828d7cSRatan Gupta                     }
418ab828d7cSRatan Gupta                     else if (ldapType == "ActiveDirectory")
419ab828d7cSRatan Gupta                     {
42054fc587aSNagaraju Goruganti                         ldapDbusType =
4210fda0f12SGeorge Liu                             "xyz.openbmc_project.User.Ldap.Config.Type.ActiveDirectory";
42254fc587aSNagaraju Goruganti                         searchString = "active_directory";
423ab828d7cSRatan Gupta                     }
424ab828d7cSRatan Gupta                     else
425ab828d7cSRatan Gupta                     {
42654fc587aSNagaraju Goruganti                         BMCWEB_LOG_ERROR
42754fc587aSNagaraju Goruganti                             << "Can't get the DbusType for the given type="
428ab828d7cSRatan Gupta                             << ldapType;
429ab828d7cSRatan Gupta                         callback(false, confData, ldapType);
430ab828d7cSRatan Gupta                         return;
431ab828d7cSRatan Gupta                     }
432ab828d7cSRatan Gupta 
433ab828d7cSRatan Gupta                     std::string ldapEnableInterfaceStr = ldapEnableInterface;
434ab828d7cSRatan Gupta                     std::string ldapConfigInterfaceStr = ldapConfigInterface;
435ab828d7cSRatan Gupta 
4366973a582SRatan Gupta                     for (const auto& object : ldapObjects)
4376973a582SRatan Gupta                     {
43854fc587aSNagaraju Goruganti                         // let's find the object whose ldap type is equal to the
43954fc587aSNagaraju Goruganti                         // given type
44054fc587aSNagaraju Goruganti                         if (object.first.str.find(searchString) ==
44154fc587aSNagaraju Goruganti                             std::string::npos)
4426973a582SRatan Gupta                         {
443ab828d7cSRatan Gupta                             continue;
444ab828d7cSRatan Gupta                         }
445ab828d7cSRatan Gupta 
4466973a582SRatan Gupta                         for (const auto& interface : object.second)
4476973a582SRatan Gupta                         {
4486973a582SRatan Gupta                             if (interface.first == ldapEnableInterfaceStr)
4496973a582SRatan Gupta                             {
4506973a582SRatan Gupta                                 // rest of the properties are string.
4516973a582SRatan Gupta                                 for (const auto& property : interface.second)
4526973a582SRatan Gupta                                 {
4536973a582SRatan Gupta                                     if (property.first == "Enabled")
4546973a582SRatan Gupta                                     {
4556973a582SRatan Gupta                                         const bool* value =
4566973a582SRatan Gupta                                             std::get_if<bool>(&property.second);
4576973a582SRatan Gupta                                         if (value == nullptr)
4586973a582SRatan Gupta                                         {
4596973a582SRatan Gupta                                             continue;
4606973a582SRatan Gupta                                         }
4616973a582SRatan Gupta                                         confData.serviceEnabled = *value;
4626973a582SRatan Gupta                                         break;
4636973a582SRatan Gupta                                     }
4646973a582SRatan Gupta                                 }
4656973a582SRatan Gupta                             }
4666973a582SRatan Gupta                             else if (interface.first == ldapConfigInterfaceStr)
4676973a582SRatan Gupta                             {
4686973a582SRatan Gupta 
4696973a582SRatan Gupta                                 for (const auto& property : interface.second)
4706973a582SRatan Gupta                                 {
471271584abSEd Tanous                                     const std::string* strValue =
47254fc587aSNagaraju Goruganti                                         std::get_if<std::string>(
47354fc587aSNagaraju Goruganti                                             &property.second);
474271584abSEd Tanous                                     if (strValue == nullptr)
4756973a582SRatan Gupta                                     {
4766973a582SRatan Gupta                                         continue;
4776973a582SRatan Gupta                                     }
4786973a582SRatan Gupta                                     if (property.first == "LDAPServerURI")
4796973a582SRatan Gupta                                     {
480271584abSEd Tanous                                         confData.uri = *strValue;
4816973a582SRatan Gupta                                     }
4826973a582SRatan Gupta                                     else if (property.first == "LDAPBindDN")
4836973a582SRatan Gupta                                     {
484271584abSEd Tanous                                         confData.bindDN = *strValue;
4856973a582SRatan Gupta                                     }
4866973a582SRatan Gupta                                     else if (property.first == "LDAPBaseDN")
4876973a582SRatan Gupta                                     {
488271584abSEd Tanous                                         confData.baseDN = *strValue;
4896973a582SRatan Gupta                                     }
49054fc587aSNagaraju Goruganti                                     else if (property.first ==
49154fc587aSNagaraju Goruganti                                              "LDAPSearchScope")
4926973a582SRatan Gupta                                     {
493271584abSEd Tanous                                         confData.searchScope = *strValue;
4946973a582SRatan Gupta                                     }
49554fc587aSNagaraju Goruganti                                     else if (property.first ==
49654fc587aSNagaraju Goruganti                                              "GroupNameAttribute")
4976973a582SRatan Gupta                                     {
498271584abSEd Tanous                                         confData.groupAttribute = *strValue;
4996973a582SRatan Gupta                                     }
50054fc587aSNagaraju Goruganti                                     else if (property.first ==
50154fc587aSNagaraju Goruganti                                              "UserNameAttribute")
5026973a582SRatan Gupta                                     {
503271584abSEd Tanous                                         confData.userNameAttribute = *strValue;
5046973a582SRatan Gupta                                     }
50554fc587aSNagaraju Goruganti                                     else if (property.first == "LDAPType")
506ab828d7cSRatan Gupta                                     {
507271584abSEd Tanous                                         confData.serverType = *strValue;
50854fc587aSNagaraju Goruganti                                     }
50954fc587aSNagaraju Goruganti                                 }
51054fc587aSNagaraju Goruganti                             }
5110fda0f12SGeorge Liu                             else if (
5120fda0f12SGeorge Liu                                 interface.first ==
5130fda0f12SGeorge Liu                                 "xyz.openbmc_project.User.PrivilegeMapperEntry")
51454fc587aSNagaraju Goruganti                             {
51554fc587aSNagaraju Goruganti                                 LDAPRoleMapData roleMapData{};
51654fc587aSNagaraju Goruganti                                 for (const auto& property : interface.second)
51754fc587aSNagaraju Goruganti                                 {
518271584abSEd Tanous                                     const std::string* strValue =
51954fc587aSNagaraju Goruganti                                         std::get_if<std::string>(
52054fc587aSNagaraju Goruganti                                             &property.second);
52154fc587aSNagaraju Goruganti 
522271584abSEd Tanous                                     if (strValue == nullptr)
52354fc587aSNagaraju Goruganti                                     {
52454fc587aSNagaraju Goruganti                                         continue;
52554fc587aSNagaraju Goruganti                                     }
52654fc587aSNagaraju Goruganti 
52754fc587aSNagaraju Goruganti                                     if (property.first == "GroupName")
52854fc587aSNagaraju Goruganti                                     {
529271584abSEd Tanous                                         roleMapData.groupName = *strValue;
53054fc587aSNagaraju Goruganti                                     }
53154fc587aSNagaraju Goruganti                                     else if (property.first == "Privilege")
53254fc587aSNagaraju Goruganti                                     {
533271584abSEd Tanous                                         roleMapData.privilege = *strValue;
53454fc587aSNagaraju Goruganti                                     }
53554fc587aSNagaraju Goruganti                                 }
53654fc587aSNagaraju Goruganti 
5370f0353b6SEd Tanous                                 confData.groupRoleList.emplace_back(
5380f0353b6SEd Tanous                                     object.first.str, roleMapData);
53954fc587aSNagaraju Goruganti                             }
54054fc587aSNagaraju Goruganti                         }
54154fc587aSNagaraju Goruganti                     }
542ab828d7cSRatan Gupta                     callback(true, confData, ldapType);
54354fc587aSNagaraju Goruganti                 },
54454fc587aSNagaraju Goruganti                 service, ldapRootObject, dbusObjManagerIntf,
5456973a582SRatan Gupta                 "GetManagedObjects");
54654fc587aSNagaraju Goruganti         },
54754fc587aSNagaraju Goruganti         mapperBusName, mapperObjectPath, mapperIntf, "GetObject",
54823a21a1cSEd Tanous         ldapConfigObjectName, interfaces);
5496973a582SRatan Gupta }
5506973a582SRatan Gupta 
5518a07d286SRatan Gupta /**
5528a07d286SRatan Gupta  * @brief parses the authentication section under the LDAP
5538a07d286SRatan Gupta  * @param input JSON data
5548a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
5558a07d286SRatan Gupta  * @param userName  userName to be filled from the given JSON.
5568a07d286SRatan Gupta  * @param password  password to be filled from the given JSON.
5578a07d286SRatan Gupta  */
5584f48d5f6SEd Tanous inline void parseLDAPAuthenticationJson(
5596c51eab1SEd Tanous     nlohmann::json input, const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5606c51eab1SEd Tanous     std::optional<std::string>& username, std::optional<std::string>& password)
5618a07d286SRatan Gupta {
5628a07d286SRatan Gupta     std::optional<std::string> authType;
5638a07d286SRatan Gupta 
5648a07d286SRatan Gupta     if (!json_util::readJson(input, asyncResp->res, "AuthenticationType",
5658a07d286SRatan Gupta                              authType, "Username", username, "Password",
5668a07d286SRatan Gupta                              password))
5678a07d286SRatan Gupta     {
5688a07d286SRatan Gupta         return;
5698a07d286SRatan Gupta     }
5708a07d286SRatan Gupta     if (!authType)
5718a07d286SRatan Gupta     {
5728a07d286SRatan Gupta         return;
5738a07d286SRatan Gupta     }
5748a07d286SRatan Gupta     if (*authType != "UsernameAndPassword")
5758a07d286SRatan Gupta     {
5768a07d286SRatan Gupta         messages::propertyValueNotInList(asyncResp->res, *authType,
5778a07d286SRatan Gupta                                          "AuthenticationType");
5788a07d286SRatan Gupta         return;
5798a07d286SRatan Gupta     }
5808a07d286SRatan Gupta }
5818a07d286SRatan Gupta /**
5828a07d286SRatan Gupta  * @brief parses the LDAPService section under the LDAP
5838a07d286SRatan Gupta  * @param input JSON data
5848a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
5858a07d286SRatan Gupta  * @param baseDNList baseDN to be filled from the given JSON.
5868a07d286SRatan Gupta  * @param userNameAttribute  userName to be filled from the given JSON.
5878a07d286SRatan Gupta  * @param groupaAttribute  password to be filled from the given JSON.
5888a07d286SRatan Gupta  */
5898a07d286SRatan Gupta 
5904f48d5f6SEd Tanous inline void
5914f48d5f6SEd Tanous     parseLDAPServiceJson(nlohmann::json input,
5928d1b46d7Szhanghch05                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5938a07d286SRatan Gupta                          std::optional<std::vector<std::string>>& baseDNList,
5948a07d286SRatan Gupta                          std::optional<std::string>& userNameAttribute,
5958a07d286SRatan Gupta                          std::optional<std::string>& groupsAttribute)
5968a07d286SRatan Gupta {
5978a07d286SRatan Gupta     std::optional<nlohmann::json> searchSettings;
5988a07d286SRatan Gupta 
5998a07d286SRatan Gupta     if (!json_util::readJson(input, asyncResp->res, "SearchSettings",
6008a07d286SRatan Gupta                              searchSettings))
6018a07d286SRatan Gupta     {
6028a07d286SRatan Gupta         return;
6038a07d286SRatan Gupta     }
6048a07d286SRatan Gupta     if (!searchSettings)
6058a07d286SRatan Gupta     {
6068a07d286SRatan Gupta         return;
6078a07d286SRatan Gupta     }
6088a07d286SRatan Gupta     if (!json_util::readJson(*searchSettings, asyncResp->res,
6098a07d286SRatan Gupta                              "BaseDistinguishedNames", baseDNList,
6108a07d286SRatan Gupta                              "UsernameAttribute", userNameAttribute,
6118a07d286SRatan Gupta                              "GroupsAttribute", groupsAttribute))
6128a07d286SRatan Gupta     {
6138a07d286SRatan Gupta         return;
6148a07d286SRatan Gupta     }
6158a07d286SRatan Gupta }
6168a07d286SRatan Gupta /**
6178a07d286SRatan Gupta  * @brief updates the LDAP server address and updates the
6188a07d286SRatan Gupta           json response with the new value.
6198a07d286SRatan Gupta  * @param serviceAddressList address to be updated.
6208a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
6218a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
6228a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
6238a07d286SRatan Gupta  */
6248a07d286SRatan Gupta 
6254f48d5f6SEd Tanous inline void handleServiceAddressPatch(
6268a07d286SRatan Gupta     const std::vector<std::string>& serviceAddressList,
6278d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6288a07d286SRatan Gupta     const std::string& ldapServerElementName,
6298a07d286SRatan Gupta     const std::string& ldapConfigObject)
6308a07d286SRatan Gupta {
6318a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
6328a07d286SRatan Gupta         [asyncResp, ldapServerElementName,
6338a07d286SRatan Gupta          serviceAddressList](const boost::system::error_code ec) {
6348a07d286SRatan Gupta             if (ec)
6358a07d286SRatan Gupta             {
6368a07d286SRatan Gupta                 BMCWEB_LOG_DEBUG
637c61704abSGunnar Mills                     << "Error Occurred in updating the service address";
6388a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
6398a07d286SRatan Gupta                 return;
6408a07d286SRatan Gupta             }
6418a07d286SRatan Gupta             std::vector<std::string> modifiedserviceAddressList = {
6428a07d286SRatan Gupta                 serviceAddressList.front()};
6438a07d286SRatan Gupta             asyncResp->res
6448a07d286SRatan Gupta                 .jsonValue[ldapServerElementName]["ServiceAddresses"] =
6458a07d286SRatan Gupta                 modifiedserviceAddressList;
6468a07d286SRatan Gupta             if ((serviceAddressList).size() > 1)
6478a07d286SRatan Gupta             {
6488a07d286SRatan Gupta                 messages::propertyValueModified(asyncResp->res,
6498a07d286SRatan Gupta                                                 "ServiceAddresses",
6508a07d286SRatan Gupta                                                 serviceAddressList.front());
6518a07d286SRatan Gupta             }
6528a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the service address";
6538a07d286SRatan Gupta         },
6548a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
6558a07d286SRatan Gupta         ldapConfigInterface, "LDAPServerURI",
656168e20c1SEd Tanous         dbus::utility::DbusVariantType(serviceAddressList.front()));
6578a07d286SRatan Gupta }
6588a07d286SRatan Gupta /**
6598a07d286SRatan Gupta  * @brief updates the LDAP Bind DN and updates the
6608a07d286SRatan Gupta           json response with the new value.
6618a07d286SRatan Gupta  * @param username name of the user which needs to be updated.
6628a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
6638a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
6648a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
6658a07d286SRatan Gupta  */
6668a07d286SRatan Gupta 
6674f48d5f6SEd Tanous inline void
6684f48d5f6SEd Tanous     handleUserNamePatch(const std::string& username,
6698d1b46d7Szhanghch05                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6708a07d286SRatan Gupta                         const std::string& ldapServerElementName,
6718a07d286SRatan Gupta                         const std::string& ldapConfigObject)
6728a07d286SRatan Gupta {
6738a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
6748a07d286SRatan Gupta         [asyncResp, username,
6758a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
6768a07d286SRatan Gupta             if (ec)
6778a07d286SRatan Gupta             {
6786c51eab1SEd Tanous                 BMCWEB_LOG_DEBUG << "Error occurred in updating the username";
6798a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
6808a07d286SRatan Gupta                 return;
6818a07d286SRatan Gupta             }
6826c51eab1SEd Tanous             asyncResp->res.jsonValue[ldapServerElementName]["Authentication"]
6836c51eab1SEd Tanous                                     ["Username"] = username;
6848a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the username";
6858a07d286SRatan Gupta         },
6868a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
687168e20c1SEd Tanous         ldapConfigInterface, "LDAPBindDN",
688168e20c1SEd Tanous         dbus::utility::DbusVariantType(username));
6898a07d286SRatan Gupta }
6908a07d286SRatan Gupta 
6918a07d286SRatan Gupta /**
6928a07d286SRatan Gupta  * @brief updates the LDAP password
6938a07d286SRatan Gupta  * @param password : ldap password which needs to be updated.
6948a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
6958a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
6968a07d286SRatan Gupta  *        server(openLDAP/ActiveDirectory)
6978a07d286SRatan Gupta  */
6988a07d286SRatan Gupta 
6994f48d5f6SEd Tanous inline void
7004f48d5f6SEd Tanous     handlePasswordPatch(const std::string& password,
7018d1b46d7Szhanghch05                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7028a07d286SRatan Gupta                         const std::string& ldapServerElementName,
7038a07d286SRatan Gupta                         const std::string& ldapConfigObject)
7048a07d286SRatan Gupta {
7058a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
7068a07d286SRatan Gupta         [asyncResp, password,
7078a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
7088a07d286SRatan Gupta             if (ec)
7098a07d286SRatan Gupta             {
7106c51eab1SEd Tanous                 BMCWEB_LOG_DEBUG << "Error occurred in updating the password";
7118a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
7128a07d286SRatan Gupta                 return;
7138a07d286SRatan Gupta             }
7146c51eab1SEd Tanous             asyncResp->res.jsonValue[ldapServerElementName]["Authentication"]
7156c51eab1SEd Tanous                                     ["Password"] = "";
7168a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the password";
7178a07d286SRatan Gupta         },
7188a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
7198a07d286SRatan Gupta         ldapConfigInterface, "LDAPBindDNPassword",
720168e20c1SEd Tanous         dbus::utility::DbusVariantType(password));
7218a07d286SRatan Gupta }
7228a07d286SRatan Gupta 
7238a07d286SRatan Gupta /**
7248a07d286SRatan Gupta  * @brief updates the LDAP BaseDN and updates the
7258a07d286SRatan Gupta           json response with the new value.
7268a07d286SRatan Gupta  * @param baseDNList baseDN list which needs to be updated.
7278a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
7288a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
7298a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
7308a07d286SRatan Gupta  */
7318a07d286SRatan Gupta 
7324f48d5f6SEd Tanous inline void
7334f48d5f6SEd Tanous     handleBaseDNPatch(const std::vector<std::string>& baseDNList,
7348d1b46d7Szhanghch05                       const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7358a07d286SRatan Gupta                       const std::string& ldapServerElementName,
7368a07d286SRatan Gupta                       const std::string& ldapConfigObject)
7378a07d286SRatan Gupta {
7388a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
7398a07d286SRatan Gupta         [asyncResp, baseDNList,
7408a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
7418a07d286SRatan Gupta             if (ec)
7428a07d286SRatan Gupta             {
7436c51eab1SEd Tanous                 BMCWEB_LOG_DEBUG << "Error Occurred in Updating the base DN";
7448a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
7458a07d286SRatan Gupta                 return;
7468a07d286SRatan Gupta             }
7478a07d286SRatan Gupta             auto& serverTypeJson =
7488a07d286SRatan Gupta                 asyncResp->res.jsonValue[ldapServerElementName];
7498a07d286SRatan Gupta             auto& searchSettingsJson =
7508a07d286SRatan Gupta                 serverTypeJson["LDAPService"]["SearchSettings"];
7516c51eab1SEd Tanous             std::vector<std::string> modifiedBaseDNList = {baseDNList.front()};
7526c51eab1SEd Tanous             searchSettingsJson["BaseDistinguishedNames"] = modifiedBaseDNList;
7538a07d286SRatan Gupta             if (baseDNList.size() > 1)
7548a07d286SRatan Gupta             {
7558a07d286SRatan Gupta                 messages::propertyValueModified(asyncResp->res,
7568a07d286SRatan Gupta                                                 "BaseDistinguishedNames",
7578a07d286SRatan Gupta                                                 baseDNList.front());
7588a07d286SRatan Gupta             }
7598a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the base DN";
7608a07d286SRatan Gupta         },
7618a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
7628a07d286SRatan Gupta         ldapConfigInterface, "LDAPBaseDN",
763168e20c1SEd Tanous         dbus::utility::DbusVariantType(baseDNList.front()));
7648a07d286SRatan Gupta }
7658a07d286SRatan Gupta /**
7668a07d286SRatan Gupta  * @brief updates the LDAP user name attribute and updates the
7678a07d286SRatan Gupta           json response with the new value.
7688a07d286SRatan Gupta  * @param userNameAttribute attribute to be updated.
7698a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
7708a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
7718a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
7728a07d286SRatan Gupta  */
7738a07d286SRatan Gupta 
7744f48d5f6SEd Tanous inline void
7754f48d5f6SEd Tanous     handleUserNameAttrPatch(const std::string& userNameAttribute,
7768d1b46d7Szhanghch05                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7778a07d286SRatan Gupta                             const std::string& ldapServerElementName,
7788a07d286SRatan Gupta                             const std::string& ldapConfigObject)
7798a07d286SRatan Gupta {
7808a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
7818a07d286SRatan Gupta         [asyncResp, userNameAttribute,
7828a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
7838a07d286SRatan Gupta             if (ec)
7848a07d286SRatan Gupta             {
785c61704abSGunnar Mills                 BMCWEB_LOG_DEBUG << "Error Occurred in Updating the "
7868a07d286SRatan Gupta                                     "username attribute";
7878a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
7888a07d286SRatan Gupta                 return;
7898a07d286SRatan Gupta             }
7908a07d286SRatan Gupta             auto& serverTypeJson =
7918a07d286SRatan Gupta                 asyncResp->res.jsonValue[ldapServerElementName];
7928a07d286SRatan Gupta             auto& searchSettingsJson =
7938a07d286SRatan Gupta                 serverTypeJson["LDAPService"]["SearchSettings"];
7948a07d286SRatan Gupta             searchSettingsJson["UsernameAttribute"] = userNameAttribute;
7958a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the user name attr.";
7968a07d286SRatan Gupta         },
7978a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
7988a07d286SRatan Gupta         ldapConfigInterface, "UserNameAttribute",
799168e20c1SEd Tanous         dbus::utility::DbusVariantType(userNameAttribute));
8008a07d286SRatan Gupta }
8018a07d286SRatan Gupta /**
8028a07d286SRatan Gupta  * @brief updates the LDAP group attribute and updates the
8038a07d286SRatan Gupta           json response with the new value.
8048a07d286SRatan Gupta  * @param groupsAttribute attribute to be updated.
8058a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
8068a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
8078a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
8088a07d286SRatan Gupta  */
8098a07d286SRatan Gupta 
8104f48d5f6SEd Tanous inline void handleGroupNameAttrPatch(
8118d1b46d7Szhanghch05     const std::string& groupsAttribute,
8128d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8138a07d286SRatan Gupta     const std::string& ldapServerElementName,
8148a07d286SRatan Gupta     const std::string& ldapConfigObject)
8158a07d286SRatan Gupta {
8168a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
8178a07d286SRatan Gupta         [asyncResp, groupsAttribute,
8188a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
8198a07d286SRatan Gupta             if (ec)
8208a07d286SRatan Gupta             {
821c61704abSGunnar Mills                 BMCWEB_LOG_DEBUG << "Error Occurred in Updating the "
8228a07d286SRatan Gupta                                     "groupname attribute";
8238a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
8248a07d286SRatan Gupta                 return;
8258a07d286SRatan Gupta             }
8268a07d286SRatan Gupta             auto& serverTypeJson =
8278a07d286SRatan Gupta                 asyncResp->res.jsonValue[ldapServerElementName];
8288a07d286SRatan Gupta             auto& searchSettingsJson =
8298a07d286SRatan Gupta                 serverTypeJson["LDAPService"]["SearchSettings"];
8308a07d286SRatan Gupta             searchSettingsJson["GroupsAttribute"] = groupsAttribute;
8318a07d286SRatan Gupta             BMCWEB_LOG_DEBUG << "Updated the groupname attr";
8328a07d286SRatan Gupta         },
8338a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
8348a07d286SRatan Gupta         ldapConfigInterface, "GroupNameAttribute",
835168e20c1SEd Tanous         dbus::utility::DbusVariantType(groupsAttribute));
8368a07d286SRatan Gupta }
8378a07d286SRatan Gupta /**
8388a07d286SRatan Gupta  * @brief updates the LDAP service enable and updates the
8398a07d286SRatan Gupta           json response with the new value.
8408a07d286SRatan Gupta  * @param input JSON data.
8418a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
8428a07d286SRatan Gupta  * @param ldapServerElementName Type of LDAP
8438a07d286SRatan Gupta  server(openLDAP/ActiveDirectory)
8448a07d286SRatan Gupta  */
8458a07d286SRatan Gupta 
8464f48d5f6SEd Tanous inline void handleServiceEnablePatch(
8476c51eab1SEd Tanous     bool serviceEnabled, const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8488a07d286SRatan Gupta     const std::string& ldapServerElementName,
8498a07d286SRatan Gupta     const std::string& ldapConfigObject)
8508a07d286SRatan Gupta {
8518a07d286SRatan Gupta     crow::connections::systemBus->async_method_call(
8528a07d286SRatan Gupta         [asyncResp, serviceEnabled,
8538a07d286SRatan Gupta          ldapServerElementName](const boost::system::error_code ec) {
8548a07d286SRatan Gupta             if (ec)
8558a07d286SRatan Gupta             {
8568a07d286SRatan Gupta                 BMCWEB_LOG_DEBUG
857c61704abSGunnar Mills                     << "Error Occurred in Updating the service enable";
8588a07d286SRatan Gupta                 messages::internalError(asyncResp->res);
8598a07d286SRatan Gupta                 return;
8608a07d286SRatan Gupta             }
8616c51eab1SEd Tanous             asyncResp->res.jsonValue[ldapServerElementName]["ServiceEnabled"] =
8628a07d286SRatan Gupta                 serviceEnabled;
8636c51eab1SEd Tanous             BMCWEB_LOG_DEBUG << "Updated Service enable = " << serviceEnabled;
8648a07d286SRatan Gupta         },
8658a07d286SRatan Gupta         ldapDbusService, ldapConfigObject, propertyInterface, "Set",
866168e20c1SEd Tanous         ldapEnableInterface, "Enabled",
867168e20c1SEd Tanous         dbus::utility::DbusVariantType(serviceEnabled));
8688a07d286SRatan Gupta }
8698a07d286SRatan Gupta 
8704f48d5f6SEd Tanous inline void
8714f48d5f6SEd Tanous     handleAuthMethodsPatch(nlohmann::json& input,
8728d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
87378158631SZbigniew Kurzynski {
87478158631SZbigniew Kurzynski     std::optional<bool> basicAuth;
87578158631SZbigniew Kurzynski     std::optional<bool> cookie;
87678158631SZbigniew Kurzynski     std::optional<bool> sessionToken;
87778158631SZbigniew Kurzynski     std::optional<bool> xToken;
878501f1e58SZbigniew Kurzynski     std::optional<bool> tls;
87978158631SZbigniew Kurzynski 
88078158631SZbigniew Kurzynski     if (!json_util::readJson(input, asyncResp->res, "BasicAuth", basicAuth,
88178158631SZbigniew Kurzynski                              "Cookie", cookie, "SessionToken", sessionToken,
882501f1e58SZbigniew Kurzynski                              "XToken", xToken, "TLS", tls))
88378158631SZbigniew Kurzynski     {
88478158631SZbigniew Kurzynski         BMCWEB_LOG_ERROR << "Cannot read values from AuthMethod tag";
88578158631SZbigniew Kurzynski         return;
88678158631SZbigniew Kurzynski     }
88778158631SZbigniew Kurzynski 
88878158631SZbigniew Kurzynski     // Make a copy of methods configuration
88952cc112dSEd Tanous     persistent_data::AuthConfigMethods authMethodsConfig =
89052cc112dSEd Tanous         persistent_data::SessionStore::getInstance().getAuthMethodsConfig();
89178158631SZbigniew Kurzynski 
89278158631SZbigniew Kurzynski     if (basicAuth)
89378158631SZbigniew Kurzynski     {
894f16f6263SAlan Kuo #ifndef BMCWEB_ENABLE_BASIC_AUTHENTICATION
895f16f6263SAlan Kuo         messages::actionNotSupported(
8960fda0f12SGeorge Liu             asyncResp->res,
8970fda0f12SGeorge Liu             "Setting BasicAuth when basic-auth feature is disabled");
898f16f6263SAlan Kuo         return;
899f16f6263SAlan Kuo #endif
90078158631SZbigniew Kurzynski         authMethodsConfig.basic = *basicAuth;
90178158631SZbigniew Kurzynski     }
90278158631SZbigniew Kurzynski 
90378158631SZbigniew Kurzynski     if (cookie)
90478158631SZbigniew Kurzynski     {
905f16f6263SAlan Kuo #ifndef BMCWEB_ENABLE_COOKIE_AUTHENTICATION
9060fda0f12SGeorge Liu         messages::actionNotSupported(
9070fda0f12SGeorge Liu             asyncResp->res,
9080fda0f12SGeorge Liu             "Setting Cookie when cookie-auth feature is disabled");
909f16f6263SAlan Kuo         return;
910f16f6263SAlan Kuo #endif
91178158631SZbigniew Kurzynski         authMethodsConfig.cookie = *cookie;
91278158631SZbigniew Kurzynski     }
91378158631SZbigniew Kurzynski 
91478158631SZbigniew Kurzynski     if (sessionToken)
91578158631SZbigniew Kurzynski     {
916f16f6263SAlan Kuo #ifndef BMCWEB_ENABLE_SESSION_AUTHENTICATION
917f16f6263SAlan Kuo         messages::actionNotSupported(
9180fda0f12SGeorge Liu             asyncResp->res,
9190fda0f12SGeorge Liu             "Setting SessionToken when session-auth feature is disabled");
920f16f6263SAlan Kuo         return;
921f16f6263SAlan Kuo #endif
92278158631SZbigniew Kurzynski         authMethodsConfig.sessionToken = *sessionToken;
92378158631SZbigniew Kurzynski     }
92478158631SZbigniew Kurzynski 
92578158631SZbigniew Kurzynski     if (xToken)
92678158631SZbigniew Kurzynski     {
927f16f6263SAlan Kuo #ifndef BMCWEB_ENABLE_XTOKEN_AUTHENTICATION
9280fda0f12SGeorge Liu         messages::actionNotSupported(
9290fda0f12SGeorge Liu             asyncResp->res,
9300fda0f12SGeorge Liu             "Setting XToken when xtoken-auth feature is disabled");
931f16f6263SAlan Kuo         return;
932f16f6263SAlan Kuo #endif
93378158631SZbigniew Kurzynski         authMethodsConfig.xtoken = *xToken;
93478158631SZbigniew Kurzynski     }
93578158631SZbigniew Kurzynski 
936501f1e58SZbigniew Kurzynski     if (tls)
937501f1e58SZbigniew Kurzynski     {
938f16f6263SAlan Kuo #ifndef BMCWEB_ENABLE_MUTUAL_TLS_AUTHENTICATION
9390fda0f12SGeorge Liu         messages::actionNotSupported(
9400fda0f12SGeorge Liu             asyncResp->res,
9410fda0f12SGeorge Liu             "Setting TLS when mutual-tls-auth feature is disabled");
942f16f6263SAlan Kuo         return;
943f16f6263SAlan Kuo #endif
944501f1e58SZbigniew Kurzynski         authMethodsConfig.tls = *tls;
945501f1e58SZbigniew Kurzynski     }
946501f1e58SZbigniew Kurzynski 
94778158631SZbigniew Kurzynski     if (!authMethodsConfig.basic && !authMethodsConfig.cookie &&
948501f1e58SZbigniew Kurzynski         !authMethodsConfig.sessionToken && !authMethodsConfig.xtoken &&
949501f1e58SZbigniew Kurzynski         !authMethodsConfig.tls)
95078158631SZbigniew Kurzynski     {
95178158631SZbigniew Kurzynski         // Do not allow user to disable everything
95278158631SZbigniew Kurzynski         messages::actionNotSupported(asyncResp->res,
95378158631SZbigniew Kurzynski                                      "of disabling all available methods");
95478158631SZbigniew Kurzynski         return;
95578158631SZbigniew Kurzynski     }
95678158631SZbigniew Kurzynski 
95752cc112dSEd Tanous     persistent_data::SessionStore::getInstance().updateAuthMethodsConfig(
95852cc112dSEd Tanous         authMethodsConfig);
95978158631SZbigniew Kurzynski     // Save configuration immediately
96052cc112dSEd Tanous     persistent_data::getConfig().writeData();
96178158631SZbigniew Kurzynski 
96278158631SZbigniew Kurzynski     messages::success(asyncResp->res);
96378158631SZbigniew Kurzynski }
96478158631SZbigniew Kurzynski 
9658a07d286SRatan Gupta /**
9668a07d286SRatan Gupta  * @brief Get the required values from the given JSON, validates the
9678a07d286SRatan Gupta  *        value and create the LDAP config object.
9688a07d286SRatan Gupta  * @param input JSON data
9698a07d286SRatan Gupta  * @param asyncResp pointer to the JSON response
9708a07d286SRatan Gupta  * @param serverType Type of LDAP server(openLDAP/ActiveDirectory)
9718a07d286SRatan Gupta  */
9728a07d286SRatan Gupta 
9736c51eab1SEd Tanous inline void handleLDAPPatch(nlohmann::json& input,
9748d1b46d7Szhanghch05                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
9758a07d286SRatan Gupta                             const std::string& serverType)
9768a07d286SRatan Gupta {
977eb2bbe56SRatan Gupta     std::string dbusObjectPath;
978eb2bbe56SRatan Gupta     if (serverType == "ActiveDirectory")
979eb2bbe56SRatan Gupta     {
9802c70f800SEd Tanous         dbusObjectPath = adConfigObject;
981eb2bbe56SRatan Gupta     }
982eb2bbe56SRatan Gupta     else if (serverType == "LDAP")
983eb2bbe56SRatan Gupta     {
98423a21a1cSEd Tanous         dbusObjectPath = ldapConfigObjectName;
985eb2bbe56SRatan Gupta     }
986cb13a392SEd Tanous     else
987cb13a392SEd Tanous     {
988cb13a392SEd Tanous         return;
989cb13a392SEd Tanous     }
990eb2bbe56SRatan Gupta 
9918a07d286SRatan Gupta     std::optional<nlohmann::json> authentication;
9928a07d286SRatan Gupta     std::optional<nlohmann::json> ldapService;
9938a07d286SRatan Gupta     std::optional<std::vector<std::string>> serviceAddressList;
9948a07d286SRatan Gupta     std::optional<bool> serviceEnabled;
9958a07d286SRatan Gupta     std::optional<std::vector<std::string>> baseDNList;
9968a07d286SRatan Gupta     std::optional<std::string> userNameAttribute;
9978a07d286SRatan Gupta     std::optional<std::string> groupsAttribute;
9988a07d286SRatan Gupta     std::optional<std::string> userName;
9998a07d286SRatan Gupta     std::optional<std::string> password;
100006785244SRatan Gupta     std::optional<std::vector<nlohmann::json>> remoteRoleMapData;
10018a07d286SRatan Gupta 
10028a07d286SRatan Gupta     if (!json_util::readJson(input, asyncResp->res, "Authentication",
10038a07d286SRatan Gupta                              authentication, "LDAPService", ldapService,
10048a07d286SRatan Gupta                              "ServiceAddresses", serviceAddressList,
100506785244SRatan Gupta                              "ServiceEnabled", serviceEnabled,
100606785244SRatan Gupta                              "RemoteRoleMapping", remoteRoleMapData))
10078a07d286SRatan Gupta     {
10088a07d286SRatan Gupta         return;
10098a07d286SRatan Gupta     }
10108a07d286SRatan Gupta 
10118a07d286SRatan Gupta     if (authentication)
10128a07d286SRatan Gupta     {
10138a07d286SRatan Gupta         parseLDAPAuthenticationJson(*authentication, asyncResp, userName,
10148a07d286SRatan Gupta                                     password);
10158a07d286SRatan Gupta     }
10168a07d286SRatan Gupta     if (ldapService)
10178a07d286SRatan Gupta     {
10188a07d286SRatan Gupta         parseLDAPServiceJson(*ldapService, asyncResp, baseDNList,
10198a07d286SRatan Gupta                              userNameAttribute, groupsAttribute);
10208a07d286SRatan Gupta     }
10218a07d286SRatan Gupta     if (serviceAddressList)
10228a07d286SRatan Gupta     {
102326f6976fSEd Tanous         if (serviceAddressList->empty())
10248a07d286SRatan Gupta         {
10258a07d286SRatan Gupta             messages::propertyValueNotInList(asyncResp->res, "[]",
10268a07d286SRatan Gupta                                              "ServiceAddress");
10278a07d286SRatan Gupta             return;
10288a07d286SRatan Gupta         }
10298a07d286SRatan Gupta     }
10308a07d286SRatan Gupta     if (baseDNList)
10318a07d286SRatan Gupta     {
103226f6976fSEd Tanous         if (baseDNList->empty())
10338a07d286SRatan Gupta         {
10348a07d286SRatan Gupta             messages::propertyValueNotInList(asyncResp->res, "[]",
10358a07d286SRatan Gupta                                              "BaseDistinguishedNames");
10368a07d286SRatan Gupta             return;
10378a07d286SRatan Gupta         }
10388a07d286SRatan Gupta     }
10398a07d286SRatan Gupta 
10408a07d286SRatan Gupta     // nothing to update, then return
10418a07d286SRatan Gupta     if (!userName && !password && !serviceAddressList && !baseDNList &&
104206785244SRatan Gupta         !userNameAttribute && !groupsAttribute && !serviceEnabled &&
104306785244SRatan Gupta         !remoteRoleMapData)
10448a07d286SRatan Gupta     {
10458a07d286SRatan Gupta         return;
10468a07d286SRatan Gupta     }
10478a07d286SRatan Gupta 
10488a07d286SRatan Gupta     // Get the existing resource first then keep modifying
10498a07d286SRatan Gupta     // whenever any property gets updated.
10506c51eab1SEd Tanous     getLDAPConfigData(serverType, [asyncResp, userName, password, baseDNList,
10516c51eab1SEd Tanous                                    userNameAttribute, groupsAttribute,
10526c51eab1SEd Tanous                                    serviceAddressList, serviceEnabled,
10536c51eab1SEd Tanous                                    dbusObjectPath, remoteRoleMapData](
10546c51eab1SEd Tanous                                       bool success,
10556c51eab1SEd Tanous                                       const LDAPConfigData& confData,
105623a21a1cSEd Tanous                                       const std::string& serverT) {
10578a07d286SRatan Gupta         if (!success)
10588a07d286SRatan Gupta         {
10598a07d286SRatan Gupta             messages::internalError(asyncResp->res);
10608a07d286SRatan Gupta             return;
10618a07d286SRatan Gupta         }
10626c51eab1SEd Tanous         parseLDAPConfigData(asyncResp->res.jsonValue, confData, serverT);
10638a07d286SRatan Gupta         if (confData.serviceEnabled)
10648a07d286SRatan Gupta         {
10658a07d286SRatan Gupta             // Disable the service first and update the rest of
10668a07d286SRatan Gupta             // the properties.
10676c51eab1SEd Tanous             handleServiceEnablePatch(false, asyncResp, serverT, dbusObjectPath);
10688a07d286SRatan Gupta         }
10698a07d286SRatan Gupta 
10708a07d286SRatan Gupta         if (serviceAddressList)
10718a07d286SRatan Gupta         {
10726c51eab1SEd Tanous             handleServiceAddressPatch(*serviceAddressList, asyncResp, serverT,
10736c51eab1SEd Tanous                                       dbusObjectPath);
10748a07d286SRatan Gupta         }
10758a07d286SRatan Gupta         if (userName)
10768a07d286SRatan Gupta         {
10776c51eab1SEd Tanous             handleUserNamePatch(*userName, asyncResp, serverT, dbusObjectPath);
10788a07d286SRatan Gupta         }
10798a07d286SRatan Gupta         if (password)
10808a07d286SRatan Gupta         {
10816c51eab1SEd Tanous             handlePasswordPatch(*password, asyncResp, serverT, dbusObjectPath);
10828a07d286SRatan Gupta         }
10838a07d286SRatan Gupta 
10848a07d286SRatan Gupta         if (baseDNList)
10858a07d286SRatan Gupta         {
10866c51eab1SEd Tanous             handleBaseDNPatch(*baseDNList, asyncResp, serverT, dbusObjectPath);
10878a07d286SRatan Gupta         }
10888a07d286SRatan Gupta         if (userNameAttribute)
10898a07d286SRatan Gupta         {
10906c51eab1SEd Tanous             handleUserNameAttrPatch(*userNameAttribute, asyncResp, serverT,
10916c51eab1SEd Tanous                                     dbusObjectPath);
10928a07d286SRatan Gupta         }
10938a07d286SRatan Gupta         if (groupsAttribute)
10948a07d286SRatan Gupta         {
10956c51eab1SEd Tanous             handleGroupNameAttrPatch(*groupsAttribute, asyncResp, serverT,
10966c51eab1SEd Tanous                                      dbusObjectPath);
10978a07d286SRatan Gupta         }
10988a07d286SRatan Gupta         if (serviceEnabled)
10998a07d286SRatan Gupta         {
11008a07d286SRatan Gupta             // if user has given the value as true then enable
11018a07d286SRatan Gupta             // the service. if user has given false then no-op
11028a07d286SRatan Gupta             // as service is already stopped.
11038a07d286SRatan Gupta             if (*serviceEnabled)
11048a07d286SRatan Gupta             {
11056c51eab1SEd Tanous                 handleServiceEnablePatch(*serviceEnabled, asyncResp, serverT,
11066c51eab1SEd Tanous                                          dbusObjectPath);
11078a07d286SRatan Gupta             }
11088a07d286SRatan Gupta         }
11098a07d286SRatan Gupta         else
11108a07d286SRatan Gupta         {
11118a07d286SRatan Gupta             // if user has not given the service enabled value
11128a07d286SRatan Gupta             // then revert it to the same state as it was
11138a07d286SRatan Gupta             // before.
11148a07d286SRatan Gupta             handleServiceEnablePatch(confData.serviceEnabled, asyncResp,
111523a21a1cSEd Tanous                                      serverT, dbusObjectPath);
11168a07d286SRatan Gupta         }
111706785244SRatan Gupta 
111806785244SRatan Gupta         if (remoteRoleMapData)
111906785244SRatan Gupta         {
11206c51eab1SEd Tanous             handleRoleMapPatch(asyncResp, confData.groupRoleList, serverT,
11216c51eab1SEd Tanous                                *remoteRoleMapData);
112206785244SRatan Gupta         }
11238a07d286SRatan Gupta     });
11248a07d286SRatan Gupta }
1125d4b5443fSEd Tanous 
11266c51eab1SEd Tanous inline void updateUserProperties(std::shared_ptr<bmcweb::AsyncResp> asyncResp,
11276c51eab1SEd Tanous                                  const std::string& username,
11286c51eab1SEd Tanous                                  std::optional<std::string> password,
11296c51eab1SEd Tanous                                  std::optional<bool> enabled,
11306c51eab1SEd Tanous                                  std::optional<std::string> roleId,
11316c51eab1SEd Tanous                                  std::optional<bool> locked)
11321abe55efSEd Tanous {
1133b477fd44SP Dheeraj Srujan Kumar     sdbusplus::message::object_path tempObjPath(rootUserDbusPath);
1134b477fd44SP Dheeraj Srujan Kumar     tempObjPath /= username;
1135b477fd44SP Dheeraj Srujan Kumar     std::string dbusObjectPath(tempObjPath);
11366c51eab1SEd Tanous 
11376c51eab1SEd Tanous     dbus::utility::checkDbusPathExists(
11386c51eab1SEd Tanous         dbusObjectPath,
11391106333aSEd Tanous         [dbusObjectPath, username, password(std::move(password)),
11401106333aSEd Tanous          roleId(std::move(roleId)), enabled, locked,
11411106333aSEd Tanous          asyncResp{std::move(asyncResp)}](int rc) {
1142e662eae8SEd Tanous             if (rc <= 0)
11436c51eab1SEd Tanous             {
11446c51eab1SEd Tanous                 messages::resourceNotFound(
11456c51eab1SEd Tanous                     asyncResp->res, "#ManagerAccount.v1_4_0.ManagerAccount",
11466c51eab1SEd Tanous                     username);
11476c51eab1SEd Tanous                 return;
11486c51eab1SEd Tanous             }
11496c51eab1SEd Tanous 
11506c51eab1SEd Tanous             if (password)
11516c51eab1SEd Tanous             {
11526c51eab1SEd Tanous                 int retval = pamUpdatePassword(username, *password);
11536c51eab1SEd Tanous 
11546c51eab1SEd Tanous                 if (retval == PAM_USER_UNKNOWN)
11556c51eab1SEd Tanous                 {
11566c51eab1SEd Tanous                     messages::resourceNotFound(
11576c51eab1SEd Tanous                         asyncResp->res, "#ManagerAccount.v1_4_0.ManagerAccount",
11586c51eab1SEd Tanous                         username);
11596c51eab1SEd Tanous                 }
11606c51eab1SEd Tanous                 else if (retval == PAM_AUTHTOK_ERR)
11616c51eab1SEd Tanous                 {
11626c51eab1SEd Tanous                     // If password is invalid
11636c51eab1SEd Tanous                     messages::propertyValueFormatError(asyncResp->res,
11646c51eab1SEd Tanous                                                        *password, "Password");
11656c51eab1SEd Tanous                     BMCWEB_LOG_ERROR << "pamUpdatePassword Failed";
11666c51eab1SEd Tanous                 }
11676c51eab1SEd Tanous                 else if (retval != PAM_SUCCESS)
11686c51eab1SEd Tanous                 {
11696c51eab1SEd Tanous                     messages::internalError(asyncResp->res);
11706c51eab1SEd Tanous                     return;
11716c51eab1SEd Tanous                 }
1172*e7b1b62bSEd Tanous                 else
1173*e7b1b62bSEd Tanous                 {
1174*e7b1b62bSEd Tanous                     messages::success(asyncResp->res);
1175*e7b1b62bSEd Tanous                 }
11766c51eab1SEd Tanous             }
11776c51eab1SEd Tanous 
11786c51eab1SEd Tanous             if (enabled)
11796c51eab1SEd Tanous             {
11806c51eab1SEd Tanous                 crow::connections::systemBus->async_method_call(
11816c51eab1SEd Tanous                     [asyncResp](const boost::system::error_code ec) {
11826c51eab1SEd Tanous                         if (ec)
11836c51eab1SEd Tanous                         {
11846c51eab1SEd Tanous                             BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
11856c51eab1SEd Tanous                             messages::internalError(asyncResp->res);
11866c51eab1SEd Tanous                             return;
11876c51eab1SEd Tanous                         }
11886c51eab1SEd Tanous                         messages::success(asyncResp->res);
11896c51eab1SEd Tanous                         return;
11906c51eab1SEd Tanous                     },
1191e05aec50SEd Tanous                     "xyz.openbmc_project.User.Manager", dbusObjectPath,
11926c51eab1SEd Tanous                     "org.freedesktop.DBus.Properties", "Set",
11936c51eab1SEd Tanous                     "xyz.openbmc_project.User.Attributes", "UserEnabled",
1194168e20c1SEd Tanous                     dbus::utility::DbusVariantType{*enabled});
11956c51eab1SEd Tanous             }
11966c51eab1SEd Tanous 
11976c51eab1SEd Tanous             if (roleId)
11986c51eab1SEd Tanous             {
11996c51eab1SEd Tanous                 std::string priv = getPrivilegeFromRoleId(*roleId);
12006c51eab1SEd Tanous                 if (priv.empty())
12016c51eab1SEd Tanous                 {
12026c51eab1SEd Tanous                     messages::propertyValueNotInList(asyncResp->res, *roleId,
12036c51eab1SEd Tanous                                                      "RoleId");
12046c51eab1SEd Tanous                     return;
12056c51eab1SEd Tanous                 }
12066c51eab1SEd Tanous                 if (priv == "priv-noaccess")
12076c51eab1SEd Tanous                 {
12086c51eab1SEd Tanous                     priv = "";
12096c51eab1SEd Tanous                 }
12106c51eab1SEd Tanous 
12116c51eab1SEd Tanous                 crow::connections::systemBus->async_method_call(
12126c51eab1SEd Tanous                     [asyncResp](const boost::system::error_code ec) {
12136c51eab1SEd Tanous                         if (ec)
12146c51eab1SEd Tanous                         {
12156c51eab1SEd Tanous                             BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
12166c51eab1SEd Tanous                             messages::internalError(asyncResp->res);
12176c51eab1SEd Tanous                             return;
12186c51eab1SEd Tanous                         }
12196c51eab1SEd Tanous                         messages::success(asyncResp->res);
12206c51eab1SEd Tanous                     },
1221e05aec50SEd Tanous                     "xyz.openbmc_project.User.Manager", dbusObjectPath,
12226c51eab1SEd Tanous                     "org.freedesktop.DBus.Properties", "Set",
12236c51eab1SEd Tanous                     "xyz.openbmc_project.User.Attributes", "UserPrivilege",
1224168e20c1SEd Tanous                     dbus::utility::DbusVariantType{priv});
12256c51eab1SEd Tanous             }
12266c51eab1SEd Tanous 
12276c51eab1SEd Tanous             if (locked)
12286c51eab1SEd Tanous             {
12296c51eab1SEd Tanous                 // admin can unlock the account which is locked by
12306c51eab1SEd Tanous                 // successive authentication failures but admin should
12316c51eab1SEd Tanous                 // not be allowed to lock an account.
12326c51eab1SEd Tanous                 if (*locked)
12336c51eab1SEd Tanous                 {
12346c51eab1SEd Tanous                     messages::propertyValueNotInList(asyncResp->res, "true",
12356c51eab1SEd Tanous                                                      "Locked");
12366c51eab1SEd Tanous                     return;
12376c51eab1SEd Tanous                 }
12386c51eab1SEd Tanous 
12396c51eab1SEd Tanous                 crow::connections::systemBus->async_method_call(
12406c51eab1SEd Tanous                     [asyncResp](const boost::system::error_code ec) {
12416c51eab1SEd Tanous                         if (ec)
12426c51eab1SEd Tanous                         {
12436c51eab1SEd Tanous                             BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
12446c51eab1SEd Tanous                             messages::internalError(asyncResp->res);
12456c51eab1SEd Tanous                             return;
12466c51eab1SEd Tanous                         }
12476c51eab1SEd Tanous                         messages::success(asyncResp->res);
12486c51eab1SEd Tanous                         return;
12496c51eab1SEd Tanous                     },
1250e05aec50SEd Tanous                     "xyz.openbmc_project.User.Manager", dbusObjectPath,
12516c51eab1SEd Tanous                     "org.freedesktop.DBus.Properties", "Set",
12526c51eab1SEd Tanous                     "xyz.openbmc_project.User.Attributes",
1253168e20c1SEd Tanous                     "UserLockedForFailedAttempt",
1254168e20c1SEd Tanous                     dbus::utility::DbusVariantType{*locked});
12556c51eab1SEd Tanous             }
12566c51eab1SEd Tanous         });
12576c51eab1SEd Tanous }
12586c51eab1SEd Tanous 
12596c51eab1SEd Tanous inline void requestAccountServiceRoutes(App& app)
12606c51eab1SEd Tanous {
12616c51eab1SEd Tanous 
12626c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/")
1263ed398213SEd Tanous         .privileges(redfish::privileges::getAccountService)
12646c51eab1SEd Tanous         .methods(
126572048780SAbhishek Patel             boost::beast::http::verb::get)([](const crow::Request& req,
12666c51eab1SEd Tanous                                               const std::shared_ptr<
12676c51eab1SEd Tanous                                                   bmcweb::AsyncResp>& asyncResp)
12686c51eab1SEd Tanous                                                -> void {
126952cc112dSEd Tanous             const persistent_data::AuthConfigMethods& authMethodsConfig =
12706c51eab1SEd Tanous                 persistent_data::SessionStore::getInstance()
12716c51eab1SEd Tanous                     .getAuthMethodsConfig();
127278158631SZbigniew Kurzynski 
12738d1b46d7Szhanghch05             asyncResp->res.jsonValue = {
12743d958bbcSAppaRao Puli                 {"@odata.id", "/redfish/v1/AccountService"},
12753d958bbcSAppaRao Puli                 {"@odata.type", "#AccountService."
1276ba9dd4a8SGunnar Mills                                 "v1_5_0.AccountService"},
12773d958bbcSAppaRao Puli                 {"Id", "AccountService"},
12783d958bbcSAppaRao Puli                 {"Name", "Account Service"},
12793d958bbcSAppaRao Puli                 {"Description", "Account Service"},
12803d958bbcSAppaRao Puli                 {"ServiceEnabled", true},
1281343ff2e1SAppaRao Puli                 {"MaxPasswordLength", 20},
12823d958bbcSAppaRao Puli                 {"Accounts",
12833d958bbcSAppaRao Puli                  {{"@odata.id", "/redfish/v1/AccountService/Accounts"}}},
128437cce918SMarri Devender Rao                 {"Roles", {{"@odata.id", "/redfish/v1/AccountService/Roles"}}},
128578158631SZbigniew Kurzynski                 {"Oem",
128678158631SZbigniew Kurzynski                  {{"OpenBMC",
128778158631SZbigniew Kurzynski                    {{"@odata.type", "#OemAccountService.v1_0_0.AccountService"},
1288d8e3c29aSEd Tanous                     {"@odata.id", "/redfish/v1/AccountService#/Oem/OpenBMC"},
128978158631SZbigniew Kurzynski                     {"AuthMethods",
129078158631SZbigniew Kurzynski                      {
129178158631SZbigniew Kurzynski                          {"BasicAuth", authMethodsConfig.basic},
129278158631SZbigniew Kurzynski                          {"SessionToken", authMethodsConfig.sessionToken},
129378158631SZbigniew Kurzynski                          {"XToken", authMethodsConfig.xtoken},
129478158631SZbigniew Kurzynski                          {"Cookie", authMethodsConfig.cookie},
1295501f1e58SZbigniew Kurzynski                          {"TLS", authMethodsConfig.tls},
129672048780SAbhishek Patel                      }}}}}}};
129772048780SAbhishek Patel             // /redfish/v1/AccountService/LDAP/Certificates is something only
129872048780SAbhishek Patel             // ConfigureManager can access then only display when the user has
129972048780SAbhishek Patel             // permissions ConfigureManager
130072048780SAbhishek Patel             Privileges effectiveUserPrivileges =
130172048780SAbhishek Patel                 redfish::getUserPrivileges(req.userRole);
130272048780SAbhishek Patel 
130372048780SAbhishek Patel             if (isOperationAllowedWithPrivileges({{"ConfigureManager"}},
130472048780SAbhishek Patel                                                  effectiveUserPrivileges))
130572048780SAbhishek Patel             {
130672048780SAbhishek Patel                 asyncResp->res.jsonValue["LDAP"] = {
130772048780SAbhishek Patel                     {"Certificates",
130837cce918SMarri Devender Rao                      {{"@odata.id",
130972048780SAbhishek Patel                        "/redfish/v1/AccountService/LDAP/Certificates"}}}};
131072048780SAbhishek Patel             }
13113d958bbcSAppaRao Puli             crow::connections::systemBus->async_method_call(
13123d958bbcSAppaRao Puli                 [asyncResp](
13133d958bbcSAppaRao Puli                     const boost::system::error_code ec,
1314b9d36b47SEd Tanous                     const dbus::utility::DBusPropertiesMap& propertiesList) {
13153d958bbcSAppaRao Puli                     if (ec)
13163d958bbcSAppaRao Puli                     {
13173d958bbcSAppaRao Puli                         messages::internalError(asyncResp->res);
13183d958bbcSAppaRao Puli                         return;
13193d958bbcSAppaRao Puli                     }
13203d958bbcSAppaRao Puli                     BMCWEB_LOG_DEBUG << "Got " << propertiesList.size()
13213d958bbcSAppaRao Puli                                      << "properties for AccountService";
13223d958bbcSAppaRao Puli                     for (const std::pair<std::string,
1323168e20c1SEd Tanous                                          dbus::utility::DbusVariantType>&
1324168e20c1SEd Tanous                              property : propertiesList)
13253d958bbcSAppaRao Puli                     {
13263d958bbcSAppaRao Puli                         if (property.first == "MinPasswordLength")
13273d958bbcSAppaRao Puli                         {
13283d958bbcSAppaRao Puli                             const uint8_t* value =
1329abf2add6SEd Tanous                                 std::get_if<uint8_t>(&property.second);
13303d958bbcSAppaRao Puli                             if (value != nullptr)
13313d958bbcSAppaRao Puli                             {
13323d958bbcSAppaRao Puli                                 asyncResp->res.jsonValue["MinPasswordLength"] =
13333d958bbcSAppaRao Puli                                     *value;
13343d958bbcSAppaRao Puli                             }
13353d958bbcSAppaRao Puli                         }
13363d958bbcSAppaRao Puli                         if (property.first == "AccountUnlockTimeout")
13373d958bbcSAppaRao Puli                         {
13383d958bbcSAppaRao Puli                             const uint32_t* value =
1339abf2add6SEd Tanous                                 std::get_if<uint32_t>(&property.second);
13403d958bbcSAppaRao Puli                             if (value != nullptr)
13413d958bbcSAppaRao Puli                             {
13426c51eab1SEd Tanous                                 asyncResp->res
13436c51eab1SEd Tanous                                     .jsonValue["AccountLockoutDuration"] =
13443d958bbcSAppaRao Puli                                     *value;
13453d958bbcSAppaRao Puli                             }
13463d958bbcSAppaRao Puli                         }
13473d958bbcSAppaRao Puli                         if (property.first == "MaxLoginAttemptBeforeLockout")
13483d958bbcSAppaRao Puli                         {
13493d958bbcSAppaRao Puli                             const uint16_t* value =
1350abf2add6SEd Tanous                                 std::get_if<uint16_t>(&property.second);
13513d958bbcSAppaRao Puli                             if (value != nullptr)
13523d958bbcSAppaRao Puli                             {
13533d958bbcSAppaRao Puli                                 asyncResp->res
13546c51eab1SEd Tanous                                     .jsonValue["AccountLockoutThreshold"] =
13556c51eab1SEd Tanous                                     *value;
13563d958bbcSAppaRao Puli                             }
13573d958bbcSAppaRao Puli                         }
13583d958bbcSAppaRao Puli                     }
13593d958bbcSAppaRao Puli                 },
13603d958bbcSAppaRao Puli                 "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user",
13613d958bbcSAppaRao Puli                 "org.freedesktop.DBus.Properties", "GetAll",
13623d958bbcSAppaRao Puli                 "xyz.openbmc_project.User.AccountPolicy");
13636973a582SRatan Gupta 
1364ab828d7cSRatan Gupta             auto callback = [asyncResp](bool success, LDAPConfigData& confData,
1365ab828d7cSRatan Gupta                                         const std::string& ldapType) {
1366cb13a392SEd Tanous                 if (!success)
1367cb13a392SEd Tanous                 {
1368cb13a392SEd Tanous                     return;
1369cb13a392SEd Tanous                 }
13706c51eab1SEd Tanous                 parseLDAPConfigData(asyncResp->res.jsonValue, confData,
13716c51eab1SEd Tanous                                     ldapType);
1372ab828d7cSRatan Gupta             };
1373ab828d7cSRatan Gupta 
1374ab828d7cSRatan Gupta             getLDAPConfigData("LDAP", callback);
1375ab828d7cSRatan Gupta             getLDAPConfigData("ActiveDirectory", callback);
13766c51eab1SEd Tanous         });
13776973a582SRatan Gupta 
1378f5ffd806SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/")
13791ec43ee3SGunnar Mills         .privileges(redfish::privileges::patchAccountService)
1380f5ffd806SEd Tanous         .methods(boost::beast::http::verb::patch)(
1381f5ffd806SEd Tanous             [](const crow::Request& req,
1382f5ffd806SEd Tanous                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) -> void {
1383f5ffd806SEd Tanous                 std::optional<uint32_t> unlockTimeout;
1384f5ffd806SEd Tanous                 std::optional<uint16_t> lockoutThreshold;
1385ef73ad0dSPaul Fertser                 std::optional<uint8_t> minPasswordLength;
1386f5ffd806SEd Tanous                 std::optional<uint16_t> maxPasswordLength;
1387f5ffd806SEd Tanous                 std::optional<nlohmann::json> ldapObject;
1388f5ffd806SEd Tanous                 std::optional<nlohmann::json> activeDirectoryObject;
1389f5ffd806SEd Tanous                 std::optional<nlohmann::json> oemObject;
1390f5ffd806SEd Tanous 
139115ed6780SWilly Tu                 if (!json_util::readJsonPatch(
1392f5ffd806SEd Tanous                         req, asyncResp->res, "AccountLockoutDuration",
1393f5ffd806SEd Tanous                         unlockTimeout, "AccountLockoutThreshold",
1394f5ffd806SEd Tanous                         lockoutThreshold, "MaxPasswordLength",
1395f5ffd806SEd Tanous                         maxPasswordLength, "MinPasswordLength",
1396f5ffd806SEd Tanous                         minPasswordLength, "LDAP", ldapObject,
1397f5ffd806SEd Tanous                         "ActiveDirectory", activeDirectoryObject, "Oem",
1398f5ffd806SEd Tanous                         oemObject))
1399f5ffd806SEd Tanous                 {
1400f5ffd806SEd Tanous                     return;
1401f5ffd806SEd Tanous                 }
1402f5ffd806SEd Tanous 
1403f5ffd806SEd Tanous                 if (minPasswordLength)
1404f5ffd806SEd Tanous                 {
1405ef73ad0dSPaul Fertser                     crow::connections::systemBus->async_method_call(
1406ef73ad0dSPaul Fertser                         [asyncResp](const boost::system::error_code ec) {
1407ef73ad0dSPaul Fertser                             if (ec)
1408ef73ad0dSPaul Fertser                             {
1409ef73ad0dSPaul Fertser                                 messages::internalError(asyncResp->res);
1410ef73ad0dSPaul Fertser                                 return;
1411ef73ad0dSPaul Fertser                             }
1412ef73ad0dSPaul Fertser                             messages::success(asyncResp->res);
1413ef73ad0dSPaul Fertser                         },
1414ef73ad0dSPaul Fertser                         "xyz.openbmc_project.User.Manager",
1415ef73ad0dSPaul Fertser                         "/xyz/openbmc_project/user",
1416ef73ad0dSPaul Fertser                         "org.freedesktop.DBus.Properties", "Set",
1417ef73ad0dSPaul Fertser                         "xyz.openbmc_project.User.AccountPolicy",
1418ef73ad0dSPaul Fertser                         "MinPasswordLength",
1419ef73ad0dSPaul Fertser                         dbus::utility::DbusVariantType(*minPasswordLength));
1420f5ffd806SEd Tanous                 }
1421f5ffd806SEd Tanous 
1422f5ffd806SEd Tanous                 if (maxPasswordLength)
1423f5ffd806SEd Tanous                 {
1424f5ffd806SEd Tanous                     messages::propertyNotWritable(asyncResp->res,
1425f5ffd806SEd Tanous                                                   "MaxPasswordLength");
1426f5ffd806SEd Tanous                 }
1427f5ffd806SEd Tanous 
1428f5ffd806SEd Tanous                 if (ldapObject)
1429f5ffd806SEd Tanous                 {
1430f5ffd806SEd Tanous                     handleLDAPPatch(*ldapObject, asyncResp, "LDAP");
1431f5ffd806SEd Tanous                 }
1432f5ffd806SEd Tanous 
1433f5ffd806SEd Tanous                 if (std::optional<nlohmann::json> oemOpenBMCObject;
1434f5ffd806SEd Tanous                     oemObject &&
1435f5ffd806SEd Tanous                     json_util::readJson(*oemObject, asyncResp->res, "OpenBMC",
1436f5ffd806SEd Tanous                                         oemOpenBMCObject))
1437f5ffd806SEd Tanous                 {
1438f5ffd806SEd Tanous                     if (std::optional<nlohmann::json> authMethodsObject;
1439f5ffd806SEd Tanous                         oemOpenBMCObject &&
1440f5ffd806SEd Tanous                         json_util::readJson(*oemOpenBMCObject, asyncResp->res,
1441f5ffd806SEd Tanous                                             "AuthMethods", authMethodsObject))
1442f5ffd806SEd Tanous                     {
1443f5ffd806SEd Tanous                         if (authMethodsObject)
1444f5ffd806SEd Tanous                         {
1445f5ffd806SEd Tanous                             handleAuthMethodsPatch(*authMethodsObject,
1446f5ffd806SEd Tanous                                                    asyncResp);
1447f5ffd806SEd Tanous                         }
1448f5ffd806SEd Tanous                     }
1449f5ffd806SEd Tanous                 }
1450f5ffd806SEd Tanous 
1451f5ffd806SEd Tanous                 if (activeDirectoryObject)
1452f5ffd806SEd Tanous                 {
1453f5ffd806SEd Tanous                     handleLDAPPatch(*activeDirectoryObject, asyncResp,
1454f5ffd806SEd Tanous                                     "ActiveDirectory");
1455f5ffd806SEd Tanous                 }
1456f5ffd806SEd Tanous 
1457f5ffd806SEd Tanous                 if (unlockTimeout)
1458f5ffd806SEd Tanous                 {
1459f5ffd806SEd Tanous                     crow::connections::systemBus->async_method_call(
1460f5ffd806SEd Tanous                         [asyncResp](const boost::system::error_code ec) {
1461f5ffd806SEd Tanous                             if (ec)
1462f5ffd806SEd Tanous                             {
1463f5ffd806SEd Tanous                                 messages::internalError(asyncResp->res);
1464f5ffd806SEd Tanous                                 return;
1465f5ffd806SEd Tanous                             }
1466f5ffd806SEd Tanous                             messages::success(asyncResp->res);
1467f5ffd806SEd Tanous                         },
1468f5ffd806SEd Tanous                         "xyz.openbmc_project.User.Manager",
1469f5ffd806SEd Tanous                         "/xyz/openbmc_project/user",
1470f5ffd806SEd Tanous                         "org.freedesktop.DBus.Properties", "Set",
1471f5ffd806SEd Tanous                         "xyz.openbmc_project.User.AccountPolicy",
1472f5ffd806SEd Tanous                         "AccountUnlockTimeout",
1473168e20c1SEd Tanous                         dbus::utility::DbusVariantType(*unlockTimeout));
1474f5ffd806SEd Tanous                 }
1475f5ffd806SEd Tanous                 if (lockoutThreshold)
1476f5ffd806SEd Tanous                 {
1477f5ffd806SEd Tanous                     crow::connections::systemBus->async_method_call(
1478f5ffd806SEd Tanous                         [asyncResp](const boost::system::error_code ec) {
1479f5ffd806SEd Tanous                             if (ec)
1480f5ffd806SEd Tanous                             {
1481f5ffd806SEd Tanous                                 messages::internalError(asyncResp->res);
1482f5ffd806SEd Tanous                                 return;
1483f5ffd806SEd Tanous                             }
1484f5ffd806SEd Tanous                             messages::success(asyncResp->res);
1485f5ffd806SEd Tanous                         },
1486f5ffd806SEd Tanous                         "xyz.openbmc_project.User.Manager",
1487f5ffd806SEd Tanous                         "/xyz/openbmc_project/user",
1488f5ffd806SEd Tanous                         "org.freedesktop.DBus.Properties", "Set",
1489f5ffd806SEd Tanous                         "xyz.openbmc_project.User.AccountPolicy",
1490f5ffd806SEd Tanous                         "MaxLoginAttemptBeforeLockout",
1491168e20c1SEd Tanous                         dbus::utility::DbusVariantType(*lockoutThreshold));
1492f5ffd806SEd Tanous                 }
1493f5ffd806SEd Tanous             });
1494f5ffd806SEd Tanous 
14956c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Accounts/")
1496ed398213SEd Tanous         .privileges(redfish::privileges::getManagerAccountCollection)
14976c51eab1SEd Tanous         .methods(boost::beast::http::verb::get)(
14986c51eab1SEd Tanous             [](const crow::Request& req,
14996c51eab1SEd Tanous                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) -> void {
15008d1b46d7Szhanghch05                 asyncResp->res.jsonValue = {
15018d1b46d7Szhanghch05                     {"@odata.id", "/redfish/v1/AccountService/Accounts"},
15020f74e643SEd Tanous                     {"@odata.type", "#ManagerAccountCollection."
15030f74e643SEd Tanous                                     "ManagerAccountCollection"},
15040f74e643SEd Tanous                     {"Name", "Accounts Collection"},
15050f74e643SEd Tanous                     {"Description", "BMC User Accounts"}};
15060f74e643SEd Tanous 
15076c51eab1SEd Tanous                 Privileges effectiveUserPrivileges =
15086c51eab1SEd Tanous                     redfish::getUserPrivileges(req.userRole);
15096c51eab1SEd Tanous 
1510f5e29f33SJunLin Chen                 std::string thisUser;
1511f5e29f33SJunLin Chen                 if (req.session)
1512f5e29f33SJunLin Chen                 {
1513f5e29f33SJunLin Chen                     thisUser = req.session->username;
1514f5e29f33SJunLin Chen                 }
1515b9b2e0b2SEd Tanous                 crow::connections::systemBus->async_method_call(
1516cef1ddfbSEd Tanous                     [asyncResp, thisUser, effectiveUserPrivileges](
1517cef1ddfbSEd Tanous                         const boost::system::error_code ec,
1518711ac7a9SEd Tanous                         const dbus::utility::ManagedObjectType& users) {
1519b9b2e0b2SEd Tanous                         if (ec)
1520b9b2e0b2SEd Tanous                         {
1521f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
1522b9b2e0b2SEd Tanous                             return;
1523b9b2e0b2SEd Tanous                         }
1524b9b2e0b2SEd Tanous 
1525cef1ddfbSEd Tanous                         bool userCanSeeAllAccounts =
1526cef1ddfbSEd Tanous                             effectiveUserPrivileges.isSupersetOf(
15274f48d5f6SEd Tanous                                 {"ConfigureUsers"});
1528cef1ddfbSEd Tanous 
1529cef1ddfbSEd Tanous                         bool userCanSeeSelf =
1530cef1ddfbSEd Tanous                             effectiveUserPrivileges.isSupersetOf(
15314f48d5f6SEd Tanous                                 {"ConfigureSelf"});
1532cef1ddfbSEd Tanous 
1533b9b2e0b2SEd Tanous                         nlohmann::json& memberArray =
1534b9b2e0b2SEd Tanous                             asyncResp->res.jsonValue["Members"];
1535b9b2e0b2SEd Tanous                         memberArray = nlohmann::json::array();
1536b9b2e0b2SEd Tanous 
15379eb808c1SEd Tanous                         for (const auto& userpath : users)
1538b9b2e0b2SEd Tanous                         {
15392dfd18efSEd Tanous                             std::string user = userpath.first.filename();
15402dfd18efSEd Tanous                             if (user.empty())
1541b9b2e0b2SEd Tanous                             {
15422dfd18efSEd Tanous                                 messages::internalError(asyncResp->res);
15432dfd18efSEd Tanous                                 BMCWEB_LOG_ERROR << "Invalid firmware ID";
15442dfd18efSEd Tanous 
15452dfd18efSEd Tanous                                 return;
1546b9b2e0b2SEd Tanous                             }
1547f365910cSGunnar Mills 
1548f365910cSGunnar Mills                             // As clarified by Redfish here:
1549f365910cSGunnar Mills                             // https://redfishforum.com/thread/281/manageraccountcollection-change-allows-account-enumeration
15506c51eab1SEd Tanous                             // Users without ConfigureUsers, only see their own
15516c51eab1SEd Tanous                             // account. Users with ConfigureUsers, see all
15526c51eab1SEd Tanous                             // accounts.
1553cef1ddfbSEd Tanous                             if (userCanSeeAllAccounts ||
1554cef1ddfbSEd Tanous                                 (thisUser == user && userCanSeeSelf))
1555f365910cSGunnar Mills                             {
1556b9b2e0b2SEd Tanous                                 memberArray.push_back(
1557f365910cSGunnar Mills                                     {{"@odata.id",
15586c51eab1SEd Tanous                                       "/redfish/v1/AccountService/Accounts/" +
15596c51eab1SEd Tanous                                           user}});
1560b9b2e0b2SEd Tanous                             }
1561f365910cSGunnar Mills                         }
1562f365910cSGunnar Mills                         asyncResp->res.jsonValue["Members@odata.count"] =
1563f365910cSGunnar Mills                             memberArray.size();
1564b9b2e0b2SEd Tanous                     },
15656c51eab1SEd Tanous                     "xyz.openbmc_project.User.Manager",
15666c51eab1SEd Tanous                     "/xyz/openbmc_project/user",
1567b9b2e0b2SEd Tanous                     "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
15686c51eab1SEd Tanous             });
15696c51eab1SEd Tanous 
15706c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Accounts/")
1571ed398213SEd Tanous         .privileges(redfish::privileges::postManagerAccountCollection)
15726c51eab1SEd Tanous         .methods(boost::beast::http::verb::post)([](const crow::Request& req,
15736c51eab1SEd Tanous                                                     const std::shared_ptr<
15746c51eab1SEd Tanous                                                         bmcweb::AsyncResp>&
15756c51eab1SEd Tanous                                                         asyncResp) -> void {
15769712f8acSEd Tanous             std::string username;
15779712f8acSEd Tanous             std::string password;
1578a24526dcSEd Tanous             std::optional<std::string> roleId("User");
1579a24526dcSEd Tanous             std::optional<bool> enabled = true;
158015ed6780SWilly Tu             if (!json_util::readJsonPatch(req, asyncResp->res, "UserName",
158115ed6780SWilly Tu                                           username, "Password", password,
158215ed6780SWilly Tu                                           "RoleId", roleId, "Enabled", enabled))
158304ae99ecSEd Tanous             {
158404ae99ecSEd Tanous                 return;
158504ae99ecSEd Tanous             }
158604ae99ecSEd Tanous 
158754fc587aSNagaraju Goruganti             std::string priv = getPrivilegeFromRoleId(*roleId);
158884e12cb7SAppaRao Puli             if (priv.empty())
158904ae99ecSEd Tanous             {
15906c51eab1SEd Tanous                 messages::propertyValueNotInList(asyncResp->res, *roleId,
15916c51eab1SEd Tanous                                                  "RoleId");
159204ae99ecSEd Tanous                 return;
159304ae99ecSEd Tanous             }
159496200606Sjayaprakash Mutyala             // TODO: Following override will be reverted once support in
15956c51eab1SEd Tanous             // phosphor-user-manager is added. In order to avoid dependency
15966c51eab1SEd Tanous             // issues, this is added in bmcweb, which will removed, once
159796200606Sjayaprakash Mutyala             // phosphor-user-manager supports priv-noaccess.
159896200606Sjayaprakash Mutyala             if (priv == "priv-noaccess")
159996200606Sjayaprakash Mutyala             {
160096200606Sjayaprakash Mutyala                 roleId = "";
160196200606Sjayaprakash Mutyala             }
160296200606Sjayaprakash Mutyala             else
160396200606Sjayaprakash Mutyala             {
16049712f8acSEd Tanous                 roleId = priv;
160596200606Sjayaprakash Mutyala             }
160604ae99ecSEd Tanous 
1607599c71d8SAyushi Smriti             // Reading AllGroups property
16081e1e598dSJonathan Doman             sdbusplus::asio::getProperty<std::vector<std::string>>(
16091e1e598dSJonathan Doman                 *crow::connections::systemBus,
16101e1e598dSJonathan Doman                 "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user",
16111e1e598dSJonathan Doman                 "xyz.openbmc_project.User.Manager", "AllGroups",
1612599c71d8SAyushi Smriti                 [asyncResp, username, password{std::move(password)}, roleId,
1613168e20c1SEd Tanous                  enabled](const boost::system::error_code ec,
16141e1e598dSJonathan Doman                           const std::vector<std::string>& allGroupsList) {
1615599c71d8SAyushi Smriti                     if (ec)
1616599c71d8SAyushi Smriti                     {
1617599c71d8SAyushi Smriti                         BMCWEB_LOG_DEBUG << "ERROR with async_method_call";
1618599c71d8SAyushi Smriti                         messages::internalError(asyncResp->res);
1619599c71d8SAyushi Smriti                         return;
1620599c71d8SAyushi Smriti                     }
1621599c71d8SAyushi Smriti 
16221e1e598dSJonathan Doman                     if (allGroupsList.empty())
1623599c71d8SAyushi Smriti                     {
1624599c71d8SAyushi Smriti                         messages::internalError(asyncResp->res);
1625599c71d8SAyushi Smriti                         return;
1626599c71d8SAyushi Smriti                     }
1627599c71d8SAyushi Smriti 
162804ae99ecSEd Tanous                     crow::connections::systemBus->async_method_call(
1629f23b7296SEd Tanous                         [asyncResp, username,
1630f23b7296SEd Tanous                          password](const boost::system::error_code ec2,
16310d4197e0Sanil kumar appana                                    sdbusplus::message::message& m) {
163223a21a1cSEd Tanous                             if (ec2)
163304ae99ecSEd Tanous                             {
16346c51eab1SEd Tanous                                 userErrorMessageHandler(
16356c51eab1SEd Tanous                                     m.get_error(), asyncResp, username, "");
163604ae99ecSEd Tanous                                 return;
163704ae99ecSEd Tanous                             }
163804ae99ecSEd Tanous 
163966b5ca76Sjayaprakash Mutyala                             if (pamUpdatePassword(username, password) !=
164066b5ca76Sjayaprakash Mutyala                                 PAM_SUCCESS)
164104ae99ecSEd Tanous                             {
16426c51eab1SEd Tanous                                 // At this point we have a user that's been
16436c51eab1SEd Tanous                                 // created, but the password set
16446c51eab1SEd Tanous                                 // failed.Something is wrong, so delete the user
16456c51eab1SEd Tanous                                 // that we've already created
1646b477fd44SP Dheeraj Srujan Kumar                                 sdbusplus::message::object_path tempObjPath(
1647b477fd44SP Dheeraj Srujan Kumar                                     rootUserDbusPath);
1648b477fd44SP Dheeraj Srujan Kumar                                 tempObjPath /= username;
1649b477fd44SP Dheeraj Srujan Kumar                                 const std::string userPath(tempObjPath);
1650b477fd44SP Dheeraj Srujan Kumar 
165104ae99ecSEd Tanous                                 crow::connections::systemBus->async_method_call(
165223a21a1cSEd Tanous                                     [asyncResp, password](
165323a21a1cSEd Tanous                                         const boost::system::error_code ec3) {
165423a21a1cSEd Tanous                                         if (ec3)
165504ae99ecSEd Tanous                                         {
16566c51eab1SEd Tanous                                             messages::internalError(
16576c51eab1SEd Tanous                                                 asyncResp->res);
165804ae99ecSEd Tanous                                             return;
165904ae99ecSEd Tanous                                         }
166004ae99ecSEd Tanous 
16610d4197e0Sanil kumar appana                                         // If password is invalid
16620d4197e0Sanil kumar appana                                         messages::propertyValueFormatError(
16636c51eab1SEd Tanous                                             asyncResp->res, password,
16646c51eab1SEd Tanous                                             "Password");
166504ae99ecSEd Tanous                                     },
166604ae99ecSEd Tanous                                     "xyz.openbmc_project.User.Manager",
1667b477fd44SP Dheeraj Srujan Kumar                                     userPath,
16686c51eab1SEd Tanous                                     "xyz.openbmc_project.Object.Delete",
16696c51eab1SEd Tanous                                     "Delete");
167004ae99ecSEd Tanous 
167104ae99ecSEd Tanous                                 BMCWEB_LOG_ERROR << "pamUpdatePassword Failed";
167204ae99ecSEd Tanous                                 return;
167304ae99ecSEd Tanous                             }
167404ae99ecSEd Tanous 
1675f12894f8SJason M. Bills                             messages::created(asyncResp->res);
167604ae99ecSEd Tanous                             asyncResp->res.addHeader(
167704ae99ecSEd Tanous                                 "Location",
16786c51eab1SEd Tanous                                 "/redfish/v1/AccountService/Accounts/" +
16796c51eab1SEd Tanous                                     username);
168004ae99ecSEd Tanous                         },
1681599c71d8SAyushi Smriti                         "xyz.openbmc_project.User.Manager",
1682599c71d8SAyushi Smriti                         "/xyz/openbmc_project/user",
16836c51eab1SEd Tanous                         "xyz.openbmc_project.User.Manager", "CreateUser",
16841e1e598dSJonathan Doman                         username, allGroupsList, *roleId, *enabled);
16851e1e598dSJonathan Doman                 });
16866c51eab1SEd Tanous         });
1687b9b2e0b2SEd Tanous 
16886c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Accounts/<str>/")
1689ed398213SEd Tanous         .privileges(redfish::privileges::getManagerAccount)
16906c51eab1SEd Tanous         .methods(
16916c51eab1SEd Tanous             boost::beast::http::verb::
16926c51eab1SEd Tanous                 get)([](const crow::Request& req,
16936c51eab1SEd Tanous                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16946c51eab1SEd Tanous                         const std::string& accountName) -> void {
16956c51eab1SEd Tanous             if (req.session->username != accountName)
1696b9b2e0b2SEd Tanous             {
16976c51eab1SEd Tanous                 // At this point we've determined that the user is trying to
16986c51eab1SEd Tanous                 // modify a user that isn't them.  We need to verify that they
16996c51eab1SEd Tanous                 // have permissions to modify other users, so re-run the auth
17006c51eab1SEd Tanous                 // check with the same permissions, minus ConfigureSelf.
17016c51eab1SEd Tanous                 Privileges effectiveUserPrivileges =
17026c51eab1SEd Tanous                     redfish::getUserPrivileges(req.userRole);
17036c51eab1SEd Tanous                 Privileges requiredPermissionsToChangeNonSelf = {
17044f48d5f6SEd Tanous                     "ConfigureUsers", "ConfigureManager"};
17056c51eab1SEd Tanous                 if (!effectiveUserPrivileges.isSupersetOf(
17066c51eab1SEd Tanous                         requiredPermissionsToChangeNonSelf))
1707900f9497SJoseph Reynolds                 {
1708900f9497SJoseph Reynolds                     BMCWEB_LOG_DEBUG << "GET Account denied access";
1709900f9497SJoseph Reynolds                     messages::insufficientPrivilege(asyncResp->res);
1710900f9497SJoseph Reynolds                     return;
1711900f9497SJoseph Reynolds                 }
1712900f9497SJoseph Reynolds             }
1713900f9497SJoseph Reynolds 
1714b9b2e0b2SEd Tanous             crow::connections::systemBus->async_method_call(
1715711ac7a9SEd Tanous                 [asyncResp,
1716711ac7a9SEd Tanous                  accountName](const boost::system::error_code ec,
1717711ac7a9SEd Tanous                               const dbus::utility::ManagedObjectType& users) {
1718b9b2e0b2SEd Tanous                     if (ec)
1719b9b2e0b2SEd Tanous                     {
1720f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
1721b9b2e0b2SEd Tanous                         return;
1722b9b2e0b2SEd Tanous                     }
1723711ac7a9SEd Tanous                     const auto userIt = std::find_if(
1724b477fd44SP Dheeraj Srujan Kumar                         users.begin(), users.end(),
1725b477fd44SP Dheeraj Srujan Kumar                         [accountName](
1726b477fd44SP Dheeraj Srujan Kumar                             const std::pair<sdbusplus::message::object_path,
1727711ac7a9SEd Tanous                                             dbus::utility::DBusInteracesMap>&
1728711ac7a9SEd Tanous                                 user) {
172955f79e6fSEd Tanous                             return accountName == user.first.filename();
1730b477fd44SP Dheeraj Srujan Kumar                         });
1731b9b2e0b2SEd Tanous 
173284e12cb7SAppaRao Puli                     if (userIt == users.end())
1733b9b2e0b2SEd Tanous                     {
17346c51eab1SEd Tanous                         messages::resourceNotFound(
17356c51eab1SEd Tanous                             asyncResp->res, "ManagerAccount", accountName);
173684e12cb7SAppaRao Puli                         return;
173784e12cb7SAppaRao Puli                     }
17384e68c45bSAyushi Smriti 
17394e68c45bSAyushi Smriti                     asyncResp->res.jsonValue = {
17406c51eab1SEd Tanous                         {"@odata.type",
17416c51eab1SEd Tanous                          "#ManagerAccount.v1_4_0.ManagerAccount"},
17424e68c45bSAyushi Smriti                         {"Name", "User Account"},
17434e68c45bSAyushi Smriti                         {"Description", "User Account"},
17448114bd4dSGunnar Mills                         {"Password", nullptr},
17458114bd4dSGunnar Mills                         {"AccountTypes", {"Redfish"}}};
17464e68c45bSAyushi Smriti 
174784e12cb7SAppaRao Puli                     for (const auto& interface : userIt->second)
174865b0dc32SEd Tanous                     {
174965b0dc32SEd Tanous                         if (interface.first ==
175065b0dc32SEd Tanous                             "xyz.openbmc_project.User.Attributes")
175165b0dc32SEd Tanous                         {
175265b0dc32SEd Tanous                             for (const auto& property : interface.second)
175365b0dc32SEd Tanous                             {
175465b0dc32SEd Tanous                                 if (property.first == "UserEnabled")
175565b0dc32SEd Tanous                                 {
175665b0dc32SEd Tanous                                     const bool* userEnabled =
1757abf2add6SEd Tanous                                         std::get_if<bool>(&property.second);
175865b0dc32SEd Tanous                                     if (userEnabled == nullptr)
175965b0dc32SEd Tanous                                     {
176065b0dc32SEd Tanous                                         BMCWEB_LOG_ERROR
176165b0dc32SEd Tanous                                             << "UserEnabled wasn't a bool";
176284e12cb7SAppaRao Puli                                         messages::internalError(asyncResp->res);
176384e12cb7SAppaRao Puli                                         return;
176465b0dc32SEd Tanous                                     }
176565b0dc32SEd Tanous                                     asyncResp->res.jsonValue["Enabled"] =
176665b0dc32SEd Tanous                                         *userEnabled;
176765b0dc32SEd Tanous                                 }
176865b0dc32SEd Tanous                                 else if (property.first ==
176965b0dc32SEd Tanous                                          "UserLockedForFailedAttempt")
177065b0dc32SEd Tanous                                 {
177165b0dc32SEd Tanous                                     const bool* userLocked =
1772abf2add6SEd Tanous                                         std::get_if<bool>(&property.second);
177365b0dc32SEd Tanous                                     if (userLocked == nullptr)
177465b0dc32SEd Tanous                                     {
177584e12cb7SAppaRao Puli                                         BMCWEB_LOG_ERROR << "UserLockedForF"
177684e12cb7SAppaRao Puli                                                             "ailedAttempt "
177784e12cb7SAppaRao Puli                                                             "wasn't a bool";
177884e12cb7SAppaRao Puli                                         messages::internalError(asyncResp->res);
177984e12cb7SAppaRao Puli                                         return;
178065b0dc32SEd Tanous                                     }
178165b0dc32SEd Tanous                                     asyncResp->res.jsonValue["Locked"] =
178265b0dc32SEd Tanous                                         *userLocked;
178324c8542dSRatan Gupta                                     asyncResp->res.jsonValue
178424c8542dSRatan Gupta                                         ["Locked@Redfish.AllowableValues"] = {
17853bf4e632SJoseph Reynolds                                         "false"}; // can only unlock accounts
178665b0dc32SEd Tanous                                 }
178784e12cb7SAppaRao Puli                                 else if (property.first == "UserPrivilege")
178884e12cb7SAppaRao Puli                                 {
178954fc587aSNagaraju Goruganti                                     const std::string* userPrivPtr =
17906c51eab1SEd Tanous                                         std::get_if<std::string>(
17916c51eab1SEd Tanous                                             &property.second);
179254fc587aSNagaraju Goruganti                                     if (userPrivPtr == nullptr)
179384e12cb7SAppaRao Puli                                     {
179484e12cb7SAppaRao Puli                                         BMCWEB_LOG_ERROR
179584e12cb7SAppaRao Puli                                             << "UserPrivilege wasn't a "
179684e12cb7SAppaRao Puli                                                "string";
179784e12cb7SAppaRao Puli                                         messages::internalError(asyncResp->res);
179884e12cb7SAppaRao Puli                                         return;
179984e12cb7SAppaRao Puli                                     }
180054fc587aSNagaraju Goruganti                                     std::string role =
180154fc587aSNagaraju Goruganti                                         getRoleIdFromPrivilege(*userPrivPtr);
180254fc587aSNagaraju Goruganti                                     if (role.empty())
180384e12cb7SAppaRao Puli                                     {
180484e12cb7SAppaRao Puli                                         BMCWEB_LOG_ERROR << "Invalid user role";
180584e12cb7SAppaRao Puli                                         messages::internalError(asyncResp->res);
180684e12cb7SAppaRao Puli                                         return;
180784e12cb7SAppaRao Puli                                     }
180854fc587aSNagaraju Goruganti                                     asyncResp->res.jsonValue["RoleId"] = role;
180984e12cb7SAppaRao Puli 
18106c51eab1SEd Tanous                                     asyncResp->res.jsonValue["Links"]["Role"] =
18116c51eab1SEd Tanous                                         {{"@odata.id",
18120fda0f12SGeorge Liu                                           "/redfish/v1/AccountService/Roles/" +
181354fc587aSNagaraju Goruganti                                               role}};
181484e12cb7SAppaRao Puli                                 }
18156c51eab1SEd Tanous                                 else if (property.first ==
18166c51eab1SEd Tanous                                          "UserPasswordExpired")
18173bf4e632SJoseph Reynolds                                 {
18183bf4e632SJoseph Reynolds                                     const bool* userPasswordExpired =
18193bf4e632SJoseph Reynolds                                         std::get_if<bool>(&property.second);
18203bf4e632SJoseph Reynolds                                     if (userPasswordExpired == nullptr)
18213bf4e632SJoseph Reynolds                                     {
18220fda0f12SGeorge Liu                                         BMCWEB_LOG_ERROR
18230fda0f12SGeorge Liu                                             << "UserPasswordExpired wasn't a bool";
18243bf4e632SJoseph Reynolds                                         messages::internalError(asyncResp->res);
18253bf4e632SJoseph Reynolds                                         return;
18263bf4e632SJoseph Reynolds                                     }
18273bf4e632SJoseph Reynolds                                     asyncResp->res
18283bf4e632SJoseph Reynolds                                         .jsonValue["PasswordChangeRequired"] =
18293bf4e632SJoseph Reynolds                                         *userPasswordExpired;
18303bf4e632SJoseph Reynolds                                 }
183165b0dc32SEd Tanous                             }
183265b0dc32SEd Tanous                         }
183365b0dc32SEd Tanous                     }
183465b0dc32SEd Tanous 
1835b9b2e0b2SEd Tanous                     asyncResp->res.jsonValue["@odata.id"] =
183684e12cb7SAppaRao Puli                         "/redfish/v1/AccountService/Accounts/" + accountName;
1837b9b2e0b2SEd Tanous                     asyncResp->res.jsonValue["Id"] = accountName;
1838b9b2e0b2SEd Tanous                     asyncResp->res.jsonValue["UserName"] = accountName;
1839b9b2e0b2SEd Tanous                 },
1840b9b2e0b2SEd Tanous                 "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user",
1841b9b2e0b2SEd Tanous                 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
18426c51eab1SEd Tanous         });
1843a840879dSEd Tanous 
18446c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Accounts/<str>/")
1845ed398213SEd Tanous         // TODO this privilege should be using the generated endpoints, but
1846ed398213SEd Tanous         // because of the special handling of ConfigureSelf, it's not able to
1847ed398213SEd Tanous         // yet
18486c51eab1SEd Tanous         .privileges({{"ConfigureUsers"}, {"ConfigureSelf"}})
18496c51eab1SEd Tanous         .methods(boost::beast::http::verb::patch)(
18506c51eab1SEd Tanous             [](const crow::Request& req,
18516c51eab1SEd Tanous                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
18526c51eab1SEd Tanous                const std::string& username) -> void {
1853a24526dcSEd Tanous                 std::optional<std::string> newUserName;
1854a24526dcSEd Tanous                 std::optional<std::string> password;
1855a24526dcSEd Tanous                 std::optional<bool> enabled;
1856a24526dcSEd Tanous                 std::optional<std::string> roleId;
185724c8542dSRatan Gupta                 std::optional<bool> locked;
1858e9cc5172SEd Tanous 
1859e9cc5172SEd Tanous                 Privileges effectiveUserPrivileges =
1860e9cc5172SEd Tanous                     redfish::getUserPrivileges(req.userRole);
1861e9cc5172SEd Tanous                 Privileges configureUsers = {"ConfigureUsers"};
1862e9cc5172SEd Tanous                 bool userHasConfigureUsers =
1863e9cc5172SEd Tanous                     effectiveUserPrivileges.isSupersetOf(configureUsers);
1864e9cc5172SEd Tanous                 if (userHasConfigureUsers)
1865e9cc5172SEd Tanous                 {
1866e9cc5172SEd Tanous                     // Users with ConfigureUsers can modify for all users
186715ed6780SWilly Tu                     if (!json_util::readJsonPatch(
186815ed6780SWilly Tu                             req, asyncResp->res, "UserName", newUserName,
186915ed6780SWilly Tu                             "Password", password, "RoleId", roleId, "Enabled",
1870e9cc5172SEd Tanous                             enabled, "Locked", locked))
1871a840879dSEd Tanous                     {
1872a840879dSEd Tanous                         return;
1873a840879dSEd Tanous                     }
1874e9cc5172SEd Tanous                 }
1875e9cc5172SEd Tanous                 else
1876900f9497SJoseph Reynolds                 {
1877e9cc5172SEd Tanous                     // ConfigureSelf accounts can only modify their own account
1878e9cc5172SEd Tanous                     if (username != req.session->username)
1879900f9497SJoseph Reynolds                     {
1880900f9497SJoseph Reynolds                         messages::insufficientPrivilege(asyncResp->res);
1881900f9497SJoseph Reynolds                         return;
1882900f9497SJoseph Reynolds                     }
1883e9cc5172SEd Tanous                     // ConfigureSelf accounts can only modify their password
188415ed6780SWilly Tu                     if (!json_util::readJsonPatch(req, asyncResp->res,
188515ed6780SWilly Tu                                                   "Password", password))
1886e9cc5172SEd Tanous                     {
1887e9cc5172SEd Tanous                         return;
1888e9cc5172SEd Tanous                     }
1889900f9497SJoseph Reynolds                 }
1890900f9497SJoseph Reynolds 
189166b5ca76Sjayaprakash Mutyala                 // if user name is not provided in the patch method or if it
18926c51eab1SEd Tanous                 // matches the user name in the URI, then we are treating it as
18936c51eab1SEd Tanous                 // updating user properties other then username. If username
18946c51eab1SEd Tanous                 // provided doesn't match the URI, then we are treating this as
18956c51eab1SEd Tanous                 // user rename request.
189666b5ca76Sjayaprakash Mutyala                 if (!newUserName || (newUserName.value() == username))
1897a840879dSEd Tanous                 {
18986c51eab1SEd Tanous                     updateUserProperties(asyncResp, username, password, enabled,
18996c51eab1SEd Tanous                                          roleId, locked);
190084e12cb7SAppaRao Puli                     return;
190184e12cb7SAppaRao Puli                 }
190284e12cb7SAppaRao Puli                 crow::connections::systemBus->async_method_call(
19036c51eab1SEd Tanous                     [asyncResp, username, password(std::move(password)),
1904f23b7296SEd Tanous                      roleId(std::move(roleId)), enabled,
190566b5ca76Sjayaprakash Mutyala                      newUser{std::string(*newUserName)},
1906f23b7296SEd Tanous                      locked](const boost::system::error_code ec,
190766b5ca76Sjayaprakash Mutyala                              sdbusplus::message::message& m) {
190884e12cb7SAppaRao Puli                         if (ec)
190984e12cb7SAppaRao Puli                         {
19106c51eab1SEd Tanous                             userErrorMessageHandler(m.get_error(), asyncResp,
19116c51eab1SEd Tanous                                                     newUser, username);
1912a840879dSEd Tanous                             return;
1913a840879dSEd Tanous                         }
1914a840879dSEd Tanous 
19156c51eab1SEd Tanous                         updateUserProperties(asyncResp, newUser, password,
19166c51eab1SEd Tanous                                              enabled, roleId, locked);
191784e12cb7SAppaRao Puli                     },
19186c51eab1SEd Tanous                     "xyz.openbmc_project.User.Manager",
19196c51eab1SEd Tanous                     "/xyz/openbmc_project/user",
192084e12cb7SAppaRao Puli                     "xyz.openbmc_project.User.Manager", "RenameUser", username,
192184e12cb7SAppaRao Puli                     *newUserName);
19226c51eab1SEd Tanous             });
192384e12cb7SAppaRao Puli 
19246c51eab1SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Accounts/<str>/")
1925ed398213SEd Tanous         .privileges(redfish::privileges::deleteManagerAccount)
19266c51eab1SEd Tanous         .methods(boost::beast::http::verb::delete_)(
19276c51eab1SEd Tanous             [](const crow::Request& /*req*/,
19286c51eab1SEd Tanous                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
19296c51eab1SEd Tanous                const std::string& username) -> void {
1930b477fd44SP Dheeraj Srujan Kumar                 sdbusplus::message::object_path tempObjPath(rootUserDbusPath);
1931b477fd44SP Dheeraj Srujan Kumar                 tempObjPath /= username;
1932b477fd44SP Dheeraj Srujan Kumar                 const std::string userPath(tempObjPath);
193324c8542dSRatan Gupta 
19346c51eab1SEd Tanous                 crow::connections::systemBus->async_method_call(
19356c51eab1SEd Tanous                     [asyncResp, username](const boost::system::error_code ec) {
19366c51eab1SEd Tanous                         if (ec)
193766b5ca76Sjayaprakash Mutyala                         {
193866b5ca76Sjayaprakash Mutyala                             messages::resourceNotFound(
193966b5ca76Sjayaprakash Mutyala                                 asyncResp->res,
19406c51eab1SEd Tanous                                 "#ManagerAccount.v1_4_0.ManagerAccount",
1941f12894f8SJason M. Bills                                 username);
194206e086d9SEd Tanous                             return;
194306e086d9SEd Tanous                         }
194406e086d9SEd Tanous 
1945f12894f8SJason M. Bills                         messages::accountRemoved(asyncResp->res);
194606e086d9SEd Tanous                     },
194706e086d9SEd Tanous                     "xyz.openbmc_project.User.Manager", userPath,
194806e086d9SEd Tanous                     "xyz.openbmc_project.Object.Delete", "Delete");
19496c51eab1SEd Tanous             });
195006e086d9SEd Tanous }
195188d16c9aSLewanczyk, Dawid 
195288d16c9aSLewanczyk, Dawid } // namespace redfish
1953