2018-09-25 07:30:50 -04:00
|
|
|
<?php namespace BookStack\Auth\Access;
|
2015-09-04 12:50:52 -04:00
|
|
|
|
2018-09-25 11:58:03 -04:00
|
|
|
use BookStack\Auth\SocialAccount;
|
|
|
|
use BookStack\Auth\UserRepo;
|
2015-09-10 14:31:09 -04:00
|
|
|
use BookStack\Exceptions\SocialDriverNotConfigured;
|
2018-09-25 11:58:03 -04:00
|
|
|
use BookStack\Exceptions\SocialSignInAccountNotUsed;
|
2015-09-10 14:31:09 -04:00
|
|
|
use BookStack\Exceptions\UserRegistrationException;
|
2019-09-13 18:58:40 -04:00
|
|
|
use Illuminate\Support\Str;
|
2018-09-25 11:58:03 -04:00
|
|
|
use Laravel\Socialite\Contracts\Factory as Socialite;
|
2018-09-21 13:05:06 -04:00
|
|
|
use Laravel\Socialite\Contracts\User as SocialUser;
|
2015-09-04 12:50:52 -04:00
|
|
|
|
|
|
|
class SocialAuthService
|
|
|
|
{
|
|
|
|
|
|
|
|
protected $userRepo;
|
|
|
|
protected $socialite;
|
2015-09-04 15:40:36 -04:00
|
|
|
protected $socialAccount;
|
2015-09-04 12:50:52 -04:00
|
|
|
|
2018-06-28 03:01:36 -04:00
|
|
|
protected $validSocialDrivers = ['google', 'github', 'facebook', 'slack', 'twitter', 'azure', 'okta', 'gitlab', 'twitch', 'discord'];
|
2015-09-04 12:50:52 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* SocialAuthService constructor.
|
2018-09-25 07:30:50 -04:00
|
|
|
* @param \BookStack\Auth\UserRepo $userRepo
|
2015-09-04 15:40:36 -04:00
|
|
|
* @param Socialite $socialite
|
|
|
|
* @param SocialAccount $socialAccount
|
2015-09-04 12:50:52 -04:00
|
|
|
*/
|
2015-09-04 15:40:36 -04:00
|
|
|
public function __construct(UserRepo $userRepo, Socialite $socialite, SocialAccount $socialAccount)
|
2015-09-04 12:50:52 -04:00
|
|
|
{
|
|
|
|
$this->userRepo = $userRepo;
|
|
|
|
$this->socialite = $socialite;
|
2015-09-04 15:40:36 -04:00
|
|
|
$this->socialAccount = $socialAccount;
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
|
|
|
|
2015-09-06 07:14:32 -04:00
|
|
|
|
2015-09-04 15:40:36 -04:00
|
|
|
/**
|
|
|
|
* Start the social login path.
|
2015-09-06 07:14:32 -04:00
|
|
|
* @param string $socialDriver
|
2015-09-04 15:40:36 -04:00
|
|
|
* @return \Symfony\Component\HttpFoundation\RedirectResponse
|
|
|
|
* @throws SocialDriverNotConfigured
|
|
|
|
*/
|
|
|
|
public function startLogIn($socialDriver)
|
2015-09-04 12:50:52 -04:00
|
|
|
{
|
|
|
|
$driver = $this->validateDriver($socialDriver);
|
2018-11-10 09:52:43 -05:00
|
|
|
return $this->getSocialDriver($driver)->redirect();
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-09-06 07:14:32 -04:00
|
|
|
* Start the social registration process
|
|
|
|
* @param string $socialDriver
|
|
|
|
* @return \Symfony\Component\HttpFoundation\RedirectResponse
|
|
|
|
* @throws SocialDriverNotConfigured
|
|
|
|
*/
|
|
|
|
public function startRegister($socialDriver)
|
|
|
|
{
|
|
|
|
$driver = $this->validateDriver($socialDriver);
|
2018-11-10 09:52:43 -05:00
|
|
|
return $this->getSocialDriver($driver)->redirect();
|
2015-09-06 07:14:32 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Handle the social registration process on callback.
|
2018-09-21 13:05:06 -04:00
|
|
|
* @param string $socialDriver
|
|
|
|
* @param SocialUser $socialUser
|
|
|
|
* @return SocialUser
|
2015-09-06 07:14:32 -04:00
|
|
|
* @throws UserRegistrationException
|
|
|
|
*/
|
2018-09-21 13:05:06 -04:00
|
|
|
public function handleRegistrationCallback(string $socialDriver, SocialUser $socialUser)
|
2015-09-06 07:14:32 -04:00
|
|
|
{
|
|
|
|
// Check social account has not already been used
|
|
|
|
if ($this->socialAccount->where('driver_id', '=', $socialUser->getId())->exists()) {
|
2016-12-04 11:51:39 -05:00
|
|
|
throw new UserRegistrationException(trans('errors.social_account_in_use', ['socialAccount'=>$socialDriver]), '/login');
|
2015-09-06 07:14:32 -04:00
|
|
|
}
|
|
|
|
|
2016-01-09 14:23:35 -05:00
|
|
|
if ($this->userRepo->getByEmail($socialUser->getEmail())) {
|
2015-09-06 07:14:32 -04:00
|
|
|
$email = $socialUser->getEmail();
|
2016-12-04 11:51:39 -05:00
|
|
|
throw new UserRegistrationException(trans('errors.social_account_in_use', ['socialAccount'=>$socialDriver, 'email' => $email]), '/login');
|
2015-09-06 07:14:32 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
return $socialUser;
|
|
|
|
}
|
|
|
|
|
2018-09-21 13:05:06 -04:00
|
|
|
/**
|
|
|
|
* Get the social user details via the social driver.
|
|
|
|
* @param string $socialDriver
|
|
|
|
* @return SocialUser
|
|
|
|
* @throws SocialDriverNotConfigured
|
|
|
|
*/
|
|
|
|
public function getSocialUser(string $socialDriver)
|
|
|
|
{
|
|
|
|
$driver = $this->validateDriver($socialDriver);
|
|
|
|
return $this->socialite->driver($driver)->user();
|
|
|
|
}
|
|
|
|
|
2015-09-06 07:14:32 -04:00
|
|
|
/**
|
|
|
|
* Handle the login process on a oAuth callback.
|
|
|
|
* @param $socialDriver
|
2018-09-21 13:05:06 -04:00
|
|
|
* @param SocialUser $socialUser
|
2015-09-06 07:14:32 -04:00
|
|
|
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
|
2018-09-21 13:05:06 -04:00
|
|
|
* @throws SocialSignInAccountNotUsed
|
2015-09-04 12:50:52 -04:00
|
|
|
*/
|
2018-09-21 13:05:06 -04:00
|
|
|
public function handleLoginCallback($socialDriver, SocialUser $socialUser)
|
2015-09-04 12:50:52 -04:00
|
|
|
{
|
2015-09-04 15:40:36 -04:00
|
|
|
$socialId = $socialUser->getId();
|
|
|
|
|
|
|
|
// Get any attached social accounts or users
|
|
|
|
$socialAccount = $this->socialAccount->where('driver_id', '=', $socialId)->first();
|
2015-09-05 07:29:47 -04:00
|
|
|
$isLoggedIn = auth()->check();
|
2016-09-29 07:43:46 -04:00
|
|
|
$currentUser = user();
|
2019-09-13 18:58:40 -04:00
|
|
|
$titleCaseDriver = Str::title($socialDriver);
|
2015-09-04 15:40:36 -04:00
|
|
|
|
2015-09-05 12:42:05 -04:00
|
|
|
// When a user is not logged in and a matching SocialAccount exists,
|
|
|
|
// Simply log the user into the application.
|
2015-09-04 15:40:36 -04:00
|
|
|
if (!$isLoggedIn && $socialAccount !== null) {
|
2017-09-14 15:20:47 -04:00
|
|
|
auth()->login($socialAccount->user);
|
|
|
|
return redirect()->intended('/');
|
2015-09-04 15:40:36 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// When a user is logged in but the social account does not exist,
|
|
|
|
// Create the social account and attach it to the user & redirect to the profile page.
|
|
|
|
if ($isLoggedIn && $socialAccount === null) {
|
|
|
|
$this->fillSocialAccount($socialDriver, $socialUser);
|
|
|
|
$currentUser->socialAccounts()->save($this->socialAccount);
|
2019-09-13 18:58:40 -04:00
|
|
|
session()->flash('success', trans('settings.users_social_connected', ['socialAccount' => $titleCaseDriver]));
|
2015-09-04 15:40:36 -04:00
|
|
|
return redirect($currentUser->getEditUrl());
|
|
|
|
}
|
|
|
|
|
|
|
|
// When a user is logged in and the social account exists and is already linked to the current user.
|
|
|
|
if ($isLoggedIn && $socialAccount !== null && $socialAccount->user->id === $currentUser->id) {
|
2019-09-13 18:58:40 -04:00
|
|
|
session()->flash('error', trans('errors.social_account_existing', ['socialAccount' => $titleCaseDriver]));
|
2015-09-04 15:40:36 -04:00
|
|
|
return redirect($currentUser->getEditUrl());
|
|
|
|
}
|
|
|
|
|
|
|
|
// When a user is logged in, A social account exists but the users do not match.
|
|
|
|
if ($isLoggedIn && $socialAccount !== null && $socialAccount->user->id != $currentUser->id) {
|
2019-09-13 18:58:40 -04:00
|
|
|
session()->flash('error', trans('errors.social_account_already_used_existing', ['socialAccount' => $titleCaseDriver]));
|
2015-09-05 12:42:05 -04:00
|
|
|
return redirect($currentUser->getEditUrl());
|
2015-09-04 15:40:36 -04:00
|
|
|
}
|
2015-09-04 12:50:52 -04:00
|
|
|
|
2015-09-05 12:42:05 -04:00
|
|
|
// Otherwise let the user know this social account is not used by anyone.
|
2019-09-13 18:58:40 -04:00
|
|
|
$message = trans('errors.social_account_not_used', ['socialAccount' => $titleCaseDriver]);
|
2019-12-22 08:17:14 -05:00
|
|
|
if (setting('registration-enabled') && config('auth.method') !== 'ldap') {
|
2019-09-13 18:58:40 -04:00
|
|
|
$message .= trans('errors.social_account_register_instructions', ['socialAccount' => $titleCaseDriver]);
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
2016-08-14 07:29:35 -04:00
|
|
|
|
2018-09-21 13:05:06 -04:00
|
|
|
throw new SocialSignInAccountNotUsed($message, '/login');
|
2015-09-04 15:40:36 -04:00
|
|
|
}
|
2015-09-04 12:50:52 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Ensure the social driver is correct and supported.
|
|
|
|
*
|
|
|
|
* @param $socialDriver
|
|
|
|
* @return string
|
|
|
|
* @throws SocialDriverNotConfigured
|
|
|
|
*/
|
|
|
|
private function validateDriver($socialDriver)
|
|
|
|
{
|
|
|
|
$driver = trim(strtolower($socialDriver));
|
|
|
|
|
2018-01-28 11:58:52 -05:00
|
|
|
if (!in_array($driver, $this->validSocialDrivers)) {
|
|
|
|
abort(404, trans('errors.social_driver_not_found'));
|
|
|
|
}
|
|
|
|
if (!$this->checkDriverConfigured($driver)) {
|
2019-09-13 18:58:40 -04:00
|
|
|
throw new SocialDriverNotConfigured(trans('errors.social_driver_not_configured', ['socialAccount' => Str::title($socialDriver)]));
|
2018-01-28 11:58:52 -05:00
|
|
|
}
|
2015-09-04 12:50:52 -04:00
|
|
|
|
|
|
|
return $driver;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check a social driver has been configured correctly.
|
|
|
|
* @param $driver
|
|
|
|
* @return bool
|
|
|
|
*/
|
2015-09-04 15:40:36 -04:00
|
|
|
private function checkDriverConfigured($driver)
|
2015-09-04 12:50:52 -04:00
|
|
|
{
|
2016-01-09 14:23:35 -05:00
|
|
|
$lowerName = strtolower($driver);
|
|
|
|
$configPrefix = 'services.' . $lowerName . '.';
|
|
|
|
$config = [config($configPrefix . 'client_id'), config($configPrefix . 'client_secret'), config('services.callback_url')];
|
|
|
|
return !in_array(false, $config) && !in_array(null, $config);
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the names of the active social drivers.
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getActiveDrivers()
|
|
|
|
{
|
|
|
|
$activeDrivers = [];
|
2017-02-05 10:28:53 -05:00
|
|
|
foreach ($this->validSocialDrivers as $driverKey) {
|
|
|
|
if ($this->checkDriverConfigured($driverKey)) {
|
|
|
|
$activeDrivers[$driverKey] = $this->getDriverName($driverKey);
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return $activeDrivers;
|
|
|
|
}
|
|
|
|
|
2017-02-05 10:28:53 -05:00
|
|
|
/**
|
|
|
|
* Get the presentational name for a driver.
|
|
|
|
* @param $driver
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getDriverName($driver)
|
|
|
|
{
|
|
|
|
return config('services.' . strtolower($driver) . '.name');
|
|
|
|
}
|
|
|
|
|
2015-09-04 15:40:36 -04:00
|
|
|
/**
|
2018-09-21 13:05:06 -04:00
|
|
|
* Check if the current config for the given driver allows auto-registration.
|
|
|
|
* @param string $driver
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function driverAutoRegisterEnabled(string $driver)
|
|
|
|
{
|
|
|
|
return config('services.' . strtolower($driver) . '.auto_register') === true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if the current config for the given driver allow email address auto-confirmation.
|
|
|
|
* @param string $driver
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function driverAutoConfirmEmailEnabled(string $driver)
|
|
|
|
{
|
|
|
|
return config('services.' . strtolower($driver) . '.auto_confirm') === true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $socialDriver
|
|
|
|
* @param SocialUser $socialUser
|
2015-09-06 07:14:32 -04:00
|
|
|
* @return SocialAccount
|
2015-09-04 15:40:36 -04:00
|
|
|
*/
|
2015-09-06 07:14:32 -04:00
|
|
|
public function fillSocialAccount($socialDriver, $socialUser)
|
2015-09-04 15:40:36 -04:00
|
|
|
{
|
|
|
|
$this->socialAccount->fill([
|
|
|
|
'driver' => $socialDriver,
|
|
|
|
'driver_id' => $socialUser->getId(),
|
|
|
|
'avatar' => $socialUser->getAvatar()
|
|
|
|
]);
|
2015-09-06 07:14:32 -04:00
|
|
|
return $this->socialAccount;
|
2015-09-04 15:40:36 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Detach a social account from a user.
|
|
|
|
* @param $socialDriver
|
|
|
|
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
|
|
|
|
*/
|
|
|
|
public function detachSocialAccount($socialDriver)
|
|
|
|
{
|
2016-09-29 07:43:46 -04:00
|
|
|
user()->socialAccounts()->where('driver', '=', $socialDriver)->delete();
|
2019-09-13 18:58:40 -04:00
|
|
|
session()->flash('success', trans('settings.users_social_disconnected', ['socialAccount' => Str::title($socialDriver)]));
|
2016-09-29 07:43:46 -04:00
|
|
|
return redirect(user()->getEditUrl());
|
2015-09-04 15:40:36 -04:00
|
|
|
}
|
2018-11-04 13:40:06 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Provide redirect options per service for the Laravel Socialite driver
|
2018-11-10 09:52:43 -05:00
|
|
|
* @param $driverName
|
|
|
|
* @return \Laravel\Socialite\Contracts\Provider
|
2018-11-04 13:40:06 -05:00
|
|
|
*/
|
2018-11-10 09:52:43 -05:00
|
|
|
public function getSocialDriver(string $driverName)
|
2018-11-04 13:40:06 -05:00
|
|
|
{
|
2018-11-10 09:52:43 -05:00
|
|
|
$driver = $this->socialite->driver($driverName);
|
|
|
|
|
|
|
|
if ($driverName === 'google' && config('services.google.select_account')) {
|
|
|
|
$driver->with(['prompt' => 'select_account']);
|
2018-11-04 13:40:06 -05:00
|
|
|
}
|
|
|
|
|
2018-11-10 09:52:43 -05:00
|
|
|
return $driver;
|
2018-11-04 13:40:06 -05:00
|
|
|
}
|
2018-01-28 11:58:52 -05:00
|
|
|
}
|