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

Added support for optional audience and organization options for Auth0. #2004

Merged
merged 3 commits into from
Jun 21, 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
27 changes: 22 additions & 5 deletions docs/resource_owners/auth0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,28 @@ Next configure a resource owner of type `auth0` with appropriate `client_id`,
hwi_oauth:
resource_owners:
any_name:
type: auth0
client_id: <client_id>
client_secret: <client_secret>
base_url: https://<domain>
scope: <scope>
type: auth0
client_id: <client_id>
client_secret: <client_secret>
base_url: https://<domain>
scope: <scope>
```

Optionally, you can configure the `organization` and `audience` options when the login flow for the application requires this:
```yaml
# config/packages/hwi_oauth.yaml

hwi_oauth:
resource_owners:
any_name:
type: auth0
client_id: <client_id>
client_secret: <client_secret>
base_url: https://<domain>
scope: <scope>
options:
organization: <organization>
audience: <audience>
```

When you're done. Continue by configuring the security layer or go back to
Expand Down
21 changes: 21 additions & 0 deletions src/OAuth/ResourceOwner/Auth0ResourceOwner.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,22 @@ final class Auth0ResourceOwner extends GenericOAuth2ResourceOwner
'profilepicture' => 'picture',
];

/**
* {@inheritDoc}
*/
public function getAuthorizationUrl($redirectUri, array $extraParameters = []): string
{
if (!empty($this->options['organization'])) {
$extraParameters['organization'] = $this->options['organization'];
}

if (!empty($this->options['audience'])) {
$extraParameters['audience'] = $this->options['audience'];
}

return parent::getAuthorizationUrl($redirectUri, $extraParameters);
}

/**
* {@inheritdoc}
*/
Expand All @@ -55,6 +71,11 @@ protected function configureOptions(OptionsResolver $resolver)
'auth0_client' => $auth0Client,
]);

$resolver->setDefined([
'organization',
'audience',
]);

$resolver->setRequired([
'base_url',
]);
Expand Down
24 changes: 12 additions & 12 deletions src/OAuth/ResourceOwner/KeycloakResourceOwner.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ final class KeycloakResourceOwner extends GenericOAuth2ResourceOwner
public function getAuthorizationUrl($redirectUri, array $extraParameters = [])
{
return parent::getAuthorizationUrl($redirectUri, array_merge([
'approval_prompt' => $this->getOption('approval_prompt'),
'kc_idp_hint' => $this->getOption('idp_hint'),
'approval_prompt' => $this->getOption('approval_prompt'),
'kc_idp_hint' => $this->getOption('idp_hint'),
], $extraParameters));
}

Expand All @@ -44,19 +44,19 @@ protected function configureOptions(OptionsResolver $resolver)
parent::configureOptions($resolver);

$resolver->setDefaults([
'protocol' => 'openid-connect',
'scope' => 'openid email',
'response_type' => 'code',
'approval_prompt' => 'auto',
'authorization_url' => '{keycloak_url}/auth',
'access_token_url' => '{keycloak_url}/token',
'infos_url' => '{keycloak_url}/userinfo',
'idp_hint' => null,
'protocol' => 'openid-connect',
'scope' => 'openid email',
'response_type' => 'code',
'approval_prompt' => 'auto',
'authorization_url' => '{keycloak_url}/auth',
'access_token_url' => '{keycloak_url}/token',
'infos_url' => '{keycloak_url}/userinfo',
'idp_hint' => null,
]);

$resolver->setRequired([
'realm',
'base_url',
'realm',
'base_url',
]);

$normalizer = function (Options $options, $value) {
Expand Down
4 changes: 2 additions & 2 deletions tests/App/Form/RegistrationFormType.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ public function configureOptions(OptionsResolver $resolver): void
{
$resolver->setDefaults(
[
'data_class' => User::class,
'csrf_token_id' => 'registration',
'data_class' => User::class,
'csrf_token_id' => 'registration',
]
);
}
Expand Down
8 changes: 4 additions & 4 deletions tests/App/ResourceOwner/CustomResourceOwner.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ protected function configureOptions(OptionsResolver $resolver): void

$resolver->setDefaults(
[
'authorization_url' => '{base_url}/authorize',
'access_token_url' => '{base_url}/oauth/token',
'infos_url' => '{base_url}/userinfo',
]
'authorization_url' => '{base_url}/authorize',
'access_token_url' => '{base_url}/oauth/token',
'infos_url' => '{base_url}/userinfo',
]
);

$resolver->setRequired(['base_url']);
Expand Down
16 changes: 8 additions & 8 deletions tests/OAuth/ResourceOwner/KeycloakResourceOwnerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@
final class KeycloakResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase
{
protected array $options = [
'base_url' => 'http://keycloak.example.com/auth',
'realm' => 'example',
'client_id' => 'clientid',
'client_secret' => 'clientsecret',
'base_url' => 'http://keycloak.example.com/auth',
'realm' => 'example',
'client_id' => 'clientid',
'client_secret' => 'clientsecret',

'authorization_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/auth',
'access_token_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/token',
'infos_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/userinfo',
'authorization_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/auth',
'access_token_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/token',
'infos_url' => 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/userinfo',

'attr_name' => 'access_token',
'attr_name' => 'access_token',
];

protected string $authorizationUrlBasePart = 'http://keycloak.example.com/auth/realms/example/protocol/openid-connect/auth?response_type=code&client_id=clientid&scope=openid+email';
Expand Down
6 changes: 3 additions & 3 deletions tests/Security/Http/RefreshOnExpireTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ public function testTokenIsExpiredSuccessfulRefresh()
$this->resourceOwnerMock->expects($this->once())
->method('refreshAccessToken')
->willReturn([
'expires' => 666, // expired
'refresh_token' => 'refresh_token',
]);
'expires' => 666, // expired
'refresh_token' => 'refresh_token',
]);

$this->resourceOwnerMock->expects($this->once())
->method('getUserInformation')
Expand Down
Loading