Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-29 23:22:34 +01:00
Code Issues Releases Wiki Activity

LDAP groups sync to Bookstack roles.

Browse Source 
Closes #75
This commit is contained in:
Brennan Murphy 2018-07-02 17:09:39 +00:00
parent c2d6e98985
commit d640cc1eee
5 changed files with 350 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.env.example
View File

@ -67,6 +67,15 @@ LDAP_DN=false
LDAP_PASS=false LDAP_PASS=false
LDAP_USER_FILTER=false LDAP_USER_FILTER=false
LDAP_VERSION=false LDAP_VERSION=false
#do you want to sync LDAP groups to BookStack roles for a user
LDAP_USER_TO_GROUPS=false
#what is the LDAP attribute for group memberships
LDAP_GROUP_ATTRIBUTE="memberOf"
#what LDAP group should the user be a part of to be an admin on BookStack
LDAP_ADMIN_GROUP="Domain Admins"
#would you like to remove users from roles on bookstack if they do not match on LDAP
#if false, the ldap groups-roles sync will only add users to roles
LDAP_REMOVE_FROM_GROUPS=false
# Mail settings # Mail settings
MAIL_DRIVER=smtp MAIL_DRIVER=smtp

10
app/Http/Controllers/Auth/LoginController.php
View File

@ -5,6 +5,7 @@ namespace BookStack\Http\Controllers\Auth;
use BookStack\Exceptions\AuthException; use BookStack\Exceptions\AuthException;
use BookStack\Http\Controllers\Controller; use BookStack\Http\Controllers\Controller;
use BookStack\Repos\UserRepo; use BookStack\Repos\UserRepo;
use BookStack\Repos\LdapRepo;
use BookStack\Services\SocialAuthService; use BookStack\Services\SocialAuthService;
use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Foundation\Auth\AuthenticatesUsers; use Illuminate\Foundation\Auth\AuthenticatesUsers;
@ -96,7 +97,14 @@ class LoginController extends Controller
auth()->login($user); auth()->login($user);
} }
$path = session()->pull('url.intended', '/'); // ldap groups refresh
if (config('services.ldap.user_to_groups') !== false && $request->filled('username')) {
$ldapRepo = new LdapRepo($this->userRepo);
$ldapRepo->syncGroups($user,$request->input('username'));
}
$path = session()->pull('url.intended', '/');
$path = baseUrl($path, true); $path = baseUrl($path, true);
return redirect($path); return redirect($path);
} }

84
app/Repos/LdapRepo.php Normal file
View File

@ -0,0 +1,84 @@
<?php namespace BookStack\Repos;
use BookStack\Services\Ldap;
use BookStack\Services\LdapService;
use BookStack\Role;
use BookStack\Repos\UserRepo;
class LdapRepo
{
protected $ldap = null;
protected $ldapService = null;
protected $config;
/**
* LdapRepo constructor.
* @param \BookStack\Repos\UserRepo $userRepo
*/
public function __construct(UserRepo $userRepo)
{
$this->config = config('services.ldap');
if (config('auth.method') !== 'ldap') {
return false;
}
$this->ldapService = new LdapService(new Ldap);
$this->userRepo = $userRepo;
}
/**
* If there is no ldap connection, all methods calls to this library will return null
*/
public function __call($method, $arguments)
{
if ($this->ldap === null) {
return null;
}
return call_user_func_array(array($this,$method),$arguments);
}
/**
* Sync the LDAP groups to the user roles for the current user
* @param \BookStack\User $user
* @param string $userName
* @throws \BookStack\Exceptions\NotFoundException
*/
public function syncGroups($user,$userName)
{
$userLdapGroups = $this->ldapService->getUserGroups($userName);
$userLdapGroups = $this->groupNameFilter($userLdapGroups);
// get the ids for the roles from the names
$ldapGroupsAsRoles = Role::whereIn('name',$userLdapGroups)->pluck('id');
// sync groups
if ($this->config['remove_from_groups']) {
$user->roles()->sync($ldapGroupsAsRoles);
$this->userRepo->attachDefaultRole($user);
} else {
$user->roles()->syncWithoutDetaching($ldapGroupsAsRoles);
}
// make the user an admin?
if (in_array($this->config['admin'],$userLdapGroups)) {
$this->userRepo->attachSystemRole($user,'admin');
}
}
/**
* Filter to convert the groups from ldap to the format of the roles name on BookStack
* Spaces replaced with -, all lowercase letters
* @param array $groups
* @return array
*/
private function groupNameFilter($groups)
{
$return = [];
foreach ($groups as $groupName) {
$return[] = str_replace(' ', '-', strtolower($groupName));
}
return $return;
}
}

