Module: GitHub::Ldap::Filter
Constant Summary collapse
- ALL_GROUPS_FILTER =
Net::LDAP::Filter.eq("objectClass", "groupOfNames") | Net::LDAP::Filter.eq("objectClass", "groupOfUniqueNames") | Net::LDAP::Filter.eq("objectClass", "posixGroup")
- MEMBERSHIP_NAMES =
%w(member uniqueMember)
Instance Method Summary collapse
-
#all_members_by_uid(uids, uid_attr) ⇒ Object
Filter to get all the members of a group which uid is included in ‘memberUid`.
-
#group_contains_filter(query) ⇒ Object
Filter groups that match a query cn.
-
#group_filter(group_names) ⇒ Object
Filter to get the configured groups in the ldap server.
-
#login_filter(uid, login) ⇒ Object
Filter to map a uid with a login.
-
#member_filter(user_dn = nil) ⇒ Object
Filter to check a group membership.
-
#members_of_group(group_dn, attr = 'memberOf') ⇒ Object
Filter to get all the members of a group using the virtual attribute ‘memberOf`.
-
#subgroups_of_group(group_dn, attr = 'memberOf') ⇒ Object
Filter to get all the members of a group that are groups using the virtual attribute ‘memberOf`.
Instance Method Details
#all_members_by_uid(uids, uid_attr) ⇒ Object
Filter to get all the members of a group which uid is included in ‘memberUid`.
uids: is an array with all the uids to search. uid_attr: is the names of the uid attribute in the directory.
Returns a Net::LDAP::Filter
80 81 82 |
# File 'lib/github/ldap/filter.rb', line 80 def all_members_by_uid(uids, uid_attr) uids.map {|uid| Net::LDAP::Filter.eq(uid_attr, uid)}.reduce(:|) end |
#group_contains_filter(query) ⇒ Object
Filter groups that match a query cn.
query: is a string to match the cn with.
Returns a Net::LDAP::Filter.
50 51 52 |
# File 'lib/github/ldap/filter.rb', line 50 def group_contains_filter(query) Net::LDAP::Filter.contains("cn", query) & ALL_GROUPS_FILTER end |
#group_filter(group_names) ⇒ Object
Filter to get the configured groups in the ldap server. Takes the list of the group names and generate a filter for the groups with cn that match.
group_names: is an array of group CNs.
Returns a Net::LDAP::Filter.
17 18 19 |
# File 'lib/github/ldap/filter.rb', line 17 def group_filter(group_names) group_names.map {|g| Net::LDAP::Filter.eq("cn", g)}.reduce(:|) end |
#login_filter(uid, login) ⇒ Object
Filter to map a uid with a login. It escapes the login before creating the filter.
uid: the entry field to map. login: the login to map.
Returns a Net::LDAP::Filter.
41 42 43 |
# File 'lib/github/ldap/filter.rb', line 41 def login_filter(uid, login) Net::LDAP::Filter.eq(uid, Net::LDAP::Filter.escape(login)) end |
#member_filter(user_dn = nil) ⇒ Object
Filter to check a group membership.
user_dn: is an optional user_dn to scope the search to.
Returns a Net::LDAP::Filter.
26 27 28 29 30 31 32 |
# File 'lib/github/ldap/filter.rb', line 26 def member_filter(user_dn = nil) if user_dn MEMBERSHIP_NAMES.map {|n| Net::LDAP::Filter.eq(n, user_dn)}.reduce(:|) else MEMBERSHIP_NAMES.map {|n| Net::LDAP::Filter.pres(n)}.reduce(:|) end end |
#members_of_group(group_dn, attr = 'memberOf') ⇒ Object
Filter to get all the members of a group using the virtual attribute ‘memberOf`.
group_dn: is the group dn to look members for. attr: is the membership attribute.
Returns a Net::LDAP::Filter
60 61 62 |
# File 'lib/github/ldap/filter.rb', line 60 def members_of_group(group_dn, attr = 'memberOf') Net::LDAP::Filter.eq(attr, group_dn) end |
#subgroups_of_group(group_dn, attr = 'memberOf') ⇒ Object
Filter to get all the members of a group that are groups using the virtual attribute ‘memberOf`.
group_dn: is the group dn to look members for. attr: is the membership attribute.
Returns a Net::LDAP::Filter
70 71 72 |
# File 'lib/github/ldap/filter.rb', line 70 def subgroups_of_group(group_dn, attr = 'memberOf') Net::LDAP::Filter.eq(attr, group_dn) & ALL_GROUPS_FILTER end |