PHP單點登錄

本文主要介紹了利用webservice,session,cookie技術,來進行通用的單點登陸系統的分析與設計。具體實現語言爲PHP。單點 登陸,英文名爲Single Sign On,簡稱爲 SSO,是目前企業,網絡業務的用戶綜合處理的重要組成部分。而SSO的定義,是在多個應用系統中,用戶只須要登錄一次就能夠訪問全部相互信任的應用系統。javascript

 

動機:

用過ucenter的全站登陸方式的朋友,應該都知道這是典型的觀察者模式的解決方案。用戶中心做爲subject, 其所屬observer的註冊和刪除統一在ucenter的後臺進行。而各個子應用站點都對應一個observer。每次用戶中心的登陸動做,都會觸發 js腳本回調w3c標準的子站登陸接口(api/uc.php)。php

這種方式的缺點,本人認爲主要是兩點:java

1. 子站點過多時,回調接口相應增多,這個在分佈子站的量的限制上,如何控制來使登陸效率不會過低,很差把握;web

2. 當某個子站回調接口出現問題時,默認的登陸過程會卡住(能夠限制登陸程序的執行時間,但相應出現問題子站後面的子站的回調接口就調不到了。api

基於以上問題,在實際開發過程當中,本人設計了另外一套單點登陸系統。瀏覽器

 

一. 登錄原理說明

單點登陸的技術實現機制:服務器

當用戶第一次訪問應用系統1的時候,由於尚未登陸,會被引導到認證系統中進行登陸;根據用戶提供的登陸信息,認證系統進行身份效驗。cookie

若是經過效驗,應該返回給用戶一個認證的憑據--ticket;用戶再訪問別的應用的時候,就會將這個ticket帶上,做爲本身認證的憑據,應用系統接受到請求以後會把ticket送到認證系統進行效驗,檢查ticket的合法性。網絡

若是經過效驗,用戶就能夠在不用再次登陸的狀況下訪問應用系統2和應用系統3了。session

能夠看出,要實現SSO,須要如下主要的功能:

a) 全部應用系統共享一個身份認證系統;

b) 全部應用系統可以識別和提取ticket信息;

c) 應用系統可以識別已經登陸過的用戶,能自動判斷當前用戶是否登陸過,從而完成單點登陸的功能

基於以上基本原則,本人用php語言設計了一套單點登陸系統的程序,目前已投入正式生成服務器運行。本系統程序,將ticket信息以全系統惟一的 session id做爲媒介,從而獲取當前在線用戶的全站信息(登錄狀態信息及其餘須要處理的用戶全站信息)。

 

二. 過程說明:

登錄流程:

1. 第一次登錄某個站:

a) 用戶輸入用戶名+密碼,向用戶驗證中心發送登陸請求

b) 當前登陸站點,經過webservice請求,用戶驗證中心驗證用戶名,密碼的合法性。若是驗證經過,則生成ticket,用於標識當前會話的用戶,並將當前登錄子站的站點標識符記錄到用戶中心,最後將獲取的用戶數據和ticket返回給子站。若是驗證不經過,則返回相應的錯誤狀態碼。

c) 根據上一步的webservice請求返回的結果,當前子站對用戶進行登錄處理:如狀態碼錶示成功的話,則當前站點經過本站cookie保存ticket,並本站記錄用戶的登陸狀態。狀態碼錶示失敗的話,則給用戶相應的登陸失敗提示。

2. 登錄狀態下,用戶轉到另外一子:

a) 經過本站cookie或session驗證用戶的登陸狀態:如驗證經過,進入正常本站處理程序;不然戶中心驗證用戶的登陸狀態(發送ticket到用戶驗證中心),如驗證經過,則對返回的用戶信息進行本地的登陸處理,不然代表用戶未登陸。

登出流程

a) 當前登出站清除用戶本站的登陸狀態 和 本地保存的用戶全站惟一的隨機id

b) 經過webservice接口,清除全站記錄的全站惟一的隨機id。webservice接口會返回,登出其餘已登陸子站的javascript代碼,本站輸出此代碼。

c) js代碼訪問相應站W3C標準的登出腳本

 

三. 代碼說明:

本文所涉及到相關代碼,已打包上傳,若有興趣,可在本文最後下載連接處點擊下載。

1. 登錄流程:

