rubycas-client 1.1.0 → 2.0.0

data/init.rb

@@ -1,20 +1,6 @@
-require 'cas_auth'
-require 'cas_logger'
-require 'cas_proxy_callback_controller'
+# This file makes it possible to install RubyCAS-Client as a Rails plugin.
 
-#CAS::Filter.logger = RAILS_DEFAULT_LOGGER if !RAILS_DEFAULT_LOGGER.nil?
-#CAS::Filter.logger = config.logger if !config.logger.nil?
+$: << File.expand_path(File.dirname(__FILE__))+'/lib'
 
-CAS::Filter.logger = CAS::Logger.new("#{RAILS_ROOT}/log/cas_client_#{RAILS_ENV}.log")
-CAS::Filter.logger.formatter = CAS::Logger::Formatter.new
-
-#if RAILS_ENV == "production"
-#  CAS::Filter.logger.level = Logger::WARN
-#else
-#  CAS::Filter.logger.level = Logger::DEBUG
-#end
-
-
-#class ActionController::Base
-#  append_before_filter CAS::Filter
-#end
+require 'casclient'
+require 'casclient/frameworks/rails/filter'

data/lib/casclient.rb

@@ -0,0 +1,79 @@
+require 'uri'
+require 'cgi'
+require 'net/https'
+require 'rexml/document'
+
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  require 'active_support'
+end
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+module CASClient
+  class CASException < Exception
+  end
+
+  # Customized logger for the client.
+  # This is useful if you're trying to do logging in Rails, since Rails'
+  # clean_logger.rb pretty much completely breaks the base Logger class.
+  class Logger < ::Logger
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      @default_formatter = Formatter.new
+      super
+    end
+  
+    def format_message(severity, datetime, progrname, msg)
+      (@formatter || @default_formatter).call(severity, datetime, progname, msg)
+    end
+    
+    def break
+      self << $/
+    end
+    
+    class Formatter < ::Logger::Formatter
+      Format = "[%s#%d] %5s -- %s: %s\n"
+      
+      def call(severity, time, progname, msg)
+        Format % [format_datetime(time), $$, severity, progname, msg2str(msg)]
+      end
+    end
+  end
+
+  # Wraps a real Logger. If no real Logger is set, then this wrapper
+  # will quietly swallow any logging calls.
+  class LoggerWrapper
+    def initialize(real_logger=nil)
+      set_logger(real_logger)
+    end
+    # Assign the 'real' Logger instance that this dummy instance wraps around.
+    def set_real_logger(real_logger)
+      @real_logger = real_logger
+    end
+    # Log using the appropriate method if we have a logger
+    # if we dont' have a logger, gracefully ignore.
+    def method_missing(name, *args)
+      if @real_logger && @real_logger.respond_to?(name)
+        @real_logger.send(name, *args)
+      end
+    end
+  end
+end
+
+require 'casclient/tickets'
+require 'casclient/responses'
+require 'casclient/client'
+require 'casclient/version'
+
+# Detect legacy configuration and show appropriate error message
+module CAS
+  module Filter
+    def method_missing
+      $stderr.puts "Your RubyCAS-Client configuration is no longer valid."
+      $stderr.puts "Please see http://rubycas-client.googlecode.com/svn/trunk/rubycas-client/README.txt for information on the new configuration format."
+      $stderr.puts "After upgrading your configuration you should also clear your application's session store."
+    end
+  end
+end

data/lib/casclient/client.rb

