CAS客户端整合（一） Discuz!

时间 2019-12-01

标签 cas 客户端整合 discuz 栏目 Discuz 繁體版

原文原文链接

有好几个系统须要接入CAS，因此登陆模块通通须要重构javascript

版本

CAS服务端是Java的 Cas-server-4.0
CAS的php客户端是 phpCAS-1.2.0
论坛版本是 Discuz!X3.3

Discuz! 登陆流程

由于discuz原来的流程是验证本身的一套用户密码体系，如今咱们须要将这个验证过程放在 CAS-server ，而后经过绑定的 php-cas-client 来获取登陆状态。由这个登陆状态来决定需不须要初始化用户。php

原流程

简（jian）单（nan）研究 Discuz! 的源码，大体画出它的登陆流程
html

CAS登陆流程

咱们修改后的登陆流程，橙色为须要修改的部分
java

这里能够根据本身的业务场景进行调整，大体的流程是同样的。可能在是否本地cookie自动登陆这点会有区别，在文末总结里会对这一点谈谈我我的的分析。web

整合 Discuz! 与 phpCAS

画好了流程图，而后能够开始动手写代码了。数据库

phpCAS接入

根目录下引入整个phpCAS客户端/cas/，新建一个CasClient.php用来作一些初始化工做。api

/*
 * path : /cas/CasClient.php
 */
define ( 'CAS_SERVER_HOST', 'localhost' );
define ( 'CAS_SERVER_PORT', 34382 );
define ( 'CAS_SERVER_PATH', "/cas-server" );

include_once (dirname ( __FILE__ ) . '/CAS.php'); 

// debug logfile name
phpCAS::setDebug ('./cas.log');

// initialize phpCAS
phpCAS::client ( CAS_VERSION_2_0, CAS_SERVER_HOST, CAS_SERVER_PORT, CAS_SERVER_PATH );

// no SSL validation for the CAS server
phpCAS::setNoCasServerValidation ();

// sync logout requests
phpCAS::handleLogoutRequests();

//var_dump(phpCAS::isAuthenticated());

而后在discuz中包含它，在 /source/class/class_core.php添加一行：服务器

error_reporting(E_ALL);

define('IN_DISCUZ', true);
define('DISCUZ_ROOT', substr(dirname(__FILE__), 0, -12));
define('DISCUZ_CORE_DEBUG', false);
define('DISCUZ_TABLE_EXTENDABLE', false);
// include phpCAS
require_once DISCUZ_ROOT."cas/CasClient.php";

set_exception_handler(array('core', 'handleException'));

我引入的phpCAS版本是用 global 变量来存放 PHPCAS_CLIENT，Discuz在程序初始化的时候会清空全局变量（discuz_application->_init_env()），所以致使在后面没法获取到PHPCAS_CLIENT 变量，出现phpCAS error: phpCAS::isAuthenticated(): this method should not be called before phpCAS::client() or phpCAS::proxy()错误。个人解决方案是把/cas/CAS.php里的 global 变量改为了 static，问题解决。
cookie

phpCAS 客户端是经过 session 来记录isAuthenticated()状态，引入phpCAS的地方能够获取正确的session，在后面的业务代码中就为null。聪明的你已经想到由于跟上面相同的缘由，全局的 session 变量在 Discuz 初始化的时候被清空了。所以对/source/class/discuz/discuz_application.php进行以下修改session

