README in rubycas-client-1.0.0 vs README in rubycas-client-1.1.0
- old
+ new
@@ -83,10 +83,30 @@
CAS::Filter.session_username = :casfilteruser # this is the hash in the session where the authenticated username will be stored
Note that in this example we explicitly specified the login and validate URLs instead of letting RubyCAS-Client figure them out
based on <tt>CAS::Filter.cas_base_url</tt>.
+==== Defining a 'logout' action
+
+Your Rails application's controller(s) will probably have some sort of logout function. In it you will likely want reset the
+user's session for your application, and then redirect to the CAS server's logout URL. Here's an example of how to do this:
+
+ def logout
+ reset_session
+ redirect_to CAS::Filter.logout_url(self, request.referer)
+ end
+
+==== Gatewayed authentication
+
+RubyCAS-Client supports gatewaying as of version 1.1.0. Gatewaying allows for optional CAS authentication, so that users who
+already have a pre-existing CAS SSO session will be automatically authenticated for the gatewayed service, while those who
+do not, will be allowed to access the service without authentication. This is useful for example when you want to show
+some additional private content on a homepage to authenticated users, but also want unauthenticated users to be able to
+access the page without first logging in.
+
+For more information on using gatewaying, see CAS::GatewayFilter.
+
==== How to act as a CAS proxy
CAS 2.0 has a built-in mechanism that allows a CAS-authenticated application to pass on its authentication to other applications.
An example where this is useful might be a portal site, where the user logs in to a central website and then gets forwarded to
various other sites that run independently of the portal system (but are always accessed via the portal). The exact mechanism
@@ -187,17 +207,17 @@
== License
This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
+You should have received a copy of the GNU Lesser General Public License
along with this program (see the file called LICENSE); if not, write to the
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
\ No newline at end of file