用戶從打開瀏覽器開始,第一個登錄的子站點,必須調用UClientSSO::loginSSO()方法。該方法返回全站惟一的隨機id用於標識該用戶。該隨機id在UClientSSO::loginSSO()中已經過本站cookie保存,即該子站點保留了用戶已登錄標識的存根於本站。

a) UClientSSO::loginSSO()方法以下:

<?php
/**
 * 用戶驗證中心 登錄用戶處理
 *
 * @param string $username      - 用戶名
 * @param string $password      - 用戶原始密碼
 * @param boolean $remember     - 是否永久記住登錄帳號
 * @param boolean $alreadyEnc   - 傳入的密碼是否已經通過simpleEncPass加密過
 *
 * @return array   - integer $return['status'] 大於 0:返回用戶 ID,表示用戶登陸成功
 *                                                -1:用戶不存在,或者被刪除
 *                                                -2:密碼錯
 *                                                                                                  -11:驗證碼錯誤
 *                                          string $return['username']     : 用戶名
 *                                          string $return['password']     : 密碼
 *                                          string $return['email']        : Email
 */

static public function loginSSO($username, $password, $remember=false, $alreadyEnc=false) {
self::_init();
self::_removeLocalSid();
$ret = array();

//
//1. 處理傳入webservice接口的參數
//
$_params  = array(
                'username' => $username,
                'password' => $alreadyEnc ? trim($password) : self::simpleEncPass(trim($password)),
                'ip'       => self::onlineip(),
                'siteFlag' => self::$site,
                'remember' => $remember
);
$_params['checksum'] = self::_getCheckSum($_params['username'] . $_params['password'] .
$_params['ip'] . $_params['siteFlag'] . $_params['remember']);

//
// 2.調用webservice接口,進行登錄處理
//
$aRet = self::_callSoap('loginUCenter', $_params);

if (intval($aRet['resultFlag']) > 0 && $aRet['sessID']) {
//成功登錄
//設置本地session id
self::_setLocalSid($aRet['sessID']);

//設置用戶中心的統一session id腳本路徑
self::$_synloginScript = urldecode($aRet['script']);

$ret = $aRet['userinfo'];
} else {

$ret['status'] = $aRet['resultFlag'];
}

return $ret;
}//end of function                   [/php]

b) 用戶驗證中心的webservice服務程序,接收到登錄驗證請求後,調用UCenter::loginUCenter()方法來處理登錄請求。
[php]/**
* 用戶驗證中心 登錄用戶處理
*
* @param string $username
* @param string $password
* @param string $ip
* @param string $checksum
* @return array
*/
static public function loginUCenter($username, $password, $ip, $siteFlag, $remember=false) {
self::_init();
session_start();
$ret = array();
$arr_login_res     = login_user($username, $password, $ip);
$res_login         = $arr_login_res['status'];                //
$ret['resultFlag'] = $res_login;

if ($res_login < 1) {
//登錄失敗
} else {

//登錄成功
$_SESSION[self::$_ucSessKey] = $arr_login_res;

$_SESSION[self::$_ucSessKey]['salt'] =
self::_getUserPassSalt($_SESSION[self::$_ucSessKey]['username'], $_SESSION[self::$_ucSessKey]['password']);

$ret['userinfo'] = $_SESSION[self::$_ucSessKey];
$ret['sessID']   = session_id();        //生成全站的惟一session id,做爲ticket全站通行

//
//合做中心站回調登錄接口(設置用戶中心的統一session id)
//
self::_createCoSitesInfo();
$uinfo = array();
$_timestamp = time();
$_rawCode = array(
                        'action' => 'setSid',
                        'sid'    => $ret['sessID'],
                        'time'   => $_timestamp,
);
if ($remember) {
$uinfo = array(
                                'remember' => 1,
                                'username' => $username,
                                'password' => $password
);
}

$ret['script'] = '';
$_rawStr = http_build_query(array_merge($_rawCode, $uinfo));

//
// 合做站點的全域cookie設置腳本地址
//
foreach ((array)self::$_coSitesInfo as $_siteInfo) {
$_code = self::authcode($_rawStr, 'ENCODE', $_siteInfo['key']);
$_src = $_siteInfo['url'] . '?code=' . $_code . '&time=' . $_timestamp;
$ret['script'] .= urlencode('');
}

//
// 記住已登錄戰
//
self::registerLoggedSite($siteFlag, $ret['sessID']);

unset($ret['userinfo']['salt']);
}

return $ret;
}

?>