private function _init_env() {
  ...
  foreach ($GLOBALS as $key => $value) {
      // if session of phpCAS, keep it.
      if (!isset($this->superglobal[$key])) {
          if ($key == '_SESSION') {
              $temp_phpCAS = $_SESSION['phpCAS'];
              $GLOBALS[$key] = null; unset($GLOBALS[$key]);
              $_SESSION['phpCAS'] = $temp_phpCAS;
              $temp_phpCAS = null; unset($temp_phpCAS);
              continue;
          }
          $GLOBALS[$key] = null; unset($GLOBALS[$key]);
      }
  }
  ...

这样咱们就能够在discuz的其余地方正确获取到phpCAS的client对象。

Discuz 的登陆过程

登陆过程当中有2个地方须要修改。第一是页面初始化的时候，检查cas是否已登陆，若是已登陆直接初始化用户登陆信息；第二处是若是页面发起了登陆请求，咱们须要将请求引导到cas-server端登陆，验证完成后返回。

页面初始化

修改位于/source/class/discuz/discuz_appliation.php，大体是 455 行 _init_user() 方法：

if($this->init_user) {
        /**
         * login via cas
         */
        if (phpCAS::isAuthenticated()) {
            // 根据本身实际状况获取用户字段，这里论坛帐号为中文名
            // 所以用这个中文名到数据库中查找用户uid进行初始化
            $username = phpCAS::getAttribute('cname');
            $db_user_info = DB::fetch_first("SELECT `uid`,`username`,`password`,`email` FROM ". DB::table('ucenter_members') ." WHERE `username`='$username' ");
            $discuz_pw = $db_user_info['password'];
            $discuz_uid = $db_user_info['uid'];
            // 下面这部分跟原来的验证过程一致
            if ($db_user_info) {
                $user = getuserbyuid($discuz_uid, 1);
                if(isset($user['_inarchive'])) {
                    C::t('common_member_archive')->move_to_master($discuz_uid);
                }
                $this->var['member'] = $user;
            } else {
                $user = array();
                $this->_init_guest();
            }
        } else {
            // original discuz auth via cookie

以上修改的意思是，页面初始化的时候会检查cas-server的用户登陆状态，若是已有用户登陆，获取用户名，在discuz初始化这个用户的登陆状态。

登陆跳转

接下来要处理的问题是，当用户没有登陆的时候，如何从discuz登陆到 cas-server。
discuz的全部登陆（管理后台除外）都会由/source/class/class_member.php的on_login()方法进行处理。

/*
     * discuz 原先的逻辑
    if(!submitcheck('loginsubmit', 1, $seccodestatus)) {
        登陆界面
    }
    else {
        验证帐号密码
    }
    */
    if ( TRUE ) {
            
        $username='';
        if (!phpCAS::isAuthenticated()) {
            // 很是重要
            // 构造登陆返回的url
            $url = phpCAS::$_PHPCAS_CLIENT->getServerLoginURL();
            $url = substr($url, 0, strpos($url, 'login?service='));
            $url = $url . 'login?service=' . urlencode(dreferer());
            //phpCAS::setServerLoginURL($url);
            //phpCAS::forceAuthentication ();
            showmessage ( '还没有登陆,<a href="'.$url.'" >前去登陆</a><script type="text/javascript">window.top.location.href="'.$url.'";</script>' );
        }
        // 获取用户
        $username = phpCAS::getAttribute('cname');
        $password = '';
        $email = phpCAS::getAttribute('email');
        // $result = userlogin($_GET['username'], $_GET['password'], $_GET['questionid'], $_GET['answer'], $this->setting['autoidselect'] ? 'auto' : $_GET['loginfield'], $_G['clientip']);
        // 采用本身的登录方法
                    $result = userloginCas ( $username, $email );
        $uid = $result ['ucresult'] ['uid'];
        // 后面继续按照discuz的流程便可

而后在/source/function/function_member.php添加本身的userloginCas()方法：

/**
 * Login via Cas
 * @param $member
 * @param $cookietime
 */
function userloginCas($username, $email) {
$return = array ();
$merge = 0;
    // 根据用户名获取用户信息
$db_user_info = DB::fetch_first("SELECT `uid`,`username`,`password`,`email` FROM ". DB::table('ucenter_members') ." WHERE `username`='$username' ");
if ($db_user_info) {
    $return ['ucresult'] = array(
        $db_user_info['uid'],
        $db_user_info['username'],
        $db_user_info['password'],
        $db_user_info['email'],
        $merge,
    );
} else {
    $return ['ucresult'] = array(0, '', '', '', 0);
}
    
if ($merge && $return ['ucresult'] ['uid'] > 0 || $return ['ucresult'] ['uid'] <= 0) {
    $return ['status'] = 0;
    return $return;
}
    
$member = getuserbyuid ( $return ['ucresult'] ['uid'], 1 );
if (! $member || empty ( $member ['uid'] )) {
    $return ['status'] = - 1;
    return $return;
}
$return ['member'] = $member;
$return ['status'] = 1;
if ($member ['_inarchive']) {
    C::t ( 'common_member_archive' )->move_to_master ( $member ['uid'] );
}
if ($member ['email'] != $return ['ucresult'] ['email']) {
    C::t ( 'common_member' )->update ( $return ['ucresult'] ['uid'], array (
        'email' => $return ['ucresult'] ['email']
    ) );
}
    
return $return;
}

上述代码的做用是，当用户请求登陆时，若用户未在cas服务器登陆，直接引导用户跳转至cas-server进行登陆，并记录当前页面url在验证成功以后返回。不然直接初始化当前cas登陆的用户。

隐藏右上角的登陆框

登陆所有交给cas-server，这里就再也不须要登陆框了，直接找到/template/default/member/login_simple.htm魔改消灭它。

登出处理

function on_logout() {
    global $_G;
            
    $ucsynlogout = $this->setting ['allowsynlogin'] ? uc_user_synlogout () : '';
            
    if ($_GET ['formhash'] != $_G ['formhash']) {
        $service =  dreferer ()  ;
        phpCAS::logoutWithRedirectService ( $service );
        showmessage ( 'logout_succeed', dreferer (), array (
            'formhash' => FORMHASH,
            'ucsynlogout' => $ucsynlogout,
            'referer' => rawurlencode ( dreferer () )
        ) );
    }
            
    clearcookies ();
    $_G ['groupid'] = $_G ['member'] ['groupid'] = 7;
    $_G ['uid'] = $_G ['member'] ['uid'] = 0;
    $_G ['username'] = $_G ['member'] ['username'] = $_G ['member'] ['password'] = '';
    $_G ['setting'] ['styleid'] = $this->setting ['styleid'];
            
    if (defined ( 'IN_MOBILE' )) {
        $service =  dreferer ()  ;
        phpCAS::logoutWithRedirectService ( $service );
        showmessage ( 'location_logout_succeed_mobile', dreferer (), array (
            'formhash' => FORMHASH,
            'referer' => rawurlencode ( dreferer () )
        ) );
    } else {
        // 退出
        $service =  dreferer ()  ;
        phpCAS::logoutWithRedirectService ( $service );
        // 后面这个showmessage提示实际上已经不会执行了
        // showmessage ( 'logout_succeed', dreferer (), array (
        // 'formhash' => FORMHASH,
        // 'ucsynlogout' => $ucsynlogout,
        // 'referer' => rawurlencode ( dreferer () )
        // ) );
    }
}

问题小结

本地cookie登陆
我这里登陆所有交给cas-server进行处理，每次web请求都会向cas-server进行认证，本地cookie事实上已经没有关系了。若是想把流程改成先尝试本地cookie登陆，再认证cas-server，看起来能够减小中间的会话过程（通常cas-server会在另外一台服务器上），提高页面响应速度。这种方案的流程为，在验证cas以前先尝试cookie登陆，而后尝试cas认证，认证成功则写入cookie，而后初始化用户登陆状态。麻烦的地方在于用户在其余cas更改了用户以后，如何同步响应修改cookie更改用户。
用户登陆行为记录
登陆行为记录能够考虑放在cas-server端，不然须要经过其余方式判断用户登陆行为，好比额外的参数（或者curl？）
管理后台登陆和用户管理
discuz管理员须要原生的discuz帐号密码登陆，cas用户的帐号密码由另外一个数据库进行统一管理，所以须要同步两个系统的用户帐号和密码。
事实上，当CAS链接了N个系统的时候，如何同步管理这多个系统的帐号和权限是个很是棘手的问题。
文章参考