/* // Copyright (c) 2018 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. */ #pragma once #include "node.hpp" #include #include #include #include #include namespace redfish { constexpr const char* ldapConfigObject = "/xyz/openbmc_project/user/ldap/openldap"; constexpr const char* ADConfigObject = "/xyz/openbmc_project/user/ldap/active_directory"; constexpr const char* ldapRootObject = "/xyz/openbmc_project/user/ldap"; constexpr const char* ldapDbusService = "xyz.openbmc_project.Ldap.Config"; constexpr const char* ldapConfigInterface = "xyz.openbmc_project.User.Ldap.Config"; constexpr const char* ldapCreateInterface = "xyz.openbmc_project.User.Ldap.Create"; constexpr const char* ldapEnableInterface = "xyz.openbmc_project.Object.Enable"; constexpr const char* ldapPrivMapperInterface = "xyz.openbmc_project.User.PrivilegeMapper"; constexpr const char* dbusObjManagerIntf = "org.freedesktop.DBus.ObjectManager"; constexpr const char* propertyInterface = "org.freedesktop.DBus.Properties"; constexpr const char* mapperBusName = "xyz.openbmc_project.ObjectMapper"; constexpr const char* mapperObjectPath = "/xyz/openbmc_project/object_mapper"; constexpr const char* mapperIntf = "xyz.openbmc_project.ObjectMapper"; struct LDAPRoleMapData { std::string groupName; std::string privilege; }; struct LDAPConfigData { std::string uri{}; std::string bindDN{}; std::string baseDN{}; std::string searchScope{}; std::string serverType{}; bool serviceEnabled = false; std::string userNameAttribute{}; std::string groupAttribute{}; std::vector> groupRoleList; }; using ManagedObjectType = std::vector>>>>; using GetObjectType = std::vector>>; inline std::string getRoleIdFromPrivilege(std::string_view role) { if (role == "priv-admin") { return "Administrator"; } else if (role == "priv-callback") { return "Callback"; } else if (role == "priv-user") { return "User"; } else if (role == "priv-operator") { return "Operator"; } return ""; } inline std::string getPrivilegeFromRoleId(std::string_view role) { if (role == "Administrator") { return "priv-admin"; } else if (role == "Callback") { return "priv-callback"; } else if (role == "User") { return "priv-user"; } else if (role == "Operator") { return "priv-operator"; } return ""; } void parseLDAPConfigData(nlohmann::json& json_response, const LDAPConfigData& confData, const std::string& ldapType) { std::string service = (ldapType == "LDAP") ? "LDAPService" : "ActiveDirectoryService"; nlohmann::json ldap = { {"AccountProviderType", service}, {"ServiceEnabled", confData.serviceEnabled}, {"ServiceAddresses", nlohmann::json::array({confData.uri})}, {"Authentication", {{"AuthenticationType", "UsernameAndPassword"}, {"Username", confData.bindDN}, {"Password", nullptr}}}, {"LDAPService", {{"SearchSettings", {{"BaseDistinguishedNames", nlohmann::json::array({confData.baseDN})}, {"UsernameAttribute", confData.userNameAttribute}, {"GroupsAttribute", confData.groupAttribute}}}}}, }; json_response[ldapType].update(std::move(ldap)); nlohmann::json& roleMapArray = json_response[ldapType]["RemoteRoleMapping"]; roleMapArray = nlohmann::json::array(); for (auto& obj : confData.groupRoleList) { BMCWEB_LOG_DEBUG << "Pushing the data groupName=" << obj.second.groupName << "\n"; roleMapArray.push_back( {nlohmann::json::array({"RemoteGroup", obj.second.groupName}), nlohmann::json::array( {"LocalRole", getRoleIdFromPrivilege(obj.second.privilege)})}); } } /** * @brief validates given JSON input and then calls appropriate method to * create, to delete or to set Rolemapping object based on the given input. * */ static void handleRoleMapPatch( const std::shared_ptr& asyncResp, const std::vector>& roleMapObjData, const std::string& serverType, std::vector& input) { for (size_t index = 0; index < input.size(); index++) { nlohmann::json& thisJson = input[index]; if (thisJson.is_null()) { // delete the existing object if (index < roleMapObjData.size()) { crow::connections::systemBus->async_method_call( [asyncResp, roleMapObjData, serverType, index](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "DBUS response error: " << ec; messages::internalError(asyncResp->res); return; } asyncResp->res .jsonValue[serverType]["RemoteRoleMapping"][index] = nullptr; }, ldapDbusService, roleMapObjData[index].first, "xyz.openbmc_project.Object.Delete", "Delete"); } else { BMCWEB_LOG_ERROR << "Can't delete the object"; messages::propertyValueTypeError( asyncResp->res, thisJson.dump(), "RemoteRoleMapping/" + std::to_string(index)); return; } } else if (thisJson.empty()) { // Don't do anything for the empty objects,parse next json // eg {"RemoteRoleMapping",[{}]} } else { // update/create the object std::optional remoteGroup; std::optional localRole; if (!json_util::readJson(thisJson, asyncResp->res, "RemoteGroup", remoteGroup, "LocalRole", localRole)) { continue; } // Update existing RoleMapping Object if (index < roleMapObjData.size()) { BMCWEB_LOG_DEBUG << "Update Role Map Object"; // If "RemoteGroup" info is provided if (remoteGroup) { crow::connections::systemBus->async_method_call( [asyncResp, roleMapObjData, serverType, index, remoteGroup](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "DBUS response error: " << ec; messages::internalError(asyncResp->res); return; } asyncResp->res .jsonValue[serverType]["RemoteRoleMapping"] [index]["RemoteGroup"] = *remoteGroup; }, ldapDbusService, roleMapObjData[index].first, propertyInterface, "Set", "xyz.openbmc_project.User.PrivilegeMapperEntry", "GroupName", std::variant(std::move(*remoteGroup))); } // If "LocalRole" info is provided if (localRole) { crow::connections::systemBus->async_method_call( [asyncResp, roleMapObjData, serverType, index, localRole](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "DBUS response error: " << ec; messages::internalError(asyncResp->res); return; } asyncResp->res .jsonValue[serverType]["RemoteRoleMapping"] [index]["LocalRole"] = *localRole; }, ldapDbusService, roleMapObjData[index].first, propertyInterface, "Set", "xyz.openbmc_project.User.PrivilegeMapperEntry", "Privilege", std::variant( getPrivilegeFromRoleId(std::move(*localRole)))); } } // Create a new RoleMapping Object. else { BMCWEB_LOG_DEBUG << "setRoleMappingProperties: Creating new Object"; std::string pathString = "RemoteRoleMapping/" + std::to_string(index); if (!localRole) { messages::propertyMissing(asyncResp->res, pathString + "/LocalRole"); continue; } if (!remoteGroup) { messages::propertyMissing(asyncResp->res, pathString + "/RemoteGroup"); continue; } std::string dbusObjectPath; if (serverType == "ActiveDirectory") { dbusObjectPath = ADConfigObject; } else if (serverType == "LDAP") { dbusObjectPath = ldapConfigObject; } BMCWEB_LOG_DEBUG << "Remote Group=" << *remoteGroup << ",LocalRole=" << *localRole; crow::connections::systemBus->async_method_call( [asyncResp, serverType, localRole, remoteGroup](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "DBUS response error: " << ec; messages::internalError(asyncResp->res); return; } nlohmann::json& remoteRoleJson = asyncResp->res .jsonValue[serverType]["RemoteRoleMapping"]; remoteRoleJson.push_back( {{"LocalRole", *localRole}, {"RemoteGroup", *remoteGroup}}); }, ldapDbusService, dbusObjectPath, ldapPrivMapperInterface, "Create", std::move(*remoteGroup), getPrivilegeFromRoleId(std::move(*localRole))); } } } } /** * Function that retrieves all properties for LDAP config object * into JSON */ template inline void getLDAPConfigData(const std::string& ldapType, CallbackFunc&& callback) { const std::array interfaces = {ldapEnableInterface, ldapConfigInterface}; crow::connections::systemBus->async_method_call( [callback, ldapType](const boost::system::error_code ec, const GetObjectType& resp) { LDAPConfigData confData{}; if (ec || resp.empty()) { BMCWEB_LOG_ERROR << "DBUS response error during getting of " "service name: " << ec; callback(false, confData, ldapType); return; } std::string service = resp.begin()->first; crow::connections::systemBus->async_method_call( [callback, ldapType](const boost::system::error_code error_code, const ManagedObjectType& ldapObjects) { LDAPConfigData confData{}; if (error_code) { callback(false, confData, ldapType); BMCWEB_LOG_ERROR << "D-Bus responses error: " << error_code; return; } std::string ldapDbusType; std::string searchString; if (ldapType == "LDAP") { ldapDbusType = "xyz.openbmc_project.User.Ldap.Config." "Type.OpenLdap"; searchString = "openldap"; } else if (ldapType == "ActiveDirectory") { ldapDbusType = "xyz.openbmc_project.User.Ldap.Config.Type." "ActiveDirectory"; searchString = "active_directory"; } else { BMCWEB_LOG_ERROR << "Can't get the DbusType for the given type=" << ldapType; callback(false, confData, ldapType); return; } std::string ldapEnableInterfaceStr = ldapEnableInterface; std::string ldapConfigInterfaceStr = ldapConfigInterface; for (const auto& object : ldapObjects) { // let's find the object whose ldap type is equal to the // given type if (object.first.str.find(searchString) == std::string::npos) { continue; } for (const auto& interface : object.second) { if (interface.first == ldapEnableInterfaceStr) { // rest of the properties are string. for (const auto& property : interface.second) { if (property.first == "Enabled") { const bool* value = std::get_if(&property.second); if (value == nullptr) { continue; } confData.serviceEnabled = *value; break; } } } else if (interface.first == ldapConfigInterfaceStr) { for (const auto& property : interface.second) { const std::string* strValue = std::get_if( &property.second); if (strValue == nullptr) { continue; } if (property.first == "LDAPServerURI") { confData.uri = *strValue; } else if (property.first == "LDAPBindDN") { confData.bindDN = *strValue; } else if (property.first == "LDAPBaseDN") { confData.baseDN = *strValue; } else if (property.first == "LDAPSearchScope") { confData.searchScope = *strValue; } else if (property.first == "GroupNameAttribute") { confData.groupAttribute = *strValue; } else if (property.first == "UserNameAttribute") { confData.userNameAttribute = *strValue; } else if (property.first == "LDAPType") { confData.serverType = *strValue; } } } else if (interface.first == "xyz.openbmc_project.User." "PrivilegeMapperEntry") { LDAPRoleMapData roleMapData{}; for (const auto& property : interface.second) { const std::string* strValue = std::get_if( &property.second); if (strValue == nullptr) { continue; } if (property.first == "GroupName") { roleMapData.groupName = *strValue; } else if (property.first == "Privilege") { roleMapData.privilege = *strValue; } } confData.groupRoleList.push_back(std::make_pair( object.first.str, roleMapData)); } } } callback(true, confData, ldapType); }, service, ldapRootObject, dbusObjManagerIntf, "GetManagedObjects"); }, mapperBusName, mapperObjectPath, mapperIntf, "GetObject", ldapConfigObject, interfaces); } class AccountService : public Node { public: AccountService(CrowApp& app) : Node(app, "/redfish/v1/AccountService/") { entityPrivileges = { {boost::beast::http::verb::get, {{"ConfigureUsers"}, {"ConfigureManager"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureUsers"}}}, {boost::beast::http::verb::put, {{"ConfigureUsers"}}}, {boost::beast::http::verb::delete_, {{"ConfigureUsers"}}}, {boost::beast::http::verb::post, {{"ConfigureUsers"}}}}; } private: /** * @brief parses the authentication section under the LDAP * @param input JSON data * @param asyncResp pointer to the JSON response * @param userName userName to be filled from the given JSON. * @param password password to be filled from the given JSON. */ void parseLDAPAuthenticationJson(nlohmann::json input, const std::shared_ptr& asyncResp, std::optional& username, std::optional& password) { std::optional authType; if (!json_util::readJson(input, asyncResp->res, "AuthenticationType", authType, "Username", username, "Password", password)) { return; } if (!authType) { return; } if (*authType != "UsernameAndPassword") { messages::propertyValueNotInList(asyncResp->res, *authType, "AuthenticationType"); return; } } /** * @brief parses the LDAPService section under the LDAP * @param input JSON data * @param asyncResp pointer to the JSON response * @param baseDNList baseDN to be filled from the given JSON. * @param userNameAttribute userName to be filled from the given JSON. * @param groupaAttribute password to be filled from the given JSON. */ void parseLDAPServiceJson( nlohmann::json input, const std::shared_ptr& asyncResp, std::optional>& baseDNList, std::optional& userNameAttribute, std::optional& groupsAttribute) { std::optional searchSettings; if (!json_util::readJson(input, asyncResp->res, "SearchSettings", searchSettings)) { return; } if (!searchSettings) { return; } if (!json_util::readJson(*searchSettings, asyncResp->res, "BaseDistinguishedNames", baseDNList, "UsernameAttribute", userNameAttribute, "GroupsAttribute", groupsAttribute)) { return; } } /** * @brief updates the LDAP server address and updates the json response with the new value. * @param serviceAddressList address to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleServiceAddressPatch( const std::vector& serviceAddressList, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, ldapServerElementName, serviceAddressList](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error Occured in updating the service address"; messages::internalError(asyncResp->res); return; } std::vector modifiedserviceAddressList = { serviceAddressList.front()}; asyncResp->res .jsonValue[ldapServerElementName]["ServiceAddresses"] = modifiedserviceAddressList; if ((serviceAddressList).size() > 1) { messages::propertyValueModified(asyncResp->res, "ServiceAddresses", serviceAddressList.front()); } BMCWEB_LOG_DEBUG << "Updated the service address"; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "LDAPServerURI", std::variant(serviceAddressList.front())); } /** * @brief updates the LDAP Bind DN and updates the json response with the new value. * @param username name of the user which needs to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleUserNamePatch(const std::string& username, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, username, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error occured in updating the username"; messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue[ldapServerElementName] ["Authentication"]["Username"] = username; BMCWEB_LOG_DEBUG << "Updated the username"; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "LDAPBindDN", std::variant(username)); } /** * @brief updates the LDAP password * @param password : ldap password which needs to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP * server(openLDAP/ActiveDirectory) */ void handlePasswordPatch(const std::string& password, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, password, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error occured in updating the password"; messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue[ldapServerElementName] ["Authentication"]["Password"] = ""; BMCWEB_LOG_DEBUG << "Updated the password"; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "LDAPBindDNPassword", std::variant(password)); } /** * @brief updates the LDAP BaseDN and updates the json response with the new value. * @param baseDNList baseDN list which needs to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleBaseDNPatch(const std::vector& baseDNList, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, baseDNList, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error Occured in Updating the base DN"; messages::internalError(asyncResp->res); return; } auto& serverTypeJson = asyncResp->res.jsonValue[ldapServerElementName]; auto& searchSettingsJson = serverTypeJson["LDAPService"]["SearchSettings"]; std::vector modifiedBaseDNList = { baseDNList.front()}; searchSettingsJson["BaseDistinguishedNames"] = modifiedBaseDNList; if (baseDNList.size() > 1) { messages::propertyValueModified(asyncResp->res, "BaseDistinguishedNames", baseDNList.front()); } BMCWEB_LOG_DEBUG << "Updated the base DN"; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "LDAPBaseDN", std::variant(baseDNList.front())); } /** * @brief updates the LDAP user name attribute and updates the json response with the new value. * @param userNameAttribute attribute to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleUserNameAttrPatch(const std::string& userNameAttribute, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, userNameAttribute, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error Occured in Updating the " "username attribute"; messages::internalError(asyncResp->res); return; } auto& serverTypeJson = asyncResp->res.jsonValue[ldapServerElementName]; auto& searchSettingsJson = serverTypeJson["LDAPService"]["SearchSettings"]; searchSettingsJson["UsernameAttribute"] = userNameAttribute; BMCWEB_LOG_DEBUG << "Updated the user name attr."; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "UserNameAttribute", std::variant(userNameAttribute)); } /** * @brief updates the LDAP group attribute and updates the json response with the new value. * @param groupsAttribute attribute to be updated. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleGroupNameAttrPatch(const std::string& groupsAttribute, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, groupsAttribute, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error Occured in Updating the " "groupname attribute"; messages::internalError(asyncResp->res); return; } auto& serverTypeJson = asyncResp->res.jsonValue[ldapServerElementName]; auto& searchSettingsJson = serverTypeJson["LDAPService"]["SearchSettings"]; searchSettingsJson["GroupsAttribute"] = groupsAttribute; BMCWEB_LOG_DEBUG << "Updated the groupname attr"; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapConfigInterface, "GroupNameAttribute", std::variant(groupsAttribute)); } /** * @brief updates the LDAP service enable and updates the json response with the new value. * @param input JSON data. * @param asyncResp pointer to the JSON response * @param ldapServerElementName Type of LDAP server(openLDAP/ActiveDirectory) */ void handleServiceEnablePatch(bool serviceEnabled, const std::shared_ptr& asyncResp, const std::string& ldapServerElementName, const std::string& ldapConfigObject) { crow::connections::systemBus->async_method_call( [asyncResp, serviceEnabled, ldapServerElementName](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Error Occured in Updating the service enable"; messages::internalError(asyncResp->res); return; } asyncResp->res .jsonValue[ldapServerElementName]["ServiceEnabled"] = serviceEnabled; BMCWEB_LOG_DEBUG << "Updated Service enable = " << serviceEnabled; }, ldapDbusService, ldapConfigObject, propertyInterface, "Set", ldapEnableInterface, "Enabled", std::variant(serviceEnabled)); } /** * @brief Get the required values from the given JSON, validates the * value and create the LDAP config object. * @param input JSON data * @param asyncResp pointer to the JSON response * @param serverType Type of LDAP server(openLDAP/ActiveDirectory) */ void handleLDAPPatch(nlohmann::json& input, const std::shared_ptr& asyncResp, const crow::Request& req, const std::vector& params, const std::string& serverType) { std::string dbusObjectPath; if (serverType == "ActiveDirectory") { dbusObjectPath = ADConfigObject; } else if (serverType == "LDAP") { dbusObjectPath = ldapConfigObject; } std::optional authentication; std::optional ldapService; std::optional accountProviderType; std::optional> serviceAddressList; std::optional serviceEnabled; std::optional> baseDNList; std::optional userNameAttribute; std::optional groupsAttribute; std::optional userName; std::optional password; std::optional> remoteRoleMapData; if (!json_util::readJson(input, asyncResp->res, "Authentication", authentication, "LDAPService", ldapService, "ServiceAddresses", serviceAddressList, "AccountProviderType", accountProviderType, "ServiceEnabled", serviceEnabled, "RemoteRoleMapping", remoteRoleMapData)) { return; } if (authentication) { parseLDAPAuthenticationJson(*authentication, asyncResp, userName, password); } if (ldapService) { parseLDAPServiceJson(*ldapService, asyncResp, baseDNList, userNameAttribute, groupsAttribute); } if (accountProviderType) { messages::propertyNotWritable(asyncResp->res, "AccountProviderType"); } if (serviceAddressList) { if ((*serviceAddressList).size() == 0) { messages::propertyValueNotInList(asyncResp->res, "[]", "ServiceAddress"); return; } } if (baseDNList) { if ((*baseDNList).size() == 0) { messages::propertyValueNotInList(asyncResp->res, "[]", "BaseDistinguishedNames"); return; } } // nothing to update, then return if (!userName && !password && !serviceAddressList && !baseDNList && !userNameAttribute && !groupsAttribute && !serviceEnabled && !remoteRoleMapData) { return; } // Get the existing resource first then keep modifying // whenever any property gets updated. getLDAPConfigData(serverType, [this, asyncResp, userName, password, baseDNList, userNameAttribute, groupsAttribute, accountProviderType, serviceAddressList, serviceEnabled, dbusObjectPath, remoteRoleMapData]( bool success, LDAPConfigData confData, const std::string& serverType) { if (!success) { messages::internalError(asyncResp->res); return; } parseLDAPConfigData(asyncResp->res.jsonValue, confData, serverType); if (confData.serviceEnabled) { // Disable the service first and update the rest of // the properties. handleServiceEnablePatch(false, asyncResp, serverType, dbusObjectPath); } if (serviceAddressList) { handleServiceAddressPatch(*serviceAddressList, asyncResp, serverType, dbusObjectPath); } if (userName) { handleUserNamePatch(*userName, asyncResp, serverType, dbusObjectPath); } if (password) { handlePasswordPatch(*password, asyncResp, serverType, dbusObjectPath); } if (baseDNList) { handleBaseDNPatch(*baseDNList, asyncResp, serverType, dbusObjectPath); } if (userNameAttribute) { handleUserNameAttrPatch(*userNameAttribute, asyncResp, serverType, dbusObjectPath); } if (groupsAttribute) { handleGroupNameAttrPatch(*groupsAttribute, asyncResp, serverType, dbusObjectPath); } if (serviceEnabled) { // if user has given the value as true then enable // the service. if user has given false then no-op // as service is already stopped. if (*serviceEnabled) { handleServiceEnablePatch(*serviceEnabled, asyncResp, serverType, dbusObjectPath); } } else { // if user has not given the service enabled value // then revert it to the same state as it was // before. handleServiceEnablePatch(confData.serviceEnabled, asyncResp, serverType, dbusObjectPath); } if (remoteRoleMapData) { std::vector remoteRoleMap = std::move(*remoteRoleMapData); handleRoleMapPatch(asyncResp, confData.groupRoleList, serverType, remoteRoleMap); } }); } void doGet(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); res.jsonValue = { {"@odata.context", "/redfish/v1/" "$metadata#AccountService.AccountService"}, {"@odata.id", "/redfish/v1/AccountService"}, {"@odata.type", "#AccountService." "v1_4_0.AccountService"}, {"Id", "AccountService"}, {"Name", "Account Service"}, {"Description", "Account Service"}, {"ServiceEnabled", true}, {"MaxPasswordLength", 20}, {"Accounts", {{"@odata.id", "/redfish/v1/AccountService/Accounts"}}}, {"Roles", {{"@odata.id", "/redfish/v1/AccountService/Roles"}}}, {"LDAP", {{"Certificates", {{"@odata.id", "/redfish/v1/AccountService/LDAP/Certificates"}}}}}}; crow::connections::systemBus->async_method_call( [asyncResp]( const boost::system::error_code ec, const std::vector>>& propertiesList) { if (ec) { messages::internalError(asyncResp->res); return; } BMCWEB_LOG_DEBUG << "Got " << propertiesList.size() << "properties for AccountService"; for (const std::pair>& property : propertiesList) { if (property.first == "MinPasswordLength") { const uint8_t* value = std::get_if(&property.second); if (value != nullptr) { asyncResp->res.jsonValue["MinPasswordLength"] = *value; } } if (property.first == "AccountUnlockTimeout") { const uint32_t* value = std::get_if(&property.second); if (value != nullptr) { asyncResp->res.jsonValue["AccountLockoutDuration"] = *value; } } if (property.first == "MaxLoginAttemptBeforeLockout") { const uint16_t* value = std::get_if(&property.second); if (value != nullptr) { asyncResp->res .jsonValue["AccountLockoutThreshold"] = *value; } } } }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.Properties", "GetAll", "xyz.openbmc_project.User.AccountPolicy"); auto callback = [asyncResp](bool success, LDAPConfigData& confData, const std::string& ldapType) { parseLDAPConfigData(asyncResp->res.jsonValue, confData, ldapType); }; getLDAPConfigData("LDAP", callback); getLDAPConfigData("ActiveDirectory", callback); } void doPatch(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); std::optional unlockTimeout; std::optional lockoutThreshold; std::optional minPasswordLength; std::optional maxPasswordLength; std::optional ldapObject; std::optional activeDirectoryObject; if (!json_util::readJson(req, res, "AccountLockoutDuration", unlockTimeout, "AccountLockoutThreshold", lockoutThreshold, "MaxPasswordLength", maxPasswordLength, "MinPasswordLength", minPasswordLength, "LDAP", ldapObject, "ActiveDirectory", activeDirectoryObject)) { return; } if (minPasswordLength) { messages::propertyNotWritable(asyncResp->res, "MinPasswordLength"); } if (maxPasswordLength) { messages::propertyNotWritable(asyncResp->res, "MaxPasswordLength"); } if (ldapObject) { handleLDAPPatch(*ldapObject, asyncResp, req, params, "LDAP"); } if (activeDirectoryObject) { handleLDAPPatch(*activeDirectoryObject, asyncResp, req, params, "ActiveDirectory"); } if (unlockTimeout) { crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.User.AccountPolicy", "AccountUnlockTimeout", std::variant(*unlockTimeout)); } if (lockoutThreshold) { crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.User.AccountPolicy", "MaxLoginAttemptBeforeLockout", std::variant(*lockoutThreshold)); } } }; class AccountsCollection : public Node { public: AccountsCollection(CrowApp& app) : Node(app, "/redfish/v1/AccountService/Accounts/") { entityPrivileges = { {boost::beast::http::verb::get, {{"ConfigureUsers"}, {"ConfigureManager"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureUsers"}}}, {boost::beast::http::verb::put, {{"ConfigureUsers"}}}, {boost::beast::http::verb::delete_, {{"ConfigureUsers"}}}, {boost::beast::http::verb::post, {{"ConfigureUsers"}}}}; } private: void doGet(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); res.jsonValue = {{"@odata.context", "/redfish/v1/" "$metadata#ManagerAccountCollection." "ManagerAccountCollection"}, {"@odata.id", "/redfish/v1/AccountService/Accounts"}, {"@odata.type", "#ManagerAccountCollection." "ManagerAccountCollection"}, {"Name", "Accounts Collection"}, {"Description", "BMC User Accounts"}}; crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec, const ManagedObjectType& users) { if (ec) { messages::internalError(asyncResp->res); return; } nlohmann::json& memberArray = asyncResp->res.jsonValue["Members"]; memberArray = nlohmann::json::array(); asyncResp->res.jsonValue["Members@odata.count"] = users.size(); for (auto& user : users) { const std::string& path = static_cast(user.first); std::size_t lastIndex = path.rfind("/"); if (lastIndex == std::string::npos) { lastIndex = 0; } else { lastIndex += 1; } memberArray.push_back( {{"@odata.id", "/redfish/v1/AccountService/Accounts/" + path.substr(lastIndex)}}); } }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); } void doPost(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); std::string username; std::string password; std::optional roleId("User"); std::optional enabled = true; if (!json_util::readJson(req, res, "UserName", username, "Password", password, "RoleId", roleId, "Enabled", enabled)) { return; } std::string priv = getPrivilegeFromRoleId(*roleId); if (priv.empty()) { messages::propertyValueNotInList(asyncResp->res, *roleId, "RoleId"); return; } roleId = priv; // Reading AllGroups property crow::connections::systemBus->async_method_call( [asyncResp, username, password{std::move(password)}, roleId, enabled](const boost::system::error_code ec, const std::variant>& allGroups) { if (ec) { BMCWEB_LOG_DEBUG << "ERROR with async_method_call"; messages::internalError(asyncResp->res); return; } const std::vector* allGroupsList = std::get_if>(&allGroups); if (allGroupsList == nullptr || allGroupsList->empty()) { messages::internalError(asyncResp->res); return; } crow::connections::systemBus->async_method_call( [asyncResp, username, password{std::move(password)}]( const boost::system::error_code ec) { if (ec) { messages::resourceAlreadyExists( asyncResp->res, "#ManagerAccount.v1_0_3.ManagerAccount", "UserName", username); return; } if (!pamUpdatePassword(username, password)) { // At this point we have a user that's been created, // but the password set failed.Something is wrong, // so delete the user that we've already created crow::connections::systemBus->async_method_call( [asyncResp]( const boost::system::error_code ec) { if (ec) { messages::internalError(asyncResp->res); return; } messages::invalidObject(asyncResp->res, "Password"); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user/" + username, "xyz.openbmc_project.Object.Delete", "Delete"); BMCWEB_LOG_ERROR << "pamUpdatePassword Failed"; return; } messages::created(asyncResp->res); asyncResp->res.addHeader( "Location", "/redfish/v1/AccountService/Accounts/" + username); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "xyz.openbmc_project.User.Manager", "CreateUser", username, *allGroupsList, *roleId, *enabled); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.Properties", "Get", "xyz.openbmc_project.User.Manager", "AllGroups"); } }; class ManagerAccount : public Node { public: ManagerAccount(CrowApp& app) : Node(app, "/redfish/v1/AccountService/Accounts//", std::string()) { entityPrivileges = { {boost::beast::http::verb::get, {{"ConfigureUsers"}, {"ConfigureManager"}, {"ConfigureSelf"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureUsers"}}}, {boost::beast::http::verb::put, {{"ConfigureUsers"}}}, {boost::beast::http::verb::delete_, {{"ConfigureUsers"}}}, {boost::beast::http::verb::post, {{"ConfigureUsers"}}}}; } private: void doGet(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); if (params.size() != 1) { messages::internalError(asyncResp->res); return; } crow::connections::systemBus->async_method_call( [asyncResp, accountName{std::string(params[0])}]( const boost::system::error_code ec, const ManagedObjectType& users) { if (ec) { messages::internalError(asyncResp->res); return; } auto userIt = users.begin(); for (; userIt != users.end(); userIt++) { if (boost::ends_with(userIt->first.str, "/" + accountName)) { break; } } if (userIt == users.end()) { messages::resourceNotFound(asyncResp->res, "ManagerAccount", accountName); return; } asyncResp->res.jsonValue = { {"@odata.context", "/redfish/v1/$metadata#ManagerAccount.ManagerAccount"}, {"@odata.type", "#ManagerAccount.v1_0_3.ManagerAccount"}, {"Name", "User Account"}, {"Description", "User Account"}, {"Password", nullptr}}; for (const auto& interface : userIt->second) { if (interface.first == "xyz.openbmc_project.User.Attributes") { for (const auto& property : interface.second) { if (property.first == "UserEnabled") { const bool* userEnabled = std::get_if(&property.second); if (userEnabled == nullptr) { BMCWEB_LOG_ERROR << "UserEnabled wasn't a bool"; messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue["Enabled"] = *userEnabled; } else if (property.first == "UserLockedForFailedAttempt") { const bool* userLocked = std::get_if(&property.second); if (userLocked == nullptr) { BMCWEB_LOG_ERROR << "UserLockedForF" "ailedAttempt " "wasn't a bool"; messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue["Locked"] = *userLocked; asyncResp->res.jsonValue ["Locked@Redfish.AllowableValues"] = { "false"}; } else if (property.first == "UserPrivilege") { const std::string* userPrivPtr = std::get_if(&property.second); if (userPrivPtr == nullptr) { BMCWEB_LOG_ERROR << "UserPrivilege wasn't a " "string"; messages::internalError(asyncResp->res); return; } std::string role = getRoleIdFromPrivilege(*userPrivPtr); if (role.empty()) { BMCWEB_LOG_ERROR << "Invalid user role"; messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue["RoleId"] = role; asyncResp->res.jsonValue["Links"]["Role"] = { {"@odata.id", "/redfish/v1/AccountService/" "Roles/" + role}}; } } } } asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/AccountService/Accounts/" + accountName; asyncResp->res.jsonValue["Id"] = accountName; asyncResp->res.jsonValue["UserName"] = accountName; }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); } void doPatch(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); if (params.size() != 1) { messages::internalError(asyncResp->res); return; } std::optional newUserName; std::optional password; std::optional enabled; std::optional roleId; std::optional locked; if (!json_util::readJson(req, res, "UserName", newUserName, "Password", password, "RoleId", roleId, "Enabled", enabled, "Locked", locked)) { return; } const std::string& username = params[0]; if (!newUserName) { // If the username isn't being updated, we can update the // properties directly updateUserProperties(asyncResp, username, password, enabled, roleId, locked); return; } else { crow::connections::systemBus->async_method_call( [this, asyncResp, username, password(std::move(password)), roleId(std::move(roleId)), enabled(std::move(enabled)), newUser{*newUserName}, locked(std::move(locked))]( const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; messages::resourceNotFound( asyncResp->res, "#ManagerAccount.v1_0_3.ManagerAccount", username); return; } updateUserProperties(asyncResp, newUser, password, enabled, roleId, locked); }, "xyz.openbmc_project.User.Manager", "/xyz/openbmc_project/user", "xyz.openbmc_project.User.Manager", "RenameUser", username, *newUserName); } } void updateUserProperties(std::shared_ptr asyncResp, const std::string& username, std::optional password, std::optional enabled, std::optional roleId, std::optional locked) { if (password) { if (!pamUpdatePassword(username, *password)) { BMCWEB_LOG_ERROR << "pamUpdatePassword Failed"; messages::internalError(asyncResp->res); return; } } std::string dbusObjectPath = "/xyz/openbmc_project/user/" + username; dbus::utility::escapePathForDbus(dbusObjectPath); dbus::utility::checkDbusPathExists( dbusObjectPath, [dbusObjectPath(std::move(dbusObjectPath)), username, password(std::move(password)), roleId(std::move(roleId)), enabled(std::move(enabled)), locked(std::move(locked)), asyncResp{std::move(asyncResp)}](int rc) { if (!rc) { messages::invalidObject(asyncResp->res, username.c_str()); return; } if (enabled) { crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); return; }, "xyz.openbmc_project.User.Manager", dbusObjectPath.c_str(), "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.User.Attributes", "UserEnabled", std::variant{*enabled}); } if (roleId) { std::string priv = getPrivilegeFromRoleId(*roleId); if (priv.empty()) { messages::propertyValueNotInList(asyncResp->res, *roleId, "RoleId"); return; } crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); }, "xyz.openbmc_project.User.Manager", dbusObjectPath.c_str(), "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.User.Attributes", "UserPrivilege", std::variant{priv}); } if (locked) { // admin can unlock the account which is locked by // successive authentication failures but admin should // not be allowed to lock an account. if (*locked) { messages::propertyValueNotInList(asyncResp->res, "true", "Locked"); return; } crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); return; }, "xyz.openbmc_project.User.Manager", dbusObjectPath.c_str(), "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.User.Attributes", "UserLockedForFailedAttempt", sdbusplus::message::variant{*locked}); } }); } void doDelete(crow::Response& res, const crow::Request& req, const std::vector& params) override { auto asyncResp = std::make_shared(res); if (params.size() != 1) { messages::internalError(asyncResp->res); return; } const std::string userPath = "/xyz/openbmc_project/user/" + params[0]; crow::connections::systemBus->async_method_call( [asyncResp, username{std::move(params[0])}]( const boost::system::error_code ec) { if (ec) { messages::resourceNotFound( asyncResp->res, "#ManagerAccount.v1_0_3.ManagerAccount", username); return; } messages::accountRemoved(asyncResp->res); }, "xyz.openbmc_project.User.Manager", userPath, "xyz.openbmc_project.Object.Delete", "Delete"); } }; } // namespace redfish