skylark 0.0.0.alpha.0 → 0.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33874db7557822ca39a146b1a251dfa1a2b527e5
-  data.tar.gz: 86b379aa33c8ca7cbaa17d4a356d24984fc963f4
+  metadata.gz: 2007b306b6bc887c49ad3b05960be25c59673bbd
+  data.tar.gz: d15341bea8daadd4f5e8e082217422aaf02ff4b1
 SHA512:
-  metadata.gz: d76f6233da88eae6eff6ec531cfa402b9e70256079d670d46bc84c7108c528027bb50553eb8b915511177d719128d39069f15ff757c28ff8e8f0041e79a51cb9
-  data.tar.gz: ddacd4c0e756634277d1e8eeffd995b1e6d5f36fca573e12e94fc0ed40f57674d537c2bad03e601f53a0a58bb011ffa158915bb50cd78c210387d83070a0c53e
+  metadata.gz: 50fec2e688e70b4a9674c2e0d0a9c7a9fc48cb9e20523ea102d947baaec9d4d2c15f61e444b3a14064c5e61a9917356bdd8fda5c12b41399cea8b36fe4d20c1d
+  data.tar.gz: aabf2f7b2569d47239de8596867aed9e4556b44018a245866a32f4f83a992bf9c3cc57d0c4f86fd0de1e36d40081be605c96005c92579d3303882bc2a8b09e4c

data/.gitignore

@@ -0,0 +1,8 @@
+# Ignore built gems
+*.gem
+
+# Ignore the bundle cache.
+Gemfile.lock
+
+# Ignore coverage data
+/coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+So you want to contribute to Skylark development!  Thanks in advance
+for anything that you can provide for the project.  We (well, just me
+at the moment) welcome feedback, bug reports, and---perhaps most
+importantly---pull requests.
+
+## Hacking
+
+To contribute, you should have a relatively new version of Ruby.  (The
+gemspec greedily requires Ruby 2.3 or higher because I haven't had the
+opportunity to test on anything lower.)
+
+Make sure you have installed `bundler`,
+
+```console
+$ gem install bundler
+```
+
+and make sure you have all of the project dependencies installed,
+
+```console
+$ bundle install
+```
+
+Use a branching scheme like this:
+
+* `<description-of-feature>` for feature additions
+
+* `fix-<#>-<description-of-change>` for bug/performance fixes
+
+**Fork** to your own personal or organization account (unless you
+already are an authorized contributor on this project) and **make a
+branch** for your work.  Make multiple branches if your work is
+divergent or has multiple different channels.  Feel free to merge
+between these branches in a way that makes sense.  When ready,
+**submit a pull request** with the base set to `master` on
+`rye/skylark`.  We will dispatch it to a different base if necessary.
+
+
+## Filing Issues/Pull Requests
+
+In general,
+
+* Please use English, and please be as communicative as possible.
+
+* Please make sure you have notifications turned on for GitHub on the
+  specific Issue or PR you submit---we might try to follow-up quickly.
+  In general, we'll accept anything that matches the coding style and
+  produces a valuable on-target movement towards the project's
+  purpose.

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2017 Kristofer Rye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,15 @@
+# skylark [![Gem Version](https://badge.fury.io/rb/skylark.svg)](https://badge.fury.io/rb/skylark) [![Build Status](https://travis-ci.org/rye/skylark.svg?branch=master)](https://travis-ci.org/rye/skylark) [![Code Climate](https://codeclimate.com/github/rye/skylark/badges/gpa.svg)](https://codeclimate.com/github/rye/skylark) [![Test Coverage](https://codeclimate.com/github/rye/skylark/badges/coverage.svg)](https://codeclimate.com/github/rye/skylark/coverage)
+
+Skylark is a simple CLI-based LDAP scraper whose intended purpose is to
+dump an entire LDAP search base out into a bunch of JSON files based
+on the LDIF data dumped by the LDAP server.  More precisely, every
+object in the database gets its own JSON file.
+
+## Installation/Setup
+
+Just clone the repository, cd into it, and run the following commands:
+
+```console
+$ bundle install
+$ bundle exec script/scrape config/<your configuration file>.yml
+```

data/bin/skylark

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+LIB_DIRECTORY = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift(File.expand_path(LIB_DIRECTORY)) unless $LOAD_PATH.map do |directory|
+	File.expand_path(directory)
+end.include?(LIB_DIRECTORY)
+
+require 'skylark'
+
+Skylark::CLI.run ARGV

data/lib/skylark.rb

@@ -0,0 +1,11 @@
+require 'skylark/argument_configuration'
+require 'skylark/cli'
+require 'skylark/ldap'
+require 'skylark/version'
+require 'skylark/yaml_configuration'
+
+module Skylark
+
+	ROOT_DIRECTORY = File.expand_path('..', File.dirname(__FILE__))
+
+end

data/lib/skylark/argument_configuration.rb

