2019-08-06 21:42:46 +00:00
|
|
|
<?php namespace BookStack\Auth\Access;
|
|
|
|
|
|
|
|
use BookStack\Auth\Access;
|
|
|
|
use BookStack\Auth\User;
|
|
|
|
use BookStack\Auth\UserRepo;
|
|
|
|
use BookStack\Exceptions\SamlException;
|
|
|
|
use Illuminate\Contracts\Auth\Authenticatable;
|
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class Saml2Service
|
|
|
|
* Handles any app-specific SAML tasks.
|
|
|
|
* @package BookStack\Services
|
|
|
|
*/
|
2019-08-07 10:07:21 +00:00
|
|
|
class Saml2Service extends Access\ExternalAuthService
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
|
|
|
protected $config;
|
|
|
|
protected $userRepo;
|
|
|
|
protected $user;
|
|
|
|
protected $enabled;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Saml2Service constructor.
|
|
|
|
* @param \BookStack\Auth\UserRepo $userRepo
|
|
|
|
*/
|
|
|
|
public function __construct(UserRepo $userRepo, User $user)
|
|
|
|
{
|
|
|
|
$this->config = config('services.saml');
|
|
|
|
$this->userRepo = $userRepo;
|
|
|
|
$this->user = $user;
|
|
|
|
$this->enabled = config('saml2_settings.enabled') === true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if groups should be synced.
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function shouldSyncGroups()
|
|
|
|
{
|
|
|
|
return $this->enabled && $this->config['user_to_groups'] !== false;
|
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
/** Calculate the display name
|
|
|
|
* @param array $samlAttributes
|
|
|
|
* @param string $defaultValue
|
|
|
|
* @return string
|
2019-08-06 21:42:46 +00:00
|
|
|
*/
|
2019-08-07 10:07:21 +00:00
|
|
|
protected function getUserDisplayName(array $samlAttributes, string $defaultValue)
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
|
|
|
$displayNameAttr = $this->config['display_name_attribute'];
|
|
|
|
|
|
|
|
$displayName = [];
|
|
|
|
foreach ($displayNameAttr as $dnAttr) {
|
|
|
|
$dnComponent = $this->getSamlResponseAttribute($samlAttributes, $dnAttr, null);
|
|
|
|
if ($dnComponent !== null) {
|
|
|
|
$displayName[] = $dnComponent;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (count($displayName) == 0) {
|
2019-08-07 10:07:21 +00:00
|
|
|
$displayName = $defaultValue;
|
2019-08-06 21:42:46 +00:00
|
|
|
} else {
|
|
|
|
$displayName = implode(' ', $displayName);
|
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
return $displayName;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function getUserName(array $samlAttributes, string $defaultValue)
|
|
|
|
{
|
|
|
|
$userNameAttr = $this->config['user_name_attribute'];
|
|
|
|
|
|
|
|
if ($userNameAttr === null) {
|
|
|
|
$userName = $defaultValue;
|
|
|
|
} else {
|
|
|
|
$userName = $this->getSamlResponseAttribute($samlAttributes, $userNameAttr, $defaultValue);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $userName;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extract the details of a user from a SAML response.
|
|
|
|
* @param $samlID
|
|
|
|
* @param $samlAttributes
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getUserDetails($samlID, $samlAttributes)
|
|
|
|
{
|
|
|
|
$emailAttr = $this->config['email_attribute'];
|
|
|
|
$userName = $this->getUserName($samlAttributes, $samlID);
|
|
|
|
|
2019-08-06 21:42:46 +00:00
|
|
|
return [
|
|
|
|
'uid' => $userName,
|
2019-08-07 10:07:21 +00:00
|
|
|
'name' => $this->getUserDisplayName($samlAttributes, $userName),
|
2019-08-06 21:42:46 +00:00
|
|
|
'dn' => $samlID,
|
2019-08-07 10:07:21 +00:00
|
|
|
'email' => $this->getSamlResponseAttribute($samlAttributes, $emailAttr, null),
|
2019-08-06 21:42:46 +00:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the groups a user is a part of from the SAML response.
|
|
|
|
* @param array $samlAttributes
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getUserGroups($samlAttributes)
|
|
|
|
{
|
|
|
|
$groupsAttr = $this->config['group_attribute'];
|
|
|
|
$userGroups = $samlAttributes[$groupsAttr];
|
|
|
|
|
|
|
|
if (!is_array($userGroups)) {
|
|
|
|
$userGroups = [];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $userGroups;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a property from an SAML response.
|
|
|
|
* Handles properties potentially being an array.
|
|
|
|
* @param array $userDetails
|
|
|
|
* @param string $propertyKey
|
|
|
|
* @param $defaultValue
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
protected function getSamlResponseAttribute(array $samlAttributes, string $propertyKey, $defaultValue)
|
|
|
|
{
|
|
|
|
if (isset($samlAttributes[$propertyKey])) {
|
|
|
|
$data = $samlAttributes[$propertyKey];
|
2019-08-07 10:07:21 +00:00
|
|
|
if (is_array($data)) {
|
|
|
|
if (count($data) == 0) {
|
|
|
|
$data = $defaultValue;
|
|
|
|
} else if (count($data) == 1) {
|
|
|
|
$data = $data[0];
|
|
|
|
}
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
2019-08-07 10:07:21 +00:00
|
|
|
} else {
|
|
|
|
$data = $defaultValue;
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
return $data;
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
/**
|
|
|
|
* Register a user that is authenticated but not
|
|
|
|
* already registered.
|
|
|
|
* @param array $userDetails
|
|
|
|
* @return User
|
|
|
|
*/
|
|
|
|
protected function registerUser($userDetails)
|
|
|
|
{
|
2019-08-06 21:42:46 +00:00
|
|
|
// Create an array of the user data to create a new user instance
|
|
|
|
$userData = [
|
|
|
|
'name' => $userDetails['name'],
|
|
|
|
'email' => $userDetails['email'],
|
|
|
|
'password' => str_random(30),
|
|
|
|
'external_auth_id' => $userDetails['uid'],
|
|
|
|
'email_confirmed' => true,
|
|
|
|
];
|
|
|
|
|
|
|
|
$user = $this->user->forceCreate($userData);
|
|
|
|
$this->userRepo->attachDefaultRole($user);
|
|
|
|
$this->userRepo->downloadAndAssignUserAvatar($user);
|
|
|
|
return $user;
|
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
/**
|
|
|
|
* Get the user from the database for the specified details.
|
|
|
|
* @param array $userDetails
|
|
|
|
* @return User|null
|
|
|
|
*/
|
|
|
|
protected function getOrRegisterUser($userDetails)
|
|
|
|
{
|
|
|
|
$isRegisterEnabled = config('services.saml.auto_register') === true;
|
2019-08-06 21:42:46 +00:00
|
|
|
$user = $this->user
|
2019-08-07 10:07:21 +00:00
|
|
|
->where('external_auth_id', $userDetails['uid'])
|
|
|
|
->first();
|
2019-08-06 21:42:46 +00:00
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
if ($user === null && $isRegisterEnabled) {
|
|
|
|
$user = $this->registerUser($userDetails);
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return $user;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-08-07 10:07:21 +00:00
|
|
|
* Process the SAML response for a user. Login the user when
|
|
|
|
* they exist, optionally registering them automatically.
|
|
|
|
* @param string $samlID
|
|
|
|
* @param array $samlAttributes
|
2019-08-06 21:42:46 +00:00
|
|
|
*/
|
2019-08-07 10:07:21 +00:00
|
|
|
public function processLoginCallback($samlID, $samlAttributes)
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
2019-08-07 10:07:21 +00:00
|
|
|
$userDetails = $this->getUserDetails($samlID, $samlAttributes);
|
|
|
|
$isLoggedIn = auth()->check();
|
2019-08-06 21:42:46 +00:00
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
if ($isLoggedIn) {
|
|
|
|
logger()->error("Already logged in");
|
2019-08-06 21:42:46 +00:00
|
|
|
} else {
|
2019-08-07 10:07:21 +00:00
|
|
|
$user = $this->getOrRegisterUser($userDetails);
|
|
|
|
if ($user === null) {
|
|
|
|
logger()->error("User does not exist");
|
|
|
|
} else {
|
|
|
|
auth()->login($user);
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
return $user;
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
}
|