-
Notifications
You must be signed in to change notification settings - Fork 69
/
ldap.rb
1564 lines (1316 loc) · 46.7 KB
/
ldap.rb
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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Encapsulate access to LDAP, caching results for performance. For best
# performance in applications that access large number of objects, make use
# of the preload methods to pre-fetch multiple objects in a single LDAP
# call, and rely on the cache to find the objects later.
#
# The cache makes heavy use of Weak References internally to enable garbage
# collection to reclaim objects; among other things, this ensures that
# LDAP results don't become too stale.
#
# Until garbage collection reclaims an object, calls to find methods for the
# same name is guaranteed to return the same object. Holding on to the
# results of find or preload calls (by assigning it to a variable) is
# sufficient to prevent reclaiming of objects.
#
# To illustrate, the following is likely to return the same id twice, followed
# by a new id:
# puts ASF::Person.find('rubys').__id__
# puts ASF::Person.find('rubys').__id__
# GC.start
# puts ASF::Person.find('rubys').__id__
#
# By contrast, the following is guaranteed to produce the same id three times:
# rubys1 = ASF::Person.find('rubys')
# rubys2 = ASF::Person.find('rubys')
# GC.start
# rubys3 = ASF::Person.find('rubys')
# puts [rubys1.__id__, rubys2.__id__, rubys3.__id__]
#
# Note: custom ASF LDAP attributes are defined in the file:
# https://github.com/apache/infrastructure-puppet/blob/deployment/modules/ldapserver/files/asf-custom.schema
require 'wunderbar'
require 'ldap'
require 'weakref'
require 'net/http'
require 'base64'
require 'thread'
require 'securerandom'
require 'set'
module ASF
@@weakrefs = Set.new
module LDAP
# see https://s.apache.org/IWu8
# Previously derived from the following sources:
# * https://github.com/apache/infrastructure-puppet/blob/deployment/data/common.yaml (ldapserver::slapd_peers)
# Updated 2018-02-24
RO_HOSTS = %w(
ldaps://ldap-us-ro.apache.org:636
ldaps://ldap-eu-ro.apache.org:636
)
RW_HOSTS = %w(
ldaps://ldap-master.apache.org:636
)
# Mutex preventing simultaneous connections to LDAP from a single process
CONNECT_LOCK = Mutex.new
# Round robin list of LDAP hosts to be tried after failure
HOST_QUEUE = Queue.new
# fetch configuration from apache/infrastructure-puppet
def self.puppet_config
return @puppet if @puppet
# the enclosing method is optional, so we only require the gem here
require 'yaml'
require_relative 'git' # just in case
@puppet = YAML.load(ASF::Git.infra_puppet('data/common.yaml'))
end
# extract the ldapcert from the puppet configuration
def self.puppet_cert
puppet_config['ldapclient::ldapcert']
end
# extract the ldap servers from the puppet configuration
def self.puppet_ldapservers
puppet_config['ldapserver::slapd_peers'].values.
map {|host| "ldaps://#{host}:636"}
rescue
[]
end
# connect to LDAP
def self.connect(test = true, hosts = nil)
hosts ||= self.hosts
# Try each host at most once
hosts.length.times do
# Ensure we use each host in turn
hosts.each {|host| HOST_QUEUE.push host} if HOST_QUEUE.empty?
host = HOST_QUEUE.shift
Wunderbar.info "[#{host}] - Connecting to LDAP server"
begin
# request connection
uri = URI.parse(host)
if uri.scheme == 'ldaps'
ldap = ::LDAP::SSLConn.new(uri.host, uri.port)
else
ldap = ::LDAP::Conn.new(uri.host, uri.port)
end
# test the connection
ldap.bind if test
# save the host
@host = host
return ldap
rescue ::LDAP::ResultError => re
Wunderbar.warn "[#{host}] - Error connecting to LDAP server: " +
re.message + " (continuing)"
end
end
Wunderbar.error "Failed to connect to any LDAP host"
return nil
end
# connect to LDAP with a user and password; generally required for
# update operations. If a block is passed, the connection will be
# closed after the block executes.
#
# when run interactively, will default user and prompt for password
def self.bind(user=nil, password=nil, &block)
if not user or not password
raise ArgumentError.new('Need user name and password') unless STDIN.isatty
require 'etc'
require 'io/console'
user ||= Etc.getlogin
password = STDIN.getpass("Password for #{user}:")
end
dn = ASF::Person.new(user).dn
raise ::LDAP::ResultError.new('Unknown user') unless dn
ASF.ldap.unbind if ASF.ldap.bound? rescue nil
ldap = ASF.init_ldap(true, RW_HOSTS)
if block
ASF.flush_weakrefs
ldap.bind(dn, password, &block)
ASF.init_ldap(true)
else
ldap.bind(dn, password)
end
ensure
ASF.flush_weakrefs
end
# validate HTTP authorization, and optionally invoke a block bound to
# that user.
def self.http_auth(string, &block)
auth = Base64.decode64(string.to_s[/Basic (.*)/, 1] || '')
user, password = auth.split(':', 2)
return unless password
if block
self.bind(user, password, &block)
else
begin
ASF::LDAP.bind(user, password) {}
return ASF::Person.new(user)
rescue ::LDAP::ResultError
return nil
end
end
end
# Return the last chosen host (if any)
def self.host
@host
end
# determine what LDAP hosts are available
def self.hosts(use_config = true)
return @hosts if @hosts # cache the hosts list
# try whimsy config
hosts = Array(ASF::Config.get(:ldap))
# check system configuration
if use_config and hosts.empty?
conf = "#{ETCLDAP}/ldap.conf"
if File.exist? conf
uris = File.read(conf)[/^uri\s+(.*)/i, 1].to_s
hosts = uris.scan(/ldaps?:\/\/\S+?:\d+/)
Wunderbar.debug "Using hosts from LDAP config"
end
else
Wunderbar.debug "Using hosts from Whimsy config"
end
# if all else fails, use default list
Wunderbar.debug "Using default host list" if hosts.empty?
hosts = ASF::LDAP::RO_HOSTS if hosts.empty?
hosts.shuffle!
#Wunderbar.debug "Hosts:\n#{hosts.join(' ')}"
@hosts = hosts
end
# query and extract cert from openssl output
def self.extract_cert
host = hosts.sample[%r{//(.*?)(/|$)}, 1]
puts ['openssl', 's_client', '-connect', host, '-showcerts'].join(' ')
out, err, rc = Open3.capture3 'openssl', 's_client',
'-connect', host, '-showcerts'
out[/^-+BEGIN.*?\n-+END[^\n]+\n/m]
end
# update /etc/ldap.conf. Usage:
#
# sudo ruby -r whimsy/asf -e "ASF::LDAP.configure"
#
def self.configure
cert = Dir["#{ETCLDAP}/asf*-ldap-client.pem"].first
# verify/obtain/write the cert
if not cert
cert = "#{ETCLDAP}/asf-ldap-client.pem"
File.write cert, ASF::LDAP.puppet_cert || self.extract_cert
end
# read the current configuration file
ldap_conf = "#{ETCLDAP}/ldap.conf"
content = File.read(ldap_conf)
# ensure that the right cert is used
unless content =~ /asf.*-ldap-client\.pem/
content.gsub!(/^TLS_CACERT/i, '# TLS_CACERT')
content += "TLS_CACERT #{ETCLDAP}/asf-ldap-client.pem\n"
end
# provide the URIs of the ldap hosts
content.gsub!(/^URI/, '# URI')
content += "uri \n" unless content =~ /^uri /
content[/uri (.*)\n/, 1] = hosts(false).join(' ')
# verify/set the base
unless content.include? 'base dc=apache'
content.gsub!(/^BASE/i, '# BASE')
content += "base dc=apache,dc=org\n"
end
# ensure TLS_REQCERT is allow (Mac OS/X only)
if ETCLDAP.include? 'openldap' and not content.include? 'REQCERT allow'
content.gsub!(/^TLS_REQCERT/i, '# TLS_REQCERT')
content += "TLS_REQCERT allow\n"
end
# write the configuration if there were any changes
File.write(ldap_conf, content) unless content == File.read(ldap_conf)
end
# modify an entry in LDAP; dump information on LDAP errors
def self.modify(dn, list)
ASF.ldap.modify(dn, list)
rescue ::LDAP::ResultError
Wunderbar.warn(list.inspect)
Wunderbar.warn(dn.to_s)
raise
end
# add an entry to LDAP; dump information on LDAP errors
def self.add(dn, list)
ASF.ldap.add(dn, list)
rescue ::LDAP::ResultError
Wunderbar.warn(list.inspect)
Wunderbar.warn(dn.to_s)
raise
end
# delete an entry from LDAP; dump information on LDAP errors
def self.delete(dn)
ASF.ldap.delete(dn)
rescue ::LDAP::ResultError
Wunderbar.warn(dn.to_s)
raise
end
end
# public entry point for establishing a connection safely
def self.init_ldap(reset = false, hosts = nil)
ASF::LDAP::CONNECT_LOCK.synchronize do
@ldap = nil if reset
@ldap ||= ASF::LDAP.connect(!reset, hosts)
end
end
# Directory where ldap.conf resides. Differs based on operating system.
ETCLDAP = case
when Dir.exist?('/etc/openldap') then '/etc/openldap'
when Dir.exist?('/usr/local/etc/openldap') then '/user/local//etc/openldap'
else '/etc/ldap'
end
# Returns existing LDAP connection, creating one if necessary.
def self.ldap
@ldap || self.init_ldap
end
# search with a scope of one, with automatic retry/failover
def self.search_one(base, filter, attrs=nil)
self.search_scope(::LDAP::LDAP_SCOPE_ONELEVEL, base, filter, attrs)
end
# search with a scope of subtree, with automatic retry/failover
def self.search_subtree(base, filter, attrs=nil)
self.search_scope(::LDAP::LDAP_SCOPE_SUBTREE, base, filter, attrs)
end
# search with a specified scope, with automatic retry/failover
def self.search_scope(scope, base, filter, attrs=nil)
# Dummy command, used for logging purposes only
sname = %w(base one sub children)[scope] rescue scope
cmd = "ldapsearch -x -LLL -b #{base} -s #{sname} #{filter} " +
"#{[attrs].flatten.join(' ')}"
# try once per host, with a minimum of two tries
attempts_left = [ASF::LDAP.hosts.length, 2].max
begin
attempts_left -= 1
init_ldap unless @ldap
return [] unless @ldap
target = @ldap.get_option(::LDAP::LDAP_OPT_HOST_NAME) rescue '?'
Wunderbar.info "[#{target}] #{cmd}"
result = @ldap.search2(base, scope, filter, attrs)
rescue Exception => re
if attempts_left <= 0
Wunderbar.error "[#{target}] => #{re.inspect} for #{cmd}"
raise
else
Wunderbar.warn "[#{target}] => #{re.inspect} for #{cmd}, retrying ..."
@ldap.unbind if @ldap.bound? rescue nil
@ldap = nil # force new connection
sleep 1
retry
end
end
result.map! {|hash| hash[attrs]} if String === attrs
result.compact
end
# safely dereference a weakref array attribute. Block provided is
# used when reference is not set or has been reclaimed.
def self.dereference_weakref(object, attr, &block)
attr = "@#{attr}"
value = object.instance_variable_get(attr) || block.call
value[0..-1]
rescue WeakRef::RefError
value = block.call
ensure
if not value or RUBY_VERSION.start_with? '1'
object.instance_variable_set(attr, value)
elsif value and not value.instance_of? WeakRef
object.instance_variable_set(attr, WeakRef.new(value))
end
# keep track of which weak references are saved
@@weakrefs << attr if object == self
end
def self.flush_weakrefs
@@weakrefs.each do |attr|
self.remove_instance_variable(attr)
end
@@weakrefs.clear
# run garbage collection
GC.start
end
# shortcut for dereference weakref
def self.weakref(attr, &block)
self.dereference_weakref(self, attr, &block)
end
# Obtain a list of PMC chairs from LDAP
# <tt>cn=pmc-chairs,ou=groups,ou=services,dc=apache,dc=org</tt>
def self.pmc_chairs
weakref(:pmc_chairs) {Service.find('pmc-chairs').members}
end
# Obtain a list of committers from LDAP
# <tt>cn=committers,ou=groups,dc=apache,dc=org</tt>
def self.committers
weakref(:committers) {Group.find('committers').members}
end
# Obtain a list of members from LDAP
# <tt>cn=member,ou=groups,dc=apache,dc=org</tt>
# Note: includes some non-ASF member infrastructure contractors
def self.members
weakref(:members) {Group.find('member').members}
end
# Superclass for all classes which are backed by LDAP data. Encapsulates
# the management of collections to weak references to instance data, for
# both performance and funcational reasons. Sequentially finding the same
# same object will return the same instance unless the prior instance has
# been reclaimed by garbage collection. This often prevents large numbers
# of requests to fetch the same data from LDAP.
#
# This class also contains a number of helper classes that will construct
# various LDAP <tt>mod</tt> objects.
class Base
# Simple name for the LDAP object, generally the value of <tt>uid</tt>
# for people, and the value of <tt>cn</tt> for all of the rest.
attr_reader :name
# define default sort key (make Base objects sortable)
def <=>(other)
@name <=> other.name
end
# return the LDAP base for this object: identifies the subtree where
# this object can be found.
def self.base
@base
end
# return the LDAP base for this object: identifies the subtree where
# this object can be found.
def base
self.class.base
end
# return the collection of instances of this class, as a hash. Note the
# values are weak references, so may have already been reclaimed.
def self.collection
@collection ||= Hash.new
end
# Find an instance of this class, given a name
def self.[] name
new(name)
end
# Find an instance of this class, given a name
def self.find name
new(name)
end
# Create an instance of this class, given a name. Note: if an instance
# already exists, it will return a handle to the existing object.
def self.new name
begin
object = collection[name]
return object.reference if object and object.weakref_alive?
rescue
end
super
end
# create an instance of this class, returning a weak reference to the
# object for reuse. Note: self.new will check for such a reference and
# return it in favor of allocating a new object.
def initialize name
self.class.collection[name] = WeakRef.new(self)
@name = name
end
# returns a reference to the underlying object. Useful for converting
# weak references to strong references.
def reference
self
end
# construct a weak reference to this object
def weakref(attr, &block)
ASF.dereference_weakref(self, attr, &block)
end
# Return the simple name for this LDAP object. This is the value of
# <tt>uid</tt> for people objects, and the value of <tt>cn</tt> for all
# other objects.
def id
@name
end
# helper method to construct LDAP_MOD_ADD objects
def self.mod_add(attr, vals)
::LDAP::Mod.new(::LDAP::LDAP_MOD_ADD, attr.to_s, Array(vals))
end
# helper method to construct LDAP_MOD_REPLACE objects
def self.mod_replace(attr, vals)
vals = Array(vals) unless Hash === vals
::LDAP::Mod.new(::LDAP::LDAP_MOD_REPLACE, attr.to_s, vals)
end
# helper method to construct LDAP_MOD_DELETE objects
def self.mod_delete(attr, vals)
::LDAP::Mod.new(::LDAP::LDAP_MOD_DELETE, attr.to_s, Array(vals))
end
def hasLDAP?
ASF.search_one(base, "cn=#{name}", 'cn').any?
end
end
# a hash of attributes which is not populated until the first attempt
# to reference a value
class LazyHash < Hash
# capture an initializer to be called only if necessary.
def initialize(&initializer)
@initializer = initializer
end
# if referencing a key that is not in the hash, and the initializer has
# not yet been called, call the initializer, merge the results, and
# try again.
def [](key)
result = super
if not result and not keys.include? key and @initializer
merge! @initializer.call || {}
@initializer = nil
result = super
end
result
end
end
# Manage committers: list, add, and remove people not only from the list
# of people, but from the list of committers.
class Committer < Base
@base = 'ou=role,ou=groups,dc=apache,dc=org'
# get a list of committers
def self.list()
ASF.search_one(base, 'cn=committers', 'member').flatten.
map {|uid| Person.find uid[/uid=(.*?),/,1]}
end
# get a list of committers (ids only)
def self.listids()
ASF.search_one(base, 'cn=committers', 'member').flatten.
map {|uid| uid[/uid=(.*?),/,1]}
end
# create a new person and add as a new committer to LDAP.
# Attrs must include uid, cn, and mail
def self.create(attrs)
# add person to LDAP
person = ASF::Person.add(attrs)
# add person to 'new' committers list
ASF::LDAP.modify("cn=committers,#@base",
[ASF::Base.mod_add('member', [person.dn])])
# add person to 'legacy' committers list
ASF::Group['committers'].add(person)
# return new person
person
end
# rename a person
def rename(newid, attrs={})
# ensure person exists in LDAP
raise ArgumentError(self.id) unless self.dn
# create a new person
new_person = ASF::Person.create(self.attrs.merge(attrs).merge(uid: newid))
# determine what groups the individual is a member of
uid_groups = ASF.search_subtree('dc=apache,dc=org',
'memberUid=#{self.id}', 'dn').flatten
dn_groups = ASF.search_subtree('dc=apache,dc=org',
'member=#{self.dn}', 'dn').flatten
# add new user to all groups
uid_groups.each do |dn|
ASF::LDAP.modify(dn, [ASF::Base.mod_add('memberUid', new_person.id)])
end
dn_groups.each do |dn|
ASF::LDAP.modify(dn, [ASF::Base.mod_add('member', new_person.dn)])
end
# remove original user from all groups
uid_groups.each do |dn|
ASF::LDAP.modify(dn, [ASF::Base.mod_delete('memberUid', self.id)])
end
dn_groups.each do |dn|
ASF::LDAP.modify(dn, [ASF::Base.mod_delete('member', self.dn)])
end
# remove original user
ASF::Person.remove(person.id)
# return new user
new_person
end
# completely remove a committer from LDAP
# ** DO NOT USE **
# In almost all cases, use deregister instead
def self.destroy(person)
# if person is a string, find the person object
person = ASF::Person.find(person) if person.instance_of? String
# remove person from 'legacy' committers list, ignoring exceptions
ASF::Group['committers'].remove(person) rescue nil
# remove person from 'new' committers list, ignoring exceptions
ASF::LDAP.modify("cn=committers,#@base",
[ASF::Base.mod_delete('member', [person.dn])]) rescue nil
# remove person from LDAP (should almost never be done)
ASF::Person.remove(person.id)
end
# register an existing person as a committer
# updates both committer LDAP groups
def self.register(person)
if person.instance_of? String
id = person # save for use in error message
person = ASF::Person[person] or raise ArgumentError.new("Cannot find person: '#{id}'")
end
# add person to 'new' committers list
ASF::LDAP.modify("cn=committers,#@base",
[ASF::Base.mod_add('member', [person.dn])])
# add person to 'legacy' committers list
ASF::Group['committers'].add(person)
end
# deregister an existing person as a committer
# updates both committer LDAP groups
def self.deregister(person)
if person.instance_of? String
id = person # save for use in error message
person = ASF::Person[person] or raise ArgumentError.new("Cannot find person: '#{id}'")
end
# remove person from 'legacy' committers list
ASF::Group['committers'].remove(person)
# remove person from 'new' committers list
ASF::LDAP.modify("cn=committers,#@base",
[ASF::Base.mod_delete('member', [person.dn])])
end
end
class Person < Base
@base = 'ou=people,dc=apache,dc=org'
def self.group_base
'ou=people,' + ASF::Group.base
end
# Obtain a list of people known to LDAP. LDAP filters may be used
# to retrieve only a subset.
def self.list(filter='uid=*')
ASF.search_one(base, filter, 'uid').flatten.map {|uid| find(uid)}
end
# Obtain a list of people (ids) known to LDAP. LDAP filters may be used
# to retrieve only a subset. Result is returned as a list of ids only.
def self.listids(filter='uid=*')
ASF.search_one(base, filter, 'uid').flatten
end
# pre-fetch a given set of attributes, for a given list of people
def self.preload(attributes, people=[])
list = Hash.new {|hash, name| hash[name] = find(name)}
attributes = [attributes].flatten
if people.empty? or people.length > 1000
filter = "(|#{attributes.map {|attribute| "(#{attribute}=*)"}.join})"
else
filter = "(|#{people.map {|person| "(uid=#{person.name})"}.join})"
end
zero = Hash[attributes.map {|attribute| [attribute,nil]}]
data = ASF.search_one(base, filter, attributes + ['uid'])
data = Hash[data.map! {|hash| [list[hash['uid'].first], hash]}]
data.each {|person, hash| person.attrs.merge!(zero.merge(hash))}
if people.empty?
(list.values - data.keys).each do |person|
person.attrs.merge! zero
end
end
list.values
end
# return person only if it actually exits
def self.[] id
person = super
person.attrs['dn'] ? person : nil
end
# list of LDAP attributes for this person, populated lazily upon
# first reference.
def attrs
@attrs ||= LazyHash.new {ASF.search_one(base, "uid=#{name}").first}
end
# reload all attributes from LDAP
def reload!
@attrs = nil
attrs
end
# Is this person listed in the committers LDAP group?
def asf_committer?
ASF::Group.new('committers').include? self
end
# determine if the person is banned. If scanning a large list, consider
# preloading the <tt>loginShell</tt> attributes for these people.
def banned?
# FreeBSD uses /usr/bin/false; Ubuntu uses /bin/false
not attrs['loginShell'] or %w(/bin/false bin/nologin bin/no-cla).any? {|a| attrs['loginShell'].first.include? a}
end
# determine if the person has no login. If scanning a large list, consider
# preloading the <tt>loginShell</tt> attributes for these people.
def nologin?
# FreeBSD uses /usr/bin/false; Ubuntu uses /bin/false
not attrs['loginShell'] or %w(/bin/false bin/nologin bin/no-cla).any? {|a| attrs['loginShell'].first.include? a}
end
# determine if the person has asf-banned: yes. If scanning a large list, consider
# preloading the <tt>asf-banned</tt> attributes for these people.
def asf_banned?
# No idea what this means (yet)
attrs['asf-banned'] == 'yes'
end
# primary mail addresses
def mail
attrs['mail'] || []
end
# list all of the alternative emails for this person
def alt_email
attrs['asf-altEmail'] || []
end
# list all of the PGP key fingerprints
def pgp_key_fingerprints
attrs['asf-pgpKeyFingerprint'] || []
end
# list all of the ssh public keys
def ssh_public_keys
attrs['sshPublicKey'] || []
end
# list all of the personal URLs
def urls
attrs['asf-personalURL'] || []
end
# list of LDAP committees that this individual is a member of
def committees
# legacy LDAP entries
committees = weakref(:committees) do
Committee.list("member=uid=#{name},#{base}")
end
# add in projects (currently only includes GUINEAPIGS)
# Get list of project names where the person is an owner
projects = self.projects.select{|prj| prj.owners.include? self}.map(&:name)
committees += ASF::Committee.pmcs.select do |pmc|
projects.include? pmc.name
end
# dedup
committees.uniq
end
# list of LDAP projects that this individual is a member of
def projects
weakref(:projects) do
Project.list("member=uid=#{name},#{base}")
end
end
# list of LDAP projects that this individual is an owner of - i.e. on (P)PMC
# not all PMC currently have project groups
def project_owners
weakref(:project_owners) do
Project.list("owner=uid=#{name},#{base}")
end
end
# list of LDAP groups that this individual is a member of
def groups
weakref(:groups) do
Group.list("memberUid=#{name}")
end
end
# list of LDAP services that this individual is a member of
def services
weakref(:services) do
Service.list("member=#{dn}")
end
end
# Designated Name from LDAP
def dn
"uid=#{name},#{ASF::Person.base}"
end
# Allow arbitrary LDAP attibutes to be referenced as object properties.
# Example: <tt>ASF::Person.find('rubys').cn</tt>. Can also be used
# to modify an LDAP attribute.
def method_missing(name, *args)
if name.to_s.end_with? '=' and args.length == 1
return modify(name.to_s[0..-2], args)
end
return super unless args.empty?
result = self.attrs[name.to_s]
return super unless result
if result.empty?
return nil
else
result.map! do |value|
value = value.dup.force_encoding('utf-8') if String === value
value
end
if result.length == 1
result.first
else
result
end
end
end
# update an LDAP attribute for this person. This needs to be run
# either inside or after ASF::LDAP.bind.
def modify(attr, value)
ASF::LDAP.modify(self.dn, [ASF::Base.mod_replace(attr.to_s, value)])
attrs[attr.to_s] = value
end
# add a new person to LDAP. Attrs must include uid, cn, and mail
def self.add(attrs)
# convert keys to strings
attrs = attrs.map {|key, value| [key.to_s, value]}.to_h
# verify required arguments are present
%w(uid cn mail).each do |required|
unless attrs.include? required
raise ArgumentError.new("missing attribute #{required}")
end
end
availid = attrs['uid']
# determine next uid and group, unless provided
nextuid = attrs['uidNumber'] ||
ASF::search_one(ASF::Person.base, 'uid=*', 'uidNumber').
flatten.map(&:to_i).max + 1
nextgid = attrs['gidNumber']
unless nextgid
nextgid = ASF::search_one(group_base, 'cn=*', 'gidNumber').
flatten.map(&:to_i).max + 1
# create new LDAP group
entry = [
mod_add('objectClass', ['posixGroup', 'top']),
mod_add('cn', availid),
mod_add('userPassword', '{crypt}*'),
mod_add('gidNumber', nextgid.to_s),
]
end
# fixed attributes
attrs.merge!({
'uidNumber' => nextuid.to_s,
'gidNumber' => nextuid.to_s,
'asf-committer-email' => "#{availid}@apache.org",
'objectClass' => %w(person top posixAccount organizationalPerson
inetOrgPerson asf-committer hostObject ldapPublicKey)
})
# defaults
attrs['loginShell'] ||= '/usr/local/bin/bash'
attrs['homeDirectory'] ||= "/home/#{availid}"
attrs['host'] ||= "home.apache.org"
attrs['asf-sascore'] ||= "10"
# parse name
attrs = ASF::Person.ldap_name(attrs['cn']).merge(attrs)
# generate a password that is between 8 and 16 alphanumeric characters
if not attrs['userPassword']
while attrs['userPassword'].to_s.length < 8
attrs['userPassword'] = SecureRandom.base64(12).gsub(/\W+/, '')
end
end
ASF::LDAP.add("cn=#{availid},#{group_base}", entry)
# create new LDAP person
begin
entry = attrs.map {|key, value| mod_add(key, value)}
ASF::LDAP.add("uid=#{availid},#{base}", entry)
rescue
# don't leave an orphan group behind
ASF::LDAP.delete("cn=#{availid},#{group_base}") rescue nil
raise
end
# return person object with password filled in
person = ASF::Person.find(availid)
person.attrs['userPassword'] = [attrs['userPassword']]
person
end
# remove a person from LDAP
def self.remove(availid)
ASF::LDAP.delete("cn=#{availid},#{group_base}")
ASF::LDAP.delete("uid=#{availid},#{base}")
end
end
#
# Access to LDAP groups; where committer lists for PMCs have traditionally
# been stored. The intent is to move this data to member attributes on
# Project lists.
#
class Group < Base
@base = 'ou=groups,dc=apache,dc=org'
# obtain a list of groups from LDAP
def self.list(filter='cn=*')
ASF.search_one(base, filter, 'cn').flatten.map {|cn| find(cn)}
end
# determine if a given ASF::Person is a member of this group
def include?(person)
filter = "(&(cn=#{name})(memberUid=#{person.name}))"
if ASF.search_one(base, filter, 'cn').empty?
return false
else
return true
end
end
# fetch <tt>dn</tt>, <tt>member</tt>, <tt>modifyTimestamp</tt>, and
# <tt>createTimestamp</tt> for all groups in LDAP.
def self.preload
Hash[ASF.search_one(base, "cn=*", %w(dn memberUid modifyTimestamp createTimestamp)).map do |results|
cn = results['dn'].first[/^cn=(.*?),/, 1]
group = ASF::Group.find(cn)
group.modifyTimestamp = results['modifyTimestamp'].first # it is returned as an array of 1 entry
group.createTimestamp = results['createTimestamp'].first # it is returned as an array of 1 entry
members = results['memberUid'] || []
group.members = members
[group, members]
end]
end
# Date this committee was last modified in LDAP.
attr_accessor :modifyTimestamp
# Date this committee was initially created in LDAP.
attr_accessor :createTimestamp
# return group only if it actually exits
def self.[] name
group = super
group.members.empty? ? nil : group
end
# setter for members, should only be used by #preload
def members=(members)
@members = WeakRef.new(members)
end