aurora 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-11-27
+
+* 1 major enhancement:
+  * Initial (rough) release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,33 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+examples/basics.rb
+lib/aurora.rb
+lib/aurora/client.rb
+lib/aurora/client/base.rb
+lib/aurora/client/token.rb
+lib/aurora/server.rb
+lib/aurora/server/base.rb
+lib/aurora/server/handler.rb
+lib/aurora/server/server.rb
+lib/aurora/server/token.rb
+lib/aurora/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_aurora.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,56 @@
+= Aurora Simple Authentication Server
+
+A small scale authentication server to provide multiple applications one point
+of contact for authentication against LDAP et al data stores. The system will
+respond with a temporary Authenticated Token to be used for the session. There
+will also be a client-side library for use in Ruby available.
+
+The authentication server will also have a component for user management
+including permissions and access management.
+
+== Installation
+
+$ sudo gem install aurora
+
+== Basics
+
+An Aurora server is created on a specific port which listens diligently for all
+requests and are routed accordingly. The most basic part of an Aurora server is
+the @authenticate@ block. This passes the username and password to pass auth-
+entication with and will return either a new Token for future authentication
+requests or false. (NOTE: These details could change.)
+
+Essentially what you have to do is set up hooks for the server to call when a
+particular action is requested, starting with @authenticate@ and then moving
+on to more custom functionality.
+
+Because the server is not designed with any actual authentication checks, it
+is totally up to the implementer to authenticate users, be it through an LDAP
+data store or a MySQL database. This provides a great deal of flexibility, but
+a good deal of burden and responsibility. Aurora just makes it possible to
+centralize your authentication outside of your applications (though, with a
+little creativity, you could certainly decentralize it with Aurora as well).
+
+== Copyright and Licensing
+
+Copyright (c) 2007 Matt Todd <http://purl.org/net/maraby>.
+
+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.
+
+This notice is located at: http://www.opensource.org/licenses/mit-license.php

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'aurora/version'
+
+AUTHOR = 'Matt Todd'  # can also be an array of Authors
+EMAIL = "mtodd@clayton.edu"
+DESCRIPTION = "Simple authentication server and user permissions management tool."
+GEM_NAME = 'aurora' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'aurora' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Aurora::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'Aurora Simple Authentication Server Docs',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', 'tmp/*']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [
+    ['json', '>= 1.1.1'],
+    ['mongrel', '>= 1.1.1'],
+    ['dhkeyexchange', '>= 1.0.0'],
+    ['rack', '>= 0.2.0']
+  ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'aurora'

data/examples/basics.rb

@@ -0,0 +1,14 @@
+require 'aurora/server/base'
+
+Aurora::Server::Base.new('http://localhost:2828/', :logger_level => Logger::INFO) do |serv, uri, logger|
+  serv.authenticate do |user, pass|
+    # ldap = LDAP.new('http://localhost/')
+    # if ldap.bind("#{user}@domain")
+    if user == 'mtodd' and pass == 'test'
+      # successfully bound/authenticated
+      Aurora::Server::Token.new(user, pass)
+    else
+      false
+    end
+  end
+end

data/lib/aurora.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+module Aurora
+  #
+end

data/lib/aurora/client.rb

@@ -0,0 +1,22 @@
+$:.unshift File.dirname(__FILE__)
+
+#--
+# Created by Matt Todd on 2007-11-10.
+# Copyright (c) 2007 The HUB, Clayton State University. All rights reserved.
+#++
+
+#--
+# Dependencies
+#++
+
+require 'rubygems'
+require 'uri'
+require 'json'
+require 'digest/md5'
+
+#--
+# Module
+#++
+
+require 'client/base'
+require 'client/token'

data/lib/aurora/client/base.rb

@@ -0,0 +1,15 @@
+module Aurora
+  module Client
+    class Base
+      
+      def initialize(uri)
+        @uri = URI.parse(uri)
+      end
+      
+      def authenticate(user, pass)
+        # establish connection to aurora server and attempt to authenticate
+      end
+      
+    end
+  end
+end

data/lib/aurora/client/token.rb

@@ -0,0 +1,7 @@
+module Aurora
+  module Client
+    class Token
+      #
+    end
+  end
+end

data/lib/aurora/server.rb

@@ -0,0 +1,26 @@
+$:.unshift File.dirname(__FILE__)
+
+#--
+# Created by Matt Todd on 2007-11-10.
+# Copyright (c) 2007 The HUB, Clayton State University. All rights reserved.
+#++
+
+#--
+# Dependencies
+#++
+
+require 'rubygems'
+require 'logger'
+require 'uri'
+require 'json'
+require 'digest/md5'
+require 'mongrel'
+
+#--
+# Module
+#++
+
+require 'server/base'
+require 'server/server'
+require 'server/handler'
+require 'server/token'

data/lib/aurora/server/base.rb

@@ -0,0 +1,69 @@
+module Aurora
+  module Server
+    class Base
+      
+      #--
+      # Constants and Attributes
+      #++
+      
+      DEFAULTS = {
+        :log_file => '/var/log/aurora.server.log',
+        :log_level => Logger::ERROR
+      }
+      
+      attr_accessor :options, :uri, :logger, :processes
+      
+      #--
+      # class methods
+      #++
+      
+      # Starts the server listening on the port specified
+      def initialize(uri, options = {})
+        # setup options
+        @options = DEFAULTS.merge(options)
+        @uri = URI.parse(uri)
+        @logger = Logger.new(@options[:log_file])
+        @logger.level = @options[:log_level]
+        
+        @logger.info 'Starting Aurora Authentication Server...'
+        
+        # setup authentication handlers
+        @logger.info 'Loading processes...'
+        yield self, @uri, @logger
+        @logger.info 'done.'
+        
+        # setup server
+        @logger.info 'Starting HTTP Server and setting up HTTP Handler...'
+        serv = Aurora::Server::Server.new(@uri.host, @uri.port)
+        serv.register('/', Aurora::Server::Handler.new(self))
+        @logger.info 'done. Running now.'
+        serv.run.join
+      end
+      
+      #--
+      # Instance Methods
+      #++
+      
+      def parse_credentials(body)
+        ['mtodd', 'test']
+      end
+      
+      def authenticate(&block)
+        add_process(:authenticate, block)
+      end
+      
+      def method_missing(name, *args, &block)
+        add_process(name, block)
+      end
+      
+      private
+      
+      # Adds process 
+      def add_process(name, proc)
+        @processes ||= {}
+        @processes[name] = proc
+      end
+      
+    end
+  end
+end

data/lib/aurora/server/handler.rb

@@ -0,0 +1,54 @@
+module Aurora
+  module Server
+    class Handler < Mongrel::HttpHandler
+      
+      #--
+      # constants and attributes
+      #++
+      
+      attr_accessor :serv
+      
+      #--
+      # Class Methods
+      #++
+      
+      # Stores a reference to the Base server to access the processes (procs
+      # which define auth functionality) and then returns to the super
+      def initialize(serv)
+        @serv = serv
+        @serv.logger.info 'Loading Handler.'
+        super()
+      end
+      
+      #--
+      # Instance Methods
+      #++
+      
+      # Generic request processor (Mongrel hook)
+      def process(request, response)
+        @serv.logger.info 'Request received.'
+        
+    		# parse out username and password and call the authenticate method
+    		@serv.logger.info request.body
+    		user, pass = *Aurora::Server::Base.parse_credentials(request.body)
+    		response = @serv.processses[:authenticate].call(user, pass)
+    		
+    		# prepare response
+    		if response.is_a? Aurora::Server::Token then
+      		# success
+      		code = 200
+      	else
+      	  # failure
+      	  code = 200
+    	  end
+    	  
+    	  # send response
+    	  response.start(code) do |head, out|
+      		head["Content-Type"] = "application/json"
+      		out.write(result.to_json)
+      	end
+      end
+      
+    end
+  end
+end