@@ -0,0 +1,72 @@
+require 'optparse'
+
+require 'skylark/configuration'
+
+module Skylark
+
+	class ArgumentConfiguration < Configuration
+		def self.parse(argv)
+			configuration = self.new
+
+			args = OptionParser.new do |parser|
+				configuration.define_options(parser)
+
+				parser.parse!(argv)
+
+				if argv.empty?
+					puts parser
+					$stderr.puts "Expected at least one filename; exiting."
+					exit
+				end
+
+				configuration[:spec_files] = argv.select do |argument|
+					argument_as_filename = File.expand_path(argument, Dir.pwd)
+					File.readable?(argument_as_filename)
+				end
+			end
+
+			configuration
+		end
+
+		def initialize
+			super
+
+			self[:spec_files] = []
+			self[:logger_level] = :warn
+		end
+
+		def define_options(parser)
+			parser.banner = <<-EOT
+Usage: #{$0} [options] [--] <filename> [<filename>...]
+EOT
+			parser.separator ""
+			parser.separator "OPTIONS:"
+
+			add_verbosity_option(parser)
+
+			parser.separator ""
+			parser.separator "GENERAL OPTIONS:"
+
+			parser.on_tail('-h', '--help', 'Show this usage message.') do
+				puts parser
+				exit
+			end
+
+			parser.on_tail('--version', 'Print the version.') do
+				puts Skytrain::VERSION
+				exit
+			end
+		end
+
+		def add_verbosity_option(parser)
+			parser.on('-d', '--debug-level LEVEL', 'Sets the debugging level to LEVEL.') do |level|
+				self[:logger_level] = level.downcase.to_sym
+			end
+
+			parser.on('-v', '--verbose', 'Sets the debugging level to a sensible verbose default.') do
+				self[:logger_level] = :debug
+			end
+		end
+	end
+
+end

data/lib/skylark/cli.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+require 'base64'
+require 'json'
+
+require 'skylark/ldap'
+require 'skylark/argument_configuration'
+require 'skylark/yaml_configuration'
+require 'skylark/version'
+
+module Skylark
+
+	module CLI
+
+		def self.run(args = ARGV)
+			argument_configuration = ArgumentConfiguration.parse(args)
+
+			specs = argument_configuration[:spec_files].map do |spec_file|
+				spec_configuration = YAMLConfiguration.new(spec_file)
+				spec_configuration.read!
+				spec_configuration
+
+				if spec_configuration['searches'].is_a? Array
+					spec_configuration['searches'].each do |search|
+						dump_root_directory = File.join(ROOT_DIRECTORY, 'data', spec_configuration['server']['host'])
+
+						auth = {method: :simple, username: spec_configuration['server']['auth']['username'], password: spec_configuration['server']['auth']['password']}
+						encryption = {method: :simple_tls, tls_options: {verify_mode: OpenSSL::SSL::VERIFY_NONE}}
+
+						adapter = Skylark::LDAP::Adapter.new(host: spec_configuration['server']['host'], port: spec_configuration['server']['port'].to_i, auth: auth, encryption: encryption)
+
+						adapter.search(base: search['base']) do |entry|
+							hash = {}
+
+							entry.each do |entry_key|
+								if (attributes = entry[entry_key]).is_a?(Array)
+									attributes.map! do |attribute|
+										if attribute.encoding == Encoding::ASCII_8BIT
+											Base64.strict_encode64(attribute)
+										else
+											attribute
+										end
+									end
+
+									attributes = attributes.first if attributes.count <= 1
+
+									hash[entry_key] = attributes
+								end
+							end
+
+							names = Skylark::LDAP::DN.new(hash[:dn]).names
+							domain_name_components = names.reverse.select do |name|
+								in_domain_name ||= true && (in_domain_name = name.keys[0].match?(/dc/i))
+							end.reverse.to_a
+
+							search_subnames = (names - domain_name_components).reverse
+							dump_directory = File.join(dump_root_directory, *search_subnames.select{|name| name.keys.first != 'CN'}.map{|name| name.values.first})
+
+							FileUtils.mkdir_p(dump_directory)
+
+							filename = File.join(dump_directory, "#{entry[:cn].first || ('_OU=' + entry[:ou].first if !entry[:ou].empty?) || ('_' + entry[:dn].first if !entry[:dn].empty?)}.json")
+
+							open(filename, 'wb') do |io|
+								io.write JSON.pretty_generate(hash) + '\n'
+							end
+						end
+					end
+				end
+			end
+		end
+
+	end
+
+end

data/lib/skylark/configuration.rb

@@ -0,0 +1,5 @@
+module Skylark
+
+	Configuration = Class.new(Hash)
+
+end

data/lib/skylark/ldap.rb

@@ -0,0 +1,2 @@
+require 'skylark/ldap/adapter'
+require 'skylark/ldap/dn'

data/lib/skylark/ldap/adapter.rb

@@ -0,0 +1,7 @@
+require 'net/ldap'
+
+module Skylark::LDAP
+
+	Adapter = Class.new(Net::LDAP)
+
+end

