passiveldap 0.1

data/lib/user.rb

@@ -0,0 +1,423 @@
+require "passiveldap"
+require "iconv"
+
+# the User class is a real-life example of the usage of PassiveLDAP.
+#
+# Most of the attributes are commented out, because I don't really use them, but they have their :multi_valued
+# attribute set if they may be multi_valued (using A/D and the following objectclasses: top,person,user,organizationalperson),
+# so they can be safely uncommented if needed.
+#
+# Some of the attributes are renamed, because they are used to represent something else (like workshops instead of department)
+class User < PassiveLDAP::Base
+
+  COUNTRIES = [
+    [ "(válassz)", "" ],
+    [ "Afganisztán", "AF" ],
+[ "Aland", "AX" ],
+[ "Albánia", "AL" ],
+[ "Algéria", "DZ" ],
+[ "Amerikai Csendes-óceáni szigetek", "UM" ],
+[ "Amerikai Egyesült Államok", "US" ],
+[ "Amerikai Szamoa", "AS" ],
+[ "Amerikai Virgin-szigetek", "VI" ],
+[ "Andorra", "AD" ],
+[ "Angola", "AO" ],
+[ "Anguilla", "AI" ],
+[ "Antarktisz", "AQ" ],
+[ "Antigua és Barbuda", "AG" ],
+[ "Argentína", "AR" ],
+[ "Aruba", "AW" ],
+[ "Ausztrália", "AU" ],
+[ "Ausztria", "AT" ],
+[ "Azerbajdzsán", "AZ" ],
+[ "Bahama-szigetek", "BS" ],
+[ "Bahrein", "BH" ],
+[ "Banglades", "BD" ],
+[ "Barbados", "BB" ],
+[ "Belgium", "BE" ],
+[ "Belize", "BZ" ],
+[ "Benin", "BJ" ],
+[ "Bermuda", "BM" ],
+[ "Bhután", "BT" ],
+[ "Bissau-Guinea", "GW" ],
+[ "Bolívia", "BO" ],
+[ "Bosznia-Hercegovina", "BA" ],
+[ "Botswana", "BW" ],
+[ "Bouvet-sziget", "BV" ],
+[ "Brazília", "BR" ],
+[ "Brit Indiai-óceáni terület", "IO" ],
+[ "Brit Virgin-szigetek", "VG" ],
+[ "Brunei", "BN" ],
+[ "Bulgária", "BG" ],
+[ "Burkina Faso", "BF" ],
+[ "Burundi", "BI" ],
+[ "Chile", "CL" ],
+[ "Ciprus", "CY" ],
+[ "Comore-szigetek", "KM" ],
+[ "Cook-szigetek", "CK" ],
+[ "Costa Rica", "CR" ],
+[ "Csád", "TD" ],
+[ "Csehország", "CZ" ],
+[ "Dánia", "DK" ],
+[ "Dél-afrikai Köztársaság", "ZA" ],
+[ "Dél-Georgia és Déli-Sandwich-szigetek", "GS" ],
+[ "Dominikai Közösség", "DM" ],
+[ "Dominikai Köztársaság", "DO" ],
+[ "Dzsibuti", "DJ" ],
+[ "Ecuador", "EC" ],
+[ "Egyenlítői-Guinea", "GQ" ],
+[ "Egyesült Arab Emírségek", "AE" ],
+[ "Egyiptom", "EG" ],
+[ "Elefántcsontpart", "CI" ],
+[ "El Salvador", "SV" ],
+[ "Eritrea", "ER" ],
+[ "Északi-Mariana-szigetek", "MP" ],
+[ "Észtország", "EE" ],
+[ "Etiópia", "ET" ],
+[ "Falkland-szigetek", "FK" ],
+[ "Fehéroroszország", "BY" ],
+[ "Feröer", "FO" ],
+[ "Fidzsi", "FJ" ],
+[ "Finnország", "FI" ],
+[ "Francia déli és antarktiszi területek", "TF" ],
+[ "Francia Guyana", "GF" ],
+[ "Franciaország", "FR" ],
+[ "Francia Polinézia", "PF" ],
+[ "Fülöp-szigetek", "PH" ],
+[ "Gabon", "GA" ],
+[ "Gambia", "GM" ],
+[ "Ghána", "GH" ],
+[ "Gibraltár", "GI" ],
+[ "Görögország", "GR" ],
+[ "Grenada", "GD" ],
+[ "Grönland", "GL" ],
+[ "Grúzia", "GE" ],
+[ "Guadeloupe", "GP" ],
+[ "Guam", "GU" ],
+[ "Guatemala", "GT" ],
+[ "Guinea", "GN" ],
+[ "Guyana", "GY" ],
+[ "Haiti", "HT" ],
+[ "Heard-sziget és McDonald-szigetek", "HM" ],
+[ "Holland Antillák", "AN" ],
+[ "Hollandia", "NL" ],
+[ "Honduras", "HN" ],
+[ "Hongkong", "HK" ],
+[ "Horvátország", "HR" ],
+[ "India", "IN" ],
+[ "Indonézia", "ID" ],
+[ "Irak", "IQ" ],
+[ "Irán", "IR" ],
+[ "Írország", "IE" ],
+[ "Izland", "IS" ],
+[ "Izrael", "IL" ],
+[ "Jamaika", "JM" ],
+[ "Japán", "JP" ],
+[ "Jemen", "YE" ],
+[ "Jordánia", "JO" ],
+[ "Kajmán-szigetek", "KY" ],
+[ "Kambodzsa", "KH" ],
+[ "Kamerun", "CM" ],
+[ "Kanada", "CA" ],
+[ "Karácsony-sziget", "CX" ],
+[ "Katar", "QA" ],
+[ "Kazahsztán", "KZ" ],
+[ "Kelet-Timor", "TL" ],
+[ "Kenya", "KE" ],
+[ "Kína", "CN" ],
+[ "Kirgizisztán", "KG" ],
+[ "Kiribati", "KI" ],
+[ "Kókusz (Keeling)-szigetek", "CC" ],
+[ "Kolumbia", "CO" ],
+[ "Kongói Demokratikus Köztársaság (Zaire)", "CD" ],
+[ "Kongói Köztársaság (Kongó)", "CG" ],
+[ "Dél-Korea (Koreai Köztársaság)", "KR" ],
+[ "Észak-Korea (Koreai NDK)", "KP" ],
+[ "Közép-Afrika", "CF" ],
+[ "Kuba", "CU" ],
+[ "Kuvait", "KW" ],
+[ "Laosz", "LA" ],
+[ "Lengyelország", "PL" ],
+[ "Lesotho", "LS" ],
+[ "Lettország", "LV" ],
+[ "Libanon", "LB" ],
+[ "Libéria", "LR" ],
+[ "Líbia", "LY" ],
+[ "Liechtenstein", "LI" ],
+[ "Litvánia", "LT" ],
+[ "Luxemburg", "LU" ],
+[ "Macedónia", "MK" ],
+[ "Madagaszkár", "MG" ],
+[ "Magyarország", "HU" ],
+[ "Makaó", "MO" ],
+[ "Malajzia", "MY" ],
+[ "Malawi", "MW" ],
+[ "Maldív-szigetek", "MV" ],
+[ "Mali", "ML" ],
+[ "Málta", "MT" ],
+[ "Marokkó", "MA" ],
+[ "Marshall-szigetek", "MH" ],
+[ "Martinique", "MQ" ],
+[ "Mauritánia", "MR" ],
+[ "Mauritius", "MU" ],
+[ "Mayotte", "YT" ],
+[ "Mexikó", "MX" ],
+[ "Mianmar", "MM" ],
+[ "Mikronézia", "FM" ],
+[ "Moldova", "MD" ],
+[ "Monaco", "MC" ],
+[ "Mongólia", "MN" ],
+[ "Montserrat", "MS" ],
+[ "Mozambik", "MZ" ],
+[ "Nagy-Britannia (Egyesült Királyság)", "GB" ],
+[ "Namíbia", "NA" ],
+[ "Nauru", "NR" ],
+[ "Németország", "DE" ],
+[ "Nepál", "NP" ],
+[ "Nicaragua", "NI" ],
+[ "Niger", "NE" ],
+[ "Nigéria", "NG" ],
+[ "Niue", "NU" ],
+[ "Norfolk-sziget", "NF" ],
+[ "Norvégia", "NO" ],
+[ "Nyugat-Szahara", "EH" ],
+[ "Olaszország", "IT" ],
+[ "Omán", "OM" ],
+[ "Oroszország", "RU" ],
+[ "Örményország", "AM" ],
+[ "Pakisztán", "PK" ],
+[ "Palau", "PW" ],
+[ "Palesztina", "PS" ],
+[ "Panama", "PA" ],
+[ "Pápua Új-Guinea", "PG" ],
+[ "Paraguay", "PY" ],
+[ "Peru", "PE" ],
+[ "Pitcairn-szigetek", "PN" ],
+[ "Portugália", "PT" ],
+[ "Puerto Rico", "PR" ],
+[ "Réunion", "RE" ],
+[ "Románia", "RO" ],
+[ "Ruanda", "RW" ],
+[ "Saint Kitts és Nevis", "KN" ],
+[ "Saint Lucia", "LC" ],
+[ "Saint Pierre és Miquelon", "PM" ],
+[ "Saint Vincent és a Grenadine-szigetek", "VC" ],
+[ "Salamon-szigetek", "SB" ],
+[ "San Marino", "SM" ],
+[ "Sao Tomé és Príncipe", "ST" ],
+[ "Seychelle-szigetek", "SC" ],
+[ "Sierra Leone", "SL" ],
+[ "Spanyolország", "ES" ],
+[ "Srí Lanka", "LK" ],
+[ "Suriname", "SR" ],
+[ "Svájc", "CH" ],
+[ "Svalbard (Spitzbergák) és Jan Mayen", "SJ" ],
+[ "Svédország", "SE" ],
+[ "Szamoa", "WS" ],
+[ "Szaúd-Arábia", "SA" ],
+[ "Szenegál", "SN" ],
+[ "Szent Ilona", "SH" ],
+[ "Szerbia és Montenegró", "CS" ],
+[ "Szingapúr", "SG" ],
+[ "Szíria", "SY" ],
+[ "Szlovákia", "SK" ],
+[ "Szlovénia", "SI" ],
+[ "Szomália", "SO" ],
+[ "Szudán", "SD" ],
+[ "Szváziföld", "SZ" ],
+[ "Tádzsikisztán", "TJ" ],
+[ "Tajvan", "TW" ],
+[ "Tanzánia", "TZ" ],
+[ "Thaiföld", "TH" ],
+[ "Togó", "TG" ],
+[ "Tokelau", "TK" ],
+[ "Tonga", "TO" ],
+[ "Törökország", "TR" ],
+[ "Trinidad és Tobago", "TT" ],
+[ "Tunézia", "TN" ],
+[ "Turks- és Caicos-szigetek", "TC" ],
+[ "Tuvalu", "TV" ],
+[ "Türkmenisztán", "TM" ],
+[ "Uganda", "UG" ],
+[ "Új-Kaledónia", "NC" ],
+[ "Új-Zéland", "NZ" ],
+[ "Ukrajna", "UA" ],
+[ "Uruguay", "UY" ],
+[ "Üzbegisztán", "UZ" ],
+[ "Vanuatu", "VU" ],
+[ "Vatikán", "VA" ],
+[ "Venezuela", "VE" ],
+[ "Vietnam", "VN" ],
+[ "Wallis és Futuna", "WF" ],
+[ "Zambia", "ZM" ],
+[ "Zimbabwe", "ZW" ],
+[ "Zöld-foki-szigetek", "CV" ],
+  ]
+
+  passive_ldap \
+    :id_attribute => :uidnumber, 
+    :record_base => "cn=Users,dc=eotvos,dc=elte,dc=hu",
+    :default_array_separator => "\n",
+    :default_protection_level => 2
+  passive_ldap_attr  \
+                      :badpwdcount => { :name => :bad_password_count,
+                                        :read_only => true },
+                                :c => { :name => :country_id, :default_value => "HU", :level => 1 },
+                               :cn => { :name => :common_name,
+                                        :default_value => Proc.new { |s| "user_#{s.id}" } }, 
+#                              :co => { :name => :country },
+                         :codepage => { :default_value => "0",
+                                        :read_only => true,
+                                        :hidden => true },
+                          :comment => { },
+                          :company => { :name => :university },
+#                     :countrycode => { :name => :country_code },
+                       :department => { :name => :main_workshop, :default_value => "other", :level => 1 },
+                 :departmentnumber => { :name => :workshops,
+                                        :multi_valued => true, :level => 1},
+                      :description => { :name => :about,
+                                        :multi_valued => true },
+                    # :displayname => attribute is at the end of the list!
+#                        :division => { },
+                               :dn => { :default_value => Proc.new { |s| "cn=#{s.common_name},#{s.class.settings[:record_base]}" },
+                                        :read_only => true,
+                                        :hidden => true },
+#                      :employeeid => { :name => :employee_id },
+#                  :employeenumber => { :name => :employee_number },
+                     :employeetype => { :name => :user_status, :level => 1, :default_value => "Bentlakó hallgató" },
+#        :facsimiletelephonenumber => { :name => :fax },
+                        :gidnumber => { :name => :linux_group_id,
+                                        :default_value => "10001",
+                                        :read_only => true,
+                                        :hidden => true },
+                        :givenname => { :name => :first_name, :level => 1 },
+#                   :homedirectory => { :name => :home_directory,
+#                                       :read_only => true,
+#                                       :default_value => Proc.new { |s| "/home/#{s.common_name}" } },
+                        :homephone => { :name => :home_phone, :level => 1 },
+#               :homepostaladdress => { :name => :home_postal_address },
+#                 :houseidentifier => { :name => :house_identifier,
+#                                       :multi_valued => true},
+                             :info => { },
+#                        :initials => { },
+                          :ipphone => { :name => :ip_phone, :level => 1 },
+                                :l => { :name => :location, :level => 1 },
+                       :lastlogoff => { :name => :last_logoff,
+                                        :read_only => true,
+                                        :type => PassiveLDAP::Types::ANSI_Date },
+                        :lastlogon => { :name => :last_logon,
+                                        :read_only => true,
+                                        :type => PassiveLDAP::Types::ANSI_Date },
+                       :loginshell => { :name => :linux_login_shell,
+                                        :default_value => "/usr/bin/rssh",
+                                        :read_only => true,
+                                        :hidden => true },
+                       :logoncount => { :name => :logon_count,
+                                        :read_only => true },
+                             :mail => { :level => 1},
+                      :mssfu30name => { :name => :linux_account_name,
+                                        :default_value => Proc.new { |s| s.common_name },
+                                        :read_only => true,
+                                        :hidden => true },
+                 :mssfu30nisdomain => { :name => :linux_domain,
+                                        :default_value => "eotvos",
+                                        :read_only => true,
+                                        :hidden => true },
+                       :middlename => { :name => :middle_name, :level => 1 },
+                           :mobile => { :level => 1},
+#                  :networkaddress => { :name => :network_address },
+                                :o => { :name => :organization },
+                      :objectclass => { :name => :object_class,
+                                        :default_value => %w{top person organizationalPerson user},
+                                        :multi_valued => true,
+                                        :read_only => true,
+                                        :hidden => true },
+#   :otherfacsimiletelephonenumber => { :name => :other_faxes,
+#                                       :multi_valued => true },
+                   :otherhomephone => { :name => :other_home_phones,
+                                        :multi_valued => true, :level => 1 },
+                     :otheripphone => { :name => :other_ip_phones,
+                                        :multi_valued => true, :level => 1 },
+                     :othermailbox => { :name => :other_mailboxes,
+                                        :multi_valued => true, :level => 1 },
+                      :othermobile => { :name => :other_mobiles,
+                                        :multi_valued => true, :level => 1 },
+#                      :otherpager => { :name => :other_pagers,
+#                                       :multi_valued => true },
+#                  :othertelephone => { :name => :other_phones,
+#                                       :multi_valued => true },
+#                              :ou => { :name => :organizational_unit,
+#                                       :multi_valued => true },
+#                           :pager => { },
+#                   :personaltitle => { :name => :personal_title },
+       :physicaldeliveryofficename => { :name => :office_name },
+#                   :postaladdress => { :name => :postal_address,
+#                                       :multi_valued => true},
+                       :postalcode => { :name => :postal_code, :level => 1 },
+#                  :postofficebox  => { :name => :post_office_box,
+#                                       :multi_valued => true},
+#                  :primarygroupid => { :name => :primary_group_id,
+#                                       :read_only => true },
+#                     :profilepath => { :name => :profile_path,
+#                                       :read_only => true },
+                       :pwdlastset => { :name => :password_last_set,
+                                        :read_only => true,
+                                        :type => PassiveLDAP::Types::ANSI_Date },
+                       :roomnumber => { :name => :room_number, :level => 1 },
+                   :samaccountname => { :name => :sam_account_name,
+                                        :read_only => true,
+                                        :default_value => Proc.new { |s| s.common_name },
+                                        :hidden => true },
+#                  :samaccounttype => { :name => :sam_account_type,
+#                                       :default_value => "805306368", # beware! can't set default_value of this attribute at creation, it will result in an error
+#                                       :read_only => true,
+#                                       :hidden => true },
+#                      :scriptpath => { :name => :script_path,
+#                                       :read_only => true },
+                               :sn => { :name => :surname,
+                                        :default_value => Proc.new { |s| s.common_name }, :level => 1 },
+                               :st => { :name => :state, :level => 1 },
+#                          :street => { :name => :street },
+                    :streetaddress => { :name => :street_address, :level => 1 },
+#                :telephonenumber  => { :name => :phone },
+                            :title => { :name => :occupation },
+                              :uid => { :multi_valued => true,
+                                        :default_value => Proc.new { |s| [s.common_name] },
+                                        :read_only => true,
+                                        :hidden => true },
+                       :unicodepwd => { :default_value => Proc.new { |s| if s.new_record? then Iconv.conv("UCS-2LE","UTF-8",'"aBc123!?"') else nil end },
+                                        :read_only => true,
+                                        :hidden => true }, 
+                                        # AD uses UCS-2 Little Endian encoding, and the password string is quoted with "-s.
+                                        # Because the unicodePwd is write-only and invisible in AD, we only want a default_value
+                                        # if the record is new, that is why we return nil if the record is not new.
+                                        # See PassiveLDAP::Base#set_password for more info
+                :unixhomedirectory => { :name => :linux_home_directory,
+                                        :default_value => Proc.new { |s| "/home/#{s.common_name}" },
+                                        :read_only => true,
+                                        :hidden => true },
+                              :url => { :multi_valued => true, :level => 1 },
+               :useraccountcontrol => { :default_value => "512",
+                                        :read_only => true,
+                                        :hidden => true },
+                :userprincipalname => { :name => :user_principal_name,
+                                        :default_value => Proc.new { |s| "#{s.common_name}@eotvos.elte.hu" },
+                                        :read_only => true,
+                                        :hidden => true },
+                      :wwwhomepage => { :level => 1},
+                      # this attribute is at the end, because it's default value uses surname and firstname
+                      :displayname => { :name => :display_name, :level => 1,
+                                        :default_value => Proc.new { |s| "#{s.surname} #{s.first_name}"} }
+
+  validates_presence_of :surname, :first_name, :message => "A neveket meg kell adni"
+  validates_format_of :mail, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :allow_nil => true, :allow_blank => true, :message => "Az e-mail cím formátuma hibás!"
+  validates_format_of_each :other_mailboxes, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :allow_nil => true, :allow_blank => true, :message => "A további e-mail címek valamelyike hibás formátumú!"
+  validates_format_of :mobile, :with => /\A[-+ _0-9]*\Z/, :allow_nil => true, :allow_blank => true,:message => "A mobiltelefonszám csak számokat és a \"-\", \"+\", \" \", \"_\" jeleket tartalmazhatja!"
+  validates_format_of :postal_code, :with => /\A[0-9]*\Z/,:allow_nil => true, :allow_blank => true, :message => "Az irányítószám csak szám lehet!"
+  validates_format_of :room_number, :with => /\A[0-9]*\Z/, :allow_nil => true, :allow_blank => true,:message => "A szobaszám csak szám lehet!"
+  validates_format_of :home_phone, :with => /\A[-+ _0-9]*\Z/, :allow_nil => true, :allow_blank => true,:message => "A telefonszám csak számokat és a \"-\", \"+\", \" \", \"_\" jeleket tartalmazhatja!"
+  validates_format_of_each :other_mobiles, :with => /\A[-+ _0-9]*\Z/, :allow_nil => true, :allow_blank => true,:message => "A mobilszámok csak számokat és a \"-\", \"+\", \" \", \"_\" jeleket tartalmazhatják!"
+  validates_format_of_each :other_home_phones, :with => /\A[-+ _0-9]*\Z/, :allow_nil => true, :allow_blank => true,:message => "A telefonszámok csak számokat és a \"-\", \"+\", \" \", \"_\" jeleket tartalmazhatják!"
+
+  validates_inclusion_of :country_id, :in => COUNTRIES.map { |disp, value| value }
+end

