echocas-client 2.1.1

data/lib/casclient/client.rb

@@ -0,0 +1,259 @@
+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)
+      #TODO: raise error if conf contains unrecognized cas options (this would help detect user typos in the config)
+
+      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".
+    #
+    # destination_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 the above behaviour describes RubyCAS-Server 
+    #                   -- other CAS server implementations might use this
+    #                   parameter differently (or not at all).
+    # follow_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(destination_url = nil, follow_url = nil)
+      url = @logout_url || (cas_base_url + "/logout")
+      
+      if destination_url
+        # if present, remove the 'ticket' parameter from the destination_url
+        duri = URI.parse(destination_url)
+        h = duri.query ? query_to_hash(duri.query) : {}
+        h.delete('ticket')
+        duri.query = hash_to_query(h)
+        destination_url = duri.to_s.gsub(/\?$/, '')
+      end
+      
+      if destination_url || follow_url
+        uri = URI.parse(url)
+        h = uri.query ? query_to_hash(uri.query) : {}
+        h['destination'] = destination_url if destination_url
+        h['url'] = follow_url if follow_url
+        h['gateway'] = 'true'
+        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
+    
+    # Returns true if the configured CAS server is up and responding;
+    # false otherwise.
+    def cas_server_is_up?
+      uri = URI.parse(login_url)
+      
+      log.debug "Checking if CAS server at URI '#{uri}' is up..."
+      
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      
+      begin
+        raw_res = https.start do |conn|
+          conn.get("#{uri.path}?#{uri.query}")
+        end
+      rescue Errno::ECONNREFUSED => e
+        log.warn "CAS server did not respond! (#{e.inspect})"
+        return false
+      end
+      
+      log.debug "CAS server responded with #{raw_res.inspect}:\n#{raw_res.body}"
+      
+      return raw_res.kind_of?(Net::HTTPSuccess)
+    end
+    
+    # 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 for URI #{uri}"
+      
+      uri = URI.parse(uri) unless uri.kind_of? URI
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = (uri.scheme == 'https')
+      
+      begin
+        raw_res = https.start do |conn|
+          conn.get("#{uri.path}?#{uri.query}")
+        end
+      rescue Errno::ECONNREFUSED => e
+        log.error "CAS server did not respond! (#{e.inspect})"
+        raise "The CAS authentication server at #{uri} is not responding!"
+      end
+      
+      # We accept responses of type 422 since RubyCAS-Server generates these
+      # in response to requests from the client that are processable but contain
+      # invalid CAS data (for example an invalid service ticket).
+      if raw_res.kind_of?(Net::HTTPSuccess) || raw_res.code.to_i == 422
+        log.debug "CAS server responded with #{raw_res.inspect}:\n#{raw_res.body}"
+      else
+        log.error "CAS server responded with an error! (#{raw_res.inspect})"
+        raise "The CAS authentication server at #{uri} responded with an error (#{raw_res.inspect})!"
+      end
+      
+      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/casclient/frameworks/merb/strategy.rb

