vibes-rubycas-client 2.3.0.alpha

data/lib/casclient/responses.rb

@@ -0,0 +1,197 @@
+module CASClient
+  module XmlResponse
+    attr_reader :xml, :parse_datetime
+    attr_reader :failure_code, :failure_message
+    
+    def check_and_parse_xml(raw_xml)
+      begin
+        doc = REXML::Document.new(raw_xml)
+      rescue REXML::ParseException => e
+        raise BadResponseException, 
+          "MALFORMED CAS RESPONSE:\n#{raw_xml.inspect}\n\nEXCEPTION:\n#{e}"
+      end
+      
+      unless doc.elements && doc.elements["cas:serviceResponse"]
+        raise BadResponseException, 
+          "This does not appear to be a valid CAS response (missing cas:serviceResponse root element)!\nXML DOC:\n#{doc.to_s}"
+      end
+      
+      return doc.elements["cas:serviceResponse"].elements[1]
+    end
+    
+    def to_s
+      xml.to_s
+    end
+  end
+  
+  # Represents a response from the CAS server to a 'validate' request
+  # (i.e. after validating a service/proxy ticket).
+  class ValidationResponse
+    include XmlResponse
+    
+    attr_reader :protocol, :user, :pgt_iou, :proxies, :extra_attributes
+    
+    def initialize(raw_text)
+      parse(raw_text)
+    end
+    
+    def parse(raw_text)
+      raise BadResponseException, 
+        "CAS response is empty/blank." if raw_text.blank?
+      @parse_datetime = Time.now
+      
+      if raw_text =~ /^(yes|no)\n(.*?)\n$/m
+        @protocol = 1.0
+        @valid = $~[1] == 'yes'
+        @user = $~[2]
+        return
+      end
+      
+      @xml = check_and_parse_xml(raw_text)
+      
+      # if we got this far then we've got a valid XML response, so we're doing CAS 2.0
+      @protocol = 2.0
+      
+      if is_success?
+        cas_user = @xml.elements["cas:user"]
+        @user = cas_user.text.strip if cas_user
+        @pgt_iou =  @xml.elements["cas:proxyGrantingTicket"].text.strip if @xml.elements["cas:proxyGrantingTicket"]
+        
+        proxy_els = @xml.elements.to_a('//cas:authenticationSuccess/cas:proxies/cas:proxy')
+        if proxy_els.size > 0
+          @proxies = []
+          proxy_els.each do |el|
+            @proxies << el.text
+          end
+        end
+        
+        @extra_attributes = {}
+        @xml.elements.to_a('//cas:authenticationSuccess/*').each do |el|
+          # generating the hash requires prefixes to be defined, so add all of the namespaces
+          el.namespaces.each {|k,v| el.add_namespace(k,v)}
+          @extra_attributes.merge!(Hash.from_xml(el.to_s)) unless ([cas_user, @xml.elements["cas:proxyGrantingTicket"], @xml.elements["cas:proxies"]].include?(el))
+        end
+        
+        # unserialize extra attributes
+        @extra_attributes.each do |k, v|
+          Rails.logger.debug "#{k.inspect} => #{v.inspect}"
+          if v.blank?
+            @extra_attributes[k] = nil
+          else
+            begin
+              @extra_attributes[k] = JSON.parse(v)
+            rescue JSON::ParserError => e
+              @extra_attributes[k] = v
+            end
+          end
+        end
+      elsif is_failure?
+        @failure_code = @xml.elements['//cas:authenticationFailure'].attributes['code']
+        @failure_message = @xml.elements['//cas:authenticationFailure'].text.strip
+      else
+        # this should never happen, since the response should already have been recognized as invalid
+        raise BadResponseException, "BAD CAS RESPONSE:\n#{raw_text.inspect}\n\nXML DOC:\n#{doc.inspect}"
+      end
+      
+    end
+    
+    def is_success?
+      (instance_variable_defined?(:@valid) &&  @valid) || (protocol > 1.0 && xml.name == "authenticationSuccess")
+    end
+    
+    def is_failure?
+      (instance_variable_defined?(:@valid) && !@valid) || (protocol > 1.0 && xml.name == "authenticationFailure" )
+    end
+  end
+  
+  # Represents a response from the CAS server to a proxy ticket request 
+  # (i.e. after requesting a proxy ticket).
+  class ProxyResponse
+    include XmlResponse
+    
+    attr_reader :proxy_ticket
+    
+    def initialize(raw_text)
+      parse(raw_text)
+    end
+    
+    def parse(raw_text)
+      raise BadResponseException, 
+        "CAS response is empty/blank." if raw_text.blank?
+      @parse_datetime = Time.now
+      
+      @xml = check_and_parse_xml(raw_text)
+      
+      if is_success?
+        @proxy_ticket = @xml.elements["cas:proxyTicket"].text.strip if @xml.elements["cas:proxyTicket"]
+      elsif is_failure?
+        @failure_code = @xml.elements['//cas:proxyFailure'].attributes['code']
+        @failure_message = @xml.elements['//cas:proxyFailure'].text.strip
+      else
+        # this should never happen, since the response should already have been recognized as invalid
+        raise BadResponseException, "BAD CAS RESPONSE:\n#{raw_text.inspect}\n\nXML DOC:\n#{doc.inspect}"
+      end
+      
+    end
+    
+    def is_success?
+      xml.name == "proxySuccess"
+    end
+    
+    def is_failure?
+      xml.name == "proxyFailure"
+    end
+  end
+  
+  # Represents a response from the CAS server to a login request 
+  # (i.e. after submitting a username/password).
+  class LoginResponse
+    attr_reader :tgt, :ticket, :service_redirect_url
+    attr_reader :failure_message
+    
+    def initialize(http_response = nil)
+      parse_http_response(http_response) if http_response
+    end
+    
+    def parse_http_response(http_response)
+      header = http_response.to_hash
+      
+      # FIXME: this regexp might be incorrect...
+      if header['set-cookie'] && 
+          header['set-cookie'].first && 
+          header['set-cookie'].first =~ /tgt=([^&]+);/
+        @tgt = $~[1]
+      end
+    
+      location = header['location'].first if header['location'] && header['location'].first
+      if location =~ /ticket=([^&]+)/
+        @ticket = $~[1]
+      end
+      
+      if not ((http_response.kind_of?(Net::HTTPSuccess) || http_response.kind_of?(Net::HTTPFound)) && @ticket.present?)
+        @failure = true
+        # Try to extract the error message -- this only works with RubyCAS-Server.
+        # For other servers we just return the entire response body (i.e. the whole error page).
+        body = http_response.body
+        if body =~ /<div class="messagebox mistake">(.*?)<\/div>/m
+          @failure_message = $~[1].strip
+        else
+          @failure_message = body
+        end
+      end
+      
+      @service_redirect_url = location
+    end
+    
+    def is_success?
+      !@failure && !ticket.blank?
+    end
+    
+    def is_failure?
+      @failure == true
+    end
+  end
+  
+  class BadResponseException < CASException
+  end
+end

