Skip to content

Improve security by enabling the state and code_challenge parameters #11

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve security by enabling the state and code_challenge parameters #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
735d125
enable state parameter
xi Jan 7, 2025
32c5d62
enable code_challenge parameter
xi Jan 7, 2025
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
28 changes: 23 additions & 5 deletions Keycloak.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,28 @@ class Keycloak extends AbstractOAuth2Base
*
* @return string
*/
public function getEndpoint(string $endpoint)
public function getDiscovery(string $endpoint, $default = '')
{
if (!isset($this->discovery)) {
$plugin = plugin_load('helper', 'oauthkeycloak');
$json = file_get_contents($plugin->getConf('openidurl'));
if (!$json) throw new \Exception('Failed accessing ' . $plugin->getConf('openidurl'));
$this->discovery = json_decode($json, true);
}
if (!isset($this->discovery[$endpoint])) return '';
if (!isset($this->discovery[$endpoint])) return $default;
return $this->discovery[$endpoint];
}

/** @inheritdoc */
public function getAuthorizationEndpoint()
{
return new Uri($this->getEndpoint(self::ENDPOINT_AUTH));
return new Uri($this->getDiscovery(self::ENDPOINT_AUTH));
}

/** @inheritdoc */
public function getAccessTokenEndpoint()
{
return new Uri($this->getEndpoint(self::ENDPOINT_TOKEN));
return new Uri($this->getDiscovery(self::ENDPOINT_TOKEN));
}

/** @inheritdoc */
Expand All @@ -66,6 +66,24 @@ protected function getAuthorizationMethod()
return static::AUTHORIZATION_METHOD_HEADER_BEARER;
}

/** @inheritdoc */
public function needsStateParameterInAuthUrl()
{
return true;
}

/** @inheritdoc */
public function getCodeChallengeMethod()
{
$supported = $this->getDiscovery('code_challenge_methods_supported', []);
foreach (['S256', 'plain'] as $method) {
if (in_array($method, $supported)) {
return $method;
}
}
return null;
}

/**
* Logout from Keycloak
*
Expand All @@ -88,7 +106,7 @@ public function logout()
];

$this->httpClient->retrieveResponse(
new Uri($this->getEndpoint(self::ENDPOINT_LOGOUT)),
new Uri($this->getDiscovery(self::ENDPOINT_LOGOUT)),
$parameters,
$this->getExtraOAuthHeaders()
);
Expand Down