Skip to content

Commit

Permalink
Merge pull request #383 from LDAPAccountManager/feature/332_create-gr…
Browse files Browse the repository at this point in the history 
…oup-with-same-name

Feature/332 create group with same name
  • Loading branch information
@gruberroland
gruberroland authored Nov 6, 2024
2 parents 6394b59 + 929fe3f commit fc1cf2a
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 53 deletions.
1 change: 1 addition & 0 deletions lam/HISTORY
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
December 2024 9.0
- Unix users: allow to create group with same name via account profile (#332)
- Group of (unique) names, organisational roles: added member/owner count to PDF fields
- Usability improvements (350)
- LAM Pro:
Expand Down
16 changes: 16 additions & 0 deletions lam/lib/account.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,22 @@ function in_array_ignore_case($needle, $haystack) {
return false;
}

/**
* Sorts an array in natural order by its keys.
*
* @param array $toSort array to sort
* @return array sorted array
*/
function natCaseKeySort(array $toSort): array {
$keys = array_keys($toSort);
natcasesort($keys);
$newElements = [];
foreach ($keys as $key) {
$newElements[$key] = $toSort[$key];
}
return $newElements;
}

/**
* This function will return the days from 1.1.1970 until now.
*
Expand Down
2 changes: 1 addition & 1 deletion lam/lib/baseModule.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1240,7 +1240,7 @@ abstract class baseModule {
* The modification is aborted if an error message is returned.
*
* @param boolean $newAccount new account
* @param array $attributes LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)
* @param array $attributes LDAP attributes of this entry
* @return array array which contains status messages. Each entry is an array containing the status message parameters.
*/
public function preModifyActions($newAccount, &$attributes) {
Expand Down
138 changes: 86 additions & 52 deletions lam/lib/modules/posixAccount.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
*/
private const STATUS_REMOVE_GON_GROUPS = "POSIX_ACCOUNT_REMOVE_GON_GROUPS";

/**
* Marker for GID number to create a group with the same name
*/
private const CREATE_GROUP_WITH_SAME_NAME = '*create_group_with_same_name*';

/* These two variables keep an array of groups the user is also member of. */
/** current group list */
private $groups;
Expand Down Expand Up @@ -667,6 +672,40 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
// skip saving if the extension was not added/modified
return [];
}
if (isset($this->attributes['gidNumber'][0]) && ($this->attributes['gidNumber'][0] === self::CREATE_GROUP_WITH_SAME_NAME)) {
$newGroupName = $this->attributes['uid'][0];
$existingGid = $this->getGID($newGroupName);
if ($existingGid !== null) {
$this->attributes['gidNumber'][0] = $existingGid;
}
else {
$groupType = $this->getPosixGroupType();
$sessionKey = 'TMP' . generateRandomText();
$accountContainerTmp = new accountContainer($groupType, $sessionKey);
$_SESSION[$sessionKey] = &$accountContainerTmp;
$accountContainerTmp->new_account();
$posixGroupModule = $accountContainerTmp->getAccountModule('posixGroup');
$nextGid = $posixGroupModule->getNextGIDs(1, $errors, $groupType);
unset($_SESSION[$sessionKey]);
if ($nextGid !== null) {
$dnNewGroup = 'cn=' . $newGroupName . ',' . $groupType->getSuffix();
$attributesNewGroup = [
'cn' => [$newGroupName],
'gidNumber' => $nextGid[0],
'objectClass' => ['posixGroup'],
];
$newGroupSuccess = @ldap_add(getLDAPServerHandle(), $dnNewGroup, $attributesNewGroup);
if ($newGroupSuccess) {
logNewMessage(LOG_NOTICE, 'Created new group: ' . $newGroupName);
$this->attributes['gidNumber'][0] = $nextGid[0];
$this->groupCache = null;
}
else {
logNewMessage(LOG_ERR, 'Unable to create new group: ' . getDefaultLDAPErrorString(getLDAPServerHandle()));
}
}
}
}
$modules = $this->getAccountContainer()->get_type()->getModules();
// get default changes
$return = parent::save_attributes();
Expand Down Expand Up @@ -1331,36 +1370,6 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
$this->attributes[$this->getPasswordAttrName($modules)][0] = pwd_hash('x', true, $this->moduleSettings['posixAccount_pwdHash'][0]);
}
}
if (isset($_POST['posixAccount_createGroup'])
&& !$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hideCreateGroup')
&& ($this->get_scope() == 'user')
&& $this->getAccountContainer()->isNewAccount && get_preg($this->attributes['uid'][0], 'username')) {
$groupType = $this->getPosixGroupType();
$sessionKey = 'TMP' . generateRandomText();
$accountContainerTmp = new accountContainer($groupType, $sessionKey);
$_SESSION[$sessionKey] = &$accountContainerTmp;
$accountContainerTmp->new_account();
$posixGroupModule = $accountContainerTmp->getAccountModule('posixGroup');
$nextGid = $posixGroupModule->getNextGIDs(1, $errors, $groupType);
if ($nextGid !== null) {
$newGroupName = $this->attributes['uid'][0];
$dnNewGroup = 'cn=' . $newGroupName . ',' . $groupType->getSuffix();
$attributesNewGroup = [
'cn' => [$newGroupName],
'gidNumber' => $nextGid[0],
'objectClass' => ['posixGroup'],
];
$newGroupSuccess = @ldap_add(getLDAPServerHandle(), $dnNewGroup, $attributesNewGroup);
if ($newGroupSuccess) {
$errors[] = ['INFO', _('Created new group.'), htmlspecialchars($newGroupName)];
$this->attributes['gidNumber'][0] = $nextGid[0];
$this->groupCache = null;
}
else {
$errors[] = ['ERROR', _('Unable to create new group.'), getDefaultLDAPErrorString(getLDAPServerHandle())];
}
}
}
// Return error-messages
return $errors;
}
Expand Down Expand Up @@ -1714,12 +1723,19 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
if (!$this->isOptional($modules) || $this->skipObjectClass() || (isset($this->attributes['objectClass']) && in_array('posixAccount', $this->attributes['objectClass']))) {
$this->getAccountContainer()->replaceWildcardsInArray($this->getWildcardTargetAttributeNames(), $this->attributes);
$homeDirAttr = $this->getHomedirAttrName($modules);
$allowToCreateGroupWithUserName = ($this->get_scope() === 'user')
&& $this->getAccountContainer()->isNewAccount
&& !$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hideCreateGroup');
$groupList = $this->findGroups($modules); // list of all group names
$groups = [];
for ($i = 0; $i < sizeof($groupList); $i++) {
$groups[$groupList[$i][1]] = $groupList[$i][0];
}
if (count($groups) == 0) {
$groups = natCaseKeySort($groups);
if ($allowToCreateGroupWithUserName) {
$groups = [_('Create group with same name') => self::CREATE_GROUP_WITH_SAME_NAME] + $groups;
}
if (empty($groups)) {
$return->add(new htmlStatusMessage("ERROR", _('No Unix groups found in LDAP! Please create one first.')));
return $return;
}
Expand Down Expand Up @@ -1811,22 +1827,14 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
}
$primaryGroup = [];
if (isset($this->attributes['gidNumber'][0])) {
$primaryGroup[] = $this->attributes['gidNumber'][0];
$primaryGroup = [$this->attributes['gidNumber'][0]];
}
$gidNumberSelect = new htmlResponsiveSelect('gidNumber', $groups, $primaryGroup, _('Primary group'), 'gidNumber');
$gidNumberSelect->setHasDescriptiveElements(true);
$gidNumberSelect->setSortElements(false);
$return->add($gidNumberSelect);

if ($this->get_scope() == 'user') {
// new Unix group with same name
$posixGroupType = $this->getPosixGroupType();
if ($this->getAccountContainer()->isNewAccount
&& !$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hideCreateGroup')
&& ($posixGroupType !== null)
&& (!isset($this->attributes['uid'][0]) || !isset($groups[$this->attributes['uid'][0]]))) {
$return->addLabel(new htmlOutputText('&nbsp;', false));
$return->addField(new htmlButton('posixAccount_createGroup', _('Create group with same name')));
}
// additional groups
if (!$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hidegon') || !$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hideposixGroups')) {
$return->addLabel(new htmlOutputText(_('Additional groups')));
Expand Down Expand Up @@ -2135,16 +2143,26 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
$groupList = $this->findGroups($modules);
$groups = [];
for ($i = 0; $i < sizeof($groupList); $i++) {
$groups[] = $groupList[$i][1];
$groups[$groupList[$i][1]] = $groupList[$i][1];
}
$groups = natCaseKeySort($groups);
if ($this->get_scope() == 'user') {
$shelllist = $this->getShells(); // list of all valid shells
// primary Unix group
$return->add(new htmlResponsiveSelect('posixAccount_primaryGroup', $groups, [], _('Primary group'), 'gidNumber'));
$primaryGroups = $groups;
$allowToCreateGroupWithUserName = !$this->isBooleanConfigOptionSet('posixAccount_' . $typeId . '_hideCreateGroup');
if ($allowToCreateGroupWithUserName) {
$primaryGroups = [_('Create group with same name') => self::CREATE_GROUP_WITH_SAME_NAME] + $primaryGroups;
}
$primaryGroupSelect = new htmlResponsiveSelect('posixAccount_primaryGroup', $primaryGroups, [], _('Primary group'), 'gidNumber');
$primaryGroupSelect->setHasDescriptiveElements(true);
$primaryGroupSelect->setSortElements(false);
$return->add($primaryGroupSelect);
// additional group memberships
$addGroupSelect = new htmlResponsiveSelect('posixAccount_additionalGroup', $groups, [], _('Additional groups'), 'addgroup', 10);
$addGroupSelect->setMultiSelect(true);
$addGroupSelect->setTransformSingleSelect(false);
$addGroupSelect->setHasDescriptiveElements(true);
$addGroupSelect->setSortElements(false);
$return->add($addGroupSelect);
// group of names
if (self::areGroupOfNamesActive()) {
Expand All @@ -2168,6 +2186,7 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
// home directory
$return->add(new htmlResponsiveInputField(_('Home directory'), 'posixAccount_homeDirectory', '/home/$user', 'homeDirectory'));
// login shell
$shelllist = $this->getShells(); // list of all valid shells
$return->add(new htmlResponsiveSelect('posixAccount_loginShell', $shelllist, ["/bin/bash"], _('Login shell'), 'loginShell'));
// lamdaemon settings
if ($_SESSION['config']->get_scriptPath() != null) {
Expand All @@ -2182,7 +2201,10 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
}
elseif ($this->get_scope() == 'host') {
// primary Unix group
$return->add(new htmlResponsiveSelect('posixAccount_primaryGroup', $groups, [], _('Primary group'), 'gidNumber'));
$primaryGroupSelect = new htmlResponsiveSelect('posixAccount_primaryGroup', $groups, [], _('Primary group'), 'gidNumber');
$primaryGroupSelect->setHasDescriptiveElements(true);
$primaryGroupSelect->setSortElements(false);
$return->add($primaryGroupSelect);
}
if ($this->isOptional($modules)) {
$return->add(new htmlResponsiveInputCheckbox('posixAccount_addExt', false, _('Automatically add this extension'), 'autoAdd'));
Expand Down Expand Up @@ -2215,9 +2237,14 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
// special profile options
// GID
if (isset($profile['posixAccount_primaryGroup'][0])) {
$gid = $this->getGID($profile['posixAccount_primaryGroup'][0]);
if ($gid != null) {
$this->attributes['gidNumber'][0] = $gid;
if ($profile['posixAccount_primaryGroup'][0] === self::CREATE_GROUP_WITH_SAME_NAME) {
$this->attributes['gidNumber'][0] = self::CREATE_GROUP_WITH_SAME_NAME;
}
else {
$gid = $this->getGID($profile['posixAccount_primaryGroup'][0]);
if ($gid != null) {
$this->attributes['gidNumber'][0] = $gid;
}
}
}
// other group memberships
Expand Down Expand Up @@ -4138,11 +4165,18 @@ class posixAccount extends baseModule implements passwordService, AccountStatusP
$replacements['user'] = $this->attributes['uid'][0];
}
// group name
if (!empty($_POST['gidNumber'])) {
$replacements['group'] = $this->getGroupName($_POST['gidNumber']);
if (isset($this->attributes['gidNumber'][0]) && ($this->attributes['gidNumber'][0] === self::CREATE_GROUP_WITH_SAME_NAME)) {
if (isset($replacements['user'])) {
$replacements['group'] = $replacements['user'];
}
}
elseif (!empty($this->attributes['gidNumber'][0])) {
$replacements['group'] = $this->getGroupName($this->attributes['gidNumber'][0]);
else {
if (!empty($_POST['gidNumber'])) {
$replacements['group'] = $this->getGroupName($_POST['gidNumber']);
}
elseif (!empty($this->attributes['gidNumber'][0])) {
$replacements['group'] = $this->getGroupName($this->attributes['gidNumber'][0]);
}
}
return $replacements;
}
Expand Down

0 comments on commit fc1cf2a

Please sign in to comment.