Class: CASClient::Frameworks::Rails::Filter

Inherits:
Object
  • Object
show all
Defined in:
lib/casclient/frameworks/rails/filter.rb

Direct Known Subclasses

GatewayFilter

Constant Summary collapse

@@config =

These are initialized when you call configure.

nil
@@client = 
nil
@@log = 
nil

Class Method Summary collapse

Class Method Details

.configure(config) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 35

def self.configure(config)
  @@config = config
  @@config[:logger] = RAILS_DEFAULT_LOGGER unless @@config[:logger]
  @@client = CASClient::Client.new(config)
  @@log = client.log
end

.filter(controller) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 17

def self.filter(controller)
  raise "Cannot use the CASClient filter because it has not yet been configured." if config.nil?

  case RequestHandler.determine_response(condition, use_gatewaying?)
  when :single_sign_out
    controller.send(:render, :text => "CAS Single-Sign-Out request intercepted.")
    return false
  when :allow
    return true
  when :to_login
    redirect_to_cas_for_authentication(controller)
    return false
  when :validation_failed
    redirect_to_cas_for_authentication(controller)
    return false
  end
end

.login_url(controller) ⇒ Object

Returns the login URL for the current controller. Useful when you want to provide a “Login” link in a GatewayFilter’ed action.



45
46
47
48
49
50
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 45

def self.(controller)
  service_url = read_service_url(controller)
  url = client.(service_url)
  log.debug("Generated login url: #{url}")
  return url
end

.logout(controller, service = nil) ⇒ Object

Clears the given controller’s local Rails session, does some local CAS cleanup, and redirects to the CAS logout page. Additionally, the request.referer value from the controller instance is passed to the CAS server as a ‘destination’ parameter. This allows RubyCAS server to provide a follow-up login page allowing the user to log back in to the service they just logged out from using a different username and password. Other CAS server implemenations may use this ‘destination’ parameter in different ways. If given, the optional service URL overrides request.referer.



63
64
65
66
67
68
69
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 63

def self.logout(controller, service = nil)
  referer = service || controller.request.referer
  st = controller.session[:cas_last_valid_ticket]
  delete_service_session_lookup(st) if st
  controller.send(:reset_session)
  controller.send(:redirect_to, client.logout_url(referer))
end

.redirect_to_cas_for_authentication(controller) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 71

def self.redirect_to_cas_for_authentication(controller)
  redirect_url = (controller)

  if use_gatewaying?
    controller.session[:cas_sent_to_gateway] = true
    redirect_url << "&gateway=true"
  else
    controller.session[:cas_sent_to_gateway] = false
  end

  if controller.session[:previous_redirect_to_cas] &&
        controller.session[:previous_redirect_to_cas] > (Time.now - 1.second)
    log.warn("Previous redirect to the CAS server was less than a second ago. The client at #{controller.request.remote_ip.inspect} may be stuck in a redirection loop!")
    controller.session[:cas_validation_retry_count] ||= 0

    if controller.session[:cas_validation_retry_count] > 3
      log.error("Redirection loop intercepted. Client at #{controller.request.remote_ip.inspect} will be redirected back to login page and forced to renew authentication.")
      redirect_url += "&renew=1&redirection_loop_intercepted=1"
    end

    controller.session[:cas_validation_retry_count] += 1
  else
    controller.session[:cas_validation_retry_count] = 0
  end
  controller.session[:previous_redirect_to_cas] = Time.now

  log.debug("Redirecting to #{redirect_url.inspect}")
  controller.send(:redirect_to, redirect_url)
end

.use_gatewaying? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/casclient/frameworks/rails/filter.rb', line 13

def self.use_gatewaying?
  @@config[:use_gatewaying]
end