csi-uksw/laravel-cas

UKSW CAS auth module for Laravel 5.1

Installation

Versions

Version 1.0 requires PHP 5.5.9+., _(*1)

Laravel 5.1

To install this package pull it in through Composer., _(*2)

composer require csi-uksw/laravel-cas

After Composer is done, you need to tell your application to use the CAS service provider., _(*3)

Open config/app.php and add the service provider, _(*4)

CSI_UKSW\Laravel\CAS\CASServiceProvider::class, _(*5)

after, _(*6)

Illuminate\Auth\AuthServiceProvider::class, _(*7)

As well the Facade :, _(*8)

'CAS' => CSI_UKSW\Laravel\CAS\Facades\CAS::class, _(*9)

Configuration

Basic

To set up your CAS for connections you have to publish CAS config. This will provide all the configuration values for your connection., _(*10)

php artisan vendor:publish --provider="CSI_UKSW\Laravel\CAS\CASServiceProvider"

After that please edit your app/cas.php. Using the .env file will allow you to have different environments without even touching the app/cas.php config file., _(*11)

Middleware

Optionally you can use provided Auth Middleware., _(*12)

After publishing please edit your app/Http/Kernel.php, _(*13)

protected $routeMiddleware = [
    'auth.cas' => \CSI_UKSW\Laravel\CAS\Http\Middleware\CASAuthMiddleware::class
];

Usage

Authenticate:, _(*14)

CAS::authenticate(), _(*15)

Logout:, _(*16)

CAS::logout(), _(*17)

Get username:, _(*18)

CAS::getUser(), _(*19)

Get user attributes:, _(*20)

CAS::getAttributes(), _(*21)

Check if is authenticated:, _(*22)

CAS::isAuthenticated(), _(*23)

Route middleware:, _(*24)

Route::group(['middleware' => 'auth.cas'], function () {
   get('cas', function(){
       echo 'authorized only';
   });
});