mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-23 15:40:01 -06:00
34 Create FreeIPA CLI Plugin for the 389 Auto Membership plugin
Added new container in etc to hold the automembership configs. Modified constants to point to the new container Modified dsinstance to create the container Created automember.py to add the new commands Added xmlrpc test to verify functionality Added minor fix to user.py for constant behavior between memberof and automember https://fedorahosted.org/freeipa/ticket/1272
This commit is contained in:
Jr Aquino
Martin Kosek
parent
6b19b2dc89
commit
d05ace8fba
113
API.txt
113
API.txt
@ -99,6 +99,119 @@ option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_add
|
||||
args: 1,5,3
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: Str('description', attribute=True, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_add_condition
|
||||
args: 1,8,5
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: List('automemberinclusiveregex?', alwaysask=True, cli_name='inclusive_regex', label=Gettext('Inclusive Regex', domain='ipa', localedir=None), multivalue=True)
|
||||
option: List('automemberexclusiveregex?', alwaysask=True, cli_name='exclusive_regex', label=Gettext('Exclusive Regex', domain='ipa', localedir=None), multivalue=True)
|
||||
option: Str('key', flags=['no_create', 'no_update', 'no_search'], label=Gettext('Attribute Key', domain='ipa', localedir=None))
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
output: Output('failed', <type 'dict'>, Gettext('Conditions that could not be added', domain='ipa', localedir=None))
|
||||
output: Output('completed', <type 'int'>, Gettext('Number of conditions added', domain='ipa', localedir=None))
|
||||
command: automember_default_group_remove
|
||||
args: 0,5,3
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_default_group_set
|
||||
args: 0,6,3
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: Str('automemberdefaultgroup', cli_name='default_group', flags=['no_create', 'no_update'], label=Gettext('Default Group', domain='ipa', localedir=None))
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_default_group_show
|
||||
args: 0,4,3
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_del
|
||||
args: 1,1,3
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Output('result', <type 'dict'>, 'list of deletions that failed')
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_find
|
||||
args: 1,5,4
|
||||
arg: Str('criteria?', noextrawhitespace=False)
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, query=True, required=False)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: ListOfEntries('result', (<type 'list'>, <type 'tuple'>), Gettext('A list of LDAP entries', domain='ipa', localedir=None))
|
||||
output: Output('count', <type 'int'>, 'Number of entries returned')
|
||||
output: Output('truncated', <type 'bool'>, 'True if not all results were returned')
|
||||
command: automember_mod
|
||||
args: 1,5,3
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automember_remove_condition
|
||||
args: 1,8,5
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: Str('description', attribute=True, autofill=False, cli_name='desc', label=Gettext('Description', domain='ipa', localedir=None), multivalue=False, required=False)
|
||||
option: List('automemberinclusiveregex?', alwaysask=True, cli_name='inclusive_regex', label=Gettext('Inclusive Regex', domain='ipa', localedir=None), multivalue=True)
|
||||
option: List('automemberexclusiveregex?', alwaysask=True, cli_name='exclusive_regex', label=Gettext('Exclusive Regex', domain='ipa', localedir=None), multivalue=True)
|
||||
option: Str('key', flags=['no_create', 'no_update', 'no_search'], label=Gettext('Attribute Key', domain='ipa', localedir=None))
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
output: Output('failed', <type 'dict'>, Gettext('Conditions that could not be removed', domain='ipa', localedir=None))
|
||||
output: Output('completed', <type 'int'>, Gettext('Number of conditions removed', domain='ipa', localedir=None))
|
||||
command: automember_show
|
||||
args: 1,4,3
|
||||
arg: Str('cn', cli_name='automember_rule', label=Gettext('Automember Rule', domain='ipa', localedir=None), normalizer=<lambda>)
|
||||
option: StrEnum('type', label=Gettext('Grouping Type', domain='ipa', localedir=None), values=(u'group', u'hostgroup'))
|
||||
option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
|
||||
option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
|
||||
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
|
||||
output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
|
||||
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
|
||||
command: automountkey_add
|
||||
args: 2,7,3
|
||||
arg: Str('automountlocationcn', cli_name='automountlocation', label=Gettext('Location', domain='ipa', localedir=None), query=True, required=True)
|
||||
|
||||
@ -49,6 +49,8 @@ app_DATA = \
|
||||
entryusn.ldif \
|
||||
root-autobind.ldif \
|
||||
sudobind.ldif \
|
||||
automember.ldif \
|
||||
replica-automember.ldif \
|
||||
$(NULL)
|
||||
|
||||
EXTRA_DIST = \
|
||||
|
||||
32
install/share/automember.ldif
Normal file
32
install/share/automember.ldif
Normal file
@ -0,0 +1,32 @@
|
||||
# Configuration for Auto Membership Plugin for Master
|
||||
# installation. This method should be revisted for
|
||||
# optimization due to a bug within 389 DS which prevents
|
||||
# the definition files from being added seperatly after
|
||||
# the insertion of cn=Auto Membership Plugin,cn=plugins,cn=config
|
||||
# and subsequent 389 DS restart.
|
||||
dn: cn=Auto Membership Plugin,cn=plugins,cn=config
|
||||
changetype: modify
|
||||
add: nsslapd-pluginConfigArea
|
||||
nsslapd-pluginConfigArea: cn=automember,cn=etc,$SUFFIX
|
||||
|
||||
dn: cn=automember,cn=etc,$SUFFIX
|
||||
changetype: add
|
||||
objectClass: top
|
||||
objectClass: nsContainer
|
||||
cn: automember
|
||||
|
||||
dn: cn=Hostgroup,cn=automember,cn=etc,$SUFFIX
|
||||
changetype: add
|
||||
objectclass: autoMemberDefinition
|
||||
cn: Hostgroup
|
||||
autoMemberScope: cn=computers,cn=accounts,$SUFFIX
|
||||
autoMemberFilter: objectclass=ipaHost
|
||||
autoMemberGroupingAttr: member:dn
|
||||
|
||||
dn: cn=Group,cn=automember,cn=etc,$SUFFIX
|
||||
changetype: add
|
||||
objectclass: autoMemberDefinition
|
||||
cn: Group
|
||||
autoMemberScope: cn=users,cn=accounts,$SUFFIX
|
||||
autoMemberFilter: objectclass=posixAccount
|
||||
autoMemberGroupingAttr: member:dn
|
||||
8
install/share/replica-automember.ldif
Normal file
8
install/share/replica-automember.ldif
Normal file
@ -0,0 +1,8 @@
|
||||
# Configuration for Auto Membership Plugin for Replica
|
||||
# installation. This method should be revisted for
|
||||
# optimization due to a bug within 389 DS.
|
||||
# dsinstance.py should eventually insert this during common_setup.
|
||||
dn: cn=Auto Membership Plugin,cn=plugins,cn=config
|
||||
changetype: modify
|
||||
add: nsslapd-pluginConfigArea
|
||||
nsslapd-pluginConfigArea: cn=automember,cn=etc,$SUFFIX
|
||||
@ -112,6 +112,7 @@ DEFAULT_CONFIG = (
|
||||
('container_sudocmd', 'cn=sudocmds,cn=sudo'),
|
||||
('container_sudocmdgroup', 'cn=sudocmdgroups,cn=sudo'),
|
||||
('container_entitlements', 'cn=entitlements,cn=etc'),
|
||||
('container_automember', 'cn=automember,cn=etc'),
|
||||
|
||||
# Ports, hosts, and URIs:
|
||||
# FIXME: let's renamed xmlrpc_uri to rpc_xml_uri
|
||||
|
||||
587
ipalib/plugins/automember.py
Normal file
587
ipalib/plugins/automember.py
Normal file
@ -0,0 +1,587 @@
|
||||
# Authors:
|
||||
# Jr Aquino <jr.aquino@citrix.com>
|
||||
#
|
||||
# Copyright (C) 2011 Red Hat
|
||||
# see file 'COPYING' for use and warranty information
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from ipalib import api, errors
|
||||
from ipalib import Str, StrEnum
|
||||
from ipalib.plugins.baseldap import *
|
||||
from ipalib import _, ngettext
|
||||
from ipalib.request import context
|
||||
from ipalib.dn import *
|
||||
import ldap as _ldap
|
||||
|
||||
__doc__ = _("""
|
||||
Auto Membership Rule.
|
||||
|
||||
Bring clarity to the membership of hosts and users by configuring inclusive
|
||||
or exclusive regex paterns, you can automatically assign a new entries into
|
||||
a group or hostgroup based upon attribute information.
|
||||
|
||||
A rule is directly associated with a group by name, so you cannot create
|
||||
a rule without an accompanying group or hostgroup
|
||||
|
||||
A condition is a regular expression used by 389-ds to match a new incoming
|
||||
entry with an automember rule. If it matches an inclusive rule then the
|
||||
entry is added to the appropriate group or hostgroup.
|
||||
|
||||
EXAMPLES:
|
||||
|
||||
Create the initial group or hostgroup:
|
||||
ipa hostgroup-add --desc="Web Servers" webservers
|
||||
ipa group-add --desc="Developers" devel
|
||||
|
||||
Create the initial rule:
|
||||
ipa automember-add --type=hostgroup webservers
|
||||
ipa automember-add --type=group devel
|
||||
|
||||
Add a condition to the rule:
|
||||
ipa automember-add-condition --key=fqdn --type=hostgroup --inclusive-regex=^web[1-9]+\.example\.com webservers
|
||||
ipa automember-add-condition --key=manager --type=group --inclusive-regex=^uid=mscott devel
|
||||
|
||||
Add an exclusive condition to the rule to prevent auto assignment:
|
||||
ipa automember-add-condition --key=fqdn --type=hostgroup --exclusive-regex=^web5\.example\.com webservers
|
||||
|
||||
Add a host:
|
||||
ipa host-add web1.example.com
|
||||
|
||||
Add a user:
|
||||
ipa user-add --first=Tim --last=User --password tuser1 --manager=mscott
|
||||
|
||||
Verify automembership:
|
||||
ipa hostgroup-show webservers
|
||||
Host-group: webservers
|
||||
Description: Web Servers
|
||||
Member hosts: web1.example.com
|
||||
|
||||
ipa group-show devel
|
||||
Group name: devel
|
||||
Description: Developers
|
||||
GID: 1004200000
|
||||
Member users: tuser
|
||||
|
||||
Remove a condition from the rule:
|
||||
ipa automember-remove-condition --key=fqdn --type=hostgroup --inclusive-regex=^web[1-9]+\.example\.com webservers
|
||||
|
||||
Modify the automember rule:
|
||||
ipa automember-mod
|
||||
|
||||
Set the default target group:
|
||||
ipa automember-default-group-set --default-group=webservers --type=hostgroup
|
||||
ipa automember-default-group-set --default-group=ipausers --type=group
|
||||
|
||||
Set the default target group:
|
||||
ipa automember-default-group-remove --type=hostgroup
|
||||
ipa automember-default-group-remove --type=group
|
||||
|
||||
Show the default target group:
|
||||
ipa automember-default-group-show --type=hostgroup
|
||||
ipa automember-default-group-show --type=group
|
||||
|
||||
Find all of the automember rules:
|
||||
ipa automember-find
|
||||
|
||||
Display a automember rule:
|
||||
ipa automember-show --type=hostgroup webservers
|
||||
ipa automember-show --type=group devel
|
||||
|
||||
Delete an automember rule:
|
||||
ipa automember-del --type=hostgroup webservers
|
||||
ipa automember-del --type=group devel
|
||||
""")
|
||||
|
||||
# Options used by Condition Add and Remove.
|
||||
INCLUDE_RE = 'automemberinclusiveregex'
|
||||
EXCLUDE_RE = 'automemberexclusiveregex'
|
||||
|
||||
regex_attrs = (
|
||||
List('automemberinclusiveregex?',
|
||||
cli_name='inclusive_regex',
|
||||
label=_('Inclusive Regex'),
|
||||
doc=_('Inclusive Regex'),
|
||||
multivalue=True,
|
||||
alwaysask=True,
|
||||
),
|
||||
List('automemberexclusiveregex?',
|
||||
cli_name='exclusive_regex',
|
||||
label=_('Exclusive Regex'),
|
||||
doc=_('Exclusive Regex'),
|
||||
multivalue=True,
|
||||
alwaysask=True,
|
||||
),
|
||||
Str('key',
|
||||
label=_('Attribute Key'),
|
||||
doc=_('Attribute to filter via regex. For example fqdn for a host, or manager for a user'),
|
||||
flags=['no_create', 'no_update', 'no_search']
|
||||
),
|
||||
)
|
||||
|
||||
group_type = (
|
||||
StrEnum('type',
|
||||
label=_('Grouping Type'),
|
||||
doc=_('Grouping to which the rule applies'),
|
||||
values=(u'group', u'hostgroup', ),
|
||||
),
|
||||
)
|
||||
|
||||
automember_rule = (
|
||||
Str('cn',
|
||||
cli_name='automember_rule',
|
||||
label=_('Automember Rule'),
|
||||
doc=_('Automember Rule'),
|
||||
normalizer=lambda value: value.lower(),
|
||||
),
|
||||
)
|
||||
|
||||
class automember(LDAPObject):
|
||||
|
||||
"""
|
||||
Bring automember to a hostgroup with an Auto Membership Rule.
|
||||
"""
|
||||
|
||||
container_dn = api.env.container_automember
|
||||
|
||||
object_name = 'auto_member_rule'
|
||||
object_name_plural = 'auto_member_rules'
|
||||
object_class = ['top', 'automemberregexrule']
|
||||
default_attributes = [
|
||||
'automemberinclusiveregex', 'automemberexclusiveregex',
|
||||
'cn', 'automembertargetgroup', 'description', 'automemberdefaultgroup'
|
||||
]
|
||||
|
||||
label = _('Auto Membership Rule')
|
||||
|
||||
takes_params = (
|
||||
Str('description?',
|
||||
cli_name='desc',
|
||||
label=_('Description'),
|
||||
doc=_('A description of this auto member rule'),
|
||||
),
|
||||
Str('automemberdefaultgroup?',
|
||||
cli_name='default_group',
|
||||
label=_('Default Group'),
|
||||
doc=_('Default group for entires to land'),
|
||||
flags=['no_create', 'no_update', 'no_search']
|
||||
),
|
||||
)
|
||||
|
||||
def dn_exists(self, grouptype, groupname, *keys):
|
||||
ldap = self.api.Backend.ldap2
|
||||
dn = self.api.Object[grouptype].get_dn(groupname)
|
||||
try:
|
||||
(gdn, entry_attrs) = ldap.get_entry(dn, [])
|
||||
except errors.NotFound:
|
||||
raise errors.NotFound(reason=_(u'Group: %s not found!' % groupname))
|
||||
return gdn
|
||||
|
||||
def get_dn(self, *keys, **options):
|
||||
if self.parent_object:
|
||||
parent_dn = self.api.Object[self.parent_object].get_dn(*keys[:-1])
|
||||
else:
|
||||
parent_dn = self.container_dn
|
||||
grouptype = options['type']
|
||||
try:
|
||||
ndn = DN(('cn', keys[-1]), ('cn', grouptype), DN(parent_dn))
|
||||
except IndexError:
|
||||
ndn = DN(('cn', grouptype), DN(parent_dn))
|
||||
parent_dn = str(ndn)
|
||||
return parent_dn
|
||||
|
||||
def check_attr(self, attr):
|
||||
"""
|
||||
Verify that the user supplied key is a valid attribute in the schema
|
||||
"""
|
||||
ldap = self.api.Backend.ldap2
|
||||
if not ldap.schema:
|
||||
ldap.get_schema()
|
||||
obj = ldap.schema.get_obj(_ldap.schema.AttributeType, attr)
|
||||
if obj is not None:
|
||||
return obj
|
||||
else:
|
||||
raise errors.NotFound(reason=_('%s is not a valid attribute.' % attr))
|
||||
|
||||
api.register(automember)
|
||||
|
||||
|
||||
def automember_container_exists(ldap):
|
||||
try:
|
||||
ldap.get_entry(api.env.container_automember, [])
|
||||
except errors.NotFound:
|
||||
return False
|
||||
return True
|
||||
|
||||
class automember_add(LDAPCreate):
|
||||
__doc__ = _("""
|
||||
Add an automember rule.
|
||||
""")
|
||||
takes_options = group_type
|
||||
takes_args = automember_rule
|
||||
msg_summary = _('Added automember rule "%(value)s"')
|
||||
|
||||
def pre_callback(self, ldap, dn, entry_attrs, *keys, **options):
|
||||
|
||||
entry_attrs['cn'] = keys[-1]
|
||||
if not automember_container_exists(self.api.Backend.ldap2):
|
||||
raise errors.NotFound(reason=_('Auto Membership is not configured'))
|
||||
entry_attrs['automembertargetgroup'] = self.obj.dn_exists(options['type'], keys[-1])
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_add, self).execute(*keys, **options)
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_add)
|
||||
|
||||
|
||||
class automember_add_condition(LDAPUpdate):
|
||||
__doc__ = _("""
|
||||
Add conditions to an automember rule.
|
||||
""")
|
||||
has_output_params = (
|
||||
Str('failed',
|
||||
label=_('Failed to add'),
|
||||
flags=['suppress_empty'],
|
||||
),
|
||||
)
|
||||
|
||||
takes_options = regex_attrs + group_type
|
||||
takes_args = automember_rule
|
||||
msg_summary = _('Added condition(s) to "%(value)s"')
|
||||
|
||||
# Prepare the output to expect failed results
|
||||
has_output = (
|
||||
output.summary,
|
||||
output.Entry('result'),
|
||||
output.value,
|
||||
output.Output('failed',
|
||||
type=dict,
|
||||
doc=_('Conditions that could not be added'),
|
||||
),
|
||||
output.Output('completed',
|
||||
type=int,
|
||||
doc=_('Number of conditions added'),
|
||||
),
|
||||
)
|
||||
|
||||
def pre_callback(self, ldap, dn, entry_attrs, attrs_list, *keys, **options):
|
||||
# Check to see if the automember rule exists
|
||||
try:
|
||||
(tdn, test_attrs) = ldap.get_entry(dn, [])
|
||||
except errors.NotFound:
|
||||
raise errors.NotFound(reason=_(u'Auto member rule: %s not found!' % keys[0]))
|
||||
# Define container key
|
||||
key = options['key']
|
||||
# Check to see if the attribute is valid
|
||||
self.obj.check_attr(key)
|
||||
|
||||
key = '%s=' % key
|
||||
completed = 0
|
||||
failed = {'failed': {}}
|
||||
|
||||
for attr in (INCLUDE_RE, EXCLUDE_RE):
|
||||
failed['failed'][attr] = []
|
||||
if attr in options and options[attr]:
|
||||
entry_attrs[attr] = [key + condition for condition in options[attr]]
|
||||
completed += len(entry_attrs[attr])
|
||||
try:
|
||||
(dn, old_entry) = ldap.get_entry(
|
||||
dn, [attr], normalize=self.obj.normalize_dn)
|
||||
for regex in old_entry:
|
||||
if not isinstance(entry_attrs[regex], (list, tuple)):
|
||||
entry_attrs[regex] = [entry_attrs[regex]]
|
||||
duplicate = set(old_entry[regex]) & set(entry_attrs[regex])
|
||||
if len(duplicate) > 0:
|
||||
completed -= 1
|
||||
else:
|
||||
entry_attrs[regex] = list(entry_attrs[regex]) + old_entry[regex]
|
||||
except errors.NotFound:
|
||||
failed['failed'][attr].append(regex)
|
||||
|
||||
# Set failed and completed to they can be harvested in the execute super
|
||||
setattr(context, 'failed', failed)
|
||||
setattr(context, 'completed', completed)
|
||||
setattr(context, 'entry_attrs', entry_attrs)
|
||||
|
||||
# Make sure to returned the failed results if there is nothing to remove
|
||||
if completed == 0:
|
||||
(dn, entry_attrs) = ldap.get_entry(
|
||||
dn, attrs_list, normalize=self.obj.normalize_dn
|
||||
)
|
||||
raise errors.EmptyModlist
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
__doc__ = _("""
|
||||
Override this so we can add completed and failed to the return result.
|
||||
""")
|
||||
try:
|
||||
result = super(automember_add_condition, self).execute(*keys, **options)
|
||||
except errors.EmptyModlist:
|
||||
result = {'result': getattr(context, 'entry_attrs'), 'value': keys[-1]}
|
||||
result['failed'] = getattr(context, 'failed')
|
||||
result['completed'] = getattr(context, 'completed')
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_add_condition)
|
||||
|
||||
|
||||
class automember_remove_condition(LDAPUpdate):
|
||||
__doc__ = _("""
|
||||
Remove conditions from an automember rule.
|
||||
""")
|
||||
takes_options = regex_attrs + group_type
|
||||
takes_args = automember_rule
|
||||
msg_summary = _('Removed condition(s) to "%(value)s"')
|
||||
|
||||
# Prepare the output to expect failed results
|
||||
has_output = (
|
||||
output.summary,
|
||||
output.Entry('result'),
|
||||
output.value,
|
||||
output.Output('failed',
|
||||
type=dict,
|
||||
doc=_('Conditions that could not be removed'),
|
||||
),
|
||||
output.Output('completed',
|
||||
type=int,
|
||||
doc=_('Number of conditions removed'),
|
||||
),
|
||||
)
|
||||
|
||||
def pre_callback(self, ldap, dn, entry_attrs, attrs_list, *keys, **options):
|
||||
# Check to see if the automember rule exists
|
||||
try:
|
||||
(tdn, test_attrs) = ldap.get_entry(dn, [])
|
||||
except errors.NotFound:
|
||||
raise errors.NotFound(reason=_(u'Auto member rule: %s not found!' % keys[0]))
|
||||
|
||||
# Define container key
|
||||
type_attr_default = {'group': 'manager', 'hostgroup': 'fqdn'}
|
||||
if 'key' in options:
|
||||
key = options['key']
|
||||
else:
|
||||
key = type_attr_default[options['type']]
|
||||
|
||||
key = '%s=' % key
|
||||
completed = 0
|
||||
failed = {'failed': {}}
|
||||
|
||||
# Check to see if there are existing exclusive conditions present.
|
||||
(dn, exclude_present) = ldap.get_entry(
|
||||
dn, [EXCLUDE_RE], normalize=self.obj.normalize_dn)
|
||||
|
||||
for attr in (INCLUDE_RE, EXCLUDE_RE):
|
||||
failed['failed'][attr] = []
|
||||
if attr in options and options[attr]:
|
||||
entry_attrs[attr] = [key + condition for condition in options[attr]]
|
||||
(dn, entry_attrs_) = ldap.get_entry(
|
||||
dn, [attr], normalize=self.obj.normalize_dn
|
||||
)
|
||||
old_entry = entry_attrs_.get(attr, [])
|
||||
for regex in entry_attrs[attr]:
|
||||
if regex in old_entry:
|
||||
old_entry.remove(regex)
|
||||
completed += 1
|
||||
else:
|
||||
failed['failed'][attr].append(regex)
|
||||
entry_attrs[attr] = old_entry
|
||||
# Set failed and completed to they can be harvested in the execute super
|
||||
setattr(context, 'failed', failed)
|
||||
setattr(context, 'completed', completed)
|
||||
setattr(context, 'entry_attrs', entry_attrs)
|
||||
|
||||
# Make sure to returned the failed results if there is nothing to remove
|
||||
if completed == 0:
|
||||
(dn, entry_attrs) = ldap.get_entry(
|
||||
dn, attrs_list, normalize=self.obj.normalize_dn
|
||||
)
|
||||
raise errors.EmptyModlist
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
__doc__ = _("""
|
||||
Override this so we can set completed and failed.
|
||||
""")
|
||||
try:
|
||||
result = super(automember_remove_condition, self).execute(*keys, **options)
|
||||
except errors.EmptyModlist:
|
||||
result = {'result': getattr(context, 'entry_attrs'), 'value': keys[-1]}
|
||||
result['failed'] = getattr(context, 'failed')
|
||||
result['completed'] = getattr(context, 'completed')
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_remove_condition)
|
||||
|
||||
|
||||
class automember_mod(LDAPUpdate):
|
||||
__doc__ = _("""
|
||||
Modify an automember rule.
|
||||
""")
|
||||
takes_args = automember_rule
|
||||
takes_options = group_type
|
||||
msg_summary = _('Modified automember rule "%(value)s"')
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_mod, self).execute(*keys, **options)
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_mod)
|
||||
|
||||
|
||||
class automember_del(LDAPDelete):
|
||||
__doc__ = _("""
|
||||
Delete an automember rule.
|
||||
""")
|
||||
takes_args = automember_rule
|
||||
takes_options = group_type
|
||||
msg_summary = _('Deleted automember rule "%(value)s"')
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_del, self).execute(*keys, **options)
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_del)
|
||||
|
||||
|
||||
class automember_find(LDAPSearch):
|
||||
__doc__ = _("""
|
||||
Search for automember rules.
|
||||
""")
|
||||
takes_options = group_type
|
||||
has_output_params = LDAPSearch.has_output_params + automember_rule + regex_attrs
|
||||
|
||||
msg_summary = ngettext(
|
||||
'%(count)d rules matched', '%(count)d rules matched', 0
|
||||
)
|
||||
|
||||
def pre_callback(self, ldap, filters, attrs_list, base_dn, scope, *args, **options):
|
||||
scope = ldap.SCOPE_SUBTREE
|
||||
ndn = DN(('cn', options['type']), DN(base_dn))
|
||||
base_dn = str(ndn)
|
||||
return (filters, base_dn, scope)
|
||||
|
||||
api.register(automember_find)
|
||||
|
||||
|
||||
class automember_show(LDAPRetrieve):
|
||||
__doc__ = _("""
|
||||
Display information about an automember rule.
|
||||
""")
|
||||
takes_args = automember_rule
|
||||
takes_options = group_type
|
||||
has_output_params = LDAPRetrieve.has_output_params + regex_attrs
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_show, self).execute(*keys, **options)
|
||||
result['value'] = keys[-1]
|
||||
return result
|
||||
|
||||
api.register(automember_show)
|
||||
|
||||
|
||||
class automember_default_group_set(LDAPUpdate):
|
||||
__doc__ = _("""
|
||||
Set default group for all unmatched entries.
|
||||
""")
|
||||
|
||||
takes_options = (
|
||||
Str('automemberdefaultgroup',
|
||||
cli_name='default_group',
|
||||
label=_('Default Group'),
|
||||
doc=_('Default group for entires to land'),
|
||||
flags=['no_create', 'no_update']
|
||||
),
|
||||
) + group_type
|
||||
msg_summary = _('Set default group for automember "%(value)s"')
|
||||
|
||||
def pre_callback(self, ldap, dn, entry_attrs, attrs_list, *keys, **options):
|
||||
dn = DN(('cn', options['type']), api.env.container_automember)
|
||||
dn = str(dn)
|
||||
entry_attrs['automemberdefaultgroup'] = self.obj.dn_exists(options['type'], options['automemberdefaultgroup'])
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_default_group_set, self).execute(*keys, **options)
|
||||
result['value'] = options['type']
|
||||
return result
|
||||
|
||||
api.register(automember_default_group_set)
|
||||
|
||||
|
||||
class automember_default_group_remove(LDAPUpdate):
|
||||
__doc__ = _("""
|
||||
Remove default group for all unmatched entries.
|
||||
""")
|
||||
|
||||
takes_options = group_type
|
||||
msg_summary = _('Removed default group for automember "%(value)s"')
|
||||
|
||||
def pre_callback(self, ldap, dn, entry_attrs, attrs_list, *keys, **options):
|
||||
dn = DN(('cn', options['type']), api.env.container_automember)
|
||||
dn = str(dn)
|
||||
attr = 'automemberdefaultgroup'
|
||||
|
||||
(dn, entry_attrs_) = ldap.get_entry(
|
||||
dn, [attr], normalize=self.obj.normalize_dn
|
||||
)
|
||||
|
||||
if attr not in entry_attrs_:
|
||||
raise errors.NotFound(reason=_(u'No default group set'))
|
||||
else:
|
||||
entry_attrs[attr] = []
|
||||
return dn
|
||||
|
||||
def post_callback(self, ldap, dn, entry_attrs, *keys, **options):
|
||||
if 'automemberdefaultgroup' not in entry_attrs:
|
||||
entry_attrs['automemberdefaultgroup'] = u'No default group set'
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_default_group_remove, self).execute(*keys, **options)
|
||||
result['value'] = options['type']
|
||||
return result
|
||||
|
||||
api.register(automember_default_group_remove)
|
||||
|
||||
|
||||
class automember_default_group_show(LDAPRetrieve):
|
||||
__doc__ = _("""
|
||||
Display information about the default automember groups.
|
||||
""")
|
||||
takes_options = group_type
|
||||
|
||||
def pre_callback(self, ldap, dn, attrs_list, *keys, **options):
|
||||
dn = DN(('cn', options['type']), api.env.container_automember)
|
||||
dn = str(dn)
|
||||
return dn
|
||||
|
||||
def post_callback(self, ldap, dn, entry_attrs, *keys, **options):
|
||||
if 'automemberdefaultgroup' not in entry_attrs:
|
||||
entry_attrs['automemberdefaultgroup'] = u'No default group set'
|
||||
return dn
|
||||
|
||||
def execute(self, *keys, **options):
|
||||
result = super(automember_default_group_show, self).execute(*keys, **options)
|
||||
result['value'] = options['type']
|
||||
return result
|
||||
|
||||
api.register(automember_default_group_show)
|
||||
@ -391,6 +391,9 @@ class user_add(LDAPCreate):
|
||||
def_primary_group = config.get('ipadefaultprimarygroup')
|
||||
group_dn = self.api.Object['group'].get_dn(def_primary_group)
|
||||
ldap.add_entry_to_group(dn, group_dn)
|
||||
if self.api.env.wait_for_attr:
|
||||
newentry = wait_for_value(ldap, dn, 'memberOf', def_primary_group)
|
||||
entry_from_entry(entry_attrs, newentry)
|
||||
self.obj._convert_manager(entry_attrs, **options)
|
||||
# delete description attribute NO_UPG_MAGIC if present
|
||||
if options.get('noprivate', False):
|
||||
|
||||
@ -250,6 +250,7 @@ class DsInstance(service.Service):
|
||||
self.step("configuring user private groups", self.__user_private_groups)
|
||||
self.step("configuring netgroups from hostgroups", self.__host_nis_groups)
|
||||
self.step("creating default Sudo bind user", self.__add_sudo_binduser)
|
||||
self.step("creating default Auto Member layout", self.__add_automember_config)
|
||||
if hbac_allow:
|
||||
self.step("creating default HBAC rule allow_all", self.add_hbac)
|
||||
|
||||
@ -283,6 +284,8 @@ class DsInstance(service.Service):
|
||||
|
||||
self.step("setting up initial replication", self.__setup_replica)
|
||||
self.step("adding replication acis", self.__add_replication_acis)
|
||||
# See LDIFs for automember configuration during replica install
|
||||
self.step("setting Auto Member configuration", self.__add_replica_automember_config)
|
||||
|
||||
# Managed Entries configuration is done via update files
|
||||
|
||||
@ -784,6 +787,12 @@ class DsInstance(service.Service):
|
||||
def __add_sudo_binduser(self):
|
||||
self._ldap_mod("sudobind.ldif", self.sub_dict)
|
||||
|
||||
def __add_automember_config(self):
|
||||
self._ldap_mod("automember.ldif", self.sub_dict)
|
||||
|
||||
def __add_replica_automember_config(self):
|
||||
self._ldap_mod("replica-automember.ldif", self.sub_dict)
|
||||
|
||||
def replica_populate(self):
|
||||
self.ldap_connect()
|
||||
|
||||
|
||||
@ -120,3 +120,8 @@ netgroup = [
|
||||
u'ipaassociation',
|
||||
u'ipanisnetgroup',
|
||||
]
|
||||
|
||||
automember = [
|
||||
u'top',
|
||||
u'automemberregexrule'
|
||||
]
|
||||
|
||||
1074
tests/test_xmlrpc/test_automember_plugin.py
Normal file
1074
tests/test_xmlrpc/test_automember_plugin.py
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user