摘要:
本文主要介紹了利用webservice,session,cookIE技術,來進行通用的單點登錄系統的分析與設計。具體實現語言為PHP。單點登錄,英文名為Single Sign On,簡稱為 SSO,是目前企業,網絡業務的用戶綜合處理的重要組成部分。而SSO的定義,是在多個應用系統中,用戶只需要登陸一次就可以訪問所有相互信任的應用系統。
動機:
用過uctenter的全站登錄方式的朋友,應該都知道這是典型的觀察者模式的解決方案。用戶中心作為subject, 其所屬observer的注冊和刪除統一在ucenter的後台進行。而各個子應用站點都對應一個observer。每次用戶中心的登錄動作,都會觸發JS腳本回調w3c標准的子站登錄接口(api/uc.PHP)。
這種方式的缺點,本人認為主要是兩點:1. 子站點過多時,回調接口相應增多,這個在分布子站的量的限制上,如何控制來使登錄效率不會太低,不好把握; 2. 當某個子站回調接口出現問題時,默認的登錄過程會卡住(可以限制登錄程序的執行時間,但相應出現問題子站後面的子站的回調接口就調不到了。
基於以上問題,在實際開發過程中,本人設計了另一套單點登錄系統。
一. 登陸原理說明
單點登錄的技術實現機制:當用戶第一次訪問應用系統1的時候,因為還沒有登錄,會被引導到認證系統中進行登錄;根據用戶提供的登錄信息,認證系統進行身份效驗,如果通過效驗,應該返回給用戶一個認證的憑據--ticket;用戶再訪問別的應用的時候,就會將這個ticket帶上,作為自己認證的憑據,應用系統接受到請求之後會把ticket送到認證系統進行效驗,檢查ticket的合法性。如果通過效驗,用戶就可以在不用再次登錄的情況下訪問應用系統2和應用系統3了。
可以看出,要實現SSO,需要以下主要的功能:
a) 所有應用系統共享一個身份認證系統;
b) 所有應用系統能夠識別和提取ticket信息;
c) 應用系統能夠識別已經登錄過的用戶,能自動判斷當前用戶是否登錄過,從而完成單點登錄的功能
基於以上基本原則,本人用PHP語言設計了一套單點登錄系統的程序,目前已投入正式生成服務器運行。本系統程序,將ticket信息以全系統唯一的 session id作為媒介,從而獲取當前在線用戶的全站信息(登陸狀態信息及其他需要處理的用戶全站信息)。
二. 過程說明:
登陸流程:
1. 第一次登陸某個站:
a) 用戶輸入用戶名+密碼,向用戶驗證中心發送登錄請求
b) 當前登錄站點,通過webservice請求,用戶驗證中心驗證用戶名,密碼的合法性。如果驗證通過,則生成ticket,用於標識當前會話的用戶,並將當前登陸子站的站點標識符記錄到用戶中心,最後
c) 將獲取的用戶數據和ticket返回給子站。如果驗證不通過,則返回相應的錯誤狀態碼。
d) 根據上一步的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;
} [/PHP]
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);
} [/PHP] 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;
}[/PHP]
四. 代碼部署:
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方式記錄用戶登陸狀態的站點
請在站點公用腳本開始處,添加一下代碼
[PHP]session_write_close();
ini_set('session.auto_start', 0); //關閉session自動啟動
ini_set('session.cookIE_lifetime', 0); //設置session在浏覽器關閉時失效
ini_set('session.gc_maxlifetime', 3600); //session在浏覽器未關閉時的持續存活時間 [/PHP]
b) cookIE方式記錄用戶登陸狀態的站點
請在設置用戶登陸狀態的cookie時,設置cookIE有效時間為null.