rubycas-client 2.0.0 → 2.0.1

data/CHANGELOG.txt

@@ -1,5 +1,16 @@
 = RubyCAS-Client Changelog
 
+== Version 2.0.1 :: 2008-02-27
+
+* The Rails filter no longer by default redirects to the CAS server on 
+  every request. This restores the behaviour of RubyCAS-Client 1.x.
+  In other words, if a session[:cas_user] value exists, the filter
+  will assume that the user is authenticated without going through the
+  CAS server. This behaviour can be disabled (so that a CAS re-check is 
+  done on every request) by setting the 'authenticate_on_every_request' 
+  option to true. See the "Re-authenticating on every request" section 
+  in the README.txt for details. 
+
 == Version 2.0.0 :: 2008-02-14
 
 * COMPLETE RE-WRITE OF THE ENTIRE CLIENT FROM THE GROUND UP. Oh yes.

data/README.txt

@@ -93,7 +93,8 @@ Here is a more complicated configuration showing most of the configuration optio
     :validate_url  => "https://cas.example.foo/proxyValidate",
     :session_username_key => :cas_user,
     :session_extra_attributes_key => :cas_extra_attributes
-    :logger => cas_logger
+    :logger => cas_logger,
+    :authenticate_on_every_request => true
   )
 
 Note that it is normally not necessary to specify <tt>:login_url</tt>, <tt>:logout_url</tt>, and <tt>:validate_url</tt>.
@@ -108,6 +109,23 @@ info under <tt>session[:cas_extra_attributes]</tt>).
 An arbitrary Logger instance can be given as the :logger parameter. In the example above we log all CAS activity to a 
 <tt>log/cas.log</tt> file in your Rails app's directory.
 
+==== Re-authenticating on every request (i.e. the "single sign-out problem")
+
+By default, the Rails filter will only authenticate with the CAS server when no session[:cas_user] value exists. Once the user 
+has been authenticated, no further CAS forwarding is done until the user's session is wiped. This saves you
+the trouble of having to do this check yourself (since in most cases it is not advisable to go through the CAS server
+on every request -- this is slow and would potentially lead to problems, for example for AJAX requests). However,
+the disadvantage is that the filter no longer checks to make sure that the user's CAS session is still actually open.
+In other words it is possible for the user's authentication session to be closed on the CAS server without the
+client application knowing about it.
+
+In the future RubyCAS-Client will support the new "Single Sign-Out" functionality in CAS 3.1, allowing the server to 
+notify the client application that the CAS session is closed, but for now it is up to you  to handle this by, for example, 
+by wiping the local session[:cas_user] value periodically to force a CAS re-check.
+ 
+Alternatively, it is possible to disable this authentication persistence behaviour by setting the <tt>:authenticate_on_every_request</tt>
+configuration option to true as in the example above.
+
 
 ==== Defining a 'logout' action
 

data/lib/casclient.rb

@@ -70,10 +70,20 @@ 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."
+    class << self
+    def method_missing(method, *args)
+      $stderr.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      $stderr.puts
+      $stderr.puts "WARNING: Your RubyCAS-Client configuration is no longer valid!!"
+      $stderr.puts
+      $stderr.puts "For information on the new configuration format please see: "
+      $stderr.puts
+      $stderr.puts "   http://rubycas-client.googlecode.com/svn/trunk/rubycas-client/README.txt"
+      $stderr.puts
       $stderr.puts "After upgrading your configuration you should also clear your application's session store."
+      $stderr.puts
+      $stderr.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+    end
     end
   end
 end

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

@@ -21,7 +21,7 @@ module CASClient
               # 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.")
+              log.warn("Re-using previously validated ticket since the new ticket and service are the same.")
               st = lst
             end
             
@@ -62,6 +62,12 @@ module CASClient
                 redirect_to_cas_for_authentication(controller)
                 return false
               end
+            elsif !config[:authenticate_on_every_request] && controller.session[client.username_session_key]
+              # Don't re-authenticate with the CAS server if we already previously authenticated and the
+              # :authenticate_on_every_request option is disabled (it's disabled by default).
+              log.debug "Existing local CAS session detected for #{controller.session[client.username_session_key].inspect}. "+
+                "User will not be re-authenticated."
+              return true
             else
               if returning_from_gateway?(controller)
                 log.info "Returning from CAS gateway without authentication."

data/lib/casclient/version.rb

@@ -2,7 +2,7 @@ module CASClient #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 2
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/rubycas-client.rb

@@ -1 +1,5 @@
-require 'lib/casclient'
+begin
+  require 'casclient'
+rescue MissingSourceFile
+  require 'lib/casclient'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubycas-client
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors: 
 - Matt Zukowski
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-19 00:00:00 -05:00
+date: 2008-02-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency