LDAP/Group.pm

filter: Statementstmt 100% 18 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 6 / 6 Podpod n/a totaltotal 100% 24 / 24 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« LDAP/Config.pm ↑ Summary LDAP/Machine.pm »
1 package Samba::LDAP::Group;
2  
3 # Returned by Perl::MinimumVersion 0.11
4 require 5.006;
5  
6 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 4 ▶use Regexp::DefaultFlags;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 4 ▶use Readonly;
Subroutine BEGIN: called CC=1 SCAR=0.0
10 4 ▶use Carp qw( croak carp );
Subroutine BEGIN: called CC=1 SCAR=0.0
11 4 ▶use base qw(Samba::LDAP::Base);
Subroutine BEGIN: called CC=1 SCAR=0.0
12 use Samba::LDAP;
13  
14 #use Samba::LDAP::User;
15 use List::MoreUtils qw( any );
16  
17 our $VERSION = '0.05';
18  
19 #
20 # Add Log::Log4perl to all our classes!!!!
21 #
22  
23 # Our usage messages
24 Readonly my $ADD_TO_GROUPS_USAGE =>
25 'Usage: add_to_groups( $username | HoA, Aref | HoA);';
26  
27 #========================================================================
28 # -- PUBLIC METHODS --
29 #========================================================================
30  
31 #------------------------------------------------------------------------
32 # is_group_member( $dn,$userid )
33 #
34 # Check that the user is a member of the group already
35 #------------------------------------------------------------------------
36  
37 sub is_group_member {
38 my $self = shift;
39 my $dn_group = shift;
40 my $username = shift;
41  
42 my $ldap = Samba::LDAP->new();
43 $ldap = $ldap->connect_ldap_slave();
44  
45 my $mesg = $ldap->search(
46 base => $dn_group,
47 scope => 'sub',
48 filter => "(|(memberUid=$username)(member=uid=$username,$self->{usersDN}))"
49 );
50 $mesg->code && die $mesg->error;
51  
52 return ( $mesg->count ne 0 );
53 }
54  
55 #------------------------------------------------------------------------
56 # add_to_group( $group, $username)
57 #
58 # Add $username to LDAP group $group
59 #------------------------------------------------------------------------
60  
61 sub add_to_group {
62 my $self = shift;
63 my $group = shift;
64 my $username = shift;
65  
66 my $members = q{};
67 my $dn_line = $self->_get_group_dn($group);
68  
69 if ( !defined( $self->_get_group_dn($group) ) ) {
70 $self->error("group $group does not exist\n");
71 die $self->error();
72 }
73  
74 if ( !defined($dn_line) ) {
75 $self->error("Can not find group DN\n");
76 die $self->error();
77 }
78  
79 ( my $dn = $dn_line ) =~ s{\A dn:}{};
80  
81 # Should have been checked earlier, but check again anyway
82 my $user = Samba::LDAP::User->new();
83 my $valid_user = $user->is_unix_user($username);
84  
85 # Die if they are not
86 if ( $valid_user == 1 ) {
87 $self->error("User $username, is not even a user on this system\n");
88 die $self->error();
89 }
90  
91 # Now check if the user is already present in the group
92 my $is_member = $self->is_group_member( $dn, $username );
93 if ( $is_member == 1 ) {
94 $self->error("User $username already member of the group $group\n");
95 die $self->error();
96 }
97 else {
98  
99 # bind to a directory with dn and password
100 # It does not matter if the user already exist, Net::LDAP will add the
101 # user if he does not exist, and ignore him if his already in the
102 # directory.
103 my $ldap = Samba::LDAP->new();
104 $ldap = $ldap->connect_ldap_master();
105 my $modify =
106 $ldap->modify( "$dn",
107 changes => [ add => [ memberUid => $username ] ] );
108 $modify->code && die "failed to modify entry: ", $modify->error;
109 return 0;
110 }
111  
112 return 1;
113 }
114  
115 #------------------------------------------------------------------------
116 # add_to_groups( $groups_ref | HoA, Aref | HoA, $username )
117 #
118 # Pass in a list of groups for the user to be added to.
119 #------------------------------------------------------------------------
120  
121 sub add_to_groups {
122 my $self = shift;
123 my $groups = shift;
124 my $username = shift;
125  
126 # Required arguments
127 my @required_args = ($groups);
128  
129 # Allow HoA for adding lots of users to groups next.
130 #my $groups_ref = {
131 # admin => [ 'staff', 'directors', 'contractors', ],
132 # ghenry => [ 'web_team', 'finance', 'cleaners', ],
133 # };
134  
135 croak $ADD_TO_GROUPS_USAGE
136 if any { !defined $_ } @required_args;
137  
138 # Dereference the hashref passed to us by add_user in
139 # Samba::LDAP::User to get the Array, or take a Aref ;-)
140  
141 my @groups;
142 if ( ref($groups) eq 'HASH' ) {
143 for my $key ( keys %{$groups} ) {
144  
145 # Reminder: $key is our $username
146 $self->add_to_group( $key, ${$groups}{$key} );
147 }
148 return;
149 }
150  
151 elsif ( ref($groups) eq 'ARRAY' ) {
152 @groups = @{$groups};
153 }
154 else {
155 $self->error("Need a normal Array_Ref, $ADD_TO_GROUPS_USAGE");
156 croak $self->error();
157 }
158  
159 for my $group (@groups) {
160 $self->add_to_group( $group, $username );
161 }
162 return 1;
163 }
164  
165 #------------------------------------------------------------------------
166 # add_group()
167 #
168 # Description here
169 #------------------------------------------------------------------------
170  
171 sub add_group {
172 my $self = shift;
173 }
174  
175 #------------------------------------------------------------------------
176 # show_group( $group )
177 #
178 # Lists the entries for that group
179 #------------------------------------------------------------------------
180  
181 sub show_group {
182 my $self = shift;
183 my $group = shift;
184  
185 croak "No group specified!" if !$group;
186  
187 return $self->_read_group($group);
188 }
189  
190 #------------------------------------------------------------------------
191 # list_groups()
192 #
193 # Lists the entries for that group
194 #------------------------------------------------------------------------
195  
196 sub list_groups {
197 my $self = shift;
198 }
199  
200 #------------------------------------------------------------------------
201 # delete_group( $group_name )
202 #
203 # Deletes group name from LDAP tree
204 #------------------------------------------------------------------------
205  
206 sub delete_group {
207 my $self = shift;
208 my $group = shift;
209  
210 my $ldap = Samba::LDAP->new();
211 $ldap = $ldap->connect_ldap_slave();
212  
213 my $dn_line = $self->_get_group_dn($group);
214 ( my $dn = $dn_line ) =~ s{\A dn: [ ] }{};
215  
216 if ( !defined($dn_line) ) {
217 $self->error("$group doesn't exist\n");
218 return $self->error();
219 }
220  
221 my $modify = $ldap->delete($dn);
222 $modify->code && croak "Failed to delete group : ", $modify->error;
223  
224 # take down session
225 $ldap->unbind;
226  
227 return "$group group deleted\n.";
228 }
229  
230 #------------------------------------------------------------------------
231 # read_group_entry( $group )
232 #
233 # Return all posixGroup details
234 #------------------------------------------------------------------------
235  
236 sub read_group_entry {
237 my $self = shift;
238 my $group = shift;
239 my $entry;
240  
241 my $ldap = Samba::LDAP->new();
242 $ldap = $ldap->connect_ldap_slave();
243  
244 my $mesg = $ldap->search(
245 base => $self->{groupsdn},
246 scope => $self->{scope},
247 filter => "(&(objectclass=posixGroup)(cn=$group))"
248 );
249  
250 $mesg->code && die $mesg->error;
251 my $nb = $mesg->count;
252  
253 if ( $nb > 1 ) {
254 $self->error("Error: $nb groups exist \"cn=$group\"\n");
255  
256 foreach $entry ( $mesg->all_entries ) {
257 my $dn = $entry->dn;
258 return $dn;
259 }
260  
261 return $self->error();
262 }
263 else {
264 $entry = $mesg->shift_entry();
265 }
266 return $entry;
267 }
268  
269 #------------------------------------------------------------------------
270 # read_group_entry_gid( $group )
271 #
272 # Read the group number in the LDAP Directory
273 #------------------------------------------------------------------------
274  
275 sub read_group_entry_gid {
276 my $self = shift;
277 my $group = shift;
278  
279 my $ldap = Samba::LDAP->new();
280 $ldap = $ldap->connect_ldap_master();
281  
282 my $mesg = $ldap->search( # perform a search
283 base => $self->{groupsdn},
284 scope => $self->{scope},
285 filter => "(&(objectclass=posixGroup)(gidNumber=$group))"
286 );
287  
288 $mesg->code && die $mesg->error;
289 my $entry = $mesg->shift_entry();
290 return $entry;
291 }
292  
293 #------------------------------------------------------------------------
294 # find_groups( $username )
295 #
296 # Find the groups that $username belongs to
297 #------------------------------------------------------------------------
298  
299 sub find_groups {
300 my $self = shift;
301 my $user = shift;
302 my @groups = ();
303  
304 my $ldap = Samba::LDAP->new();
305 $ldap = $ldap->connect_ldap_master();
306  
307 # Everything apart from Open-xchange uses memberUid, OX uses
308 # member, so we do 2 searches
309 my $mesg = $ldap->search(
310 base => $self->{groupsdn},
311 scope => $self->{scope},
312 filter => "(&(objectclass=posixGroup)(memberUid=$user))"
313 );
314 $mesg->code && die $mesg->error;
315  
316 my $entry;
317 while ( $entry = $mesg->shift_entry() ) {
318 push( @groups, scalar( $entry->get_value('cn') ) );
319 }
320  
321 # OX Search
322 my $userdn = "uid=$user,$self->{usersdn}";
323 my $mesg2 = $ldap->search(
324 base => $self->{suffix},
325 scope => 'sub',
326 filter => "(&(objectclass=groupOfNames)(member=$userdn))"
327 );
328 $mesg2->code && die $mesg2->error;
329  
330 my $entry2;
331 while ( $entry2 = $mesg2->shift_entry() ) {
332 push( @groups, scalar( $entry2->get_value('cn') ) );
333 }
334  
335 return (@groups);
336 }
337  
338 #------------------------------------------------------------------------
339 # parse_group( $userGidNumber )
340 #
341 # Check the group is either a name or number
342 #------------------------------------------------------------------------
343  
344 sub parse_group {
345 my $self = shift;
346 my $userGidNumber = shift;
347  
348 if ( $userGidNumber =~ /[^\d]/ ) {
349 my $gname = $userGidNumber;
350 my $gidnum = getgrnam($gname);
351 if ( $gidnum !~ /\d+/ ) {
352 return -1;
353 }
354 else {
355 $userGidNumber = $gidnum;
356 }
357 }
358 elsif ( !defined( getgrgid($userGidNumber) ) ) {
359 return -2;
360 }
361 return $userGidNumber;
362 }
363  
364 #------------------------------------------------------------------------
365 # remove_from_group( $group, $username )
366 #
367 # Remove the user from $group
368 #------------------------------------------------------------------------
369  
370 sub remove_from_group {
371 my $self = shift;
372 my $group = shift;
373 my $user = shift;
374  
375 my $members = q{};
376  
377 my $grp_line = $self->_get_group_dn($group);
378 if ( !defined($grp_line) ) {
379 return 0;
380 }
381  
382 ( my $dn = $grp_line ) =~ s{\A dn: [ ] }{};
383  
384 # we test if the user exist in the group
385 my $is_member = $self->is_group_member( $dn, $user );
386  
387 if ( $is_member == 1 ) {
388  
389 # delete only the user from the group
390 my $ldap = Samba::LDAP->new();
391 $ldap = $ldap->connect_ldap_master();
392 my $modify = $ldap->modify(
393 "$dn",
394 changes => [
395 delete => [
396 memberUid => ["$user"],
397 member => ["uid=$user,$self->{usersdn}"],
398 ],
399 ]
400 );
401 $modify->code && die "failed to delete entry: ", $modify->error;
402 }
403 return 1;
404 }
405  
406 #========================================================================
407 # -- PRIVATE METHODS --
408 #========================================================================
409  
410 #------------------------------------------------------------------------
411 # _get_group_dn( $group )
412 #
413 # Searches for a groups distinguised name
414 #------------------------------------------------------------------------
415  
416 sub _get_group_dn {
417 my $self = shift;
418 my $group = shift;
419  
420 my $ldap = Samba::LDAP->new();
421 $ldap = $ldap->connect_ldap_master();
422  
423 if ( $group =~ /\A \d+ \z/ ) {
424 $self->{filter} =
425 "(&(objectclass=posixGroup)(|(cn=$group)(gidNumber=$group)))";
426 }
427 else {
428 $self->{filter} = "(&(objectclass=posixGroup)(cn=$group))";
429 }
430  
431 my $mesg = $ldap->search(
432 base => $self->{groupsdn},
433 scope => $self->{scope},
434 filter => $self->{filter},
435 );
436 $mesg->code && croak $mesg->error;
437  
438 for my $entry ( $mesg->all_entries ) {
439 $self->{dn} = $entry->dn;
440 }
441  
442 # For OX AddressAdmins search
443 my $mesg2 = $ldap->search(
444 base => $self->{suffix},
445 scope => $self->{scope},
446 filter => "(&(objectclass=groupOfNames)(cn=$group))"
447 );
448 $mesg2->code && die $mesg2->error;
449  
450 for my $entry ( $mesg2->all_entries ) {
451 $self->{dn} = $entry->dn;
452 }
453  
454 if ( !$self->{dn} ) {
455 croak "Can not find $group Group";
456 }
457  
458 my $dn = $self->{dn};
459 chomp($dn);
460  
461 $dn = "dn: " . $dn;
462  
463 return $dn;
464 }
465  
466 #------------------------------------------------------------------------
467 # _read_group( $group )
468 #
469 # Search for members of a group
470 #------------------------------------------------------------------------
471  
472 sub _read_group {
473 my $self = shift;
474 my $group = shift;
475  
476 my $ldap_slave = Samba::LDAP->new();
477 $ldap_slave = $ldap_slave->connect_ldap_slave();
478  
479 my $mesg = $ldap_slave->search(
480 base => $self->{groupsdn},
481 scope => $self->{scope},
482 filter => "(&(objectclass=posixGroup)(cn=$group))"
483 );
484 $mesg->code && croak $mesg->error;
485  
486 my $lines = '';
487 for my $entry ( $mesg->all_entries ) {
488 $lines .= "dn: " . $entry->dn . "\n";
489 for my $attr ( $entry->attributes ) {
490 {
491 $lines .=
492 $attr . ": " . join( ',', $entry->get_value($attr) ) . "\n";
493 }
494 }
495 }
496  
497 # take down session
498 $ldap_slave->unbind;
499  
500 chomp $lines;
501 if ( $lines eq '' ) {
502 return undef;
503 }
504  
505 return $lines;
506 }
507  
508 1; # Magic true value required at end of module
509  
510 __END__
« LDAP/Config.pm ↑ Summary LDAP/Machine.pm »