summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/f_netgroup.py
blob: d6c7107095c17cf00de3dbaeb9737f8ec24312ac (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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# 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 plugin for netgroups.
"""

from ipalib import api, crud, errors2
from ipalib import Object, Command  # Plugin base classes
from ipalib import Str  # Parameter types
from ipalib import uuid

netgroup_base = "cn=ng, cn=alt"
netgroup_filter = "ipaNISNetgroup"
hostgroup_filter = "groupofnames)(!(objectclass=ipaUserGroup)"

def get_members(members):
    """
    Return a list of members.

    It is possible that the value passed in is None.
    """
    if members:
        members = members.split(',')
    else:
        members = []

    return members

def find_members(ldap, failed, members, attribute, filter=None, base=None):
    """
    Return 2 lists: one a list of DNs found, one a list of errors
    """
    found = []
    for m in members:
        if not m: continue
        try:
            member_dn = ldap.find_entry_dn(attribute, m, filter, base)
            found.append(member_dn)
        except errors2.NotFound:
            failed.append(m)
            continue

    return found, failed

def add_members(ldap, completed, members, dn, memberattr):
    add_failed = []
    for member_dn in members:
        try:
            ldap.add_member_to_group(member_dn, dn, memberattr)
            completed+=1
        except:
            add_failed.append(member_dn)

    return completed, add_failed

def add_external(ldap, completed, members, cn):
    failed = []
    netgroup = api.Command['netgroup_show'](cn)
    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 remove_members(ldap, completed, members, dn, memberattr):
    remove_failed = []
    for member_dn in members:
        try:
            ldap.remove_member_from_group(member_dn, dn, memberattr)
            completed+=1
        except:
            remove_failed.append(member_dn)

    return completed, remove_failed

def remove_external(ldap, completed, members, cn):
    failed = []
    netgroup = api.Command['netgroup_show'](cn)
    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

class netgroup(Object):
    """
    netgroups object.
    """
    takes_params = (
        Str('cn',
            cli_name='name',
            primary_key=True
        ),
        Str('description',
            doc='Description',
        ),
        Str('nisdomainname?',
            cli_name='domainname',
            doc='Domain name',
        ),
    )
api.register(netgroup)


class netgroup_add(crud.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.
        """
        self.log.info("IPA: netgroup-add '%s'" % cn)
        assert 'cn' not in kw
        assert 'dn' not in kw
        ldap = self.api.Backend.ldap
        kw['cn'] = cn
#        kw['dn'] = ldap.make_netgroup_dn()
        kw['ipauniqueid'] = str(uuid.uuid1())
        kw['dn'] = "ipauniqueid=%s,%s,%s" % (kw['ipauniqueid'], netgroup_base, 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)

    def output_for_cli(self, textui, result, *args, **options):
        """
        Output result of this command to command line interface.
        """
        textui.print_name(self.name)
        textui.print_entry(result)
        textui.print_dashed('Added netgroup "%s"' % result.get('cn'))

api.register(netgroup_add)


class netgroup_del(crud.Del):
    'Delete an existing netgroup.'

    def execute(self, cn, **kw):
        """Delete a netgroup.

           cn is the cn of the netgroup to delete

           The memberOf plugin handles removing the netgroup from any other
           groups.

           :param cn: The name of the netgroup being removed.
           :param kw: Not used.
        """
        self.log.info("IPA: netgroup-del '%s'" % cn)

        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, netgroup_filter, netgroup_base)
        return ldap.delete(dn)

    def output_for_cli(self, textui, result, cn):
        """
        Output result of this command to command line interface.
        """
        textui.print_plain('Deleted net group "%s"' % cn)

api.register(netgroup_del)


