Skip to content

add Microsoft AD FS support #110

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
christophvw wants to merge 1 commit into
base: 5.x-dev
Choose a base branch
from
Open

add Microsoft AD FS support #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 22 additions & 15 deletions Controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,21 +238,28 @@ public function callback()
$_SESSION['loginoidc_idtoken'] = empty($result->id_token) ? null : $result->id_token;
$_SESSION['loginoidc_auth'] = true;

$curl = curl_init();
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Authorization: Bearer " . $result->access_token,
"Accept: application/json",
"User-Agent: LoginOIDC-Matomo-Plugin"
));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $settings->userinfoUrl->getValue());
// request remote userinfo and remote user id
$response = curl_exec($curl);
curl_close($curl);
$result = json_decode($response);

$userinfoId = $settings->userinfoId->getValue();
$providerUserId = $result->$userinfoId;
if ($settings->getClaimsFromUserInfoEndpoint->getValue()) {
$curl = curl_init();
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Authorization: Bearer " . $result->access_token,
"Accept: application/json",
"User-Agent: LoginOIDC-Matomo-Plugin"
));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $settings->userinfoUrl->getValue());
// request remote userinfo and remote user id
$response = curl_exec($curl);
curl_close($curl);
$result = json_decode($response);

$userinfoId = $settings->userinfoId->getValue();
$providerUserId = $result->$userinfoId;
}
else {
$acc_token = json_decode(base64_decode(explode('.', $result->access_token)[1]));
$userinfoId = $settings->userinfoId->getValue();
$providerUserId = $acc_token->$userinfoId;
}

if (empty($providerUserId)) {
throw new Exception(Piwik::translate("LoginOIDC_ExceptionInvalidResponse"));
Expand Down
24 changes: 24 additions & 0 deletions SystemSettings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings
*/
public $autoLinking;

/**
* Get claims from UserInfo endpoint
*
* @var bool
*/
public $getClaimsFromUserInfoEndpoint;


/**
* The name of the oauth provider, which is also shown on the login screen.
*
Expand Down Expand Up @@ -152,6 +160,7 @@ protected function init()
$this->allowSignup = $this->createAllowSignupSetting();
$this->bypassTwoFa = $this->createBypassTwoFaSetting();
$this->autoLinking = $this->createAutoLinkingSetting();
$this->getClaimsFromUserInfoEndpoint = $this->createClaimsFromUserInfoEndpointSetting();
$this->authenticationName = $this->createAuthenticationNameSetting();
$this->authorizeUrl = $this->createAuthorizeUrlSetting();
$this->tokenUrl = $this->createTokenUrlSetting();
Expand Down Expand Up @@ -249,6 +258,21 @@ private function createAutoLinkingSetting() : SystemSetting
});
}

/**
* Add ClaimsFromUserInfoEndpoint setting.
*
* @return SystemSetting
*/
private function createClaimsFromUserInfoEndpointSetting() : SystemSetting
{
return $this->makeSetting("getClaimsFromUserInfoEndpoint", $default = true, FieldConfig::TYPE_BOOL, function(FieldConfig $field) {
$field->title = Piwik::translate("LoginOIDC_SettingGetClaimsFromUserinfoEndpoint");
$field->description = Piwik::translate("LoginOIDC_SettingGetClaimsFromUserinfoEndpointHelp");
$field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
});
}


/**
* Add authentication name setting.
*
Expand Down
2 changes: 2 additions & 0 deletions lang/de.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
"SettingAuthorizeUrlHelp": "z.B. https://<USERNAME>.eu.auth0.com/authorize",
"SettingTokenUrl": "Token URL",
"SettingTokenUrlHelp": "z.B. https://<USERNAME>.eu.auth0.com/oauth/token",
"SettingGetClaimsFromUserinfoEndpoint" : "Claims vom UserInfo Endpunkt beziehen",
"SettingGetClaimsFromUserinfoEndpointHelp" : "Bezieht die Claims vom UserInfo Endpunkt. Wird von MS AD FS nicht unterstützt.",
"SettingUserinfoUrl": "Userinfo URL",
"SettingUserinfoUrlHelp": "z.B. https://<USERNAME>.eu.auth0.com/userinfo",
"SettingEndSessionUrl": "Logout URL",
Expand Down
2 changes: 2 additions & 0 deletions lang/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"SettingAuthorizeUrlHelp": "e.g. https://<USERNAME>.eu.auth0.com/authorize",
"SettingTokenUrl": "Token URL",
"SettingTokenUrlHelp": "e.g. https://<USERNAME>.eu.auth0.com/oauth/token",
"SettingGetClaimsFromUserinfoEndpoint" : "Get claims from UserInfo endpoint",
"SettingGetClaimsFromUserinfoEndpointHelp" : "Get claims from UserInfo endpoint. Not supported by Microsoft AD FS.",
"SettingUserinfoUrl": "Userinfo URL",
"SettingUserinfoUrlHelp": "e.g. https://<USERNAME>.eu.auth0.com/userinfo",
"SettingEndSessionUrl": "Logout URL",
Expand Down
2 changes: 2 additions & 0 deletions lang/fr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
"SettingAuthorizeUrlHelp": "ex. https://<USERNAME>.eu.auth0.com/authorize",
"SettingTokenUrl": "URL Token",
"SettingTokenUrlHelp": "ex. https://<USERNAME>.eu.auth0.com/oauth/token",
"SettingGetClaimsFromUserinfoEndpoint" : "Get claims from UserInfo endpoint",
"SettingGetClaimsFromUserinfoEndpointHelp" : "Get claims from UserInfo endpoint. Not supported by Microsoft AD FS.",
"SettingUserinfoUrl": "URL Userinfo",
"SettingUserinfoUrlHelp": "ex. https://<USERNAME>.eu.auth0.com/userinfo",
"SettingEndSessionUrl": "URL Logout",
Expand Down