@@ -0,0 +1,209 @@
+module CASClient
+  # The client brokers all HTTP transactions with the CAS server.
+  class Client
+    attr_reader :cas_base_url 
+    attr_reader :log, :username_session_key, :extra_attributes_session_key
+    attr_writer :login_url, :validate_url, :proxy_url, :logout_url, :service_url
+    attr_accessor :proxy_callback_url, :proxy_retrieval_url
+    
+    def initialize(conf = nil)
+      configure(conf) if conf
+    end
+    
+    def configure(conf)
+      raise ArgumentError, "Missing :cas_base_url parameter!" unless conf[:cas_base_url]
+      
+      @cas_base_url      = conf[:cas_base_url].gsub(/\/$/, '')       
+      
+      @login_url    = conf[:login_url]
+      @logout_url   = conf[:logout_url]
+      @validate_url = conf[:validate_url]
+      @proxy_url    = conf[:proxy_url]
+      @service_url  = conf[:service_url]
+      @proxy_callback_url  = conf[:proxy_callback_url]
+      @proxy_retrieval_url = conf[:proxy_retrieval_url]
+      
+      @username_session_key         = conf[:username_session_key] || :cas_user
+      @extra_attributes_session_key = conf[:extra_attributes_session_key] || :cas_extra_attributes
+      
+      @log = CASClient::LoggerWrapper.new
+      @log.set_real_logger(conf[:logger]) if conf[:logger]
+    end
+    
+    def login_url
+      @login_url || (cas_base_url + "/login")
+    end
+    
+    def validate_url
+      @validate_url || (cas_base_url + "/proxyValidate")
+    end
+    
+    # Returns the CAS server's logout url.
+    #
+    # If a logout_url has not been explicitly configured,
+    # the default is cas_base_url + "/logout".
+    #
+    # service_url:: Set this if you want the user to be
+    #               able to immediately log back in. Generally
+    #               you'll want to use something like <tt>request.referer</tt>.
+    #               Note that this only works with RubyCAS-Server.
+    # back_url:: This satisfies section 2.3.1 of the CAS protocol spec.
+    #            See http://www.ja-sig.org/products/cas/overview/protocol
+    def logout_url(service_url = nil, back_url = nil)
+      url = @logout_url || (cas_base_url + "/logout")
+      
+      if service_url || back_url
+        uri = URI.parse(url)
+        h = uri.query ? query_to_hash(uri.query) : {}
+        h['service'] = service_url if service_url
+        h['url'] = back_url if back_url
+        uri.query = hash_to_query(h)
+        uri.to_s
+      else
+        url
+      end
+    end
+    
+    def proxy_url
+      @proxy_url || (cas_base_url + "/proxy")
+    end
+    
+    def validate_service_ticket(st)
+      uri = URI.parse(validate_url)
+      h = uri.query ? query_to_hash(uri.query) : {}
+      h['service'] = st.service
+      h['ticket'] = st.ticket
+      h['renew'] = 1 if st.renew
+      h['pgtUrl'] = proxy_callback_url if proxy_callback_url
+      uri.query = hash_to_query(h)
+      
+      st.response = request_cas_response(uri, ValidationResponse)
+      
+      return st
+    end
+    alias validate_proxy_ticket validate_service_ticket
+    
+    # Requests a login using the given credentials for the given service; 
+    # returns a LoginResponse object.
+    def login_to_service(credentials, service)
+      lt = request_login_ticket
+      
+      data = credentials.merge(
+        :lt => lt,
+        :service => service 
+      )
+      
+      res = submit_data_to_cas(login_url, data)
+      CASClient::LoginResponse.new(res)
+    end
+  
+    # Requests a login ticket from the CAS server for use in a login request;
+    # returns a LoginTicket object.
+    #
+    # This only works with RubyCAS-Server, since obtaining login
+    # tickets in this manner is not part of the official CAS spec.
+    def request_login_ticket
+      uri = URI.parse(login_url+'Ticket')
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      res = https.post(uri.path, ';')
+      
+      raise CASException, res.body unless res.kind_of? Net::HTTPSuccess
+      
+      res.body.strip
+    end
+    
+    # Requests a proxy ticket from the CAS server for the given service
+    # using the given pgt (proxy granting ticket); returns a ProxyTicket 
+    # object.
+    #
+    # The pgt required to request a proxy ticket is obtained as part of
+    # a ValidationResponse.
+    def request_proxy_ticket(pgt, target_service)
+      uri = URI.parse(proxy_url)
+      h = uri.query ? query_to_hash(uri.query) : {}
+      h['pgt'] = pgt.ticket
+      h['targetService'] = target_service
+      uri.query = hash_to_query(h)
+      
+      pr = request_cas_response(uri, ProxyResponse)
+      
+      pt = ProxyTicket.new(pr.proxy_ticket, target_service)
+      pt.response = pr
+      
+      return pt
+    end
+    
+    def retrieve_proxy_granting_ticket(pgt_iou)
+      uri = URI.parse(proxy_retrieval_url)
+      uri.query = (uri.query ? uri.query + "&" : "") + "pgtIou=#{CGI.escape(pgt_iou)}"
+      retrieve_url = uri.to_s
+      
+      log.debug "Retrieving PGT for PGT IOU #{pgt_iou.inspect} from #{retrieve_url.inspect}"
+      
+#      https = Net::HTTP.new(uri.host, uri.port)
+#      https.use_ssl = (uri.scheme == 'https')
+#      res = https.post(uri.path, ';')
+      uri = URI.parse(uri) unless uri.kind_of? URI
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      res = https.start do |conn|
+        conn.get("#{uri.path}?#{uri.query}")
+      end
+      
+      
+      raise CASException, res.body unless res.kind_of? Net::HTTPSuccess
+      
+      ProxyGrantingTicket.new(res.body.strip, pgt_iou)
+    end
+    
+    def add_service_to_login_url(service_url)
+      uri = URI.parse(login_url)
+      uri.query = (uri.query ? uri.query + "&" : "") + "service=#{CGI.escape(service_url)}"
+      uri.to_s
+    end
+    
+    private
+    # Fetches a CAS response of the given type from the given URI.
+    # Type should be either ValidationResponse or ProxyResponse.
+    def request_cas_response(uri, type)
+      log.debug "Requesting CAS response form URI #{uri.inspect}"
+      
+      uri = URI.parse(uri) unless uri.kind_of? URI
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      raw_res = https.start do |conn|
+        conn.get("#{uri.path}?#{uri.query}")
+      end
+      
+      #TODO: check to make sure that response code is 200 and handle errors otherwise
+      
+      log.debug "CAS Responded with #{raw_res.inspect}:\n#{raw_res.body}"
+      
+      type.new(raw_res.body)
+    end
+    
+    # Submits some data to the given URI and returns a Net::HTTPResponse.
+    def submit_data_to_cas(uri, data)
+      uri = URI.parse(uri) unless uri.kind_of? URI
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(data, ';')
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      https.start {|conn| conn.request(req) }
+    end
+    
+    def query_to_hash(query)
+      CGI.parse(query)
+    end
+      
+    def hash_to_query(hash)
+      pairs = []
+      hash.each do |k, vals|
+        vals = [vals] unless vals.kind_of? Array
+        vals.each {|v| pairs << "#{CGI.escape(k)}=#{CGI.escape(v)}"}
+      end
+      pairs.join("&")
+    end
+  end
+end

