README

轻松实现 Laravel 的 CAS 认证

安装

通过 Composer

$ composer require sentrasoft/laravel-cas

通过编辑 composer.json

"require": {
	"sentrasoft/laravel-cas": "dev-master"
}

接下来，从终端更新 Composer

$ composer update

配置

更新 composer 后，将 ServiceProvider 添加到 config/app.php 文件中的 providers 数组中。

'providers' => array(
    .....
    Sentrasoft\Cas\CasServiceProvider::class,
);

现在在 config/app.php 中添加别名。

'aliases' => array(
    ......
    'Cas' => Sentrasoft\Cas\Facades\Cas::class,
);

将中间件添加到您的 Kernel.php 文件或使用自己的。

'cas.auth'  => \Sentrasoft\Cas\Middleware\Authenticate::class,
'cas.guest' => \Sentrasoft\Cas\Middleware\RedirectIfAuthenticated::class,

现在发布配置文件 cas.php

$ php artisan vendor:publish --provider="Sentrasoft\Cas\CasServiceProvider" --tag="config"

在您的 .env 中添加以下新的环境变量

CAS_HOSTNAME=cas.example.com
CAS_VALIDATION=https://cas.example.com/cas/p3/serviceValidate
CAS_VERSION=3.0
CAS_LOGOUT_URL=https://cas.example.com/cas/logout

要查看更多配置，请参阅并阅读每个配置项的描述 config/cas.php

路由

认证

将用户重定向到提供者的认证页面。

Route::get('/cas/login', function() {
    return cas()->authenticate();
})->name('cas.login');

控制器和回调路由

您可以为名为 Auth\CasController 创建一个新的控制器。

php artisan make:controller Auth\CasController

class CasController extends Controller
{
    /**
     * Obtain the user information from CAS.
     *
     * @return Illuminate\Http\RedirectResponse
     */
    public function callback()
    {
        // $username = Cas::getUser();
        // Here you can store the returned information in a local User model on your database (or storage).

        // This is particularly usefull in case of profile construction with roles and other details
        // e.g. Auth::login($local_user);

        return redirect()->route('home');
    }
}

认证执行时，将调用回调 URL。在回调中，您可以处理用户并在数据库中创建本地条目。

Route::get('/cas/callback', 'Auth\CasController@callback')->name('cas.callback');

登出

登出 CAS 会话并重定向用户。

Route::post('/cas/logout', [ 'middleware' => 'cas.auth', function() {
    cas()->logout();

    // You can also add @param string $url in param[0]
    cas()->logout(url('/'));

    // Or add @param string $service in param[1]
    cas()->logout('', url('/'));

}])->name('cas.logout');

cas.auth 中间件是可选的，但当用户尝试登出而没有 CAS 会话时，您需要处理错误。

如果 .env 中的 CAS_LOGOUT_REDIRECT 配置项已添加，则从该配置项获取值。如果没有配置，则根据您指定的值获取。

如果您想使用 SLO (Single Logout)（如果 CAS 服务器支持 SLO），则您的应用程序必须有有效的 SSL，并且 CAS 服务器必须能够发送不带验证 CsrfToken 的 HTTP POST /cas/logout。因此，您必须更改 App\Http\Middleware\VerifyCsrfToken 文件并排除 /cas/logout 路由。

/**
 * The URIs that should be excluded from CSRF verification.
 *
 * @var array
 */
protected $except = [
    //

    '/cas/logout',
];

您可以通过尝试通过 cURL 发送 HTTP POST 来检查它是否正常工作。

curl -X POST https://yourapp.com/cas/logout

用法

获取用户

检索认证凭据。

不是 ID（整数），而是在 CAS 登录（用户名）表单上给出的。

$uid = Cas::user()->id;

获取用户属性

获取当前连接用户的属性。

foreach (Cas::user()->getAttributes() as $key => $value) {
	...
}

获取用户属性

通过键名检索特定属性。返回的属性可以是字符串或基于匹配的数组。

$value = Cas::user()->getAttribute('key');

支持我们

帮助我们继续制作出色的内容。您不必是开发者就可以支持我们的开源工作。如果您想获得个人支持，或者只是因为帮助开源开发而感到温暖和舒适，捐赠非常欢迎。谢谢。

许可

MIT 许可证（MIT）。有关更多信息，请参阅许可文件。