class netgroup_mod(crud.Mod):
    'Edit an existing netgroup.'
    def execute(self, cn, **kw):
        """
        Execute the netgroup-mod operation.

        The dn should not be passed as a keyword argument as it is constructed
        by this method.

        Returns the entry

        :param cn: The name of the netgroup to retrieve.
        :param kw: Keyword arguments for the other LDAP attributes.
        """
        self.log.info("IPA: netgroup-mod '%s'" % cn)
        assert 'cn' not in kw
        assert 'dn' not in kw
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, netgroup_filter, netgroup_base)
        return ldap.update(dn, **kw)

    def output_for_cli(self, textui, result, cn, **options):
        """
        Output result of this command to command line interface.
        """
        textui.print_name(self.name)
        textui.print_entry(result)
        textui.print_dashed('Updated netgroup "%s"' % result['cn'])

api.register(netgroup_mod)


class netgroup_find(crud.Find):
    'Search the netgroups.'
    def execute(self, term, **kw):
        ldap = self.api.Backend.ldap

        search_fields = ['ipauniqueid','description','nisdomainname','cn']

        search_kw = {}
        for s in search_fields:
            search_kw[s] = term

        search_kw['objectclass'] = netgroup_filter
        search_kw['base'] = netgroup_base
        return ldap.search(**search_kw)

    def output_for_cli(self, textui, result, *args, **options):
        counter = result[0]
        groups = result[1:]
        if counter == 0 or len(groups) == 0:
            textui.print_plain("No entries found")
            return
        if len(groups) == 1:
            textui.print_entry(groups[0])
            return
        textui.print_name(self.name)
        for g in groups:
            textui.print_entry(g)
            textui.print_plain('')
        if counter == -1:
            textui.print_plain('These results are truncated.')
            textui.print_plain('Please refine your search and try again.')
        textui.print_count(groups, '%d netgroups matched')

api.register(netgroup_find)


class netgroup_show(crud.Get):
    'Examine an existing netgroup.'
    def execute(self, cn, **kw):
        """
        Execute the netgroup-show operation.

        The dn should not be passed as a keyword argument as it is constructed
        by this method.

        Returns the entry

        :param cn: The name of the netgroup to retrieve.
        :param kw: Unused
        """
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, netgroup_filter, netgroup_base)
        return ldap.retrieve(dn)

    def output_for_cli(self, textui, result, *args, **options):
        textui.print_entry(result)

api.register(netgroup_show)