378
app/Services/LdapService.php
View File

@ -11,155 +11,263 @@ use Illuminate\Contracts\Auth\Authenticatable;
class LdapService class LdapService
{ {
protected $ldap; protected $ldap;
protected $ldapConnection; protected $ldapConnection;
protected $config; protected $config;
/** /**
* LdapService constructor. * LdapService constructor.
* @param Ldap $ldap * @param Ldap $ldap
*/ */
public function __construct(Ldap $ldap) public function __construct(Ldap $ldap)
{ {
$this->ldap = $ldap; $this->ldap = $ldap;
$this->config = config('services.ldap'); $this->config = config('services.ldap');
} }
/** /**
* Get the details of a user from LDAP using the given username. * Search for attributes for a specific user on the ldap
* User found via configurable user filter. * @param string $userName
* @param $userName * @param array $attributes
* @return array|null * @return null|array
* @throws LdapException * @throws LdapException
*/ */
public function getUserDetails($userName) private function getUserWithAttributes($userName,$attributes)
{ {
$ldapConnection = $this->getConnection(); $ldapConnection = $this->getConnection();
$this->bindSystemUser($ldapConnection); $this->bindSystemUser($ldapConnection);
// Find user // Find user
$userFilter = $this->buildFilter($this->config['user_filter'], ['user' => $userName]); $userFilter = $this->buildFilter($this->config['user_filter'], ['user' => $userName]);
$baseDn = $this->config['base_dn']; $baseDn = $this->config['base_dn'];
$emailAttr = $this->config['email_attribute'];
$followReferrals = $this->config['follow_referrals'] ? 1 : 0;
$this->ldap->setOption($ldapConnection, LDAP_OPT_REFERRALS, $followReferrals);
$users = $this->ldap->searchAndGetEntries($ldapConnection, $baseDn, $userFilter, ['cn', 'uid', 'dn', $emailAttr]);
if ($users['count'] === 0) {
return null;
}
$user = $users[0]; $followReferrals = $this->config['follow_referrals'] ? 1 : 0;
return [ $this->ldap->setOption($ldapConnection, LDAP_OPT_REFERRALS, $followReferrals);
'uid' => (isset($user['uid'])) ? $user['uid'][0] : $user['dn'], $users = $this->ldap->searchAndGetEntries($ldapConnection, $baseDn, $userFilter, $attributes);
'name' => $user['cn'][0], if ($users['count'] === 0) {
'dn' => $user['dn'], return null;
'email' => (isset($user[$emailAttr])) ? (is_array($user[$emailAttr]) ? $user[$emailAttr][0] : $user[$emailAttr]) : null }
];
}
/** return $users[0];
* @param Authenticatable $user }
* @param string $username
* @param string $password
* @return bool
* @throws LdapException
*/
public function validateUserCredentials(Authenticatable $user, $username, $password)
{
$ldapUser = $this->getUserDetails($username);
if ($ldapUser === null) {
return false;
}
if ($ldapUser['uid'] !== $user->external_auth_id) {
return false;
}
$ldapConnection = $this->getConnection(); /**
try { * Get the details of a user from LDAP using the given username.
$ldapBind = $this->ldap->bind($ldapConnection, $ldapUser['dn'], $password); * User found via configurable user filter.
} catch (\ErrorException $e) { * @param $userName
$ldapBind = false; * @return array|null
} * @throws LdapException
*/
public function getUserDetails($userName)
{
$emailAttr = $this->config['email_attribute'];
$user = $this->getUserWithAttributes($userName, ['cn', 'uid', 'dn', $emailAttr]);
return $ldapBind; if ($user === null) {
} return null;
}
/** return [
* Bind the system user to the LDAP connection using the given credentials 'uid' => (isset($user['uid'])) ? $user['uid'][0] : $user['dn'],
* otherwise anonymous access is attempted. 'name' => $user['cn'][0],
* @param $connection 'dn' => $user['dn'],
* @throws LdapException 'email' => (isset($user[$emailAttr])) ? (is_array($user[$emailAttr]) ? $user[$emailAttr][0] : $user[$emailAttr]) : null
*/ ];
protected function bindSystemUser($connection) }
{
$ldapDn = $this->config['dn'];
$ldapPass = $this->config['pass'];
$isAnonymous = ($ldapDn === false || $ldapPass === false); /**
if ($isAnonymous) { * @param Authenticatable $user
$ldapBind = $this->ldap->bind($connection); * @param string $username
} else { * @param string $password
$ldapBind = $this->ldap->bind($connection, $ldapDn, $ldapPass); * @return bool
} * @throws LdapException
*/
public function validateUserCredentials(Authenticatable $user, $username, $password)
{
$ldapUser = $this->getUserDetails($username);
if ($ldapUser === null) {
return false;
}
if ($ldapUser['uid'] !== $user->external_auth_id) {
return false;
}
if (!$ldapBind) { $ldapConnection = $this->getConnection();
throw new LdapException(($isAnonymous ? trans('errors.ldap_fail_anonymous') : trans('errors.ldap_fail_authed'))); try {
} $ldapBind = $this->ldap->bind($ldapConnection, $ldapUser['dn'], $password);
} } catch (\ErrorException $e) {
$ldapBind = false;
}
/** return $ldapBind;
* Get the connection to the LDAP server. }
* Creates a new connection if one does not exist.
* @return resource
* @throws LdapException
*/
protected function getConnection()
{
if ($this->ldapConnection !== null) {
return $this->ldapConnection;
}
// Check LDAP extension in installed /**
if (!function_exists('ldap_connect') && config('app.env') !== 'testing') { * Bind the system user to the LDAP connection using the given credentials
throw new LdapException(trans('errors.ldap_extension_not_installed')); * otherwise anonymous access is attempted.
} * @param $connection
* @throws LdapException
*/
protected function bindSystemUser($connection)
{
$ldapDn = $this->config['dn'];
$ldapPass = $this->config['pass'];
// Get port from server string and protocol if specified. $isAnonymous = ($ldapDn === false || $ldapPass === false);
$ldapServer = explode(':', $this->config['server']); if ($isAnonymous) {
$hasProtocol = preg_match('/^ldaps{0,1}\:\/\//', $this->config['server']) === 1; $ldapBind = $this->ldap->bind($connection);
if (!$hasProtocol) { } else {
array_unshift($ldapServer, ''); $ldapBind = $this->ldap->bind($connection, $ldapDn, $ldapPass);
} }
$hostName = $ldapServer[0] . ($hasProtocol?':':'') . $ldapServer[1];
$defaultPort = $ldapServer[0] === 'ldaps' ? 636 : 389;
$ldapConnection = $this->ldap->connect($hostName, count($ldapServer) > 2 ? intval($ldapServer[2]) : $defaultPort);
if ($ldapConnection === false) { if (!$ldapBind) {
throw new LdapException(trans('errors.ldap_cannot_connect')); throw new LdapException(($isAnonymous ? trans('errors.ldap_fail_anonymous') : trans('errors.ldap_fail_authed')));
} }
}
// Set any required options /**
if ($this->config['version']) { * Get the connection to the LDAP server.
$this->ldap->setVersion($ldapConnection, $this->config['version']); * Creates a new connection if one does not exist.
} * @return resource
* @throws LdapException
*/
protected function getConnection()
{
if ($this->ldapConnection !== null) {
return $this->ldapConnection;
}
$this->ldapConnection = $ldapConnection; // Check LDAP extension in installed
return $this->ldapConnection; if (!function_exists('ldap_connect') && config('app.env') !== 'testing') {
} throw new LdapException(trans('errors.ldap_extension_not_installed'));
}
/** // Get port from server string and protocol if specified.
* Build a filter string by injecting common variables. $ldapServer = explode(':', $this->config['server']);
* @param string $filterString $hasProtocol = preg_match('/^ldaps{0,1}\:\/\//', $this->config['server']) === 1;
* @param array $attrs if (!$hasProtocol) {
* @return string array_unshift($ldapServer, '');
*/ }
protected function buildFilter($filterString, array $attrs) $hostName = $ldapServer[0] . ($hasProtocol?':':'') . $ldapServer[1];
{ $defaultPort = $ldapServer[0] === 'ldaps' ? 636 : 389;
$newAttrs = []; $ldapConnection = $this->ldap->connect($hostName, count($ldapServer) > 2 ? intval($ldapServer[2]) : $defaultPort);
foreach ($attrs as $key => $attrText) {
$newKey = '${' . $key . '}'; if ($ldapConnection === false) {
$newAttrs[$newKey] = $attrText; throw new LdapException(trans('errors.ldap_cannot_connect'));
} }
return strtr($filterString, $newAttrs);
} // Set any required options
} if ($this->config['version']) {
$this->ldap->setVersion($ldapConnection, $this->config['version']);
}
$this->ldapConnection = $ldapConnection;
return $this->ldapConnection;
}
/**
* Build a filter string by injecting common variables.
* @param string $filterString
* @param array $attrs
* @return string
*/
protected function buildFilter($filterString, array $attrs)
{
$newAttrs = [];
foreach ($attrs as $key => $attrText) {
$newKey = '${' . $key . '}';
$newAttrs[$newKey] = $attrText;
}
return strtr($filterString, $newAttrs);
}
/**
* Get the groups a user is a part of on ldap
* @param string $userName
* @return array|null
*/
public function getUserGroups($userName)
{
$groupsAttr = $this->config['group_attribute'];
$user = $this->getUserWithAttributes($userName, [$groupsAttr]);
if ($user === null) {
return null;
}
$userGroups = $this->groupFilter($user);
$userGroups = $this->getGroupsRecursive($userGroups,[]);
return $userGroups;
}
/**
* Get the parent groups of an array of groups
* @param array $groupsArray
* @param array $checked
* @return array
*/
private function getGroupsRecursive($groupsArray,$checked) {
$groups_to_add = [];
foreach ($groupsArray as $groupName) {
if (in_array($groupName,$checked)) continue;
$groupsToAdd = $this->getGroupGroups($groupName);
$groups_to_add = array_merge($groups_to_add,$groupsToAdd);
$checked[] = $groupName;
}
$groupsArray = array_unique(array_merge($groupsArray,$groups_to_add), SORT_REGULAR);
if (!empty($groups_to_add)) {
return $this->getGroupsRecursive($groupsArray,$checked);
} else {
return $groupsArray;
}
}
/**
* Get the parent groups of a single group
* @param string $groupName
* @return array
*/
private function getGroupGroups($groupName)
{
$ldapConnection = $this->getConnection();
$this->bindSystemUser($ldapConnection);
$followReferrals = $this->config['follow_referrals'] ? 1 : 0;
$this->ldap->setOption($ldapConnection, LDAP_OPT_REFERRALS, $followReferrals);
$baseDn = $this->config['base_dn'];
$groupsAttr = strtolower($this->config['group_attribute']);
$groups = $this->ldap->searchAndGetEntries($ldapConnection, $baseDn, 'CN='.$groupName, [$groupsAttr]);
if ($groups['count'] === 0) {
return [];
}
$groupGroups = $this->groupFilter($groups[0]);
return $groupGroups;
}
/**
* Filter out LDAP CN and DN language in a ldap search return
* Gets the base CN (common name) of the string
* @param string $ldapSearchReturn
* @return array
*/
protected function groupFilter($ldapSearchReturn)
{
$groupsAttr = strtolower($this->config['group_attribute']);
$ldapGroups = [];
$count = 0;
if (isset($ldapSearchReturn[$groupsAttr]['count'])) $count = (int) $ldapSearchReturn[$groupsAttr]['count'];
for ($i=0;$i<$count;$i++) {
$dnComponents = ldap_explode_dn($ldapSearchReturn[$groupsAttr][$i],1);
if (!in_array($dnComponents[0],$ldapGroups)) {
$ldapGroups[] = $dnComponents[0];
}
}
return $ldapGroups;
}
}

6
config/services.php
View File

@ -118,6 +118,10 @@ return [
'version' => env('LDAP_VERSION', false), 'version' => env('LDAP_VERSION', false),
'email_attribute' => env('LDAP_EMAIL_ATTRIBUTE', 'mail'), 'email_attribute' => env('LDAP_EMAIL_ATTRIBUTE', 'mail'),
'follow_referrals' => env('LDAP_FOLLOW_REFERRALS', false), 'follow_referrals' => env('LDAP_FOLLOW_REFERRALS', false),
] 'user_to_groups' => env('LDAP_USER_TO_GROUPS',false),
'group_attribute' => env('LDAP_GROUP_ATTRIBUTE', 'memberOf'),
'admin' => env('LDAP_ADMIN_GROUP','Domain Admins'),
'remove_from_groups' => env('LDAP_REMOVE_FROM_GROUPS',false),
]
]; ];