十六、【适合中小企业的.Net轻量级开源框架】EnterpriseFrameWork框架核心类库之单点登录SSO

回《【开源】EnterpriseFrameWork框架系列文章索引》

EFW框架源代码下载：http://pan.baidu.com/s/1qWJjo3U

单点登录（Single Sign On），简称为 SSO，是目前比较流行的企业业务整合的解决方案之一。SSO的定义是在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的应用系统。

如上图，当用户第一次访问应用系统1的时候，因为还没有登录，会被引导到认证系统中进行登录；根据用户提供的登录信息，认证系统进行身份校验，如果通过校验，应该返回给用户一个认证的凭据－－ticket；用户再访问别的应用的时候，就会将这个ticket带上，作为自己认证的凭据，应用系统接受到请求之后会把ticket送到认证系统进行校验，检查ticket的合法性。如果通过校验，用户就可以在不用再次登录的情况下访问应用系统2和应用系统3了。

上面这段文字描叙是从网上摘抄的，觉得基本上把单点登录的原理讲得很清晰了；本章讲解EFW框架中是如何实现单点登录的以及框架中是如何使用的；

本文要点：

1.什么情况下会用到单点登录

2.框架中的三种模式Web、Winform和WCF，分别是怎样进行用户验证

3.单点登录样例

4.单点登录SSO实现代码

1.什么情况下会用到单点登录

刚开始框架中也是没有单点登录此模块的，有一次需要在Winform系统中嵌入Web页面，整合两个系统。Web页面的用户信息验证一直没找到什么好的解决办法，刚开始的办法是通过往网页地址后面自动加上登录用户名和密码，发送到后台进行登录；这样也达到了整合的目的，但是总感觉比较别扭，直接把用户名和密码暴露在地址栏肯定存在安全隐患。后来经过一番波折在网上找到类似的解决办法，利用单点登录的方案达到了比较好的效果；

除了上面说的Winform系统中嵌入Web页面这种情况，还有经常在自己公司系统中整合一些合作伙伴的系统，如此打包销售更有市场竞争力，这样首要解决的问题也是登录入口统一；如今行业软件现状，不像十年前了只有那么一两套系统，讲究着用就行了，现在没有用上十来个系统就不叫信息化了，所以你能提供一个单点登录的解决方案也是一大卖点；再就是现在的软件公司不管大小靠一个产品就能生存的很难了，基本都是最大化的挖掘客户的需求，最好能提供一整套的解决方案，这些系统能整体销售更好，而单个产品销售也得支持。所以不管是客户的需求还是内部的产品都会存在系统间整合的问题，而利用单点登录至少能解决用户统一验证的问题；

2.框架中的三种系统模式Web、Winform和WCF，分别是怎样进行用户验证

先分析一下框架中的三种系统模式的用户验证是如何实现的，然后才能正确运用单点登录的功能；

1）Web系统用户验证，输入用户名密码登录后，登录界面向后台发送登录请求调用LoggingController执行用户密码验证代码，验证正确后把用户信息存入Session；之后所有界面操作向后台发送请求，APIHttpHandler对象接收请求后，先判断Session中是否存在用户信息，只有存在才执行对应的控制器代码，否则再返回错误信息给前台；

这里增加了一个系统配置参数TurnOnLoginRight用来是否打开验证用户登录，这在我们开发系统中调试后台控制器很有用；

2）Winform系统用户验证，这个比较简单，用户登录后根据后台配置的用户权限，动态加载系统的菜单，所以后面的操作也不用再进行用户验证了；

3）WCF系统用户验证，就是上面两种的结合了，客户端如Winform系统，WCF中间件在WCFHandlerService服务中进行用户验证；

3.单点登录样例

用上面讲过的Winform系统嵌入Web页面这种情况下如何使用单点登录的功能；

在登录成功后调用框架中的SsoHelper对象的SignIn方法生成TokenKey；

然后把TokenKey值加入Web页面的URL地址之后，然后web页面向后台发送Ajax请求的时候把TokenKey当成参数传入后台，后台进行单点登录验证。

4.单点登录SSO实现代码

框架源代码目录结构：

