Refactor login/logout

Similar to what we've done elsewhere, move login and logout into their
own methods.  This reduces the amount of scopes that need to be read at
any given time.

Tested: At last commit in series.

Change-Id: Ia2aa8b3fcbed18d7a481876fe4ffd55f31120064
Signed-off-by: Ed Tanous <edtanous@google.com>

1 files changed, 171 insertions, 177 deletions

diff --git a/include/login_routes.hpp b/include/login_routes.hpp
index 2ed9951af2..b29abac00d 100644
--- a/include/login_routes.hpp
+++ b/include/login_routes.hpp
@@ -18,89 +18,61 @@ namespace crow
 namespace login_routes
 {
 
-inline void requestRoutes(App& app)
+inline void handleLogin(const crow::Request& req,
+                        const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
 {
-    BMCWEB_ROUTE(app, "/login")
-        .methods(boost::beast::http::verb::post)(
-            [](const crow::Request& req,
-               const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
-        MultipartParser parser;
-        std::string_view contentType = req.getHeaderValue("content-type");
-        std::string_view username;
-        std::string_view password;
-
-        bool looksLikePhosphorRest = false;
-
-        // This object needs to be declared at this scope so the strings
-        // within it are not destroyed before we can use them
-        nlohmann::json loginCredentials;
-        // Check if auth was provided by a payload
-        if (contentType.starts_with("application/json"))
+    MultipartParser parser;
+    std::string_view contentType = req.getHeaderValue("content-type");
+    std::string_view username;
+    std::string_view password;
+
+    bool looksLikePhosphorRest = false;
+
+    // This object needs to be declared at this scope so the strings
+    // within it are not destroyed before we can use them
+    nlohmann::json loginCredentials;
+    // Check if auth was provided by a payload
+    if (contentType.starts_with("application/json"))
+    {
+        loginCredentials = nlohmann::json::parse(req.body(), nullptr, false);
+        if (loginCredentials.is_discarded())
         {
-            loginCredentials = nlohmann::json::parse(req.body(), nullptr,
-                                                     false);
-            if (loginCredentials.is_discarded())
-            {
-                BMCWEB_LOG_DEBUG("Bad json in request");
-                asyncResp->res.result(boost::beast::http::status::bad_request);
-                return;
-            }
+            BMCWEB_LOG_DEBUG("Bad json in request");
+            asyncResp->res.result(boost::beast::http::status::bad_request);
+            return;
+        }
 
-            // check for username/password in the root object
-            // THis method is how intel APIs authenticate
-            nlohmann::json::iterator userIt = loginCredentials.find("username");
-            nlohmann::json::iterator passIt = loginCredentials.find("password");
-            if (userIt != loginCredentials.end() &&
-                passIt != loginCredentials.end())
+        // check for username/password in the root object
+        // THis method is how intel APIs authenticate
+        nlohmann::json::iterator userIt = loginCredentials.find("username");
+        nlohmann::json::iterator passIt = loginCredentials.find("password");
+        if (userIt != loginCredentials.end() &&
+            passIt != loginCredentials.end())
+        {
+            const std::string* userStr = userIt->get_ptr<const std::string*>();
+            const std::string* passStr = passIt->get_ptr<const std::string*>();
+            if (userStr != nullptr && passStr != nullptr)
             {
-                const std::string* userStr =
-                    userIt->get_ptr<const std::string*>();
-                const std::string* passStr =
-                    passIt->get_ptr<const std::string*>();
-                if (userStr != nullptr && passStr != nullptr)
-                {
-                    username = *userStr;
-                    password = *passStr;
-                }
+                username = *userStr;
+                password = *passStr;
             }
-            else
+        }
+        else
+        {
+            // Openbmc appears to push a data object that contains the
+            // same keys (username and password), attempt to use that
+            auto dataIt = loginCredentials.find("data");
+            if (dataIt != loginCredentials.end())
             {
-                // Openbmc appears to push a data object that contains the
-                // same keys (username and password), attempt to use that
-                auto dataIt = loginCredentials.find("data");
-                if (dataIt != loginCredentials.end())
+                // Some apis produce an array of value ["username",
+                // "password"]
+                if (dataIt->is_array())
                 {
-                    // Some apis produce an array of value ["username",
-                    // "password"]
-                    if (dataIt->is_array())
-                    {
-                        if (dataIt->size() == 2)
-                        {
-                            nlohmann::json::iterator userIt2 = dataIt->begin();
-                            nlohmann::json::iterator passIt2 = dataIt->begin() +
-                                                               1;
-                            looksLikePhosphorRest = true;
-                            if (userIt2 != dataIt->end() &&
-                                passIt2 != dataIt->end())
-                            {
-                                const std::string* userStr =
-                                    userIt2->get_ptr<const std::string*>();
-                                const std::string* passStr =
-                                    passIt2->get_ptr<const std::string*>();
-                                if (userStr != nullptr && passStr != nullptr)
-                                {
-                                    username = *userStr;
-                                    password = *passStr;
-                                }
-                            }
-                        }
-                    }
-                    else if (dataIt->is_object())
+                    if (dataIt->size() == 2)
                     {
-                        nlohmann::json::iterator userIt2 =
-                            dataIt->find("username");
-                        nlohmann::json::iterator passIt2 =
-                            dataIt->find("password");
+                        nlohmann::json::iterator userIt2 = dataIt->begin();
+                        nlohmann::json::iterator passIt2 = dataIt->begin() + 1;
+                        looksLikePhosphorRest = true;
                         if (userIt2 != dataIt->end() &&
                             passIt2 != dataIt->end())
                         {
@@ -116,129 +88,151 @@ inline void requestRoutes(App& app)
                         }
                     }
                 }
+                else if (dataIt->is_object())
+                {
+                    nlohmann::json::iterator userIt2 = dataIt->find("username");
+                    nlohmann::json::iterator passIt2 = dataIt->find("password");
+                    if (userIt2 != dataIt->end() && passIt2 != dataIt->end())
+                    {
+                        const std::string* userStr =
+                            userIt2->get_ptr<const std::string*>();
+                        const std::string* passStr =
+                            passIt2->get_ptr<const std::string*>();
+                        if (userStr != nullptr && passStr != nullptr)
+                        {
+                            username = *userStr;
+                            password = *passStr;
+                        }
+                    }
+                }
             }
         }
-        else if (contentType.starts_with("multipart/form-data"))
+    }
+    else if (contentType.starts_with("multipart/form-data"))
+    {
+        looksLikePhosphorRest = true;
+        ParserError ec = parser.parse(req);
+        if (ec != ParserError::PARSER_SUCCESS)
         {
-            looksLikePhosphorRest = true;
-            ParserError ec = parser.parse(req);
-            if (ec != ParserError::PARSER_SUCCESS)
+            // handle error
+            BMCWEB_LOG_ERROR("MIME parse failed, ec : {}",
+                             static_cast<int>(ec));
+            asyncResp->res.result(boost::beast::http::status::bad_request);
+            return;
+        }
+
+        for (const FormPart& formpart : parser.mime_fields)
+        {
+            boost::beast::http::fields::const_iterator it =
+                formpart.fields.find("Content-Disposition");
+            if (it == formpart.fields.end())
             {
-                // handle error
-                BMCWEB_LOG_ERROR("MIME parse failed, ec : {}",
-                                 static_cast<int>(ec));
+                BMCWEB_LOG_ERROR("Couldn't find Content-Disposition");
                 asyncResp->res.result(boost::beast::http::status::bad_request);
-                return;
+                continue;
             }
 
-            for (const FormPart& formpart : parser.mime_fields)
-            {
-                boost::beast::http::fields::const_iterator it =
-                    formpart.fields.find("Content-Disposition");
-                if (it == formpart.fields.end())
-                {
-                    BMCWEB_LOG_ERROR("Couldn't find Content-Disposition");
-                    asyncResp->res.result(
-                        boost::beast::http::status::bad_request);
-                    continue;
-                }
-
-                BMCWEB_LOG_INFO("Parsing value {}", it->value());
+            BMCWEB_LOG_INFO("Parsing value {}", it->value());
 
-                if (it->value() == "form-data; name=\"username\"")
-                {
-                    username = formpart.content;
-                }
-                else if (it->value() == "form-data; name=\"password\"")
-                {
-                    password = formpart.content;
-                }
-                else
-                {
-                    BMCWEB_LOG_INFO("Extra format, ignore it.{}", it->value());
-                }
+            if (it->value() == "form-data; name=\"username\"")
+            {
+                username = formpart.content;
+            }
+            else if (it->value() == "form-data; name=\"password\"")
+            {
+                password = formpart.content;
+            }
+            else
+            {
+                BMCWEB_LOG_INFO("Extra format, ignore it.{}", it->value());
             }
         }
-        else
+    }
+    else
+    {
+        // check if auth was provided as a headers
+        username = req.getHeaderValue("username");
+        password = req.getHeaderValue("password");
+    }
+
+    if (!username.empty() && !password.empty())
+    {
+        int pamrc = pamAuthenticateUser(username, password);
+        bool isConfigureSelfOnly = pamrc == PAM_NEW_AUTHTOK_REQD;
+        if ((pamrc != PAM_SUCCESS) && !isConfigureSelfOnly)
         {
-            // check if auth was provided as a headers
-            username = req.getHeaderValue("username");
-            password = req.getHeaderValue("password");
+            asyncResp->res.result(boost::beast::http::status::unauthorized);
         }
-
-        if (!username.empty() && !password.empty())
+        else
         {
-            int pamrc = pamAuthenticateUser(username, password);
-            bool isConfigureSelfOnly = pamrc == PAM_NEW_AUTHTOK_REQD;
-            if ((pamrc != PAM_SUCCESS) && !isConfigureSelfOnly)
+            auto session = persistent_data::SessionStore::getInstance()
+                               .generateUserSession(
+                                   username, req.ipAddress, std::nullopt,
+                                   persistent_data::PersistenceType::TIMEOUT,
+                                   isConfigureSelfOnly);
+
+            if (looksLikePhosphorRest)
             {
-                asyncResp->res.result(boost::beast::http::status::unauthorized);
+                // Phosphor-Rest requires a very specific login
+                // structure, and doesn't actually look at the status
+                // code.
+                // TODO(ed).... Fix that upstream
+
+                asyncResp->res.jsonValue["data"] =
+                    "User '" + std::string(username) + "' logged in";
+                asyncResp->res.jsonValue["message"] = "200 OK";
+                asyncResp->res.jsonValue["status"] = "ok";
+
+                asyncResp->res.addHeader(boost::beast::http::field::set_cookie,
+                                         "XSRF-TOKEN=" + session->csrfToken +
+                                             "; SameSite=Strict; Secure");
+                asyncResp->res.addHeader(
+                    boost::beast::http::field::set_cookie,
+                    "SESSION=" + session->sessionToken +
+                        "; SameSite=Strict; Secure; HttpOnly");
             }
             else
             {
-                auto session =
-                    persistent_data::SessionStore::getInstance()
-                        .generateUserSession(
-                            username, req.ipAddress, std::nullopt,
-                            persistent_data::PersistenceType::TIMEOUT,
-                            isConfigureSelfOnly);
-
-                if (looksLikePhosphorRest)
-                {
-                    // Phosphor-Rest requires a very specific login
-                    // structure, and doesn't actually look at the status
-                    // code.
-                    // TODO(ed).... Fix that upstream
-
-                    asyncResp->res.jsonValue["data"] =
-                        "User '" + std::string(username) + "' logged in";
-                    asyncResp->res.jsonValue["message"] = "200 OK";
-                    asyncResp->res.jsonValue["status"] = "ok";
-
-                    asyncResp->res.addHeader(
-                        boost::beast::http::field::set_cookie,
-                        "XSRF-TOKEN=" + session->csrfToken +
-                            "; SameSite=Strict; Secure");
-                    asyncResp->res.addHeader(
-                        boost::beast::http::field::set_cookie,
-                        "SESSION=" + session->sessionToken +
-                            "; SameSite=Strict; Secure; HttpOnly");
-                }
-                else
-                {
-                    // if content type is json, assume json token
-                    asyncResp->res.jsonValue["token"] = session->sessionToken;
-                }
+                // if content type is json, assume json token
+                asyncResp->res.jsonValue["token"] = session->sessionToken;
             }
         }
-        else
-        {
-            BMCWEB_LOG_DEBUG("Couldn't interpret password");
-            asyncResp->res.result(boost::beast::http::status::bad_request);
-        }
-        });
+    }
+    else
+    {
+        BMCWEB_LOG_DEBUG("Couldn't interpret password");
+        asyncResp->res.result(boost::beast::http::status::bad_request);
+    }
+}
+
+inline void handleLogout(const crow::Request& req,
+                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
+{
+    const auto& session = req.session;
+    if (session != nullptr)
+    {
+        asyncResp->res.jsonValue["data"] = "User '" + session->username +
+                                           "' logged out";
+        asyncResp->res.jsonValue["message"] = "200 OK";
+        asyncResp->res.jsonValue["status"] = "ok";
+
+        asyncResp->res.addHeader("Set-Cookie",
+                                 "SESSION="
+                                 "; SameSite=Strict; Secure; HttpOnly; "
+                                 "expires=Thu, 01 Jan 1970 00:00:00 GMT");
+        asyncResp->res.addHeader("Clear-Site-Data",
+                                 R"("cache","cookies","storage")");
+        persistent_data::SessionStore::getInstance().removeSession(session);
+    }
+}
+
+inline void requestRoutes(App& app)
+{
+    BMCWEB_ROUTE(app, "/login")
+        .methods(boost::beast::http::verb::post)(handleLogin);
 
     BMCWEB_ROUTE(app, "/logout")
-        .methods(boost::beast::http::verb::post)(
-            [](const crow::Request& req,
-               const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
-        const auto& session = req.session;
-        if (session != nullptr)
-        {
-            asyncResp->res.jsonValue["data"] = "User '" + session->username +
-                                               "' logged out";
-            asyncResp->res.jsonValue["message"] = "200 OK";
-            asyncResp->res.jsonValue["status"] = "ok";
-
-            asyncResp->res.addHeader("Set-Cookie",
-                                     "SESSION="
-                                     "; SameSite=Strict; Secure; HttpOnly; "
-                                     "expires=Thu, 01 Jan 1970 00:00:00 GMT");
-            asyncResp->res.addHeader("Clear-Site-Data",
-                                     R"("cache","cookies","storage")");
-            persistent_data::SessionStore::getInstance().removeSession(session);
-        }
-        });
+        .methods(boost::beast::http::verb::post)(handleLogout);
 }
 } // namespace login_routes
 } // namespace crow