data/lib/{cas_proxy_callback_controller.rb → casclient/frameworks/rails/cas_proxy_callback_controller.rb}

@@ -1,6 +1,6 @@
 require 'pstore'
 
-# Controller that responds to proxy generating ticket callbacks from the CAS server and allows
+# Rails controller that responds to proxy generating ticket callbacks from the CAS server and allows
 # for retrieval of those PGTs.
 class CasProxyCallbackController < ActionController::Base
 

data/lib/casclient/frameworks/rails/filter.rb

@@ -0,0 +1,149 @@
+module CASClient
+  module Frameworks
+    module Rails
+      class Filter
+        cattr_reader :config, :log, :client
+        
+        # These are initialized when you call configure.
+        @@config = nil
+        @@client = nil
+        @@log = nil
+        
+        class << self
+          def filter(controller)
+            raise "Cannot use the CASClient filter because it has not yet been configured." if config.nil?
+
+            st = read_ticket(controller)
+            
+            lst = controller.session[:cas_last_valid_ticket]
+            
+            if st && lst && lst.ticket == st.ticket && lst.service == st.service
+              # warn() rather than info() because we really shouldn't be re-validating the same ticket. 
+              # The only time when this is acceptable is if the user manually does a refresh and the ticket
+              # happens to be in the URL.
+              log.warn("Reusing previously validated ticket since the new ticket and service are the same.")
+              st = lst
+            end
+            
+            if st
+              client.validate_service_ticket(st) unless st.has_been_validated?
+              vr = st.response
+              
+              if st.is_valid?
+                log.info("Ticket #{st.ticket.inspect} for service #{st.service.inspect} belonging to user #{vr.user.inspect} is VALID.")
+                controller.session[client.username_session_key] = vr.user
+                controller.session[client.extra_attributes_session_key] = vr.extra_attributes
+                
+                # RubyCAS-Client 1.x used :casfilteruser as it's username session key,
+                # so we need to set this here to ensure compatibility with configurations
+                # built around the old client.
+                controller.session[:casfilteruser] = vr.user
+                
+                # Store the ticket in the session to avoid re-validating the same service
+                # ticket with the CAS server.
+                controller.session[:cas_last_valid_ticket] = st
+                
+                if vr.pgt_iou
+                  log.info("Receipt has a proxy-granting ticket IOU. Attempting to retrieve the proxy-granting ticket...")
+                  pgt = client.retrieve_proxy_granting_ticket(vr.pgt_iou)
+                  if pgt
+                    log.debug("Got PGT #{pgt.ticket.inspect} for PGT IOU #{pgt.iou.inspect}. This will be stored in the session.")
+                    controller.session[:cas_pgt] = pgt
+                    # For backwards compatibility with RubyCAS-Client 1.x configurations...
+                    controller.session[:casfilterpgt] = pgt
+                  else
+                    log.error("Failed to retrieve a PGT for PGT IOU #{vr.pgt_iou}!")
+                  end
+                end
+                
+                return true
+              else
+                log.warn("Ticket #{st.ticket.inspect} failed validation -- #{vr.failure_code}: #{vr.failure_message}")
+                redirect_to_cas_for_authentication(controller)
+                return false
+              end
+            else
+              if returning_from_gateway?(controller)
+                log.info "Returning from CAS gateway without authentication."
+                
+                if use_gatewaying?
+                  log.info "This CAS client is configured to use gatewaying, so we will permit the user to continue without authentication."
+                  return true
+                else
+                  log.warn "The CAS client is NOT configured to allow gatewaying, yet this request was gatewayed. Something is not right!"
+                end
+              end
+              
+              redirect_to_cas_for_authentication(controller)
+              return false
+            end
+          end
+          
+          def configure(config)
+            @@config = config
+            @@config[:logger] = RAILS_DEFAULT_LOGGER unless @@config[:logger]
+            @@client = CASClient::Client.new(config)
+            @@log = client.log
+          end
+          
+          def use_gatewaying?
+            @@config[:use_gatewaying]
+          end
+          
+          def returning_from_gateway?(controller)
+            controller.session[:cas_sent_to_gateway]
+          end
+          
+          def redirect_to_cas_for_authentication(controller)
+            service_url = read_service_url(controller)
+            redirect_url = client.add_service_to_login_url(service_url)
+            
+            if use_gatewaying?
+              controller.session[:cas_sent_to_gateway] = true
+              redirect_url << "&gateway=true"
+            else
+              controller.session[:cas_sent_to_gateway] = false
+            end
+            
+            log.debug("Redirecting to #{redirect_url.inspect}")
+            controller.send(:redirect_to, redirect_url)
+          end
+          
+          private
+          def read_ticket(controller)
+            ticket = controller.params[:ticket]
+            
+            return nil unless ticket
+            
+            log.debug("Request contains ticket #{ticket.inspect}.")
+            
+            if ticket =~ /^PT-/
+              ProxyTicket.new(ticket, read_service_url(controller), controller.params[:renew])
+            else
+              ServiceTicket.new(ticket, read_service_url(controller), controller.params[:renew])
+            end
+          end
+          
+          def read_service_url(controller)
+            if config[:service_url]
+              log.debug("Using explicitly set service url: #{config[:service_url]}")
+              return config[:service_url]
+            end
+            
+            params = controller.params.dup
+            params.delete(:ticket)
+            service_url = controller.url_for(params)
+            log.debug("Guessed service url: #{service_url.inspect}")
+            return service_url
+          end
+        end
+      end
+    
+      class GatewayFilter < Filter
+        def self.use_gatewaying?
+          return true unless @@config[:use_gatewaying] == false
+        end
+      end
+    end
+  end
+end