data/tests/README

@@ -0,0 +1,20 @@
+== Info
+
+These tests should run by an ADAM instance, whose schema has been
+extended by the schema_adam.ldif file (change the CN=X to your
+configuration base), and the person class has been extended with
+this uidnumber attribute. The :record_base and some other config
+values are hard-coded in the user.rb test files, so you should change
+it too.
+
+Of course other LDAP servers should work too, but I only tested this in
+an ADAM instance, because I didn't want to make a test environment
+in our production AD server. Some functions could not be tested
+in ADAM (for example I could only bind to an ADAM instence
+using anonymous connection, so things like set_protection_level,
+bind, or anything else that needs authentication are untested)
+
+Be sure to allow anonymous access, read/write, etc in your ADAM server!
+
+If you use some other servers please modify the test so they could work on
+them, and send those tests to me!

data/tests/scheme_adam.ldif

@@ -0,0 +1,19 @@
+dn: CN=Uid-Number,CN=Schema,CN=Configuration,CN=X
+changetype: ntdsschemaadd
+objectClass: top
+objectClass: attributeSchema
+cn: Uid-Number
+attributeID: 1.2.840.113556.1.4.302.1.2.3.4.5.6.7
+attributeSyntax: 2.5.5.9
+isSingleValued: TRUE
+rangeLower: 1
+rangeUpper: 100000
+showInAdvancedViewOnly: TRUE
+adminDisplayName: Uid-Number
+adminDescription: Uid-Number
+instanceType: 4
+oMSyntax: 2
+searchFlags: 0
+lDAPDisplayName: uidNumber
+schemaIDGUID:: MnqWv+YM0BGihQCqADBJ4g==
+systemOnly: FALSE