summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/netgroup.py
blob: 3ee23d6a55b8321366e5a3ede668672835fc9f18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# 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

"""
Frontend plugins for netgroups.
"""

from ipalib import api
from ipalib.plugins.basegroup import *
from ipalib import uuid

display_attributes = ['cn','description','memberhost','externalhost','memberuser','member']
container_netgroup = "cn=ng, cn=alt"
default_class = "ipaNISNetgroup"

class netgroup(BaseGroup):
    """
    netgroup object.
    """
    container=container_netgroup

api.register(netgroup)


class netgroup_add(basegroup_add):
    'Add a new netgroup.'
    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.ldap
        kw['cn'] = cn
        kw['ipauniqueid'] = str(uuid.uuid1())
        kw['dn'] = "ipauniqueid=%s,%s,%s" % (kw['ipauniqueid'], container_netgroup, api.env.basedn)
        if not kw.get('nisdomainname', False):
            kw['nisdomainname'] = api.env.domain

        # some required objectclasses
        kw['objectclass'] = ['top', 'ipaAssociation', 'ipaNISNetgroup']

        return ldap.create(**kw)

api.register(netgroup_add)


class netgroup_del(basegroup_del):
    'Delete an existing netgroup.'
    container = container_netgroup
    filter_class = default_class

api.register(netgroup_del)


class netgroup_mod(basegroup_mod):
    'Edit an existing netgroup.'
    container = container_netgroup
    filter_class = default_class

api.register(netgroup_mod)


class netgroup_find(basegroup_find):
    'Search the groups.'
    container = container_netgroup
    filter_class = default_class

api.register(netgroup_find)


class netgroup_show(basegroup_show):
    'Examine an existing netgroup.'
    default_attributes = display_attributes
    container = container_netgroup
    filter_class = default_class

api.register(netgroup_show)


class netgroup_add_member(basegroup_add_member):
    'Add a member to a netgroup.'
    default_attributes = display_attributes
    container = container_netgroup
    filter_class = default_class
    takes_options = basegroup_add_member.takes_options + (
        List('hosts?', doc='comma-separated list of hosts to add'),
        List('hostgroups?', doc='comma-separated list of host groups to add'),
        List('netgroups?', doc='comma-separated list of netgroups to add'),
    )

    def _add_external(self, ldap, completed, members, cn):
        failed = []
        kw = {"all": True}
        netgroup = api.Command['netgroup_show'](cn, **kw)
        external = netgroup.get('externalhost', [])
        if not isinstance(external, list):
            external = [external]
        external_len = len(external)
        for m in members:
            if not m in external:
                external.append(m)
                completed+=1
            else:
                failed.append(m)
        if len(external) > external_len:
            kw = {'externalhost': external}
            ldap.update(netgroup['dn'], **kw)

        return completed, failed

    def execute(self, cn, **kw):
        """
        Execute the group-add-member operation.

        Returns the updated group 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.ldap
        dn = ldap.find_entry_dn("cn", cn, self.filter_class, self.container)
        add_failed = []
        to_add = []
        completed = 0

        # Hosts
        members = kw.get('hosts', [])
        (to_add, add_failed) = self._find_members(ldap, add_failed, members, "cn", "ipaHost")

        # 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, cn)

        (completed, add_failed) = self._add_members(ldap, completed, to_add, add_failed, dn, "memberhost")

        # Hostgroups
        members = kw.get('hostgroups', [])
        (to_add, add_failed) = self._find_members(ldap, add_failed, members, "cn", "ipaHostGroup", self.api.env.container_hostgroup)
        (completed, add_failed) = self._add_members(ldap, completed, to_add, add_failed, dn, "memberhost")

        # User
        members = kw.get('users', [])
        (to_add, add_failed) = self._find_members(ldap, add_failed, members, "uid", "posixAccount", self.api.env.container_user)
        (completed, add_failed) = self._add_members(ldap, completed, to_add, add_failed, dn, "memberuser")

        # Groups
        members = kw.get('groups', [])
        (to_add, add_failed) = self._find_members(ldap, add_failed, members, "cn", "ipaUserGroup", self.api.env.container_group)
        (completed, failed) = self._add_members(ldap, completed, to_add, add_failed, dn, "memberuser")

        # Netgroups
        members = kw.get('netgroups', [])
        (to_add, add_failed) = self._find_members(ldap, add_failed, members, "cn", self.filter_class, self.container)
        (completed, add_failed) = self._add_members(ldap, completed, to_add, add_failed, dn, "member")

        return add_failed

api.register(netgroup_add_member)


class netgroup_remove_member(basegroup_remove_member):
    'Remove a member from a netgroup.'
    default_attributes = display_attributes
    container = container_netgroup
    filter_class = default_class
    takes_options = basegroup_remove_member.takes_options + (
        List('hosts?', doc='comma-separated list of hosts to remove'),
        List('hostgroups?', doc='comma-separated list of host groups to remove'),
        List('netgroups?', doc='comma-separated list of netgroups to remove'),
    )

    def _remove_external(self, ldap, completed, members, cn):
        failed = []
        kw = {"all": True}
        netgroup = api.Command['netgroup_show'](cn, **kw)
        external = netgroup.get('externalhost', [])
        if not isinstance(external, list):
            external = [external]
        external_len = len(external)
        for m in members:
            try:
                external.remove(m)
                completed+=1
            except ValueError:
                failed.append(m)
        if len(external) < external_len:
            kw = {'externalhost': external}
            ldap.update(netgroup['dn'], **kw)

        return completed, failed

    def execute(self, cn, **kw):
        """
        Execute the group-remove-member operation.

        Returns the updated group 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.ldap
        dn = ldap.find_entry_dn("cn", cn, self.filter_class, self.container)
        remove_failed = []
        to_remove = []
        completed = 0

        # Hosts
        members = kw.get('hosts', [])
        (to_remove, remove_failed) = self._find_members(ldap, remove_failed, members, "cn", "ipaHost")

        # If a host is not found we'll consider it an externalHost. It will
        # be up to the user to handle typos
        if remove_failed:
            (completed, remove_failed) = self._remove_external(ldap, completed, remove_failed, cn)

        (completed, remove_failed) = self._remove_members(ldap, completed, to_remove, remove_failed, dn, "memberhost")

        # Hostgroups
        members = kw.get('hostgroups', [])
        (to_remove, remove_failed) = self._find_members(ldap, remove_failed, members, "cn", "ipaHostGroup", self.api.env.container_hostgroup)
        (completed, remove_failed) = self._remove_members(ldap, completed, to_remove, remove_failed, dn, "memberhost")

        # User
        members = kw.get('users', [])
        (to_remove, remove_failed) = self._find_members(ldap, remove_failed, members, "uid", "posixAccount", self.api.env.container_user)
        (completed, remove_failed) = self._remove_members(ldap, completed, to_remove, remove_failed, dn, "memberuser")

        # Groups
        members = kw.get('groups', [])
        (to_remove, remove_failed) = self._find_members(ldap, remove_failed, members, "cn", "ipaUserGroup", self.api.env.container_group)
        (completed, failed) = self._remove_members(ldap, completed, to_remove, remove_failed, dn, "memberuser")

        # Netgroups
        members = kw.get('netgroups', [])
        (to_remove, remove_failed) = self._find_members(ldap, remove_failed, members, "cn", self.filter_class, self.container)
        (completed, remove_failed) = self._remove_members(ldap, completed, to_remove, remove_failed, dn, "member")

        return remove_failed

api.register(netgroup_remove_member)