PHP版單點登陸實現方案的實例
- 黄舟原創
- 2017-02-28 09:18:591314瀏覽
摘要：
本文主要介紹了利用webservice,session,cookie技術，來進行通用的單一登入系統的分析與設計。具體實作語言為PHP。單點 登錄，英文名為Single Sign On，簡稱 SSO，是目前企業，網絡業務的用戶綜合處理的重要組成部分。而SSO的定義，是在多個應用系統中，使用者只需要登陸一次就可以存取所有互信的應用系 統。
動機：
用過ucenter的全站登入方式的朋友，應該都知道這是典型的觀察者模式的解決方案。用戶中心作為subject, 其所屬observer的註冊和刪除統一在ucenter的後台進行。而各個子應用程式站點都對應一個observer。每次使用者中心的登入動作，都會觸發 js腳本回呼w3c標準的子站登入介面(api/uc.php)。
這種方式的缺點，本人認為主要是兩點：1. 子站點過多時，回調接口相應增多，這個在分佈子站的量的限制上，如何控制來使登錄效率不會太低，不好把握; 2. 當某個子站回調介面出現問題時，預設的登入程序會卡住(可以限制登入程序的執行時間，但對應出現問題子站後面的子站的回呼介面就調不到了。
單點登錄的技術實現機制：當用戶第一次訪問應用系統1的時候，因為還沒有登錄，會被引導到認證系統中進行登錄;根據用戶提供的登錄信息，認證系統進行身份效驗，如果通過效驗，應該返回給用戶一個認證的憑證--ticket;用戶再訪問別的應用的時候，就會將這個ticket帶上，作為自己認證的憑據，應用系統接受到請求之後會把ticket送到認證系統進行效驗，檢查ticket的合法性。需要以下主要的功能：
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
//b) 用户验证中心的webservice服务程序，接收到登陆验证请求后，调用UCenter::loginUCenter()方法来处理登陆请求。
/**
* 用户验证中心 登陆用户处理
*
* @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;
}
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()方法来处理登陆请求：
/**
* 登出全站处理
*
* @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內容，請造訪http://www.php.cn/ 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在浏览器未关闭时的持续存活时间 ?>
b) cookie方式記錄使用者登陸狀態的網站
請在設定使用者登陸狀態的cookie時，設定cookie有效時間為null.