其中外部调用SSO功能只需要调用SsoHelper对象就可以了，SsoHelper把SSO封装成外部调用的类；包括SignIn、SignOut、ValidateToken等方法；TokenManager类存储所有登录用户的信息，TokenInfo类封装的用户信息结构；
SsoHelper文件

 /// <summary>
     /// 单点登录辅助类
     /// </summary>
     public class SsoHelper
     {
         /// <summary>
         /// 登录
         /// </summary>
         /// <param name="userId"></param>
         /// <param name="tokenid"></param>
         /// <returns></returns>
         public static bool SignIn(string userId,string userName, out Guid tokenid)
         {
             TokenInfo existToken = TokenManager.GetToken(userId);
             if (existToken != null)
             {
                 tokenid = existToken.tokenId;
                 return true;
             }

             TokenInfo token = new TokenInfo()
             {
                 tokenId = Guid.NewGuid(),
                 IsValid = true,
                 CreateTime = DateTime.Now,
                 ActivityTime=DateTime.Now,
                 UserId = userId,
                 UserName=userName//,
                 //RemoteIp = Utility.RemoteIp
             };
             tokenid = token.tokenId;
             return TokenManager.AddToken(token);
         }
         /// <summary>
         /// 注销
         /// </summary>
         /// <param name="token"></param>
         /// <returns></returns>
         public static bool SignOut(Guid token)
         {
             return TokenManager.RemoveToken(token);
         }
         /// <summary>
         /// 是否有效登录
         /// </summary>
         /// <param name="token"></param>
         /// <returns></returns>
         public static AuthResult ValidateToken(string token)
         {
             Guid guid= ConvertHelper.GetGuid(token, Guid.NewGuid());

             AuthResult result = new AuthResult() { ErrorMsg = "Token不存在" };
             TokenInfo existToken = TokenManager.GetToken(guid);

             if (existToken != null)
             {
                 #region 客户端IP不一致
                 //if (existToken.RemoteIp != entity.RemoteIp)
                 //{
                 //    result.ErrorMsg = "客户端IP不一致";
                 //}
                 #endregion

                 if (existToken.IsValid == false)
                 {
                     result.ErrorMsg = "Token已过期" + existToken.ActivityTime.ToLongTimeString() + ":" + DateTime.Now.ToLocalTime();
                     TokenManager.RemoveToken(existToken.tokenId);//移除
                 }
                 else
                 {
                     result.User = new UserInfo() { UserId = existToken.UserId,UserName=existToken.UserName, CreateDate = existToken.CreateTime };
                     result.ErrorMsg = string.Empty;
                 }
             }

             return result;
         }

         /// <summary>
         /// 定时触发登录码的活动时间，频率必须小于4分钟
         /// </summary>
         /// <param name="token"></param>
         public static void UserActivity(Guid token)
         {
             TokenInfo existToken = TokenManager.GetToken(token);
             existToken.ActivityTime = DateTime.Now;
         }

         /// <summary>
         /// 用户是否在线
         /// </summary>
         /// <param name="userId"></param>
         /// <returns></returns>
         public static bool IsUserOnline(string userId)
         {
             TokenInfo existToken = TokenManager.GetToken(userId);
             if (existToken != null) return true;
             return false;
         }
     }

TokenManager文件

  public class TokenManager
     {
         private const int _TimerPeriod = ;//60秒
         private static Timer thTimer;

         static List<TokenInfo> tokenList = null;

         static TokenManager()
         {
             tokenList = new List<TokenInfo>();
             thTimer = new Timer(_ThreadTimerCallback, null, _TimerPeriod, _TimerPeriod);
         }

         public static bool AddToken(TokenInfo entity)
         {
             tokenList.Add(entity);
             return true;
         }

         public static bool RemoveToken(Guid token)
         {
             TokenInfo existToken = tokenList.SingleOrDefault(t => t.tokenId ==token);
             if (existToken != null)
             {
                 tokenList.Remove(existToken);
                 return true;
             }

             return false;
         }

         public static TokenInfo GetToken(Guid token)
         {
             TokenInfo existToken = tokenList.SingleOrDefault(t => t.tokenId == token);
             return existToken;
         }

         public static TokenInfo GetToken(string userId)
         {
             TokenInfo existToken = tokenList.SingleOrDefault(t => (t.UserId == userId && t.IsValid==true));
             return existToken;
         }

         private static void _ThreadTimerCallback(Object state)
         {
             DateTime now = DateTime.Now;

             Monitor.Enter(tokenList);
             try
             {
                 // Searching for expired users
                 foreach (TokenInfo t in tokenList)
                 {
                     if (((TimeSpan)(now - t.ActivityTime)).TotalMilliseconds > _TimerPeriod)
                     {
                         t.IsValid = false;//失效
                     }
                 }
             }
             finally
             {
                 Monitor.Exit(tokenList);
             }
         }
     }

TokenInfo文件

  public class TokenInfo
     {
         public Guid tokenId { get; set; }

         public DateTime CreateTime { get; set; }

         public DateTime ActivityTime { get; set; }

         public string RemoteIp { get; set; }

         public string UserId { get; set; }

         public string UserName { get; set; }

         public bool IsValid { get; set; }
     }

参考资料：

编写你自己的单点登录（SSO）服务

http://blog.csdn.net/javachannel/article/details/752437