data/lib/skylark/ldap/dn.rb

@@ -0,0 +1,21 @@
+module Skylark::LDAP
+
+	class DN
+		attr_reader :names
+
+		def initialize(dn_string)
+			parse!(dn_string)
+		end
+
+		def parse!(dn_string)
+			@names = parse(dn_string)
+		end
+
+		def parse(dn_string)
+			dn_string.scan(/(?<type>OU|CN|DC)=(?<data>[A-z][\w\ -]*),?/i).map do |match|
+				{match.first => match.last}
+			end
+		end
+	end
+
+end

data/lib/skylark/version.rb

@@ -0,0 +1,26 @@
+module Skylark
+
+	class Version
+
+		attr_reader :major
+		attr_reader :minor
+		attr_reader :patch
+		attr_reader :prerelease
+
+		def initialize(major, minor = 0, patch = 0, prerelease = nil)
+			@major, @minor, @patch, @prerelease = major, minor, patch, prerelease
+		end
+
+		def to_s(mode = :standard)
+			case mode
+			when :standard
+				"v#{@major}.#{@minor}.#{@patch}#{('-' + @prerelease) if !!@prerelease}"
+			when :gemspec
+				"#{@major}.#{@minor}.#{@patch}#{('.' + @prerelease) if !!@prerelease}"
+			end
+		end
+	end
+
+	VERSION = Version.new(0, 0, 0, 'alpha.1')
+
+end

data/lib/skylark/yaml_configuration.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+require 'skylark/configuration'
+
+module Skylark
+
+	class YAMLConfiguration < Configuration
+
+		attr_reader :filename
+
+		def initialize(filename)
+			super
+
+			@filename = filename
+		end
+
+		def read!
+			self.merge!(parse_yaml(read_file(@filename)))
+		end
+
+		protected
+
+		def read_file(filename)
+			open(filename, 'rb') do |io|
+				io.read
+			end
+		end
+
+		def parse_yaml(data)
+			YAML.load(data)
+		end
+
+	end
+
+end

data/skylark.gemspec

@@ -0,0 +1,45 @@
+LIB_DIRECTORY = File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift(File.expand_path(LIB_DIRECTORY)) unless $LOAD_PATH.map do |directory|
+	File.expand_path(directory)
+end.include?(LIB_DIRECTORY)
+
+require 'skylark/version'
+
+Gem::Specification.new do |s|
+
+	s.name = %q[skylark]
+	s.version = Skylark::VERSION.to_s :gemspec
+
+	$stderr.puts "Building #{s.name} #{s.version}..."
+
+	s.authors = ['Kristofer Rye']
+	s.email = 'kristofer.rye+skylark@gmail.com'
+	s.homepage = 'https://github.com/rye/skylark' # TODO gh-pages
+
+	s.summary = 'A CLI-based LDAP scraper whose intended purpose is to dump an entire LDAP search into a bunch of JSON files.'
+
+	s.files = []
+	s.files << '.gitignore'
+	s.files << '.rspec'
+	s.files << 'bin/skylark'
+	s.files << Dir.glob('lib/**/*.rb')
+	s.files << Dir.glob('spec/**/*.rb')
+	s.files << 'skylark.gemspec'
+	s.files << 'CONTRIBUTING.md'
+	s.files << 'LICENSE.md'
+	s.files << 'README.md'
+
+	s.licenses = ['MIT']
+
+	s.platform = Gem::Platform::RUBY
+	s.required_ruby_version = ['>= 2.3.3', '<= 2.5']
+
+	s.add_dependency 'net-ldap', '~> 0.16'
+
+	s.add_development_dependency 'rake', '~> 12'
+	s.add_development_dependency 'rspec', '~> 3.6'
+
+	s.add_development_dependency 'codeclimate', '~> 0.65'
+	s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+
+end

data/spec/lib/skylark_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'lib/skylark.rb' do
+
+	it 'can be required without error' do
+		expect do
+			require 'skylark'
+		end.not_to raise_error
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+require 'simplecov'
+SimpleCov.start

metadata

@@ -1,21 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: skylark
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha.0
+  version: 0.0.0.alpha.1
 platform: ruby
 authors:
 - Kristofer Rye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
-dependencies: []
+date: 2017-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 
 email: kristofer.rye+skylark@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- bin/skylark
+- lib/skylark.rb
+- lib/skylark/argument_configuration.rb
+- lib/skylark/cli.rb
+- lib/skylark/configuration.rb
+- lib/skylark/ldap.rb
+- lib/skylark/ldap/adapter.rb
+- lib/skylark/ldap/dn.rb
+- lib/skylark/version.rb
+- lib/skylark/yaml_configuration.rb
+- skylark.gemspec
+- spec/lib/skylark_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/rye/skylark
 licenses:
 - MIT
@@ -28,7 +116,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.3
+  - - "<="
+    - !ruby/object:Gem::Version
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -36,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A CLI-based LDAP scraper whose intended purpose is to dump an entire LDAP