@@ -0,0 +1,110 @@
+# The 'cas' strategy attempts to login users based on the CAS protocol 
+# http://www.ja-sig.org/products/cas/overview/background/index.html
+# 
+# install the rubycas-client gem
+# http://rubyforge.org/projects/rubycas-client/
+#
+require 'casclient'
+class Merb::Authentication
+  module Strategies
+    class CAS < Merb::Authentication::Strategy
+
+      include CASClient
+
+      def run!
+        @client ||= Client.new(config)
+
+        service_ticket = read_ticket
+
+        cas_login_url = @client.add_service_to_login_url(service_url)
+
+        last_service_ticket = session[:cas_last_valid_ticket]
+        if (service_ticket && last_service_ticket && 
+            last_service_ticket.ticket == service_ticket.ticket && 
+            last_service_ticket.service == service_ticket.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.")
+          service_ticket = last_service_ticket
+        elsif last_service_ticket &&
+          !config[:authenticate_on_every_request] && 
+          session[@client.username_session_key]
+          # Re-use the previous ticket if the user already has a local CAS session (i.e. if they were already
+          # previously authenticated for this service). This is to prevent redirection to the CAS server on every
+          # request.
+          # This behaviour can be disabled (so that every request is routed through the CAS server) by setting
+          # the :authenticate_on_every_request config option to false. 
+          log.debug "Existing local CAS session detected for #{session[@client.username_session_key].inspect}. "+
+                  "Previous ticket #{last_service_ticket.ticket.inspect} will be re-used."
+                  service_ticket = last_service_ticket
+        end
+
+        if service_ticket
+          @client.validate_service_ticket(service_ticket) unless service_ticket.has_been_validated?
+          validation_response = service_ticket.response
+
+          if service_ticket.is_valid?
+            log.info("Ticket #{service_ticket.inspect} for service #{service_ticket.service.inspect} " + 
+                    "belonging to user #{validation_response.user.inspect} is VALID.")
+
+            session[@client.username_session_key] = validation_response.user
+            session[@client.extra_attributes_session_key] = validation_response.extra_attributes
+
+            # Store the ticket in the session to avoid re-validating the same service
+            # ticket with the CAS server.
+            session[:cas_last_valid_ticket] = service_ticket
+            return true
+          else  
+            log.warn("Ticket #{service_ticket.ticket.inspect} failed validation -- " + 
+                    "#{validation_response.failure_code}: #{validation_response.failure_message}")
+            redirect!(cas_login_url)
+            return false
+          end
+        else
+          log.warn("No ticket -- redirecting to #{cas_login_url}")
+          redirect!(cas_login_url)
+          return false
+        end
+      end
+
+      def read_ticket
+        ticket = request.params[:ticket]
+
+        return nil unless ticket
+
+        log.debug("Request contains ticket #{ticket.inspect}.")
+
+        if ticket =~ /^PT-/
+          ProxyTicket.new(ticket, service_url, request.params[:renew])
+        else
+          ServiceTicket.new(ticket, service_url, request.params[:renew])
+        end
+      end
+
+      def service_url
+        if config[:service_url]
+          log.debug("Using explicitly set service url: #{config[:service_url]}")
+          return config[:service_url]
+        end
+
+        params = request.params.dup
+        params.delete(:ticket)
+        service_url = "#{request.protocol}://#{request.host}" + request.path
+        log.debug("Guessed service url: #{service_url.inspect}")
+        return service_url
+      end
+
+      def config
+        ::Merb::Plugins.config[:"rubycas-client"]
+      end
+
+      def log
+        ::Merb.logger
+      end
+
+    end # CAS
+  end # Strategies
+end
+

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

@@ -0,0 +1,76 @@
+require 'pstore'
+
+# Rails controller that responds to proxy generating ticket callbacks from the CAS server and allows
+# for retrieval of those PGTs.
+class CasProxyCallbackController < ActionController::Base
+
+  # Receives a proxy granting ticket from the CAS server and stores it in the database.
+  # Note that this action should ALWAYS be called via https, otherwise you have a gaping security hole.
+  # In fact, the JA-SIG implementation of the CAS server will refuse to send PGTs to non-https URLs.
+  def receive_pgt
+	#FIXME: these checks don't work because REMOTE_HOST doesn't work consistently under all web servers (for example it doesn't work at all under mongrel)
+	#				... need to find a reliable way to check if the request came through from a reverse HTTPS proxy -- until then I'm disabling this check
+    #render_error "PGTs can be received only via HTTPS or local connections." and return unless
+    #  request.ssl? or request.env['REMOTE_HOST'] == "127.0.0.1"
+
+    pgtIou = params['pgtIou']
+    
+    # CAS Protocol spec says that the argument should be called 'pgt', but the JA-SIG CAS server seems to use pgtId.
+    # To accomodate this, we check for both parameters, although 'pgt' takes precedence over 'pgtId'.
+    pgtId = params['pgt'] || params['pgtId']
+    
+    # We need to render a response with HTTP status code 200 when no pgtIou/pgtId is specified because CAS seems first
+    # call the action without any parameters (maybe to check if the server responds correctly)
+    render :text => "Okay, the server is up, but please specify a pgtIou and pgtId." and return unless pgtIou and pgtId
+    
+    # TODO: pstore contents should probably be encrypted...
+    pstore = open_pstore
+    
+    pstore.transaction do
+      pstore[pgtIou] = pgtId
+    end
+    
+    render :text => "PGT received. Thank you!" and return
+  end
+  
+  # Retreives a proxy granting ticket, sends it to output, and deletes the pgt from session storage.
+  # Note that this action should ALWAYS be called via https, otherwise you have a gaping security hole --
+  # in fact, the action will not work if the request is not made via SSL or is not local (we allow for local
+  # non-SSL requests since this allows for the use of reverse HTTPS proxies like Pound).
+  def retrieve_pgt
+    #render_error "You can only retrieve PGTs via HTTPS or local connections." and return unless
+    #  request.ssl? or request.env['REMOTE_HOST'] == "127.0.0.1"
+    
+    pgtIou = params['pgtIou']
+    
+    render_error "No pgtIou specified. Cannot retreive the pgtId." and return unless pgtIou
+  
+    pstore = open_pstore
+  
+    pgt = nil
+    pstore.transaction do
+      pgt = pstore[pgtIou]
+    end
+    
+    if not pgt
+      render_error "Invalid pgtIou specified. Perhaps this pgt has already been retrieved?" and return
+    end
+    
+    render :text => pgt
+    
+    # TODO: need to periodically clean the storage, otherwise it will just keep growing
+    pstore.transaction do
+      pstore.delete pgtIou
+    end
+  end
+  
+  private
+    def render_error(msg)
+      # Note that the error messages are mostly just for debugging, since the CAS server never reads them.
+      render :text => msg, :status => 500
+    end
+    
+    def open_pstore
+      PStore.new("#{RAILS_ROOT}/tmp/cas_pgt.pstore")
+    end
+end