jforum SSO

JForum与已有的web应用的整合，以及JForum单点登陆原理与配置【有修改】
2010-12-22 19:30 / 标签: jforum 单点登录.sso / 分类: jforum 邓华锋
博主ps:红色部分是我添加或修改的部分，供初学参考适宜，高手可免。
JForum是一个功能强大的开放源代码的BBS论坛。
本文介绍 JForum与已有的web应用的整合，以及JForum单点登陆原理与配置。

JForum可以单独作为一个BBS论坛运行，但是很多情况，我们需要在我们已有的WEB应用中集成JForum。
JForum的与已有WEB应用的集成有很多种方法。本文介绍JForum官方推荐的通过自定义SSO类实现来完成JForum与已有WEB应用的集成。

目标：
实现SSO (Single Sign On) ：单点登陆。
一般来说，两个不同系统的整合的难点部分，便是需要解决单点登陆问题。
对于我们已有的WEB应用中的用户，若该用户已经登陆，并通过 联结迁移到JForum页面时，JForum要能够识别该用户已经登陆（不需要二次登陆）才不会让用户感到别扭（对用户来说，就好像使用的是同一个系统似的）。
但由于分属于2个不同的系统，所以它们之间不能共用同一套Session，这就需要使用一种特殊的机制来实现它们之间的互相通信。

好在，JForum为我们考虑到了这一点，它提供了灵活的SSO接口与配置机制，我们只需要简单地实现一个SSO类，同时在JForum的配置文件中加以配置即可。

JForum SSO机制的原理
- 当一个用户访问JForum时，JForum便会检查是否配置SSO，如果配置了SSO，JForum便会调用authenticateUser()方法。该方法简单地返回username或null。
- 若返回了一个不为空的username时，JForum将会检查是否匹配JForum数据库的userid。
- 若没有匹配的userid，JForum将动态加以创建
- JForum设置该user为登陆状态
- 若返回了一个null，则设置为“Anonymous”
- 若一个“Anonymous”用户试图访问权限以外的页面，JForum将根据SSO的设置导航到登陆页面，同时传递给一个登陆成功后应该迁移到的地址参数给login页面。


JForum SSO的实现
上面，我们大致了解了一下JForum的SSO机制的原理。根据SSO机制的原理，我们已经知道该怎么实现SSO。
1，需要实现一个SSO类，该类需要取得从另外一个系统登陆进来的用户信息。
一种最简单的方法是使用Cookie来实现。让已有的WEB应用在用户登陆时写入Cookie信息，然后JForum的SSO实现类中将该Cookie取出即可。
另外，还可以使用web-service，文件的写入等等方式来实现。反正一个最基本的原则是：用户登陆时写入用户信息，然后在JForum一方能取出相同信息即可。

实现SSO类：
CookieUserSSO.java

