PHP 單點登入實現方案
單點登入SSO(Single Sign On)說得簡單點就是在一個多系統共存的環境下,使用者在一處登入後,就不用在其他系統中登入,也就是使用者的一次登入能得到其他所有系統的信任。單點登入在大型網站裡使用得非常頻繁,例如像阿里巴巴這樣的網站,在網站的背後是成百上千的子系統,使用者一次操作或交易可能涉及到幾十個子系統的協作,如果每個子系統都需要使用者認證,不僅使用者會瘋掉,各子系統也會為這種重複認證授權的邏輯搞瘋掉。實現單點登入說到底就是要解決如何產生和儲存那個信任,再就是其他系統如何驗證這個信任的有效性,因此要點也就以下幾個:
- 儲存信任
- 驗證信任
只要解決了以上的問題,達到了開頭講得效果就可以說是SSO。最簡單實現SSO的方法就是用Cookie,實現流程如下所示:
不然發現以上的方案是把信任儲存在客戶端的Cookie裡,這種方法雖然實現方便但立馬會讓人質疑兩個問題:
- Cookie不安全
- 不能跨域免登
對於第一個問題一般都是通過加密Cookie來處理,第二個問題是硬傷,其實這種方案的思路的就是要把這個信任關係儲存在客戶端,要實現這個也不一定只能用Cookie,用flash也能解決,flash的Shared Object API就提供了儲存能力。
一般說來,大型系統會採取在服務端儲存信任關係的做法,實現流程如下所示:
以上方案就是要把信任關係儲存在單獨的SSO系統(暫且這麼稱呼它)裡,說起來只是簡單地從客戶端移到了服務端,但其中幾個問題需要重點解決:
- 如何高效儲存大量臨時性的信任資料
- 如何防止資訊傳遞過程被篡改
- 如何讓SSO系統信任登入系統和免登系統
對於第一個問題,一般可以採用類似與memcached的分散式快取的方案,既能提供可擴充套件資料量的機制,也能提供高效訪問。對於第二個問題,一般採取數字簽名的方法,要麼通過數字證書籤名,要麼通過像md5的方式,這就需要SSO系統返回免登URL的時候對需驗證的引數進行md5加密,並帶上token一起返回,最後需免登的系統進行驗證信任關係的時候,需把這個token傳給SSO系統,SSO系統通過對token的驗證就可以辨別資訊是否被改過。對於最後一個問題,可以通過白名單來處理,說簡單點只有在白名單上的系統才能請求生產信任關係,同理只有在白名單上的系統才能被免登入。
-------------------------------------------------------------------------------------------------------
利用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的合法性。如果通過效驗,使用者就可以在不用再次登入的情況下訪問應用系統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()方法如下:
1 <?php 2 /** 3 * 使用者驗證中心 登陸使用者處理 4 * 5 * @param string $username - 使用者名稱 6 * @param string $password - 使用者原始密碼 7 * @param boolean $remember - 是否永久記住登陸賬號 8 * @param boolean $alreadyEnc - 傳入的密碼是否已經經過simpleEncPass加密過 9 * 10 * @return array - integer $return['status'] 大於 0:返回使用者 ID,表示使用者登入成功 11 * -1:使用者不存在,或者被刪除 12 * -2:密碼錯 13 * -11:驗證碼錯誤 14 * string $return['username'] : 使用者名稱 15 * string $return['password'] : 密碼 16 * string $return['email'] : Email 17 */ 18 19 static public function loginSSO($username, $password, $remember=false, $alreadyEnc=false) { 20 self::_init(); 21 self::_removeLocalSid(); 22 $ret = array(); 23 24 // 25 //1. 處理傳入webservice介面的引數 26 // 27 $_params = array( 28 'username' => $username, 29 'password' => $alreadyEnc ? trim($password) : self::simpleEncPass(trim($password)), 30 'ip' => self::onlineip(), 31 'siteFlag' => self::$site, 32 'remember' => $remember 33 ); 34 $_params['checksum'] = self::_getCheckSum($_params['username'] . $_params['password'] . 35 $_params['ip'] . $_params['siteFlag'] . $_params['remember']); 36 37 // 38 // 2.呼叫webservice介面,進行登陸處理 39 // 40 $aRet = self::_callSoap('loginUCenter', $_params); 41 42 if (intval($aRet['resultFlag']) > 0 && $aRet['sessID']) { 43 //成功登陸 44 //設定本地session id 45 self::_setLocalSid($aRet['sessID']); 46 47 //設定使用者中心的統一session id指令碼路徑 48 self::$_synloginScript = urldecode($aRet['script']); 49 50 $ret = $aRet['userinfo']; 51 } else { 52 53 $ret['status'] = $aRet['resultFlag']; 54 } 55 56 return $ret; 57 }//end of function [/php] 58 59 b) 使用者驗證中心的webservice服務程式,接收到登陸驗證請求後,呼叫UCenter::loginUCenter()方法來處理登陸請求。 60 [php]/** 61 * 使用者驗證中心 登陸使用者處理 62 * 63 * @param string $username 64 * @param string $password 65 * @param string $ip 66 * @param string $checksum 67 * @return array 68 */ 69 static public function loginUCenter($username, $password, $ip, $siteFlag, $remember=false) { 70 self::_init(); 71 session_start(); 72 $ret = array(); 73 $arr_login_res = login_user($username, $password, $ip); 74 $res_login = $arr_login_res['status']; // 75 $ret['resultFlag'] = $res_login; 76 77 if ($res_login < 1) { 78 //登陸失敗 79 } else { 80 81 //登陸成功 82 $_SESSION[self::$_ucSessKey] = $arr_login_res; 83 84 $_SESSION[self::$_ucSessKey]['salt'] = 85 self::_getUserPassSalt($_SESSION[self::$_ucSessKey]['username'], $_SESSION[self::$_ucSessKey]['password']); 86 87 $ret['userinfo'] = $_SESSION[self::$_ucSessKey]; 88 $ret['sessID'] = session_id(); //生成全站的唯一session id,作為ticket全站通行 89 90 // 91 //合作中心站回撥登陸介面(設定使用者中心的統一session id) 92 // 93 self::_createCoSitesInfo(); 94 $uinfo = array(); 95 $_timestamp = time(); 96 $_rawCode = array( 97 'action' => 'setSid', 98 'sid' => $ret['sessID'], 99 'time' => $_timestamp, 100 ); 101 if ($remember) { 102 $uinfo = array( 103 'remember' => 1, 104 'username' => $username, 105 'password' => $password 106 ); 107 } 108 109 $ret['script'] = ''; 110 $_rawStr = http_build_query(array_merge($_rawCode, $uinfo)); 111 112 // 113 // 合作站點的全域cookie設定指令碼地址 114 // 115 foreach ((array)self::$_coSitesInfo as $_siteInfo) { 116 $_code = self::authcode($_rawStr, 'ENCODE', $_siteInfo['key']); 117 $_src = $_siteInfo['url'] . '?code=' . $_code . '&time=' . $_timestamp; 118 $ret['script'] .= urlencode(''); 119 } 120 121 // 122 // 記住已登陸戰 123 // 124 self::registerLoggedSite($siteFlag, $ret['sessID']); 125 126 unset($ret['userinfo']['salt']); 127 } 128 129 return $ret; 130 } 131 132 ?>
2. 本站登陸成功後,進行本地化的使用者登陸處理,其後驗證使用者是否登陸只在本地驗證。(本地存取登陸使用者狀態的資訊,請設定為關閉瀏覽器就退出)
3. 當檢測使用者登陸狀態時,請先呼叫本地的驗證處理,若本地驗證不通過,再呼叫UClientSSO::checkUserLogin()方法到使用者中心檢測使用者的登陸狀態。
a) UClientSSO::checkUserLogin()方法如下:
1 <?php 2 /** 3 * 使用者單點登陸驗證函式 4 * 5 * @return array - integer $return['status'] 大於 0:返回使用者 ID,表示使用者登入成功 6 * 0:使用者沒有在全站登陸 7 * -1:使用者不存在,或者被刪除 8 * -2:密碼錯 9 * -3:未進行過單點登陸處理 10 * -11:驗證碼錯誤 11 * string $return['username'] : 使用者名稱 12 * string $return['password'] : 密碼 13 * string $return['email'] : Email 14 */ 15 public static function checkUserLogin(){ 16 self::_init(); 17 $ret = array(); 18 $_sessId = self::_getLocalSid(); 19 if (empty($_sessId)) { 20 //永久記住賬號處理 21 if(isset($_COOKIE[_UC_USER_COOKIE_NAME]) && !empty($_COOKIE[_UC_USER_COOKIE_NAME])) { 22 23 // 24 // 根據cookie裡的使用者名稱和密碼判斷使用者是否已經登陸。 25 // 26 $_userinfo = explode('|g|', self::authcode($_COOKIE[_UC_USER_COOKIE_NAME], 'DECODE', self::$_authcodeKey)); 27 28 $username = $_userinfo[0]; 29 $password = isset($_userinfo[1]) ? $_userinfo[1] : ''; 30 if (empty($password)) { 31 $ret['status'] = -3; 32 } else { 33 return self::loginSSO($username, $password, true, true); 34 } 35 36 } else { 37 $ret['status'] = -3; 38 } 39 40 } else { 41 // 42 //本站原先已經登陸過,通過保留的sesson id存根去使用者中心驗證 43 // 44 $_params = array( 45 'sessId' => $_sessId, 46 'siteFlag' => self::$site, 47 'checksum' => md5($_sessId . self::$site . self::$_mcComunicationKey) 48 ); 49 $aRet = self::_callSoap('getOnlineUser', $_params); 50 if (intval($aRet['resultFlag']) > 0) { 51 //成功登陸 52 $ret = $aRet['userinfo']; 53 } else { 54 $ret['status'] = $aRet['resultFlag']; 55 } 56 } 57 58 return $ret; 59 } [/php] 60 61 b) 使用者驗證中心的webservice服務程式,接收到檢驗登陸的請求後,呼叫UCenter::getOnlineUser()方法來處理登陸請求: 62 [php]/** 63 * 根據sid,獲取當前登陸的使用者資訊 64 * 65 * @param string $sessId - 全站唯一session id,用做ticket 66 * @return array 67 */ 68 /** 69 * 根據sid,獲取當前登陸的使用者資訊 70 * 71 * @param string $sessId - 全站唯一session id,用做ticket 72 * @return array 73 */ 74 static public function getOnlineUser($sessId, $siteFlag) { 75 self::_init(); 76 session_id(trim($sessId)); 77 session_start(); 78 79 $ret = array(); 80 $_userinfo = $_SESSION[self::$_ucSessKey]; 81 82 if (isset($_userinfo['username']) && isset($_userinfo['password']) && 83 self::_getUserPassSalt($_userinfo['username'], $_userinfo['password'])) { 84 $ret['resultFlag'] = "1"; 85 $ret['userinfo'] = $_userinfo; 86 87 self::registerLoggedSite($siteFlag, $sessId); //記住已登陸戰 88 unset($ret['userinfo']['salt']); 89 } else { 90 $ret['resultFlag'] = "0"; 91 } 92 93 return ($ret); 94 } 95 ?>
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.