Handle Redfish PasswordChangeRequired
This enhances BMCWeb authentication to recognize when the user's password is
correct but expired. The Redfish SessionService is enhanced to comply with
the Redfish PasswordChangeRequired spec which allows the session to be
created, but limits that sesion to changing the password only, and includes
the PasswordChangeRequired message in the response body.
Specifically, when the account's password is expired, a successful
authentication via the following interfaces will have these results:
- POST /redfish/v1/SessionService/Sessions -- follows Redfish spec
- POST /login -- creates a session limited to changing the password,
similar to Redfish
- Basic authentication -- continues to treat the password
change required condition as an authentication failure and gives no
indication the password is expired.
- Cookie auth -- works as before
- Token auth -- works as before
This patchset is intended to allow web applications to use the presence
of the Redfish PasswordChangeRequired message or the extendedMessage
field to trigger the password change dialog.
This does not implement the PasswordChangeRequired property in the
ManagerAccount resource.
This implements the Redfish privilege overrides associated with the
ConfigureSelf privilege. Specifically, this correctly implements the
Password property override, and the ManagerAccount Resource URI override.
When an API results in 403 Forbidden and the issuing session has the
PasswordChangeRequired condition, appropriate JSON is given.
Tested:
Yes, see https://github.com/openbmc/bmcweb/issues/103
No, did not run Redfish validator
Signed-off-by: Joseph Reynolds <joseph-reynolds@charter.net>
Change-Id: Ibbf5f6414ac55c0e7bea14c721f6db227b52fe40
diff --git a/include/token_authorization_middleware.hpp b/include/token_authorization_middleware.hpp
index 2ff3879..5842ae5 100644
--- a/include/token_authorization_middleware.hpp
+++ b/include/token_authorization_middleware.hpp
@@ -6,6 +6,7 @@
#include <crow/http_response.h>
#include <boost/container/flat_set.hpp>
+#include <error_messages.hpp>
#include <pam_authenticate.hpp>
#include <persistent_data_middleware.hpp>
#include <random>
@@ -129,7 +130,9 @@
BMCWEB_LOG_DEBUG << "[AuthMiddleware] Authenticating user: " << user;
- if (!pamAuthenticateUser(user, pass))
+ bool passwordChangeRequired = false;
+ if (!pamAuthenticateUser(user, pass, passwordChangeRequired) ||
+ passwordChangeRequired)
{
return nullptr;
}
@@ -141,7 +144,8 @@
// This whole flow needs to be revisited anyway, as we can't be
// calling directly into pam for every request
return persistent_data::SessionStore::getInstance().generateUserSession(
- user, crow::persistent_data::PersistenceType::SINGLE_REQUEST);
+ user, false,
+ crow::persistent_data::PersistenceType::SINGLE_REQUEST);
}
const std::shared_ptr<crow::persistent_data::UserSession>
@@ -380,14 +384,17 @@
if (!username.empty() && !password.empty())
{
- if (!pamAuthenticateUser(username, password))
+ bool passwordChangeRequired = false;
+ if (!pamAuthenticateUser(username, password,
+ passwordChangeRequired))
{
res.result(boost::beast::http::status::unauthorized);
}
else
{
auto session = persistent_data::SessionStore::getInstance()
- .generateUserSession(username);
+ .generateUserSession(
+ username, passwordChangeRequired);
if (looksLikeIbm)
{
@@ -421,6 +428,10 @@
// if content type is json, assume json token
res.jsonValue = {{"token", session->sessionToken}};
}
+ if (passwordChangeRequired)
+ {
+ crow::setPasswordChangeRequired(res, session->username);
+ }
}
}
else