1. package  net.jforum.sso;   
2.   
3. import  javax.servlet.http.Cookie;   
4. import  javax.servlet.http.HttpServletRequest;   
5.   
6. import  net.jforum.ActionServletRequest;   
7. import  net.jforum.ControllerUtils;   
8. import  net.jforum.entities.UserSession;   
9. import  net.jforum.util.preferences.ConfigKeys;   
10. import  net.jforum.util.preferences.SystemGlobals;   
11.   
12. import  org.apache.log4j.Logger;   
13.   
14. public   class  CookieUserSSO  implements  SSO {   
15.      static   final  Logger logger = Logger.getLogger(CookieUserSSO. class .getName());   
16.   
17.      public  String  authenticateUser(ActionServletRequest request) {   
18.          // login cookie set by my web LOGIN application   
19.         Cookie cookieNameUser = ControllerUtils.getCookie(SystemGlobals   
20.                 .getValue(ConfigKeys.COOKIE_NAME_USER));   
21.         String  username =  null ;   
22.   
23.          if  (cookieNameUser !=  null ) {   
24.             username = cookieNameUser.getValue();   
25.         }   
26.          return  username;  // return username for jforum   
27.          // jforum will use this name to regist database or set in HttpSession    
28.     }   
29.   
30.      public   boolean   isSessionValid(UserSession userSession, HttpServletRequest request) {   
31.         Cookie   cookieNameUser = ControllerUtils.getCookie(SystemGlobals   
32.                 .getValue(ConfigKeys.COOKIE_NAME_USER));  // user cookie   
33.         String  remoteUser =  null ;   
34.   
35.          if  (cookieNameUser !=  null ) {   
36.             remoteUser = cookieNameUser.getValue();  // jforum username   
37.         }   
38.   
39.          if  (remoteUser ==  null   
40.                 && userSession.getUserId() != SystemGlobals   
41.                         .getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {   
42.              // user has since logged out   
43.              return   false ;   
44.         }  else   if  (remoteUser !=  null   
45.                 && userSession.getUserId() == SystemGlobals   
46.                         .getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {   
47.              // anonymous user has logged in   
48.              return   false ;   
49.         }  else   if  (remoteUser !=  null   
50.                 && !remoteUser.equals(userSession.getUsername())) {   
51.              // not the same user (cookie and session)   
52.              return   false ;   
53.         }   
54.          return   true ;  // myapp user and forum user the same. valid user.   
55.     }   
56. } 

JForum本身也提供了一个RemoteUserSSO.java实现，由于该实现的authenticateUser方法只是简单地返回request.getRemoteUser()，不能显示已登陆的用户名，另外我们也可以对放进cookies的信息进行一些加密。

2，配置JForum。

修改SystemGlobals.properties
有些JForum版本为jforum-custom.conf文件。
   查找“SSO”字样，找到“SSO / User authentication”配置部分，将其修改为以下内容：

authentication.type = sso
##...
sso.implementation = net.jforum.sso.CookieUserSSO
并根据实际情况，修改
cookie.name.user=“你应用添加的cookies名”
例如：cookie.name.user=jforumSSOCookieNameUser

3，修改你的web应用(注意：是你的web应用，而不是jforum应用) 用户登录/注销部分的代码逻辑部分：
博主ps:下面是struts2 action登录的示例。
登陆部分加入以下内容：

public void doLogin() {
    ...
    //Cookie cookie = new Cookie("jforumSSOCookieNameUser" , "denghuafeng");
    Cookie cookie = new Cookie("jforumSSOCookieNameUser" , loginUser.getUsername());
    cookie.setMaxAge(-1);
    cookie.setPath("/"); //设置目录为根路径使cookie共享
    response.addCookie(cookie);
    ...
}
注销部分加以以下内容：

public void doLogout() {
    ...
    Cookie cookie = new Cookie("jforumSSOCookieNameUser" , "");
    cookie.setMaxAge(0); // delete the cookie.
    cookie.setPath("/"); //设置目录为根路径使cookie共享
    response.addCookie(cookie);
    ...
}

forumSSOCookieNameUser为cookie.name.user的设置内容。

4，在你的HTML/JSP里加上
<a href= "/jforum" >论坛</a>  


设置了单点登陆后，jforum的注册及登陆都会交给你的应用去实现了，所以你还要修改一下jforum的模板，把注册及登陆的连接指向你应用的相应页面！
原文出处：http://www.crazyjava.org/archiver/?tid-218.html
本文介绍 JForum与已有的web应用的整合，以及JForum单点登陆原理与配置。


博主ps:
你可在新建项目jsp页面里这样测试登录
<%
   Cookie cookie = new Cookie("jforumSSOCookieNameUser","huafeng8808301");// 保存用户名到Cookie
    cookie.setPath("/");
    //String host = request.getServerName();//本地测试时注释掉的代码
    //cookie.setDomain(host);//本地测试时需注释掉的代码
    cookie.setMaxAge(99999999);
    response.addCookie(cookie);
    response.sendRedirect(http://localhost:8080/jforum );//跳转到jforum论坛,看看是否登录了
    %>
访问这个页面后，再访问jforum程序，看看有没有显示用户名，如果有，那就代表单点登录成功。
CookieUserSSO.java只是简单的实现了单点登录，cookie的值在客户段很容易被人修改的,这存在安全隐患，所以得想想办法解决安全问题呀。

注：如需转载，请注明出处，欢迎交流！Email:[e-mail]