(r2) CasLoginContrib < TWiki

Tags: view all tags
<!--
This topic is part of the documentation for CasLoginContrib and is
automatically generated from Subversion. Do not edit it! Your edits
will be lost the next time the topic is uploaded!

If you want to report an error in the topic, please raise a report at
http://develop.twiki.org/~twiki4/cgi-bin/view/Bugs/CasLoginContrib
-->

---+!! !CasLoginContrib
<!--
One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = CAS login manager for TWiki
-->
%SHORTDESCRIPTION%

%TOC%

---++ Usage

This is a login manager for TWiki which allows integration in a [[Wikipedia:Central_Authentication_Service][CAS]] Single Sign On infrastructure.

Once installed, it provides users with a "trip" to a CAS server to enter usernames and passwords when authentication is required in TWiki.

To activate it, you will specify =TWiki::LoginManager::CasLogin= (or =TWiki::Client::CasLogin= for TWiki 4.1.x) in the security setup section of [[%SCRIPTURL{"configure"}%][configure]]. 


---++ Examples

Configure the following variables to activate this Login manager :
<verbatim>
$TWiki::cfg{LoginManager} = 'TWiki::LoginManager::CasLogin'; # or 'TWiki::Client::CasLogin'; for TWiki 4.1.x
$TWiki::cfg{CAS}{casUrl} = 'https://yourcas.yourdomain/cas';
$TWiki::cfg{CAS}{CAFile} = '/etc/ssl/certs/your_CAS.pem';
</verbatim>

Should you wish to trace execution of Client/LoginManager, you may set also :
<verbatim>
$TWiki::cfg{Trace}{Client} = 1;
</verbatim>

---++ Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully
automatic installer script written using the Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   * If you have any problems, then you can still install manually from the command-line:
      1 Download one of the =.zip= or =.tgz= archives
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat for any missing dependencies.
   * If you are *still* having problems, then instead of running the installer script:
      1 Make sure that the file permissions allow the webserver user to access all files.
      1 Check in any installed files that have existing =,v= files in your existing install (take care *not* to lock the files when you check in)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


---++ Contrib Info

This initial attempt at packaging the <nop>CasLogin is based on work done
by Main.CharlieReitsma (See Codev.CasLogin), modified by
Main.OlivierBerger to work with TWiki 4.1.2, and assembled into a
Contrib package.

You'll find the original version of Main.CharlieReitsma meant for TWiki 4.2 in Codev.CasLogin.

|  Contrib Author(s): | Main.CharlieReitsma, Main.OlivierBerger |
|  Copyright: | &copy; Greg Abbas, Charlie Reitsma, Olivier Berger |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Contrib Version: | 17456 (26 Aug 2008) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  v. 0.17456 (26 Aug 2008) | Updating documentation, adding Config.spec, managing Contrib sources in SVN. |
|  v. 2 (20080815) | Adding <nop>TWiki::LoginManager::CasLogin for TWiki 4.2 to ship both versions at the same time. |
|  v. 1 (20080814) | Initial release with <nop>TWiki::Client::CasLogin, only for TWiki 4.1.2. |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">AuthCAS</td><td align="left">&gt;=1.3.1</td><td align="left">Required. See : CPAN:AuthCAS, Codev.AuthCAS#AuthCAS_Module</td></tr></table> |
|  Contrib Home: | http://twiki.org/cgi-bin/view/Plugins/CasLoginContrib |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/CasLoginContribDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/CasLoginContribAppraisal |

__Related Topics:__ %TWIKIWEB%.TWikiContribs, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on twiki.org instead. -->
Topic revision: r1 - 2008-08-26 - TWikiGuest
Account
- Log In
~~Edit~~
~~Attach~~
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.CasLoginContrib.