Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 2.32 KB

README.md

File metadata and controls

46 lines (38 loc) · 2.32 KB
Raw

yourls-cas-plugin

This plugin for YOURLS enables the use of Central Authentication Service for user authentication. CAS is commonly used at higher-ed institutions to provide faculty, staff, and students with SSO (Single Sign-On) capability for web services.

Installation

  1. Download phpCAS and give your webserver (eg. Apache) read permissions on it
  2. Download the latest release of yourls-cas-plugin.
  3. Copy the plugin folder into your user/plugins folder for YOURLS.
  4. Set up the parameters for phpCAS (details below)
  5. Activate the plugin with the plugin manager in the admin interface.

Usage

When yourls-cas-plugin is enabled, the login screen will never be shown. Instead, you will be immediately redirected to the CAS server. If CAS login is successful, then you will immediately go to the admin interface.

Configuration

  • PHPCAS_PATH The path to where you installed the phpCAS library. This should be an absolute path ending with CAS.php.
  • PHPCAS_HOST The hostname of your CAS server
  • PHPCAS_CONTEXT The webapp subdirectory of your CAS server (typically /cas)
  • PHPCAS_CERTCHAIN_PATH You need a local copy of the certificate chain from the CAS server. That's the only way for phpCAS to verify the server's authenticity. Also, you can concatenate multiple certs into a single PEM file.

Troubleshooting

Check all of your error logs.

  • PHP error log usually at /var/log/php.log
  • phpCAS error log usually at /tmp/phpcas.log
  • And your Apache error_log, of course.

License

Copyright 2013 Nicholas Waller (code@nicwaller.com)

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 the Free Software Foundation, either version 3 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 along with this program. If not, see http://www.gnu.org/licenses/.