-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add github via OAuth2 auth as login method
- adds value for yform Formbuilder - adds settings file for oauth2_github - add special Provider for github - add documentation
- Loading branch information
Showing
9 changed files
with
415 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <?php | ||
|
|
||
| $settings = [ | ||
| 'clientId' => 'someJibberish', // Go to https://github.com/settings/apps and setup a Github app. Fill out, add return url, set scopes in Account permissions: Email addresses => Read only, Profile => Read and write | ||
| 'clientSecret' => 'moreJibbereish', // In your project at https://github.com/settings/apps, click on your created project and then "Generate a new client secret". | ||
| 'redirectUri' => 'https://your-url.com/maybe-a-subpage/?rex_ycom_auth_mode=oauth2_google&rex_ycom_auth_func=code', // do not fill out first and wait for the login error message to fill it out | ||
| ]; |
166 changes: 166 additions & 0 deletions
166
plugins/auth/lib/yform/trait_value_auth_oauth2_github.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| <?php | ||
|
|
||
| trait rex_yform_trait_value_auth_oauth2_github | ||
| { | ||
| /** | ||
| * @throws rex_exception | ||
| * @return array|string[] | ||
| */ | ||
| private function auth_loadSettings(): array | ||
| { | ||
| $SettingFile = $this->auth_ClassKey . '.php'; | ||
| $SettingsPath = rex_addon::get('ycom')->getDataPath($SettingFile); | ||
| if (!file_exists($SettingsPath)) { | ||
| throw new rex_exception($this->auth_ClassKey . '-Settings file not found [' . $SettingsPath . ']'); | ||
| } | ||
|
|
||
| $settings = []; | ||
| include $SettingsPath; | ||
| return $settings; | ||
| } | ||
|
|
||
| private function auth_getReturnTo(): string | ||
| { | ||
| $returnTos = []; | ||
| $returnTos[] = rex_request('returnTo', 'string'); // wenn returnTo übergeben wurde, diesen nehmen | ||
| $returnTos[] = rex_getUrl(rex_config::get('ycom/auth', 'article_id_jump_ok'), '', [], '&'); // Auth Ok -> article_id_jump_ok / Current Language will be selected | ||
| return rex_ycom_auth::getReturnTo($returnTos, ('' == $this->getElement(3)) ? [] : explode(',', $this->getElement(3))); | ||
| } | ||
|
|
||
| private function auth_FormOutput(string $url): void | ||
| { | ||
| if ($this->needsOutput()) { | ||
| $this->params['form_output'][$this->getId()] = $this->parse(['value.ycom_auth_' . $this->auth_ClassKey . '.tpl.php', 'value.ycom_auth_extern.tpl.php'], [ | ||
| 'url' => $url, | ||
| 'name' => '{{ ' . $this->auth_ClassKey . '_auth }}', | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| private function auth_redirectToFailed(string $message = ''): string | ||
| { | ||
| if ($this->params['debug']) { | ||
| dump($message); | ||
| return $message; | ||
| } | ||
| if ($this->auth_directLink) { | ||
| rex_response::sendCacheControl(); | ||
| rex_response::sendRedirect(rex_getUrl(rex_config::get('ycom/auth', 'article_id_jump_not_ok'))); | ||
| } | ||
| return ''; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<int|string, mixed> $Userdata | ||
| * @throws rex_exception | ||
| */ | ||
| private function auth_createOrUpdateYComUser(array $Userdata, string $returnTo): void | ||
| { | ||
| $defaultUserAttributes = []; | ||
| if ('' != $this->getElement(4)) { | ||
| if (null == $defaultUserAttributes = json_decode($this->getElement(4), true)) { | ||
| throw new rex_exception($this->auth_ClassKey . '-DefaultUserAttributes is not a json' . $this->getElement(4)); | ||
| } | ||
| } | ||
|
|
||
| $data = []; | ||
| $data['email'] = ''; | ||
| foreach (['User.email', 'emailAddress', 'email'] as $Key) { | ||
| if (isset($Userdata[$Key])) { | ||
| $data['email'] = is_array($Userdata[$Key]) ? implode(' ', $Userdata[$Key]) : $Userdata[$Key]; | ||
| } | ||
| } | ||
|
|
||
| $data['firstname'] = ''; | ||
| foreach (['login'] as $Key) { | ||
| if (isset($Userdata[$Key])) { | ||
| $data['firstname'] = is_array($Userdata[$Key]) ? implode(' ', $Userdata[$Key]) : $Userdata[$Key]; | ||
| } | ||
| } | ||
|
|
||
| $data['name'] = ''; | ||
| foreach (['name'] as $Key) { | ||
| if (isset($Userdata[$Key])) { | ||
| $data['name'] = is_array($Userdata[$Key]) ? implode(' ', $Userdata[$Key]) : $Userdata[$Key]; | ||
| } | ||
| } | ||
|
|
||
| $data['user_image'] = ''; | ||
| foreach (['avatar_url'] as $Key) { | ||
| if (isset($Userdata[$Key])) { | ||
| $data['user_image'] = is_array($Userdata[$Key]) ? implode(' ', $Userdata[$Key]) : $Userdata[$Key]; | ||
| } | ||
| } | ||
|
|
||
| foreach ($defaultUserAttributes as $defaultUserAttributeKey => $defaultUserAttributeValue) { | ||
| $data[$defaultUserAttributeKey] = $defaultUserAttributeValue; | ||
| } | ||
|
|
||
| $data = rex_extension::registerPoint(new rex_extension_point('YCOM_AUTH_MATCHING', $data, ['Userdata' => $Userdata, 'AuthType' => $this->auth_ClassKey])); | ||
|
|
||
| self::auth_clearUserSession(); | ||
|
|
||
| // not logged in - check if available | ||
| $params = [ | ||
| 'loginName' => $data['email'], | ||
| 'loginPassword' => '', | ||
| 'loginStay' => true, | ||
| 'filter' => 'status > 0', | ||
| 'ignorePassword' => true, | ||
| ]; | ||
|
|
||
| $loginStatus = rex_ycom_auth::login($params); | ||
| if (2 == $loginStatus) { | ||
| // already logged in | ||
| rex_ycom_user::updateUser($data); | ||
| rex_response::sendCacheControl(); | ||
| rex_response::sendRedirect($returnTo); | ||
| } | ||
|
|
||
| // if user not found, check if exists, but no permission | ||
| $user = rex_ycom_user::query()->where('email', $data['email'])->findOne(); | ||
| if ($user) { | ||
| $this->auth_redirectToFailed('{{ ' . $this->auth_ClassKey . '.error.ycom_login_failed }}'); | ||
| $this->params['warning_messages'][] = ('' != $this->getElement(2)) ? $this->getElement(2) : '{{ ' . $this->auth_ClassKey . '.error.ycom_login_failed }}'; | ||
| return; | ||
| } | ||
|
|
||
| $user = rex_ycom_user::createUserByEmail($data); | ||
| if (!$user || count($user->getMessages()) > 0) { | ||
| if ($user && $this->params['debug']) { | ||
| dump($user->getMessages()); | ||
| } | ||
| $this->auth_redirectToFailed('{{ ' . $this->auth_ClassKey . '.error.ycom_create_user }}'); | ||
| $this->params['warning_messages'][] = ('' != $this->getElement(2)) ? $this->getElement(2) : '{{ ' . $this->auth_ClassKey . '.error.ycom_create_user }}'; | ||
| return; | ||
| } | ||
|
|
||
| $params = []; | ||
| $params['loginName'] = $user->getValue('email'); | ||
| $params['ignorePassword'] = true; | ||
| $params['loginStay'] = false; | ||
| $params['filter'] = 'status > 0'; | ||
| $params['loginPassword'] = ''; | ||
| $loginStatus = rex_ycom_auth::login($params); | ||
|
|
||
| if (2 != $loginStatus) { | ||
| if ($this->params['debug']) { | ||
| dump($loginStatus); | ||
| dump($user); | ||
| } | ||
| $this->auth_redirectToFailed('{{ ' . $this->auth_ClassKey . '.error.ycom_login_created_user }}'); | ||
| $this->params['warning_messages'][] = ('' != $this->getElement(2)) ? $this->getElement(2) : '{{ ' . $this->auth_ClassKey . '.error.ycom_login_created_user }}'; | ||
| return; | ||
| } | ||
|
|
||
| rex_response::sendCacheControl(); | ||
| rex_response::sendRedirect($returnTo); | ||
| } | ||
|
|
||
| private function auth_clearUserSession(): void | ||
| { | ||
| foreach ($this->auth_SessionVars as $SessionKey) { | ||
| rex_ycom_auth::unsetSessionVar($SessionKey); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.