Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Oauth: Implement support for prompt_values_supported in .well-known/openid-configuration #11729

Merged
merged 2 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions changelog/unreleased/11729
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Enhancement: Support for prompt_values_supported in openid-configuration

We implemnted support for idp's to specify the supported prompt values.

https://github.com/owncloud/client/pull/11729
7 changes: 5 additions & 2 deletions src/common/utility.h
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,10 @@ OCSYNC_EXPORT Q_DECLARE_LOGGING_CATEGORY(lcUtility)
template <class E>
E stringToEnum(const char *key)
{
return static_cast<E>(QMetaEnum::fromType<E>().keyToValue(key));
bool ok;
auto out = static_cast<E>(QMetaEnum::fromType<E>().keyToValue(key, &ok));
Q_ASSERT(ok);
return out;
}

template <class E>
Expand All @@ -252,7 +255,7 @@ OCSYNC_EXPORT Q_DECLARE_LOGGING_CATEGORY(lcUtility)
template <class E>
QString enumToString(E value)
{
return QString::fromUtf8(QMetaEnum::fromType<E>().valueToKeys(value));
return QString::fromUtf8(QMetaEnum::fromType<E>().valueToKeys(static_cast<int>(value)));
}

template <class E = void>
Expand Down
39 changes: 37 additions & 2 deletions src/libsync/creds/oauth.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,20 @@ Q_LOGGING_CATEGORY(lcOauth, "sync.credentials.oauth", QtInfoMsg)

namespace {

static const QString wellKnownPathC = QStringLiteral("/.well-known/openid-configuration");
const QString wellKnownPathC = QStringLiteral("/.well-known/openid-configuration");

const auto defaultOauthPromtValue()
{
static const auto promptValue = [] {
OAuth::PromptValuesSupportedFlags out = OAuth::PromptValuesSupported::none;
// convert the legacy openIdConnectPrompt() to QFlags
for (const auto &x : Theme::instance()->openIdConnectPrompt().split(QLatin1Char(' '))) {
out |= Utility::stringToEnum<OAuth::PromptValuesSupported>(x);
}
return out;
}();
return promptValue;
}

QString renderHttpTemplate(const QString &title, const QString &content)
{
Expand Down Expand Up @@ -239,6 +252,7 @@ OAuth::OAuth(const QUrl &serverUrl, const QString &davUser, QNetworkAccessManage
, _clientId(Theme::instance()->oauthClientId())
, _clientSecret(Theme::instance()->oauthClientSecret())
, _redirectUrl(Theme::instance()->oauthLocalhost())
, _supportedPromtValues(defaultOauthPromtValue())
{
}

Expand Down Expand Up @@ -450,7 +464,7 @@ QUrl OAuth::authorisationLink() const
{QStringLiteral("redirect_uri"), QStringLiteral("%1:%2").arg(_redirectUrl, QString::number(_server.serverPort()))},
{QStringLiteral("code_challenge"), QString::fromLatin1(code_challenge)}, {QStringLiteral("code_challenge_method"), QStringLiteral("S256")},
{QStringLiteral("scope"), QString::fromUtf8(QUrl::toPercentEncoding(Theme::instance()->openIdConnectScopes()))},
{QStringLiteral("prompt"), QString::fromUtf8(QUrl::toPercentEncoding(Theme::instance()->openIdConnectPrompt()))},
{QStringLiteral("prompt"), QString::fromUtf8(QUrl::toPercentEncoding(toString(_supportedPromtValues)))},
{QStringLiteral("state"), QString::fromUtf8(_state)}};

if (!_davUser.isEmpty()) {
Expand Down Expand Up @@ -548,6 +562,16 @@ void OAuth::fetchWellKnown()
} else {
OC_ASSERT_X(false, qPrintable(QStringLiteral("Unsupported token_endpoint_auth_methods_supported: %1").arg(QDebug::toString(authMethods))));
}
const auto promtValuesSupported = data.value(QStringLiteral("prompt_values_supported")).toArray();
if (!promtValuesSupported.isEmpty()) {
_supportedPromtValues = PromptValuesSupported::none;
for (const auto &x : promtValuesSupported) {
const auto flag = Utility::stringToEnum<PromptValuesSupported>(x.toString());
// only use flags present in Theme::instance()->openIdConnectPrompt()
if (flag & defaultOauthPromtValue())
_supportedPromtValues |= flag;
}
}

qCDebug(lcOauth) << "parsing .well-known reply successful, auth endpoint" << _authEndpoint
<< "and token endpoint" << _tokenEndpoint
Expand Down Expand Up @@ -725,4 +749,15 @@ void AccountBasedOAuth::refreshAuthentication(const QString &refreshToken)
});
}

QString OCC::toString(OAuth::PromptValuesSupportedFlags s)
{
QStringList out;
for (auto k : {OAuth::PromptValuesSupported::consent, OAuth::PromptValuesSupported::select_account})
if (s & k) {
out += Utility::enumToString(k);
}
return out.join(QLatin1Char(' '));
}


#include "oauth.moc"
9 changes: 8 additions & 1 deletion src/libsync/creds/oauth.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,13 @@ class OWNCLOUDSYNC_EXPORT OAuth : public QObject
public:
enum Result { NotSupported, LoggedIn, Error, ErrorInsecureUrl };
Q_ENUM(Result)
enum class TokenEndpointAuthMethods { client_secret_basic, client_secret_post };
enum class TokenEndpointAuthMethods : char { client_secret_basic, client_secret_post };
Q_ENUM(TokenEndpointAuthMethods)

enum class PromptValuesSupported : char { none = 0, consent = 1 << 0, select_account = 1 << 1 };
Q_ENUM(PromptValuesSupported)
Q_DECLARE_FLAGS(PromptValuesSupportedFlags, PromptValuesSupported)

OAuth(const QUrl &serverUrl, const QString &davUser, QNetworkAccessManager *networkAccessManager, const QVariantMap &dynamicRegistrationData, QObject *parent);
~OAuth() override;

Expand Down Expand Up @@ -117,6 +121,7 @@ class OWNCLOUDSYNC_EXPORT OAuth : public QObject
QByteArray _state;

TokenEndpointAuthMethods _endpointAuthMethod = TokenEndpointAuthMethods::client_secret_basic;
PromptValuesSupportedFlags _supportedPromtValues = {PromptValuesSupported::consent, PromptValuesSupported::select_account};
};

/**
Expand Down Expand Up @@ -146,4 +151,6 @@ class OWNCLOUDSYNC_EXPORT AccountBasedOAuth : public OAuth
AccountPtr _account;
};

QString OWNCLOUDSYNC_EXPORT toString(OAuth::PromptValuesSupportedFlags s);
Q_DECLARE_OPERATORS_FOR_FLAGS(OAuth::PromptValuesSupportedFlags)
} // namespce OCC
Loading