2019-08-06 21:42:46 +00:00
|
|
|
<?php namespace BookStack\Auth\Access;
|
|
|
|
|
|
|
|
use BookStack\Auth\User;
|
|
|
|
use BookStack\Auth\UserRepo;
|
|
|
|
use BookStack\Exceptions\SamlException;
|
2019-11-16 14:42:51 +00:00
|
|
|
use Illuminate\Support\Str;
|
2019-08-06 21:42:46 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Class Saml2Service
|
|
|
|
* Handles any app-specific SAML tasks.
|
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
class Saml2Service extends ExternalAuthService
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
|
|
|
protected $config;
|
|
|
|
protected $userRepo;
|
|
|
|
protected $user;
|
|
|
|
protected $enabled;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Saml2Service constructor.
|
|
|
|
*/
|
|
|
|
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.
|
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
protected function shouldSyncGroups(): bool
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
|
|
|
return $this->enabled && $this->config['user_to_groups'] !== false;
|
|
|
|
}
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
/**
|
|
|
|
* Calculate the display name
|
2019-08-06 21:42:46 +00:00
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
protected function getUserDisplayName(array $samlAttributes, string $defaultValue): string
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
2019-11-16 14:42:51 +00:00
|
|
|
$displayNameAttr = $this->config['display_name_attributes'];
|
2019-08-06 21:42:46 +00:00
|
|
|
|
|
|
|
$displayName = [];
|
|
|
|
foreach ($displayNameAttr as $dnAttr) {
|
2019-11-16 14:42:51 +00:00
|
|
|
$dnComponent = $this->getSamlResponseAttribute($samlAttributes, $dnAttr, null);
|
|
|
|
if ($dnComponent !== null) {
|
|
|
|
$displayName[] = $dnComponent;
|
|
|
|
}
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (count($displayName) == 0) {
|
2019-11-16 14:42:51 +00:00
|
|
|
$displayName = $defaultValue;
|
2019-08-06 21:42:46 +00:00
|
|
|
} else {
|
2019-11-16 14:42:51 +00:00
|
|
|
$displayName = implode(' ', $displayName);
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
return $displayName;
|
|
|
|
}
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
/**
|
|
|
|
* Get the value to use as the external id saved in BookStack
|
|
|
|
* used to link the user to an existing BookStack DB user.
|
|
|
|
*/
|
|
|
|
protected function getExternalId(array $samlAttributes, string $defaultValue)
|
2019-08-07 10:07:21 +00:00
|
|
|
{
|
2019-11-16 14:42:51 +00:00
|
|
|
$userNameAttr = $this->config['external_id_attribute'];
|
2019-08-07 10:07:21 +00:00
|
|
|
if ($userNameAttr === null) {
|
2019-11-16 14:42:51 +00:00
|
|
|
return $defaultValue;
|
2019-08-07 10:07:21 +00:00
|
|
|
}
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
return $this->getSamlResponseAttribute($samlAttributes, $userNameAttr, $defaultValue);
|
2019-08-07 10:07:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extract the details of a user from a SAML response.
|
2019-11-16 14:42:51 +00:00
|
|
|
* @throws SamlException
|
2019-08-07 10:07:21 +00:00
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
public function getUserDetails(string $samlID, $samlAttributes): array
|
2019-08-07 10:07:21 +00:00
|
|
|
{
|
|
|
|
$emailAttr = $this->config['email_attribute'];
|
2019-11-16 14:42:51 +00:00
|
|
|
$externalId = $this->getExternalId($samlAttributes, $samlID);
|
|
|
|
$email = $this->getSamlResponseAttribute($samlAttributes, $emailAttr, null);
|
|
|
|
|
|
|
|
if ($email === null) {
|
|
|
|
throw new SamlException(trans('errors.saml_no_email_address'));
|
|
|
|
}
|
2019-08-07 10:07:21 +00:00
|
|
|
|
2019-08-06 21:42:46 +00:00
|
|
|
return [
|
2019-11-16 14:42:51 +00:00
|
|
|
'external_id' => $externalId,
|
|
|
|
'name' => $this->getUserDisplayName($samlAttributes, $externalId),
|
|
|
|
'email' => $email,
|
|
|
|
'saml_id' => $samlID,
|
2019-08-06 21:42:46 +00:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the groups a user is a part of from the SAML response.
|
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
public function getUserGroups(array $samlAttributes): array
|
2019-08-06 21:42:46 +00:00
|
|
|
{
|
|
|
|
$groupsAttr = $this->config['group_attribute'];
|
2019-11-16 14:42:51 +00:00
|
|
|
$userGroups = $samlAttributes[$groupsAttr] ?? null;
|
2019-08-06 21:42:46 +00:00
|
|
|
|
|
|
|
if (!is_array($userGroups)) {
|
|
|
|
$userGroups = [];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $userGroups;
|
|
|
|
}
|
|
|
|
|
2019-08-07 13:31:10 +00:00
|
|
|
/**
|
|
|
|
* For an array of strings, return a default for an empty array,
|
|
|
|
* a string for an array with one element and the full array for
|
|
|
|
* more than one element.
|
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
protected function simplifyValue(array $data, $defaultValue)
|
|
|
|
{
|
2019-08-07 13:31:10 +00:00
|
|
|
switch (count($data)) {
|
|
|
|
case 0:
|
|
|
|
$data = $defaultValue;
|
|
|
|
break;
|
|
|
|
case 1:
|
|
|
|
$data = $data[0];
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
|
2019-08-06 21:42:46 +00:00
|
|
|
/**
|
|
|
|
* Get a property from an SAML response.
|
|
|
|
* Handles properties potentially being an array.
|
|
|
|
*/
|
|
|
|
protected function getSamlResponseAttribute(array $samlAttributes, string $propertyKey, $defaultValue)
|
|
|
|
{
|
|
|
|
if (isset($samlAttributes[$propertyKey])) {
|
2019-11-16 14:42:51 +00:00
|
|
|
return $this->simplifyValue($samlAttributes[$propertyKey], $defaultValue);
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
return $defaultValue;
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-08-07 10:07:21 +00:00
|
|
|
/**
|
2019-11-16 14:42:51 +00:00
|
|
|
* Register a user that is authenticated but not already registered.
|
2019-08-07 10:07:21 +00:00
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
protected function registerUser(array $userDetails): User
|
2019-08-07 10:07:21 +00:00
|
|
|
{
|
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'],
|
2019-11-16 15:24:09 +00:00
|
|
|
'email' => $userDetails['email'],
|
2019-11-16 14:42:51 +00:00
|
|
|
'password' => Str::random(32),
|
|
|
|
'external_auth_id' => $userDetails['external_id'],
|
2019-08-06 21:42:46 +00:00
|
|
|
'email_confirmed' => true,
|
|
|
|
];
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
// TODO - Handle duplicate email address scenario
|
2019-08-06 21:42:46 +00:00
|
|
|
$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.
|
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
protected function getOrRegisterUser(array $userDetails): ?User
|
2019-08-07 10:07:21 +00:00
|
|
|
{
|
|
|
|
$isRegisterEnabled = config('services.saml.auto_register') === true;
|
2019-08-06 21:42:46 +00:00
|
|
|
$user = $this->user
|
2019-11-16 14:42:51 +00:00
|
|
|
->where('external_auth_id', $userDetails['external_id'])
|
2019-08-07 10:07:21 +00:00
|
|
|
->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-11-16 14:42:51 +00:00
|
|
|
* Process the SAML response for a user. Login the user when
|
|
|
|
* they exist, optionally registering them automatically.
|
|
|
|
* @throws SamlException
|
2019-08-06 21:42:46 +00:00
|
|
|
*/
|
2019-11-16 14:42:51 +00:00
|
|
|
public function processLoginCallback(string $samlID, array $samlAttributes): User
|
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) {
|
2019-08-07 13:31:10 +00:00
|
|
|
throw new SamlException(trans('errors.saml_already_logged_in'), '/login');
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
|
2019-11-16 14:42:51 +00:00
|
|
|
$user = $this->getOrRegisterUser($userDetails);
|
|
|
|
if ($user === null) {
|
|
|
|
throw new SamlException(trans('errors.saml_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->shouldSyncGroups()) {
|
|
|
|
$groups = $this->getUserGroups($samlAttributes);
|
|
|
|
$this->syncWithGroups($user, $groups);
|
|
|
|
}
|
|
|
|
|
|
|
|
auth()->login($user);
|
2019-08-07 10:07:21 +00:00
|
|
|
return $user;
|
2019-08-06 21:42:46 +00:00
|
|
|
}
|
|
|
|
}
|