├── VERSION
├── .gitignore
├── Gemfile
├── Rakefile
├── lib
├── active_directory
│ ├── version.rb
│ ├── attributes.rb
│ ├── attributes
│ │ ├── group_type.rb
│ │ └── sam_account_type.rb
│ ├── computer.rb
│ ├── field_type
│ │ ├── binary.rb
│ │ ├── date.rb
│ │ ├── dn_array.rb
│ │ ├── group_dn_array.rb
│ │ ├── user_dn_array.rb
│ │ ├── password.rb
│ │ ├── member_dn_array.rb
│ │ └── timestamp.rb
│ ├── member.rb
│ ├── container.rb
│ ├── group.rb
│ ├── user.rb
│ └── base.rb
└── active_directory.rb
├── CHANGELOG.adoc
├── test
└── sid.rb
├── active_directory.gemspec
├── README.md
└── LICENSE
/VERSION:
--------------------------------------------------------------------------------
1 | 1.6.2
2 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | pkg/*
2 | *.gem
3 | .bundle
4 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | gemspec
3 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | require 'bundler'
2 | Bundler::GemHelper.install_tasks
3 |
--------------------------------------------------------------------------------
/lib/active_directory/version.rb:
--------------------------------------------------------------------------------
1 | module ActiveDirectory
2 | VERSION = '1.6.1.1'.freeze
3 | end
4 |
--------------------------------------------------------------------------------
/lib/active_directory/attributes.rb:
--------------------------------------------------------------------------------
1 | %w[sam_account_type group_type].each do |file_name|
2 | require 'active_directory/attributes/' + file_name
3 | end
4 |
--------------------------------------------------------------------------------
/CHANGELOG.adoc:
--------------------------------------------------------------------------------
1 | Ruby ActiveDirectory ChangeLog
2 | ==============================
3 |
4 | :website: https://github.com/Mazwak/active_directory
5 |
6 |
7 | Version 1.6.2 (2015-06-04)
8 | --------------------------
9 | .Additions and changes
10 | - Add from_dn method in base to access a single entry
11 | - Add an experimental security group creation
12 |
--------------------------------------------------------------------------------
/lib/active_directory/attributes/group_type.rb:
--------------------------------------------------------------------------------
1 | module ActiveDirectory
2 | module GroupType
3 | BUILTIN_LOCAL_GROUP = 0x00000001
4 | ACCOUNT_GROUP = 0x00000002
5 | RESSOURCE_GROUP = 0x00000004
6 | UNIVERSAL_GROUP = 0x00000008
7 | APP_BASIC_GROUP = 0x00000010
8 | APP_QUERY_GROUP = 0x00000020
9 | SECURITY_ENABLED = 0x80000000
10 | end
11 | end
12 |
--------------------------------------------------------------------------------
/test/sid.rb:
--------------------------------------------------------------------------------
1 | require 'minitest/autorun'
2 |
3 | class TestActiveDirectory < MiniTest::Test
4 | def test_binary_sid_to_string
5 | assert_equal 'S-1-5-21-1482476501-1993962763-1801674531-17860',
6 | ActiveDirectory::SID.read(['010500000000000515000000d5cb5c580b75d976235f636bc4450000'].pack('H*')).to_s
7 | assert_equal 'S-1-5-21-1482476501-1993962763-1801674531-9679',
8 | ActiveDirectory::SID.read(['010500000000000515000000d5cb5c580b75d976235f636bcf250000'].pack('H*')).to_s
9 | end
10 | end
11 |
--------------------------------------------------------------------------------
/lib/active_directory/attributes/sam_account_type.rb:
--------------------------------------------------------------------------------
1 | module ActiveDirectory
2 | module SamAccountType
3 | DOMAIN_OBJECT = 0x0
4 | GROUP_OBJECT = 0x10000000
5 | NON_SECURITY_GROUP_OBJECT = 0x10000001
6 | ALIAS_OBJECT = 0x20000000
7 | NON_SECURITY_ALIAS_OBJECT = 0x20000001
8 | USER_OBJECT = 0x30000000
9 | NORMAL_USER_ACCOUNT = 0x30000000
10 | MACHINE_ACCOUNT = 0x30000001
11 | TRUST_ACCOUNT = 0x30000002
12 | APP_BASIC_GROUP = 0x40000000
13 | APP_QUERY_GROUP = 0x40000001
14 | ACCOUNT_TYPE_MAX = 0x7fffffff
15 | end
16 | end
17 |
--------------------------------------------------------------------------------
/active_directory.gemspec:
--------------------------------------------------------------------------------
1 | require File.expand_path('./lib/active_directory/version', __FILE__)
2 |
3 | Gem::Specification.new do |s|
4 | s.name = 'active_directory'
5 | s.license = 'GPL-3.0'
6 | s.version = ActiveDirectory::VERSION
7 | s.date = Date.today.to_s
8 | s.summary = "An interface library for accessing Microsoft's Active Directory."
9 | s.description = <<-DESC
10 | ActiveDirectory uses Net::LDAP to provide a means of accessing
11 | and modifying an Active Directory data store.
12 | This is a fork of the activedirectory gem.
13 | DESC
14 | s.authors = ['Simon Arnaud', 'Adam T Kerr', 'Keith Pitty', 'James Hunt']
15 | s.email = 'active_directory.ruby.maz@kabalo.org'
16 | s.homepage = 'http://github.com/mazwak/active_directory'
17 |
18 | s.files = Dir['lib/**/*', 'README*', 'LICENSE*', 'VERSION*']
19 | s.extra_rdoc_files = [
20 | 'README.md'
21 | ]
22 |
23 | s.required_ruby_version = '~> 2'
24 | s.add_dependency 'net-ldap', '~> 0'
25 | s.add_dependency 'bindata', '~> 2'
26 |
27 | s.add_development_dependency 'minitest', '~> 5'
28 | end
29 |
--------------------------------------------------------------------------------
/lib/active_directory/computer.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | class Computer < Base
23 | def self.filter # :nodoc:
24 | Net::LDAP::Filter.eq(:objectClass, 'computer')
25 | end
26 |
27 | def self.required_attributes # :nodoc:
28 | { objectClass: %w[top person organizationalPerson user computer] }
29 | end
30 |
31 | def hostname
32 | dNSHostName || name
33 | end
34 | end
35 | end
36 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/binary.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class Binary
24 | #
25 | # Encodes a hex string into a GUID
26 | #
27 | def self.encode(hex_string)
28 | [hex_string].pack('H*')
29 | end
30 |
31 | #
32 | # Decodes a binary GUID as a hex string
33 | #
34 | def self.decode(guid)
35 | guid.unpack('H*').first.to_s
36 | end
37 | end
38 | end
39 | end
40 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/date.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class Date
24 | #
25 | # Converts a time object into an ISO8601 format compatable with Active Directory
26 | #
27 | def self.encode(local_time)
28 | local_time.strftime('%Y%m%d%H%M%S.0Z')
29 | end
30 |
31 | #
32 | # Decodes an Active Directory date when stored as ISO8601
33 | #
34 | def self.decode(remote_time)
35 | Time.parse(remote_time)
36 | end
37 | end
38 | end
39 | end
40 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/dn_array.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class DnArray
24 | #
25 | # Encodes an array of objects into a list of dns
26 | #
27 | def self.encode(obj_array)
28 | obj_array.collect(&:dn)
29 | end
30 |
31 | #
32 | # Decodes a list of DNs into the objects that they are
33 | #
34 | def self.decode(dn_array)
35 | # How to do user or group?
36 | Base.find(:all, distinguishedname: dn_array)
37 | end
38 | end
39 | end
40 | end
41 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/group_dn_array.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class GroupDnArray
24 | #
25 | # Encodes an array of objects into a list of dns
26 | #
27 | def self.encode(obj_array)
28 | obj_array.collect(&:dn)
29 | end
30 |
31 | #
32 | # Decodes a list of DNs into the objects that they are
33 | #
34 | def self.decode(dn_array)
35 | # How to do user or group?
36 | Group.find(:all, distinguishedname: dn_array)
37 | end
38 | end
39 | end
40 | end
41 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/user_dn_array.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class UserDnArray
24 | #
25 | # Encodes an array of objects into a list of dns
26 | #
27 | def self.encode(obj_array)
28 | obj_array.collect(&:dn)
29 | end
30 |
31 | #
32 | # Decodes a list of DNs into the objects that they are
33 | #
34 | def self.decode(dn_array)
35 | # How to do user or group?
36 | User.find(:all, distinguishedname: dn_array)
37 | end
38 | end
39 | end
40 | end
41 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/password.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class Password
24 | #
25 | # Encodes an unencrypted password into an encrypted password
26 | # that the Active Directory server will understand.
27 | #
28 | def self.encode(password)
29 | ("\"#{password}\"".split(//).collect { |c| "#{c}\000" }).join
30 | end
31 |
32 | #
33 | # Always returns nil, since you can't decrypt the User's encrypted
34 | # password.
35 | #
36 | def self.decode(_hashed)
37 | nil
38 | end
39 | end
40 | end
41 | end
42 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | = Active Directory
2 |
3 | Ruby Integration with Microsoft's Active Directory system based on original code by Justin Mecham and James Hunt at http://rubyforge.org/projects/activedirectory
4 |
5 | See documentation on ActiveDirectory::Base for more information.
6 |
7 | Caching:
8 | Queries for membership and group membership are based on the distinguished name of objects. Doing a lot of queries, especially for a Rails app, is a sizable slowdown. To alleviate the problem, I've implemented a very basic cache for queries which search by :distinguishedname. This is disabled by default. All other queries are unaffected.
9 |
10 |
11 | A code example is worth a thousand words:
12 |
13 |
14 | require 'rubygems'
15 | require 'active_directory'
16 |
17 | # Uses the same settings as net/ldap
18 | settings = {
19 | :host => 'domain-controller.example.local',
20 | :base => 'dc=example,dc=local',
21 | :port => 636,
22 | :encryption => :simple_tls,
23 | :auth => {
24 | :method => :simple,
25 | :username => "username",
26 | :password => "password"
27 | }
28 | }
29 |
30 | # Basic usage
31 | ActiveDirectory::Base.setup(settings)
32 |
33 | ActiveDirectory::User.find(:all)
34 | ActiveDirectory::User.find(:first, :userprincipalname => "john.smith@domain.com")
35 |
36 | ActiveDirectory::Group.find(:all)
37 |
38 | #Caching is disabled by default, to enable:
39 | ActiveDirectory::Base.enable_cache
40 | ActiveDirectory::Base.disable_cache
41 | ActiveDirectory::Base.cache?
42 |
43 |
44 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/member_dn_array.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class MemberDnArray
24 | #
25 | # Encodes an array of objects into a list of dns
26 | #
27 | def self.encode(obj_array)
28 | obj_array.collect(&:dn)
29 | end
30 |
31 | #
32 | # Decodes a list of DNs into the objects that they are
33 | #
34 | def self.decode(dn_array)
35 | # Ensures that the objects are cast correctly
36 | users = User.find(:all, distinguishedname: dn_array)
37 | groups = Group.find(:all, distinguishedname: dn_array)
38 |
39 | arr = []
40 | arr << users unless users.nil?
41 | arr << groups unless groups.nil?
42 |
43 | arr.flatten
44 | end
45 | end
46 | end
47 | end
48 |
--------------------------------------------------------------------------------
/lib/active_directory/field_type/timestamp.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module FieldType
23 | class Timestamp
24 | AD_DIVISOR = 10_000_000 #:nodoc:
25 | AD_OFFSET = 11_644_473_600 #:nodoc:
26 |
27 | #
28 | # Encodes a local Time object (or the number of seconds since January
29 | # 1, 1970) into a timestamp that the Active Directory server can
30 | # understand (number of 100 nanosecond time units since January 1, 1600)
31 | #
32 | def self.encode(local_time)
33 | (local_time.to_i + AD_OFFSET) * AD_DIVISOR
34 | end
35 |
36 | #
37 | # Decodes an Active Directory timestamp (the number of 100 nanosecond time
38 | # units since January 1, 1600) into a Ruby Time object.
39 | #
40 | def self.decode(remote_time)
41 | Time.at((remote_time.to_i / AD_DIVISOR) - AD_OFFSET)
42 | end
43 | end
44 | end
45 | end
46 |
--------------------------------------------------------------------------------
/lib/active_directory/member.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | module Member
23 | #
24 | # Returns true if this member (User or Group) is a member of
25 | # the passed Group object.
26 | #
27 | def member_of?(usergroup)
28 | group_dns = memberOf
29 | return false if group_dns.nil? || group_dns.empty?
30 | # group_dns = [group_dns] unless group_dns.is_a?(Array)
31 | group_dns.map(&:dn).include?(usergroup.dn)
32 | end
33 |
34 | #
35 | # Add the member to the passed Group object. Returns true if this object
36 | # is already a member of the Group, or if the operation to add it succeeded.
37 | #
38 | def join(group)
39 | return false unless group.is_a?(Group)
40 | group.add(self)
41 | end
42 |
43 | #
44 | # Remove the member from the passed Group object. Returns true if this
45 | # object is not a member of the Group, or if the operation to remove it
46 | # succeeded.
47 | #
48 | def unjoin(group)
49 | return false unless group.is_a?(Group)
50 | group.remove(self)
51 | end
52 | end
53 | end
54 |
--------------------------------------------------------------------------------
/lib/active_directory.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | require 'net/ldap'
22 |
23 | require 'active_directory/base.rb'
24 | require 'active_directory/container.rb'
25 | require 'active_directory/member.rb'
26 |
27 | require 'active_directory/user.rb'
28 | require 'active_directory/group.rb'
29 | require 'active_directory/computer.rb'
30 |
31 | require 'active_directory/field_type/password.rb'
32 | require 'active_directory/field_type/binary.rb'
33 | require 'active_directory/field_type/date.rb'
34 | require 'active_directory/field_type/timestamp.rb'
35 | require 'active_directory/field_type/dn_array.rb'
36 | require 'active_directory/field_type/user_dn_array.rb'
37 | require 'active_directory/field_type/group_dn_array.rb'
38 | require 'active_directory/field_type/member_dn_array.rb'
39 |
40 | module ActiveDirectory
41 | # Special Fields
42 | def self.special_fields
43 | @@special_fields
44 | end
45 |
46 | def self.special_fields=(sp_fields)
47 | @@special_fields = sp_fields
48 | end
49 |
50 | @@special_fields = {
51 |
52 | # All objects in the AD
53 | Base: {
54 | objectguid: :Binary,
55 | whencreated: :Date,
56 | whenchanged: :Date,
57 | memberof: :DnArray
58 | },
59 |
60 | # User objects
61 | User: {
62 | objectguid: :Binary,
63 | whencreated: :Date,
64 | whenchanged: :Date,
65 | objectsid: :Binary,
66 | msexchmailboxguid: :Binary,
67 | msexchmailboxsecuritydescriptor: :Binary,
68 | lastlogontimestamp: :Timestamp,
69 | pwdlastset: :Timestamp,
70 | accountexpires: :Timestamp,
71 | memberof: :MemberDnArray
72 | },
73 |
74 | # Group objects
75 | Group: {
76 | objectguid: :Binary,
77 | whencreate: :Date,
78 | whenchanged: :Date,
79 | objectsid: :Binary,
80 | memberof: :GroupDnArray,
81 | member: :MemberDnArray
82 | },
83 |
84 | # Computer objects
85 | Computer: {
86 | objectguid: :Binary,
87 | whencreated: :Date,
88 | whenchanged: :Date,
89 | objectsid: :Binary,
90 | memberof: :GroupDnArray,
91 | member: :MemberDnArray
92 | }
93 | }
94 | end
95 |
--------------------------------------------------------------------------------
/lib/active_directory/container.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | #
23 | # The ActiveDirectory::Container class represents a more malleable way
24 | # of dealing with LDAP Distinguished Names (dn), like
25 | # "cn=UserName,ou=Users,dc=example,dc=org".
26 | #
27 | # The following two representations of the above dn are identical:
28 | #
29 | # dn = "cn=UserName,ou=Users,dc=example,dc=org"
30 | # dn = ActiveDirectory::Container.dc('org').dc('example').ou('Users').cn('UserName').to_s
31 | #
32 | class Container
33 | attr_reader :type
34 | attr_reader :name
35 | attr_reader :parent
36 |
37 | def initialize(type, name, node = nil) #:nodoc:
38 | @type = type
39 | @name = name
40 | @node = node
41 | end
42 |
43 | #
44 | # Creates a starting OU (Organizational Unit) dn part.
45 | #
46 | # # ou_part = "ou=OrganizationalUnit"
47 | # ou_part = ActiveDirectory::Container.ou('OrganizationalUnit').to_s
48 | #
49 | def self.ou(name)
50 | new(:ou, name, nil)
51 | end
52 |
53 | #
54 | # Creates a starting DC (Domain Component) dn part.
55 | #
56 | # # dc_part = "dc=net"
57 | # dc_part = ActiveDirectory::Container.dc('net').to_s
58 | #
59 | def self.dc(name)
60 | new(:dc, name, nil)
61 | end
62 |
63 | #
64 | # Creates a starting CN (Canonical Name) dn part.
65 | #
66 | # # cn_part = "cn=CanonicalName"
67 | # cn_part = ActiveDirectory::Container.cn('CanonicalName').to_s
68 | #
69 | def self.cn(name)
70 | new(:cn, name, nil)
71 | end
72 |
73 | #
74 | # Appends an OU (Organizational Unit) dn part to another Container.
75 | #
76 | # # ou = "ou=InfoTech,dc=net"
77 | # ou = ActiveDirectory::Container.dc("net").ou("InfoTech").to_s
78 | #
79 | def ou(name)
80 | self.class.new(:ou, name, self)
81 | end
82 |
83 | #
84 | # Appends a DC (Domain Component) dn part to another Container.
85 | #
86 | # # base = "dc=example,dc=net"
87 | # base = ActiveDirectory::Container.dc("net").dc("example").to_s
88 | #
89 | def dc(name)
90 | self.class.new(:dc, name, self)
91 | end
92 |
93 | #
94 | # Appends a CN (Canonical Name) dn part to another Container.
95 | #
96 | # # user = "cn=UID,ou=Users"
97 | # user = ActiveDirectory::Container.ou("Users").cn("UID")
98 | #
99 | def cn(name)
100 | self.class.new(:cn, name, self)
101 | end
102 |
103 | #
104 | # Converts the Container object to its String representation.
105 | #
106 | def to_s
107 | @node ? "#{@type}=#{name},#{@node}" : "#{@type}=#{name}"
108 | end
109 |
110 | def ==(other) #:nodoc:
111 | to_s.casecmp(other.to_s.downcase).zero?
112 | end
113 | end
114 | end
115 |
--------------------------------------------------------------------------------
/lib/active_directory/group.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | require 'active_directory/attributes'
22 |
23 | module ActiveDirectory
24 | class Group < Base
25 | include Member
26 |
27 | def self.filter # :nodoc:
28 | Net::LDAP::Filter.eq(:objectClass, 'group')
29 | end
30 |
31 | def self.required_attributes # :nodoc:
32 | { objectClass: %w[top group] }
33 | end
34 |
35 | def reload # :nodoc:
36 | @member_users_non_r = nil
37 | @member_users_r = nil
38 | @member_groups_non_r = nil
39 | @member_groups_r = nil
40 | @groups = nil
41 | super
42 | end
43 |
44 | #
45 | # Returns true if the passed User or Group object belongs to
46 | # this group. For performance reasons, the check is handled
47 | # by the User or Group object passed.
48 | #
49 | def has_member?(user)
50 | user.member_of?(self)
51 | end
52 |
53 | def self.create_security_group(ou, name, type)
54 | type_mask = GroupType::SECURITY_ENABLED
55 | case type
56 | when :local
57 | type_mask |= GroupType::RESSOURCE_GROUP
58 | when :global
59 | type_mask |= GroupType::ACCOUNT_GROUP
60 | when :universal
61 | type_mask |= GroupType::UNIVERSAL_GROUP
62 | else
63 | raise "Unknown type specified : #{type}"
64 | end
65 | dn = 'CN=' + name + ',' + ou
66 | attributes = {
67 | objectClass: %w[top group],
68 | sAMAccountName: name,
69 | objectCategory: 'CN=Group,CN=Schema,CN=Configuration,DC=afssa,DC=fr',
70 | groupType: type_mask.to_s
71 | }
72 | @@ldap.add(dn: dn, attributes: attributes)
73 | from_dn(dn)
74 | end
75 |
76 | #
77 | # Add the passed User or Group object to this Group. Returns true if
78 | # the User or Group is already a member of the group, or if the operation
79 | # to add them succeeds.
80 | #
81 | def add(new_member)
82 | return false unless new_member.is_a?(User) || new_member.is_a?(Group)
83 | if @@ldap.modify(dn: distinguishedName, operations: [
84 | [:add, :member, new_member.distinguishedName]
85 | ])
86 | return true
87 | else
88 | return has_member?(new_member)
89 | end
90 | end
91 |
92 | #
93 | # Remove a User or Group from this Group. Returns true if the User or
94 | # Group does not belong to this Group, or if the oepration to remove them
95 | # succeeds.
96 | #
97 | def remove(member)
98 | return false unless member.is_a?(User) || member.is_a?(Group)
99 | if @@ldap.modify(dn: distinguishedName, operations: [
100 | [:delete, :member, member.distinguishedName]
101 | ])
102 | return true
103 | else
104 | return !has_member?(member)
105 | end
106 | end
107 |
108 | def has_members?
109 | return @entry.member.nil? || @entry.member.empty? ? false : true
110 | rescue NoMethodError
111 | return false
112 | end
113 |
114 | #
115 | # Returns an array of all User objects that belong to this group.
116 | #
117 | # If the recursive argument is passed as false, then only Users who
118 | # belong explicitly to this Group are returned.
119 | #
120 | # If the recursive argument is passed as true, then all Users who
121 | # belong to this Group, or any of its subgroups, are returned.
122 | #
123 | def member_users(recursive = false)
124 | @member_users = User.find(:all, distinguishedname: @entry[:member]).delete_if(&:nil?)
125 | if recursive
126 | member_groups.each do |group|
127 | @member_users.concat(group.member_users(true))
128 | end
129 | end
130 | @member_users
131 | end
132 |
133 | #
134 | # Returns an array of all Group objects that belong to this group.
135 | #
136 | # If the recursive argument is passed as false, then only Groups that
137 | # belong explicitly to this Group are returned.
138 | #
139 | # If the recursive argument is passed as true, then all Groups that
140 | # belong to this Group, or any of its subgroups, are returned.
141 | #
142 | def member_groups(recursive = false)
143 | @member_groups ||= Group.find(:all, distinguishedname: @entry[:member]).delete_if(&:nil?)
144 | if recursive
145 | member_groups.each do |group|
146 | @member_groups.concat(group.member_groups(true))
147 | end
148 | end
149 | @member_groups
150 | end
151 |
152 | #
153 | # Returns an array of Group objects that this Group belongs to.
154 | #
155 | def groups
156 | return [] if memberOf.nil?
157 | @groups ||= Group.find(:all, distinguishedname: @entry.memberOf).delete_if(&:nil?)
158 | end
159 | end
160 | end
161 |
--------------------------------------------------------------------------------
/lib/active_directory/user.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | module ActiveDirectory
22 | class User < Base
23 | include Member
24 |
25 | UAC_ACCOUNT_DISABLED = 0x0002
26 | UAC_NORMAL_ACCOUNT = 0x0200 # 512
27 | UAC_PASSWORD_NEVER_EXPIRES = 0x10000 # 65536
28 |
29 | def self.filter # :nodoc:
30 | Net::LDAP::Filter.eq(:objectClass, 'user') & ~Net::LDAP::Filter.eq(:objectClass, 'computer')
31 | end
32 |
33 | def self.required_attributes #:nodoc:
34 | { objectClass: %w[top organizationalPerson person user] }
35 | end
36 |
37 | # Try to authenticate the current User against Active Directory
38 | # using the supplied password. Returns false upon failure.
39 | #
40 | # Authenticate can fail for a variety of reasons, primarily:
41 | #
42 | # * The password is wrong
43 | # * The account is locked
44 | # * The account is disabled
45 | #
46 | # User#locked? and User#disabled? can be used to identify the
47 | # latter two cases, and if the account is enabled and unlocked,
48 | # Athe password is probably invalid.
49 | #
50 | def authenticate(password)
51 | return false if password.to_s.empty?
52 |
53 | auth_ldap = @@ldap.dup.bind_as(
54 | filter: "(sAMAccountName=#{sAMAccountName})",
55 | password: password
56 | )
57 | end
58 |
59 | #
60 | # Return the User's manager (another User object), depending on
61 | # what is stored in the manager attribute.
62 | #
63 | # Returns nil if the schema does not include the manager attribute
64 | # or if no manager has been configured.
65 | #
66 | def manager
67 | return nil if @entry.manager.nil?
68 | User.find_by_distinguishedName(@entry.manager.to_s)
69 | end
70 |
71 | #
72 | # Returns an array of Group objects that this User belongs to.
73 | # Only the immediate parent groups are returned, so if the user
74 | # Sally is in a group called Sales, and Sales is in a group
75 | # called Marketting, this method would only return the Sales group.
76 | #
77 | def groups
78 | @groups ||= Group.find(:all, distinguishedname: @entry[:memberOf])
79 | end
80 |
81 | #
82 | # Returns an array of User objects that have this
83 | # User as their manager.
84 | #
85 | def direct_reports
86 | return [] if @entry.directReports.nil?
87 | @direct_reports ||= User.find(:all, @entry.directReports)
88 | end
89 |
90 | #
91 | # Returns true if this account has been locked out
92 | # (usually because of too many invalid authentication attempts).
93 | #
94 | # Locked accounts can be unlocked with the User#unlock! method.
95 | #
96 | def locked?
97 | !lockoutTime.nil? && lockoutTime.to_i != 0
98 | end
99 |
100 | #
101 | # Returns true if this account has been disabled.
102 | #
103 | def disabled?
104 | userAccountControl.to_i & UAC_ACCOUNT_DISABLED != 0
105 | end
106 |
107 | #
108 | # Disables the account
109 | #
110 | def disable
111 | new_mask = userAccountControl.to_i | UAC_ACCOUNT_DISABLED
112 | update_attributes userAccountControl: new_mask.to_s
113 | end
114 |
115 | #
116 | # Enables the account
117 | #
118 | def enable
119 | new_mask = userAccountControl.to_i ^ UAC_ACCOUNT_DISABLED
120 | update_attributes userAccountControl: new_mask.to_s
121 | end
122 |
123 | #
124 | # Returns true if this account is expired.
125 | #
126 | def expired?
127 | !lockoutTime.nil? && lockoutTime.to_i != 0
128 | end
129 |
130 | #
131 | # Returns true if this account has a password that does not expire.
132 | #
133 | def password_never_expires?
134 | userAccountControl.to_i & UAC_PASSWORD_NEVER_EXPIRES != 0
135 | end
136 |
137 | #
138 | # Returns true if the user should be able to log in with a correct
139 | # password (essentially, their account is not disabled or locked
140 | # out).
141 | #
142 | def can_login?
143 | !disabled? && !locked?
144 | end
145 |
146 | #
147 | # Change the password for this account.
148 | #
149 | # This operation requires that the bind user specified in
150 | # Base.setup have heightened privileges. It also requires an
151 | # SSL connection.
152 | #
153 | # If the force_change argument is passed as true, the password will
154 | # be marked as 'expired', forcing the user to change it the next
155 | # time they successfully log into the domain.
156 | #
157 | def change_password(new_password, force_change = false)
158 | settings = @@settings.dup.merge(
159 | port: 636,
160 | encryption: { method: :simple_tls }
161 | )
162 |
163 | ldap = Net::LDAP.new(settings)
164 | ldap.modify(
165 | dn: distinguishedName,
166 | operations: [
167 | [:replace, :lockoutTime, ['0']],
168 | [:replace, :unicodePwd, [FieldType::Password.encode(new_password)]],
169 | [:replace, :userAccountControl, [UAC_NORMAL_ACCOUNT.to_s]],
170 | [:replace, :pwdLastSet, [(force_change ? '0' : '-1')]]
171 | ]
172 | )
173 | end
174 |
175 | #
176 | # Unlocks this account.
177 | #
178 | def unlock!
179 | @@ldap.replace_attribute(distinguishedName, :lockoutTime, ['0'])
180 | end
181 | end
182 | end
183 |
--------------------------------------------------------------------------------
/lib/active_directory/base.rb:
--------------------------------------------------------------------------------
1 | #-- license
2 | #
3 | # Based on original code by Justin Mecham and James Hunt
4 | # at http://rubyforge.org/projects/activedirectory
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU General Public License
17 | # along with this program. If not, see .
18 | #
19 | #++ license
20 |
21 | require 'bindata'
22 |
23 | module ActiveDirectory
24 | #
25 | # Create a SID from the binary string in the directory
26 | #
27 | class SID < BinData::Record
28 | endian :little
29 | uint8 :revision
30 | uint8 :dashes
31 | uint48be :nt_authority
32 | uint32 :nt_non_unique
33 | array :uuids, type: :uint32, initial_length: -> { dashes - 1 }
34 | def to_s
35 | ['S', revision, nt_authority, nt_non_unique, uuids].join('-')
36 | end
37 | end
38 |
39 | #
40 | # Base class for all Ruby/ActiveDirectory Entry Objects (like User and Group)
41 | #
42 | class Base
43 | #
44 | # A Net::LDAP::Filter object that doesn't do any filtering
45 | # (outside of check that the CN attribute is present. This
46 | # is used internally for specifying a 'no filter' condition
47 | # for methods that require a filter object.
48 | #
49 | NIL_FILTER = Net::LDAP::Filter.pres('cn')
50 |
51 | @@ldap = nil
52 | @@ldap_connected = false
53 | @@caching = false
54 | @@cache = {}
55 |
56 | #
57 | # Configures the connection for the Ruby/ActiveDirectory library.
58 | #
59 | # For example:
60 | #
61 | # ActiveDirectory::Base.setup(
62 | # :host => 'domain_controller1.example.org',
63 | # :port => 389,
64 | # :base => 'dc=example,dc=org',
65 | # :auth => {
66 | # :method => :simple,
67 | # :username => 'querying_user@example.org',
68 | # :password => 'querying_users_password'
69 | # }
70 | # )
71 | #
72 | # This will configure Ruby/ActiveDirectory to connect to the domain
73 | # controller at domain_controller1.example.org, using port 389. The
74 | # domain's base LDAP dn is expected to be 'dc=example,dc=org', and
75 | # Ruby/ActiveDirectory will try to bind as the
76 | # querying_user@example.org user, using the supplied password.
77 | #
78 | # Currently, there can be only one active connection per
79 | # execution context.
80 | #
81 | # For more advanced options, refer to the Net::LDAP.new
82 | # documentation.
83 | #
84 | def self.setup(settings)
85 | @@settings = settings
86 | @@ldap_connected = false
87 | @@ldap = Net::LDAP.new(settings)
88 | end
89 |
90 | def self.error
91 | "#{@@ldap.get_operation_result.code}: #{@@ldap.get_operation_result.message}"
92 | end
93 |
94 | ##
95 | # Return the last errorcode that ldap generated
96 | def self.error_code
97 | @@ldap.get_operation_result.code
98 | end
99 |
100 | ##
101 | # Check to see if the last query produced an error
102 | # Note: Invalid username/password combinations will not
103 | # produce errors
104 | def self.error?
105 | @@ldap.nil? ? false : @@ldap.get_operation_result.code != 0
106 | end
107 |
108 | ##
109 | # Check to see if we are connected to the LDAP server
110 | # This method will try to connect, if we haven't already
111 | def self.connected?
112 | @@ldap_connected ||= @@ldap.bind unless @@ldap.nil?
113 | @@ldap_connected
114 | rescue Net::LDAP::LdapError
115 | false
116 | end
117 |
118 | ##
119 | # Check to see if result caching is enabled
120 | def self.cache?
121 | @@caching
122 | end
123 |
124 | ##
125 | # Clears the cache
126 | def self.clear_cache
127 | @@cache = {}
128 | end
129 |
130 | ##
131 | # Enable caching for queries against the DN only
132 | # This is to prevent membership lookups from hitting the
133 | # AD unnecessarilly
134 | def self.enable_cache
135 | @@caching = true
136 | end
137 |
138 | ##
139 | # Disable caching
140 | def self.disable_cache
141 | @@caching = false
142 | end
143 |
144 | def self.filter # :nodoc:
145 | NIL_FILTER
146 | end
147 |
148 | def self.required_attributes # :nodoc:
149 | {}
150 | end
151 |
152 | #
153 | # Check to see if any entries matching the passed criteria exists.
154 | #
155 | # Filters should be passed as a hash of
156 | # attribute_name => expected_value, like:
157 | #
158 | # User.exists?(
159 | # :sn => 'Hunt',
160 | # :givenName => 'James'
161 | # )
162 | #
163 | # which will return true if one or more User entries have an
164 | # sn (surname) of exactly 'Hunt' and a givenName (first name)
165 | # of exactly 'James'.
166 | #
167 | # Partial attribute matches are available. For instance,
168 | #
169 | # Group.exists?(
170 | # :description => 'OldGroup_*'
171 | # )
172 | #
173 | # would return true if there are any Group objects in
174 | # Active Directory whose descriptions start with OldGroup_,
175 | # like OldGroup_Reporting, or OldGroup_Admins.
176 | #
177 | # Note that the * wildcard matches zero or more characters,
178 | # so the above query would also return true if a group named
179 | # 'OldGroup_' exists.
180 | #
181 | def self.exists?(filter_as_hash)
182 | criteria = make_filter_from_hash(filter_as_hash) & filter
183 | @@ldap.search(filter: criteria).!empty?
184 | end
185 |
186 | #
187 | # Whether or not the entry has local changes that have not yet been
188 | # replicated to the Active Directory server via a call to Base#save
189 | #
190 | def changed?
191 | !@attributes.empty?
192 | end
193 |
194 | ##
195 | # Makes a single filter from a given key and value
196 | # It will try to encode an array if there is a process for it
197 | # Otherwise, it will treat it as an or condition
198 | def self.make_filter(key, value)
199 | # Join arrays using OR condition
200 | if value.is_a? Array
201 | filter = ~NIL_FILTER
202 |
203 | value.each do |v|
204 | filter |= Net::LDAP::Filter.eq(key, encode_field(key, v).to_s)
205 | end
206 | else
207 | filter = Net::LDAP::Filter.eq(key, encode_field(key, value).to_s)
208 | end
209 |
210 | filter
211 | end
212 |
213 | def self.make_filter_from_hash(hash) # :nodoc:
214 | return NIL_FILTER if hash.nil? || hash.empty?
215 |
216 | filter = NIL_FILTER
217 |
218 | hash.each do |key, value|
219 | filter &= make_filter(key, value)
220 | end
221 |
222 | filter
223 | end
224 |
225 | def self.from_dn(dn)
226 | ldap_result = @@ldap.search(filter: '(objectClass=*)', base: dn)
227 | return nil unless ldap_result
228 |
229 | ad_obj = new(ldap_result[0])
230 | @@cache[ad_obj.dn] = ad_obj unless ad_obj.instance_of? Base
231 | ad_obj
232 | end
233 |
234 | #
235 | # Performs a search on the Active Directory store, with similar
236 | # syntax to the Rails ActiveRecord#find method.
237 | #
238 | # The first argument passed should be
239 | # either :first or :all, to indicate that we want only one
240 | # (:first) or all (:all) results back from the resultant set.
241 | #
242 | # The second argument should be a hash of attribute_name =>
243 | # expected_value pairs.
244 | #
245 | # User.find(:all, :sn => 'Hunt')
246 | #
247 | # would find all of the User objects in Active Directory that
248 | # have a surname of exactly 'Hunt'. As with the Base.exists?
249 | # method, partial searches are allowed.
250 | #
251 | # This method always returns an array if the caller specifies
252 | # :all for the search e (first argument). If no results
253 | # are found, the array will be empty.
254 | #
255 | # If you call find(:first, ...), you will either get an object
256 | # (a User or a Group) back, or nil, if there were no entries
257 | # matching your filter.
258 | #
259 | def self.find(*args)
260 | return false unless connected?
261 |
262 | options = {
263 | filter: args[1].nil? ? NIL_FILTER : args[1],
264 | in: args[1].nil? ? '' : (args[1][:in] || '')
265 | }
266 | options[:filter].delete(:in)
267 |
268 | cached_results = find_cached_results(args[1])
269 | return cached_results if cached_results || cached_results.nil?
270 |
271 | options[:in] = [options[:in].to_s, @@settings[:base]].delete_if(&:empty?).join(',')
272 |
273 | if options[:filter].is_a? Hash
274 | options[:filter] = make_filter_from_hash(options[:filter])
275 | end
276 |
277 | options[:filter] = options[:filter] & filter unless filter == NIL_FILTER
278 |
279 | if args.first == :all
280 | find_all(options)
281 | elsif args.first == :first
282 | find_first(options)
283 | else
284 | raise ArgumentError,
285 | 'Invalid specifier (not :all, and not :first) passed to find()'
286 | end
287 | end
288 |
289 | ##
290 | # Searches the cache and returns the result
291 | # Returns false on failure, nil on wrong object type
292 | #
293 | def self.find_cached_results(filters)
294 | return false unless cache?
295 |
296 | # Check to see if we're only looking for :distinguishedname
297 | return false unless filters.is_a?(Hash) && filters.keys == [:distinguishedname]
298 |
299 | # Find keys we're looking up
300 | dns = filters[:distinguishedname]
301 |
302 | if dns.is_a? Array
303 | result = []
304 |
305 | dns.each do |dn|
306 | entry = @@cache[dn]
307 |
308 | # If the object isn't in the cache just run the query
309 | return false if entry.nil?
310 |
311 | # Only permit objects of the type we're looking for
312 | result << entry if entry.is_a? self
313 | end
314 |
315 | return result
316 | else
317 | return false unless @@cache.key? dns
318 | return @@cache[dns] if @@cache[dns].is_a? self
319 | end
320 | end
321 |
322 | def self.find_all(options)
323 | results = []
324 | ldap_objs = @@ldap.search(filter: options[:filter], base: options[:in]) || []
325 |
326 | ldap_objs.each do |entry|
327 | ad_obj = new(entry)
328 | @@cache[entry.dn] = ad_obj unless ad_obj.instance_of? Base
329 | results << ad_obj
330 | end
331 |
332 | results
333 | end
334 |
335 | def self.find_first(options)
336 | ldap_result = @@ldap.search(filter: options[:filter], base: options[:in])
337 | return nil if ldap_result.empty?
338 |
339 | ad_obj = new(ldap_result[0])
340 | @@cache[ad_obj.dn] = ad_obj unless ad_obj.instance_of? Base
341 | ad_obj
342 | end
343 |
344 | def self.method_missing(name, *args) # :nodoc:
345 | name = name.to_s
346 | if name[0, 5] == 'find_'
347 | find_spec, attribute_spec = parse_finder_spec(name)
348 | raise ArgumentError, "find: Wrong number of arguments (#{args.size} for #{attribute_spec.size})" unless args.size == attribute_spec.size
349 | filters = {}
350 | [attribute_spec, args].transpose.each { |pr| filters[pr[0]] = pr[1] }
351 | find(find_spec, filter: filters)
352 | else
353 | super name.to_sym, args
354 | end
355 | end
356 |
357 | def self.parse_finder_spec(method_name) # :nodoc:
358 | # FIXME: This is a prime candidate for a
359 | # first-class object, FinderSpec
360 |
361 | method_name = method_name.gsub(/^find_/, '').gsub(/^by_/, 'first_by_')
362 | find_spec, attribute_spec = *method_name.split('_by_')
363 | find_spec = find_spec.to_sym
364 | attribute_spec = attribute_spec.split('_and_').collect(&:to_sym)
365 |
366 | [find_spec, attribute_spec]
367 | end
368 |
369 | def ==(other) # :nodoc:
370 | return false if other.nil?
371 | other[:objectguid] == get_attr(:objectguid)
372 | end
373 |
374 | #
375 | # Returns true if this entry does not yet exist in Active Directory.
376 | #
377 | def new_record?
378 | @entry.nil?
379 | end
380 |
381 | #
382 | # Refreshes the attributes for the entry with updated data from the
383 | # domain controller.
384 | #
385 | def reload
386 | return false if new_record?
387 |
388 | @entry = @@ldap.search(filter: Net::LDAP::Filter.eq('distinguishedName', distinguishedName))[0]
389 | !@entry.nil?
390 | end
391 |
392 | #
393 | # Updates a single attribute (name) with one or more values
394 | # (value), by immediately contacting the Active Directory
395 | # server and initiating the update remotely.
396 | #
397 | # Entries are always reloaded (via Base.reload) after calling
398 | # this method.
399 | #
400 | def update_attribute(name, value)
401 | update_attributes(name.to_s => value)
402 | end
403 |
404 | #
405 | # Updates multiple attributes, like ActiveRecord#update_attributes.
406 | # The updates are immediately sent to the server for processing,
407 | # and the entry is reloaded after the update (if all went well).
408 | #
409 | def update_attributes(attributes_to_update)
410 | return true if attributes_to_update.empty?
411 | rename = false
412 |
413 | operations = []
414 | attributes_to_update.each do |attribute, values|
415 | if attribute == :cn
416 | rename = true
417 | else
418 | if values.nil? || values.empty?
419 | operations << [:delete, attribute, nil]
420 | else
421 | values = [values] unless values.is_a? Array
422 | values = values.collect(&:to_s)
423 |
424 | current_value = begin
425 | @entry[attribute]
426 | rescue NoMethodError
427 | nil
428 | end
429 |
430 | operations << [(current_value.nil? ? :add : :replace), attribute, values]
431 | end
432 | end
433 | end
434 |
435 | unless operations.empty?
436 | @@ldap.modify(
437 | dn: distinguishedName,
438 | operations: operations
439 | )
440 | end
441 | if rename
442 | @@ldap.modify(
443 | dn: distinguishedName,
444 | operations: [[(name.nil? ? :add : :replace), 'samaccountname', attributes_to_update[:cn]]]
445 | )
446 | @@ldap.rename(olddn: distinguishedName, newrdn: 'cn=' + attributes_to_update[:cn], delete_attributes: true)
447 | end
448 | reload
449 | end
450 |
451 | #
452 | # Create a new entry in the Active Record store.
453 | #
454 | # dn is the Distinguished Name for the new entry. This must be
455 | # a unique identifier, and can be passed as either a Container
456 | # or a plain string.
457 | #
458 | # attributes is a symbol-keyed hash of attribute_name => value
459 | # pairs.
460 | #
461 | def self.create(dn, attributes)
462 | return nil if dn.nil? || attributes.nil?
463 | begin
464 | attributes.merge!(required_attributes)
465 | if @@ldap.add(dn: dn.to_s, attributes: attributes)
466 | ldap_obj = @@ldap.search(base: dn.to_s)
467 | return new(ldap_obj[0])
468 | else
469 | return nil
470 | end
471 | rescue
472 | return nil
473 | end
474 | end
475 |
476 | #
477 | # Deletes the entry from the Active Record store and returns true
478 | # if the operation was successfully.
479 | #
480 | def destroy
481 | return false if new_record?
482 |
483 | if @@ldap.delete(dn: distinguishedName)
484 | @entry = nil
485 | @attributes = {}
486 | return true
487 | else
488 | return false
489 | end
490 | end
491 |
492 | #
493 | # Saves any pending changes to the entry by updating the remote
494 | # entry.
495 | #
496 | def save
497 | if update_attributes(@attributes)
498 | @attributes = {}
499 | true
500 | else
501 | false
502 | end
503 | end
504 |
505 | #
506 | # This method may one day provide the ability to move entries from
507 | # container to container. Currently, it does nothing, as we are
508 | # waiting on the Net::LDAP folks to either document the
509 | # Net::LDAP#modrdn method, or provide a similar method for
510 | # moving / renaming LDAP entries.
511 | #
512 | def move(new_rdn)
513 | return false if new_record?
514 | puts "Moving #{distinguishedName} to RDN: #{new_rdn}"
515 |
516 | settings = @@settings.dup
517 | settings[:port] = 636
518 | settings[:encryption] = { method: :simple_tls }
519 |
520 | ldap = Net::LDAP.new(settings)
521 |
522 | if ldap.rename(
523 | olddn: distinguishedName,
524 | newrdn: new_rdn,
525 | delete_attributes: false
526 | )
527 | return true
528 | else
529 | puts Base.error
530 | return false
531 | end
532 | end
533 |
534 | # FIXME: Need to document the Base::new
535 | def initialize(attributes = {}) # :nodoc:
536 | if attributes.is_a? Net::LDAP::Entry
537 | @entry = attributes
538 | @attributes = {}
539 | else
540 | @entry = nil
541 | @attributes = attributes
542 | end
543 | end
544 |
545 | ##
546 | # Pull the class we're in
547 | # This isn't quite right, as extending the object does funny things to how we
548 | # lookup objects
549 | def self.class_name
550 | @klass ||= (name.include?('::') ? name[/.*::(.*)/, 1] : name)
551 | end
552 |
553 | ##
554 | # Grabs the field type depending on the class it is called from
555 | # Takes the field name as a parameter
556 | def self.get_field_type(name)
557 | # Extract class name
558 | throw 'Invalid field name' if name.nil?
559 | type = ::ActiveDirectory.special_fields[class_name.to_sym][name.to_s.downcase.to_sym]
560 | type.to_s unless type.nil?
561 | end
562 |
563 | @types = {}
564 |
565 | def self.decode_field(name, value) # :nodoc:
566 | type = get_field_type name
567 | if !type.nil? && ::ActiveDirectory::FieldType.const_defined?(type)
568 | return ::ActiveDirectory::FieldType.const_get(type).decode(value)
569 | end
570 | value
571 | end
572 |
573 | def self.encode_field(name, value) # :nodoc:
574 | type = get_field_type name
575 | if !type.nil? && ::ActiveDirectory::FieldType.const_defined?(type)
576 | return ::ActiveDirectory::FieldType.const_get(type).encode(value)
577 | end
578 | value
579 | end
580 |
581 | def valid_attribute?(name)
582 | @attributes.key?(name) || @entry.attribute_names.include?(name)
583 | end
584 |
585 | def get_attr(name)
586 | name = name.to_s.downcase
587 |
588 | return self.class.decode_field(name, @attributes[name.to_sym]) if @attributes.key?(name.to_sym)
589 |
590 | if @entry.attribute_names.include? name.to_sym
591 | value = @entry[name.to_sym]
592 | value = value.first if value.is_a?(Array) && value.size == 1
593 | value = value.to_s if value.nil? || value.size == 1
594 | value = nil.to_s if value.empty?
595 | return self.class.decode_field(name, value)
596 | end
597 | end
598 |
599 | def set_attr(name, value)
600 | @attributes[name.to_sym] = self.class.encode_field(name, value)
601 | end
602 |
603 | ##
604 | # Reads the array of values for the provided attribute. The attribute name
605 | # is canonicalized prior to reading. Returns an empty array if the
606 | # attribute does not exist.
607 | alias [] get_attr
608 | alias []= set_attr
609 |
610 | ##
611 | # Weird fluke with flattening, probably because of above attribute
612 | def to_ary; end
613 |
614 | def sid
615 | unless @sid
616 | raise 'Object has no sid' unless valid_attribute? :objectsid
617 | # SID is stored as a binary in the directory
618 | # however, Net::LDAP returns an hex string
619 | #
620 | # As per [1], there seems to be 2 ways to get back binary data.
621 | #
622 | # [str].pack("H*")
623 | # str.gsub(/../) { |b| b.hex.chr }
624 | #
625 | # [1] :
626 | # http://stackoverflow.com/questions/22957688/convert-string-with-hex-ascii-codes-to-characters
627 | #
628 | @sid = SID.read([get_attr(:objectsid)].pack('H*'))
629 | end
630 | @sid.to_s
631 | end
632 |
633 | def method_missing(name, args = []) # :nodoc:
634 | name = name.to_s.downcase
635 |
636 | return set_attr(name.chop, args) if name[-1] == '='
637 |
638 | if valid_attribute? name.to_sym
639 | get_attr(name)
640 | else
641 | super
642 | end
643 | end
644 | end
645 | end
646 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
--------------------------------------------------------------------------------