2. 本站登錄成功後,進行本地化的用戶登錄處理,其後驗證用戶是否登錄只在本地驗證。(本地存取登錄用戶狀態的信息,請設置爲關閉瀏覽器就退出)

3. 當檢測用戶登錄狀態時,請先調用本地的驗證處理,若本地驗證不經過,再調用UClientSSO::checkUserLogin()方法到用戶中心檢測用戶的登錄狀態。

a) UClientSSO::checkUserLogin()方法以下:

<?php
/**
 * 用戶單點登錄驗證函數
 *
 * @return array   - integer $return['status'] 大於 0:返回用戶 ID,表示用戶登陸成功
 *                                                                                                    0:用戶沒有在全站登錄
 *                                                -1:用戶不存在,或者被刪除
 *                                                -2:密碼錯
 *                                                -3:未進行過單點登錄處理
 *                                                                                                  -11:驗證碼錯誤
 *                                          string $return['username']     : 用戶名
 *                                          string $return['password']     : 密碼
 *                                          string $return['email']        : Email
 */
public static function checkUserLogin(){
self::_init();
$ret = array();
$_sessId = self::_getLocalSid();
if (empty($_sessId)) {
//永久記住帳號處理
if(isset($_COOKIE[_UC_USER_COOKIE_NAME]) && !empty($_COOKIE[_UC_USER_COOKIE_NAME])) {

//
// 根據cookie裏的用戶名和密碼判斷用戶是否已經登錄。
//
$_userinfo = explode('|g|', self::authcode($_COOKIE[_UC_USER_COOKIE_NAME], 'DECODE', self::$_authcodeKey));

$username = $_userinfo[0];
$password = isset($_userinfo[1]) ? $_userinfo[1] : '';
if (empty($password)) {
$ret['status'] = -3;
} else {
return self::loginSSO($username, $password, true, true);
}

} else {
$ret['status'] = -3;
}

} else {
//
//本站原先已經登錄過,經過保留的sesson id存根去用戶中心驗證
//
$_params  = array(
                        'sessId'   => $_sessId,
                        'siteFlag' => self::$site,
                        'checksum' => md5($_sessId . self::$site . self::$_mcComunicationKey)
);
$aRet = self::_callSoap('getOnlineUser', $_params);
if (intval($aRet['resultFlag']) > 0) {
//成功登錄
$ret = $aRet['userinfo'];
} else {
$ret['status'] = $aRet['resultFlag'];
}
}

return $ret;
}                   [/php]

b) 用戶驗證中心的webservice服務程序,接收到檢驗登錄的請求後,調用UCenter::getOnlineUser()方法來處理登錄請求:
[php]/**
* 根據sid,獲取當前登錄的用戶信息
*
* @param string $sessId        - 全站惟一session id,用作ticket
* @return array
*/
/**
 * 根據sid,獲取當前登錄的用戶信息
 *
 * @param string $sessId        - 全站惟一session id,用作ticket
 * @return array
 */
static public function getOnlineUser($sessId, $siteFlag) {
self::_init();
session_id(trim($sessId));
session_start();

$ret = array();
$_userinfo = $_SESSION[self::$_ucSessKey];

if (isset($_userinfo['username']) && isset($_userinfo['password']) &&
self::_getUserPassSalt($_userinfo['username'], $_userinfo['password'])) {
$ret['resultFlag'] = "1";
$ret['userinfo'] = $_userinfo;

self::registerLoggedSite($siteFlag, $sessId);                //記住已登錄戰
unset($ret['userinfo']['salt']);
} else {
$ret['resultFlag'] = "0";
}

return ($ret);
}
?>

4. 單點登出時,調用UClientSSO::logoutSSO()方法。調用成功後,如需其餘已登錄站當即登出,請調用 UClientSSO::getSynloginScript()方法獲取W3C標準的script,在頁面輸出。

a) UClientSSO::logoutSSO()方法以下:

<?php
/**
* 全站單點登出
*  - 經過webservice請求註銷掉用戶的全站惟一標識
*
* @return integer    1: 成功
*                                     -11:驗證碼錯誤
*/
public static function logoutSSO(){
        self::_init();
        $_sessId = self::_getLocalSid();

        //
        //本站沒有登錄的話,不讓同步登出其餘站
        //
        if (empty($_sessId)) {
                self::_initSess(true);
                return false;
        }
        $_params  = array(
                'sessId'   => $_sessId,
                'siteFlag' => self::$site,
                'checksum' => md5($_sessId . self::$site . self::$_mcComunicationKey)
        );

        $aRet = self::_callSoap('logoutUCenter', $_params);
        if (intval($aRet['resultFlag']) > 0) {
                //成功登出
                self::_removeLocalSid();                //移除本站記錄的sid存根
                self::$_synlogoutScript = urldecode($aRet['script']);
                $ret = 1;
        } else {
                $ret = $aRet['resultFlag'];
        }
        return intval($ret);
}                   [/php]

        b) 用戶驗證中心的webservice服務程序,接收到全站登出請求後,調用UCenter::loginUCenter()方法來處理登錄請求:
[php]/**
* 登出全站處理
*
* @param string - 全站惟一session id,用作ticket
* @return boolean
*/
static public function logoutUCenter($sessId) {
        self::_init();
        session_id(trim($sessId));
        session_start();

        $_SESSION = array();
        return empty($_SESSION) ? true : false;
}
?>

 

四. 代碼部署:

1. 用戶驗證中心設置

a) 用戶驗證中心向分站提供的webservice服務接口文件,即UserSvc.php部署在hostname/webapps/port/ UserSvc.php中。查看wsdl內容,請訪問https://hostname/port/ UserSvc.php?wsdl
b) 用戶中心用戶單點服務類文件爲UCenterSSO.class.php,文件路徑爲在hostname/webapps/include /UCenterSSO.class.php。該文件爲用戶單點登錄處理 的服務端類,被hostname/webapps/port/ UserSvc.php調用。用於獲取用戶的登錄信息,是否單點登錄的狀態信息,單點登出處理等。
c) 用戶驗證中心經過W3C標準,利用cookie方式記錄,刪除全站統一的用戶惟一隨機id 的腳本文件爲hostname/webapps/port/cookie_mgr.php.

2. 子站點設置

a) 各子站點請將,UClientSSO.class.php部署在用戶中心服務客戶端目錄下。部署好後,請修改最後一行的UClientSSO::setSite('1'); 參數值爲用戶驗證中心統一分配給各站的標識id.
b) 在部署的用戶中心服務客戶端包下的api目錄下下,請將logout_sso.php腳本轉移到此處,並編寫進行本站登出的處理腳本。
c) 在子站點驗證用戶登錄狀態的代碼部分,額外增長到用戶中心的單點登錄驗證的處理。
即在首先經過本站驗證用戶的登錄狀態,若是未經過驗證,則去用戶中心驗證。驗證操做要調用UClientSSO::checkUserLogin();接口,接口含義請查看代碼註釋。
d) 在分站的登出處理腳本中,經過UClientSSO::getSynlogoutScript();獲取script串輸出便可。

 

五. 擴展功能:

1. 記錄跟蹤全部在線用戶

由於全部用戶的登陸都要通過用戶驗證中心,全部用戶的ticket都在驗證中心生成,能夠將用戶和該ticket(session id)在內存表中創建一個映射表。獲得全部在線用戶的記錄表。
後期若有必要跟蹤用戶狀態來實現其餘功能,只要跟蹤這個映射表就能夠了。其餘功能能夠爲: 獲取在線用戶列表,判斷用戶在線狀態,獲取在線用戶人數等。

2. 特殊統計處理

由於整個系統登陸登出要通過用戶驗證中心,因此能夠針對用戶的特殊統計進行處理。

如用戶天天的登陸次數,登錄時間,登錄狀態失效時間,各時段的在線用戶人數走勢等。

 

六. 其餘事項:

1. 本站登錄狀態有效時間問題:

全站要求用戶登錄狀態在關閉瀏覽器時就失效。要求各分站對session或cookie的處理方式按照以下進行:
a) Session方式記錄用戶登錄狀態的站點
請在站點公用腳本開始處,添加一下代碼

1 <?php
2 session_write_close();
3 ini_set('session.auto_start', 0);                    //關閉session自動啓動
4 ini_set('session.cookie_lifetime', 0);            //設置session在瀏覽器關閉時失效
5 ini_set('session.gc_maxlifetime', 3600);  //session在瀏覽器未關閉時的持續存活時間     
6 ?>

b) cookie方式記錄用戶登錄狀態的站點

請在設置用戶登錄狀態的cookie時,設置cookie有效時間爲null

 

attachments-2020-04-OQ7PhgMm5e8e77b63d38f.jpg

相關文章
相關標籤/搜索