data/lib/casclient/tickets.rb

@@ -0,0 +1,38 @@
+module CASClient
+  # Represents a CAS service ticket.
+  class ServiceTicket
+    attr_reader :ticket, :service, :renew
+    attr_accessor :response
+    
+    def initialize(ticket, service, renew = false)
+      @ticket = ticket
+      @service = service
+      @renew = renew
+    end
+    
+    def is_valid?
+      response.is_success?
+    end
+    
+    def has_been_validated?
+      not response.nil?
+    end
+  end
+  
+  # Represents a CAS proxy ticket.
+  class ProxyTicket < ServiceTicket
+  end
+  
+  class ProxyGrantingTicket
+    attr_reader :ticket, :iou
+    
+    def initialize(ticket, iou)
+      @ticket = ticket
+      @iou = iou
+    end
+    
+    def to_s
+      ticket
+    end
+  end
+end

data/lib/vibes-rubycas-client.rb

@@ -0,0 +1 @@
+require 'casclient'

data/vibes-rubycas-client.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vibes-rubycas-client}
+  s.version = "2.3.0.alpha"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Campbell", "Rahul Joshi", "Matt Zukowski", "Matt Walker"]
+  s.date = %q{2011-06-09}
+  s.description = %q{We've taken the rubycas-client and added some enterprisey features and improved compatibility with JASIG's CAS server}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rvmrc",
+    ".source_index",
+    "CHANGELOG.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "History.txt",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/merb/.gitignore",
+    "examples/merb/README.textile",
+    "examples/merb/Rakefile",
+    "examples/merb/merb.thor",
+    "examples/merb/merb_auth_cas.rb",
+    "examples/merb/spec/spec_helper.rb",
+    "examples/rails/README",
+    "examples/rails/app/controllers/advanced_example_controller.rb",
+    "examples/rails/app/controllers/application.rb",
+    "examples/rails/app/controllers/simple_example_controller.rb",
+    "examples/rails/app/views/advanced_example/index.html.erb",
+    "examples/rails/app/views/advanced_example/my_account.html.erb",
+    "examples/rails/app/views/simple_example/index.html.erb",
+    "examples/rails/config/boot.rb",
+    "examples/rails/config/environment.rb",
+    "examples/rails/config/environments/development.rb",
+    "examples/rails/config/environments/production.rb",
+    "examples/rails/config/environments/test.rb",
+    "examples/rails/config/initializers/inflections.rb",
+    "examples/rails/config/initializers/mime_types.rb",
+    "examples/rails/config/initializers/new_rails_defaults.rb",
+    "examples/rails/config/routes.rb",
+    "examples/rails/log/development.log",
+    "examples/rails/log/production.log",
+    "examples/rails/log/server.log",
+    "examples/rails/log/test.log",
+    "examples/rails/script/about",
+    "examples/rails/script/console",
+    "examples/rails/script/server",
+    "lib/casclient.rb",
+    "lib/casclient/client.rb",
+    "lib/casclient/frameworks/merb/filter.rb",
+    "lib/casclient/frameworks/merb/strategy.rb",
+    "lib/casclient/frameworks/rails/cas_proxy_callback_controller.rb",
+    "lib/casclient/frameworks/rails/filter.rb",
+    "lib/casclient/responses.rb",
+    "lib/casclient/tickets.rb",
+    "lib/vibes-rubycas-client.rb",
+    "vibes-rubycas-client.gemspec"
+  ]
+  s.homepage = %q{http://github.com/vibes/rubycas-client}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Client library for the Central Authentication Service (CAS) protocol.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3.11"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 2.3.11"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 2.3.11"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification 
+name: vibes-rubycas-client
+version: !ruby/object:Gem::Version 
+  hash: -1851332218
+  prerelease: 6
+  segments: 
+  - 2
+  - 3
+  - 0
+  - alpha
+  version: 2.3.0.alpha
+platform: ruby
+authors: 
+- Matt Campbell
+- Rahul Joshi
+- Matt Zukowski
+- Matt Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  name: activesupport
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: jeweler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id005
+  prerelease: false
+description: We've taken the rubycas-client and added some enterprisey features and improved compatibility with JASIG's CAS server
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .rvmrc
+- .source_index
+- CHANGELOG.txt
+- Gemfile
+- Gemfile.lock
+- History.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/merb/.gitignore
+- examples/merb/README.textile
+- examples/merb/Rakefile
+- examples/merb/merb.thor
+- examples/merb/merb_auth_cas.rb
+- examples/merb/spec/spec_helper.rb
+- examples/rails/README
+- examples/rails/app/controllers/advanced_example_controller.rb
+- examples/rails/app/controllers/application.rb
+- examples/rails/app/controllers/simple_example_controller.rb
+- examples/rails/app/views/advanced_example/index.html.erb
+- examples/rails/app/views/advanced_example/my_account.html.erb
+- examples/rails/app/views/simple_example/index.html.erb
+- examples/rails/config/boot.rb
+- examples/rails/config/environment.rb
+- examples/rails/config/environments/development.rb
+- examples/rails/config/environments/production.rb
+- examples/rails/config/environments/test.rb
+- examples/rails/config/initializers/inflections.rb
+- examples/rails/config/initializers/mime_types.rb
+- examples/rails/config/initializers/new_rails_defaults.rb
+- examples/rails/config/routes.rb
+- examples/rails/log/development.log
+- examples/rails/log/production.log
+- examples/rails/log/server.log
+- examples/rails/log/test.log
+- examples/rails/script/about
+- examples/rails/script/console
+- examples/rails/script/server
+- lib/casclient.rb
+- lib/casclient/client.rb
+- lib/casclient/frameworks/merb/filter.rb
+- lib/casclient/frameworks/merb/strategy.rb
+- lib/casclient/frameworks/rails/cas_proxy_callback_controller.rb
+- lib/casclient/frameworks/rails/filter.rb
+- lib/casclient/responses.rb
+- lib/casclient/tickets.rb
+- lib/vibes-rubycas-client.rb
+- vibes-rubycas-client.gemspec
+has_rdoc: true
+homepage: http://github.com/vibes/rubycas-client
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Client library for the Central Authentication Service (CAS) protocol.
+test_files: []
+