class netgroup_add_member(Command):
    'Add a member to a group.'
    takes_args = (
        Str('cn',
            cli_name='name',
            primary_key=True
        ),
    )
    takes_options = (
        Str('hosts?', doc='comma-separated list of hosts to add'),
        Str('hostgroups?', doc='comma-separated list of host groups to add'),
        Str('users?', doc='comma-separated list of users to add'),
        Str('groups?', doc='comma-separated list of groups to add'),
        Str('netgroups?', doc='comma-separated list of netgroups to add'),
    )

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

        Returns the updated group entry

        :param cn: The netgroup name to add new members to.
        :param kw: hosts is a comma-separated list of hosts to add
        :param kw: hostgroups is a comma-separated list of host groups to add
        :param kw: users is a comma-separated list of users to add
        :param kw: groups is a comma-separated list of groups to add
        :param kw: netgroups is a comma-separated list of netgroups to add
        """
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, netgroup_filter, netgroup_base)
        add_failed = []
        to_add = []
        completed = 0

        # Hosts
        members = get_members(kw.get('hosts', ''))
        (to_add, add_failed) = 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, failed) = add_external(ldap, completed, add_failed, cn)
            add_failed = failed

        (completed, failed) = add_members(ldap, completed, to_add, dn, 'memberhost')
        add_failed+=failed

        # Host groups
        members = get_members(kw.get('hostgroups', ''))
        (to_add, add_failed) = find_members(ldap, add_failed, members, "cn", hostgroup_filter)
        (completed, failed) = add_members(ldap, completed, to_add, dn, 'memberhost')
        add_failed+=failed

        # User
        members = get_members(kw.get('users', ''))
        (to_add, add_failed) = find_members(ldap, add_failed, members, "uid")
        (completed, failed) = add_members(ldap, completed, to_add, dn, 'memberuser')
        add_failed+=failed

        # Groups
        members = get_members(kw.get('groups', ''))
        (to_add, add_failed) = find_members(ldap, add_failed, members, "cn", "ipaUserGroup")
        (completed, failed) = add_members(ldap, completed, to_add, dn, 'memberuser')
        add_failed+=failed

        # Netgroups
        members = get_members(kw.get('netgroups', ''))
        (to_add, add_failed) = find_members(ldap, add_failed, members, "cn", netgroup_filter, netgroup_base)
        (completed, failed) = add_members(ldap, completed, to_add, dn, 'member')
        add_failed+=failed

        if completed == 0 and len(add_failed) == 0:
            return 0

        return add_failed

    def output_for_cli(self, textui, result, *args, **options):
        """
        Output result of this command to command line interface.
        """
        if result:
            textui.print_plain("These entries failed to add to the group:")
            for a in result:
                print "\t'%s'" % a
        else:
            if not type(result) in (list, tuple) and result == 0:
                textui.print_plain("nothing to do.")
            else:
                textui.print_plain("netgroup membership updated.")

api.register(netgroup_add_member)


class netgroup_remove_member(Command):
    'Remove a member from a group.'
    takes_args = (
        Str('cn',
            cli_name='name',
            primary_key=True
        ),
    )
    takes_options = (
        Str('hosts?', doc='comma-separated list of hosts to remove'),
        Str('hostgroups?', doc='comma-separated list of groups to remove'),
        Str('users?', doc='comma-separated list of users to remove'),
        Str('groups?', doc='comma-separated list of groups to remove'),
        Str('netgroups?', doc='comma-separated list of netgroups to add'),
    )
    def execute(self, cn, **kw):
        """
        Execute the group-remove-member operation.

        Returns the members that could not be added

        :param cn: The group name to add new members to.
        :param kw: hosts is a comma-separated list of hosts to remove
        :param kw: hostgroups is a comma-separated list of host groups to remove
        :param kw: users is a comma-separated list of users to remove
        :param kw: groups is a comma-separated list of groups to remove
        :param kw: netgroups is a comma-separated list of netgroups to add
        """
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, netgroup_filter, netgroup_base)
        remove_failed = []
        to_remove = []
        completed = 0

        # Hosts
        members = get_members(kw.get('hosts', ''))
        (to_remove, remove_failed) = 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, failed) = remove_external(ldap, completed, remove_failed, cn)
            remove_failed = failed

        (completed, failed) = remove_members(ldap, completed, to_remove, dn, 'memberhost')
        remove_failed+=failed

        # Host groups
        members = get_members(kw.get('hostgroups', ''))
        (to_remove, remove_failed) = find_members(ldap, remove_failed, members, "cn", hostgroup_filter)
        (completed, failed) = remove_members(ldap, completed, to_remove, dn, 'memberhost')
        remove_failed+=failed

        # User
        members = get_members(kw.get('users', ''))
        (to_remove, remove_failed) = find_members(ldap, remove_failed, members, "uid")
        (completed, failed) = remove_members(ldap, completed, to_remove, dn, 'memberuser')
        remove_failed+=failed

        # Groups
        members = get_members(kw.get('groups', ''))
        (to_remove, remove_failed) = find_members(ldap, remove_failed, members, "cn", "ipaUserGroup")
        (completed, failed) = remove_members(ldap, completed, to_remove, dn, 'memberuser')
        remove_failed+=failed

        # Netgroups
        members = get_members(kw.get('netgroups', ''))
        (to_remove, remove_failed) = find_members(ldap, remove_failed, members, "cn", netgroup_filter, netgroup_base)
        (completed, failed) = remove_members(ldap, completed, to_remove, dn, 'member')
        remove_failed+=failed

        return remove_failed

    def output_for_cli(self, textui, result, *args, **options):
        """
        Output result of this command to command line interface.
        """
        if result:
            textui.print_plain("These entries failed to be removed from the group:")
            for a in result:
                print "\t'%s'" % a
        else:
            textui.print_plain("netgroup membership updated.")

api.register(netgroup_remove_member)