summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/netgroup.py
diff options
context:
space:
mode:
authorPavel Zuna <pzuna@redhat.com>2009-06-16 13:44:37 +0200
committerRob Crittenden <rcritten@redhat.com>2009-07-02 13:33:01 -0400
commite1e1db9c9fc71c88e847aba8a9a02bc383317c18 (patch)
tree13f21fa86f4669710106ed8f1eb5dd812ca7e74b /ipalib/plugins/netgroup.py
parent8c7883364ca3c73c9e2c503428495a4405b44e39 (diff)
downloadfreeipa-e1e1db9c9fc71c88e847aba8a9a02bc383317c18.tar.gz
freeipa-e1e1db9c9fc71c88e847aba8a9a02bc383317c18.tar.xz
freeipa-e1e1db9c9fc71c88e847aba8a9a02bc383317c18.zip
Rename plugins2 files (remove '2' suffix').
Diffstat (limited to 'ipalib/plugins/netgroup.py')
-rw-r--r--ipalib/plugins/netgroup.py372
1 files changed, 372 insertions, 0 deletions
diff --git a/ipalib/plugins/netgroup.py b/ipalib/plugins/netgroup.py
new file mode 100644
index 000000000..a967791d3
--- /dev/null
+++ b/ipalib/plugins/netgroup.py
@@ -0,0 +1,372 @@
+# Authors:
+# Rob Crittenden <rcritten@redhat.com>
+#
+# Copyright (C) 2009 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; version 2 only
+#
+# 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, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+"""
+Netgroups.
+"""
+
+from ipalib import api
+from ipalib.plugins.basegroup2 import *
+from ipalib import uuid
+
+_container_dn = 'cn=ng,cn=alt'
+_default_attributes = [
+ 'cn', 'description', 'member', 'memberUser', 'memberhost','externalhost'
+]
+_default_class = 'ipanisnetgroup'
+
+
+class netgroup2(basegroup2):
+ """
+ Netgroup object.
+ """
+ container = _container_dn
+
+api.register(netgroup2)
+
+
+class netgroup2_create(basegroup2_create):
+ """
+ Create new netgroup.
+ """
+ takes_options = (
+ Str('nisdomainname?',
+ cli_name='nisdomain',
+ doc='NIS domain name',
+ ),
+ )
+
+ def execute(self, cn, **kw):
+ """
+ Execute the netgroup-add operation.
+
+ The dn should not be passed as a keyword argument as it is constructed
+ by this method.
+
+ Returns the entry as it will be created in LDAP.
+
+ :param cn: The name of the netgroup
+ :param kw: Keyword arguments for the other LDAP attributes.
+ """
+ assert 'cn' not in kw
+ assert 'dn' not in kw
+ ldap = self.api.Backend.ldap2
+
+ entry_attrs = self.args_options_2_entry(cn, **kw)
+ entry_attrs['ipauniqueid'] = str(uuid.uuid1())
+ entry_attrs['objectclass'] = ['top', 'ipaassociation', _default_class]
+ entry_attrs.setdefault('nisdomainname', self.api.env.domain)
+
+ dn = ldap.make_dn(entry_attrs, 'ipauniqueid', _container_dn)
+
+ ldap.add_entry(dn, entry_attrs)
+
+ return ldap.get_entry(dn, _default_attributes)
+
+api.register(netgroup2_create)
+
+
+class netgroup2_delete(basegroup2_delete):
+ """
+ Delete netgroup.
+ """
+ container = _container_dn
+ filter_class = _default_class
+
+ def execute(self, cn, **kw):
+ return super(netgroup2_delete, self).execute(cn, **kw)
+
+api.register(netgroup2_delete)
+
+
+class netgroup2_mod(basegroup2_mod):
+ """
+ Edit an existing netgroup.
+ """
+ container = _container_dn
+ filter_class = _default_class
+
+ def execute(self, cn, **kw):
+ return super(netgroup2_mod, self).execute(cn, **kw)
+
+api.register(netgroup2_mod)
+
+
+class netgroup2_find(basegroup2_find):
+ """
+ Search the groups.
+ """
+ container = _container_dn
+ filter_class = _default_class
+
+ def execute(self, cn, **kw):
+ return super(netgroup2_find, self).execute(cn, **kw)
+
+api.register(netgroup2_find)
+
+
+class netgroup2_show(basegroup2_show):
+ """
+ Display netgroup.
+ """
+ filter_class = _default_class
+ default_attributes = _default_attributes
+ container = _container_dn
+
+ def execute(self, cn, **kw):
+ return super(netgroup2_show, self).execute(cn, **kw)
+
+api.register(netgroup2_show)
+
+
+class netgroup2_add_member(basegroup2_add_member):
+ """
+ Add members to netgroup.
+ """
+ default_attributes = _default_attributes
+ container = _container_dn
+ filter_class = _default_class
+
+ takes_options = basegroup2_add_member.takes_options + (
+ List('hosts?',
+ cli_name='hosts',
+ doc='comma-separated list of hosts to add'
+ ),
+ List('hostgroups?',
+ cli_name='hostgroups',
+ doc='comma-separated list of host groups to add'
+ ),
+ List('netgroups?',
+ cli_name='netgroups',
+ doc='comma-separated list of netgroups to add'
+ ),
+ )
+
+ def _add_external(self, ldap, completed, members, group_dn):
+ add_failed = []
+ entry_attrs = ldap.get_entry(group_dn, ['externalhost'])
+ external_hosts = entry_attrs.get('externalhost', [])
+
+ for m in members:
+ m = m.lower()
+ if m not in external_hosts:
+ external_hosts.append(m)
+ completed += 1
+ else:
+ add_failed.append(m)
+
+ try:
+ ldap.update_entry(group_dn, **{'externalhost': external_hosts})
+ except errors.EmptyModlist:
+ pass
+
+ return (completed, add_failed)
+
+ def execute(self, cn, **kw):
+ """
+ Execute the group-add-member operation.
+
+ Returns a tuple containing the number of members added
+ and the updated entry.
+
+ :param cn: The group name to add new members to.
+ :param kw: groups is a comma-separated list of groups to add
+ :param kw: users is a comma-separated list of users to add
+ :param kw: hostgroups is a comma-separated list of hostgroups to add
+ """
+ assert self.container
+ ldap = self.api.Backend.ldap2
+ dn = get_dn_by_attr(ldap, 'cn', cn, self.filter_class, self.container)
+ to_add = []
+ add_failed = []
+ completed = 0
+
+ members = kw.get('groups', [])
+ (to_add, add_failed) = find_members(
+ ldap, add_failed, members, 'cn', 'ipausergroup',
+ self.api.env.container_group
+ )
+ (completed, add_failed) = add_members(
+ ldap, completed, to_add, add_failed, dn, 'member'
+ )
+
+ members = kw.get('users', [])
+ (to_add, add_failed) = find_members(
+ ldap, add_failed, members, 'uid', 'posixaccount',
+ self.api.env.container_user
+ )
+ (completed, add_failed) = add_members(
+ ldap, completed, to_add, add_failed, dn, 'member'
+ )
+
+ members = kw.get('hosts', [])
+ (to_add, add_failed) = find_members(
+ ldap, add_failed, members, 'cn', 'ipahost',
+ self.api.env.container_host
+ )
+
+ # If a host is not found we'll consider it an externalHost. It will
+ # be up to the user to handle typos
+ if add_failed:
+ (completed, add_failed) = self._add_external(ldap, completed, add_failed, dn)
+
+ (completed, add_failed) = add_members(
+ ldap, completed, to_add, add_failed, dn, 'member'
+ )
+
+ members = kw.get('hostgroups', [])
+ (to_add, add_failed) = find_members(
+ ldap, add_failed, members, 'cn', 'ipahostgroup',
+ self.api.env.container_hostgroup
+ )
+ (completed, add_failed) = add_members(
+ ldap, completed, to_add, add_failed, dn, 'member'
+ )
+
+ members = kw.get('netgroups', [])
+ (to_add, add_failed) = find_members(
+ ldap, add_failed, members, 'cn', _default_class,
+ _container_dn
+ )
+ (completed, add_failed) = add_members(
+ ldap, completed, to_add, add_failed, dn, 'member'
+ )
+
+ return (completed, ldap.get_entry(dn, _default_attributes))
+
+api.register(netgroup2_add_member)
+
+
+class netgroup2_del_member(basegroup2_del_member):
+ """
+ Remove a member from a netgroup.
+ """
+ default_attributes = _default_attributes
+ container = _container_dn
+ filter_class = _default_class
+
+ takes_options = basegroup2_del_member.takes_options + (
+ List('hosts?',
+ cli_name='hosts',
+ doc='comma-separated list of hosts to remove'
+ ),
+ List('hostgroups?',
+ cli_name='hostgroups',
+ doc='comma-separated list of host groups to remove'
+ ),
+ List('netgroups?',
+ cli_name='netgroups',
+ doc='comma-separated list of netgroups to remove'
+ ),
+ )
+
+ def _del_external(self, ldap, completed, members, group_dn):
+ rem_failed = []
+ entry_attrs = ldap.get_entry(group_dn, ['externalhost'])
+ external_hosts = entry_attrs.get('externalhost', [])
+
+ for m in members:
+ m = m.lower()
+ if m in external_hosts:
+ external_hosts.remove(m)
+ completed += 1
+ else:
+ rem_failed.append(m)
+
+ try:
+ ldap.update_entry(group_dn, **{'externalhost': external_hosts})
+ except errors.EmptyModlist:
+ pass
+
+ return (completed, rem_failed)
+
+ def execute(self, cn, **kw):
+ """
+ Execute the group-remove-member operation.
+
+ Returns a tuple containing the number of members removed
+ and the updated entry.
+
+ :param cn: The group name to remove new members to.
+ :param kw: groups is a comma-separated list of groups to remove
+ :param kw: users is a comma-separated list of users to remove
+ :param kw: hostgroups is a comma-separated list of hostgroups to remove
+ """
+ assert self.container
+ ldap = self.api.Backend.ldap2
+ dn = get_dn_by_attr(ldap, 'cn', cn, self.filter_class, self.container)
+ to_rem = []
+ rem_failed = []
+ completed = 0
+
+ members = kw.get('groups', [])
+ (to_rem, rem_failed) = find_members(
+ ldap, rem_failed, members, 'cn', 'ipausergroup',
+ self.api.env.container_group
+ )
+ (completed, rem_failed) = del_members(
+ ldap, completed, to_rem, rem_failed, dn, 'member'
+ )
+
+ members = kw.get('users', [])
+ (to_rem, rem_failed) = find_members(
+ ldap, rem_failed, members, 'uid', 'posixaccount',
+ self.api.env.container_user
+ )
+ (completed, rem_failed) = del_members(
+ ldap, completed, to_rem, rem_failed, dn, 'member'
+ )
+
+ members = kw.get('hosts', [])
+ (to_rem, rem_failed) = find_members(
+ ldap, rem_failed, members, 'cn', 'ipahost',
+ self.api.env.container_host
+ )
+
+ # If a host is not found we'll consider it an externalHost. It will
+ # be up to the user to handle typos
+ if rem_failed:
+ (completed, rem_failed) = self._del_external(ldap, completed, rem_failed, dn)
+
+ (completed, rem_failed) = del_members(
+ ldap, completed, to_rem, rem_failed, dn, 'member'
+ )
+
+ members = kw.get('hostgroups', [])
+ (to_rem, rem_failed) = find_members(
+ ldap, rem_failed, members, 'cn', 'ipahostgroup',
+ self.api.env.container_hostgroup
+ )
+ (completed, rem_failed) = del_members(
+ ldap, completed, to_rem, rem_failed, dn, 'member'
+ )
+
+ members = kw.get('netgroups', [])
+ (to_rem, rem_failed) = find_members(
+ ldap, rem_failed, members, 'cn', _default_class,
+ _container_dn
+ )
+ (completed, rem_failed) = del_members(
+ ldap, completed, to_rem, rem_failed, dn, 'member'
+ )
+
+ return (completed, ldap.get_entry(dn, _default_attributes))
+
+api.register(netgroup2_del_member)
+