JForum SSO - 整合已有的web应用 - JForum单点登陆原理与配置

JForum SSO - 整合已有的web应用 - JForum单点登陆原理与配置

2009-05-15

JForum SSO - 整合已有的web应用 - JForum单点登陆原理与配置

编辑关键字: jforum

JForum是一个功能强大的开放源代码的BBS论坛。我们在

JForum -基于BSD授权的免费论坛

JForum安装详解

等文章中已经对JForum的概要，安装步骤等作了比较详细的介绍。

本文介绍 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一方能取出相同信息即可。

2，配置JForum。

下面，我们以使用Cookie的方式为例来实现JForum SSO：

1，实现SSO类：

CookieUserSSO.java

1. packagenet.jforum.sso;
3. importjavax.servlet.http.Cookie;
4. importjavax.servlet.http.HttpServletRequest;
6. importnet.jforum.ActionServletRequest;
7. importnet.jforum.ControllerUtils;
8. importnet.jforum.entities.UserSession;
9. importnet.jforum.util.preferences.ConfigKeys;
10. importnet.jforum.util.preferences.SystemGlobals;
12. importorg.apache.log4j.Logger;
14. publicclassCookieUserSSOimplementsSSO{
15. staticfinalLoggerlogger=Logger.getLogger(CookieUserSSO.class.getName());
17. publicStringauthenticateUser(ActionServletRequestrequest){
18. //logincookiesetbymywebLOGINapplication
19. CookiecookieNameUser=ControllerUtils.getCookie(SystemGlobals
20. .getValue(ConfigKeys.COOKIE_NAME_USER));
21. Stringusername=null;
23. if(cookieNameUser!=null){
24. username=cookieNameUser.getValue();
25. }
26. returnusername;//returnusernameforjforum
27. //jforumwillusethisnametoregistdatabaseorsetinHttpSession
28. }
30. publicbooleanisSessionValid(UserSessionuserSession,HttpServletRequestrequest){
31. CookiecookieNameUser=ControllerUtils.getCookie(SystemGlobals
32. .getValue(ConfigKeys.COOKIE_NAME_USER));//usercookie
33. StringremoteUser=null;
35. if(cookieNameUser!=null){
36. remoteUser=cookieNameUser.getValue();//jforumusername
37. }
39. if(remoteUser==null
40. &&userSession.getUserId()!=SystemGlobals
41. .getIntValue(ConfigKeys.ANONYMOUS_USER_ID)){
42. //userhassinceloggedout
43. returnfalse;
44. }elseif(remoteUser!=null
45. &&userSession.getUserId()==SystemGlobals
46. .getIntValue(ConfigKeys.ANONYMOUS_USER_ID)){
47. //anonymoususerhasloggedin
48. returnfalse;
49. }elseif(remoteUser!=null
50. &&!remoteUser.equals(userSession.getUsername())){
51. //notthesameuser(cookieandsession)
52. returnfalse;
53. }
54. returntrue;//myappuserandforumuserthesame.validuser.
55. }
56. }

JForum本身也提供了一个RemoteUserSSO.java实现，由于该实现的authenticateUser方法只是简单地返回request.getRemoteUser()，不能显示已登陆的用户名。

2，修改SystemGlobals.properties

有些JForum版本为jforum-custom.conf文件。

查找“SSO”字样，找到“SSO / User authentication”配置部分，将其修改为以下内容：

authentication.type = sso

##...

sso.implementation = net.jforum.sso.CookieUserSSO

##...

sso.redirect=http://yourdomain/yourLogin.page?url=

并根据实际情况，修改

cookie.name.user

设置

3，修改你的web应用用户登陆/注销部分的代码逻辑部分：

登陆部分加入以下内容：

1. publicvoiddoLogin(){
2. ...
3. Cookiecookie=newCookie(jforumSSOCookieNameUser,loginUser.getUsername());
4. cookie.setMaxAge(-1);
5. response.addCookie(cookie);
6. ...
7. }

注销部分加以以下内容：

1. publicvoiddoLogin(){
2. ...
3. Cookiecookie=newCookie(jforumSSOCookieNameUser,"");
4. cookie.setMaxAge(0);//deletethecookie.
5. response.addCookie(cookie);
6. ...
7. }

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

4，在你的HTML/JSP里加上

1. <ahref="/jforum">论坛</a>

联结。

至此，基本配置完成。

JForum SSO其他相关参考资料

http://www.jforum.net/doc/SSO

[JForum官方文档]

JForum: ImplementSSO

[JForum官方给出的一个SSO实现范例]

[v2.1.7] Cookie-based JForum Single Sign-On (SSO)

JForum安装详解

jforum与web项目的整合（通过Cookie实现SSO）

jforum与web项目的整合（通过Cookie实现SSO）

jforum是一个不错的开源BBS论坛，支持中文，操作方便，容易扩展，是一个不错的选择。通过参考网上的资料，下面给出了jforum与web项目整合的方法：
1、实现SSO类：

package net.jforum.sso;

import javax.servlet.http.Cookie;

import net.jforum.ControllerUtils;
import net.jforum.context.RequestContext;
import net.jforum.entities.UserSession;
import net.jforum.util.preferences.ConfigKeys;
import net.jforum.util.preferences.SystemGlobals;
import org.apache.log4j.Logger;

public class CookieUserSSO implements SSO {

static final Logger logger = Logger.getLogger(CookieUserSSO.class.getName());

public String authenticateUser(RequestContext request) {
// myapp login cookie, contain logged username
Cookie myCookie = ControllerUtils.getCookie("jforumSSOCookieNameUser");

String username = null;
if (myCookie != null) username = myCookie.getValue();
System.out.println("cookie_name1="+myCookie.getName());
System.out.println("cookie value1="+myCookie.getValue());

if (myCookie == null || username.trim().equals("")) {
//JForumExecutionContext.setRedirect(SystemGlobals.getValue(ConfigKeys.SSO_REDIRECT));
return null; // no cookie found
}
System.out.println("cookie_name2="+myCookie.getName());
System.out.println("cookie value2="+myCookie.getValue());
return username; // jforum username
}

public boolean isSessionValid(UserSession userSession, RequestContext request) {
System.out.println("执行isSessionValid方法");
Cookie SSOCookie = ControllerUtils.getCookie("jforumSSOCookieNameUser"); // myapp login cookie

String remoteUser = null;

if (SSOCookie != null) remoteUser = SSOCookie.getValue(); // jforum username

// user has since logged out
if(remoteUser == null &&
userSession.getUserId() != SystemGlobals.getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {
return false;
// user has since logged in
} else if(remoteUser != null &&
userSession.getUserId() == SystemGlobals.getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {
return false;
// user has changed user
} else if(remoteUser != null && !remoteUser.equals(userSession.getUsername())) {
return false;
}
return true; // myapp user and forum user the same
}
}

把该类放在jforum\WEB-INF\classes下，然后用javac -d .CookieUserSSO .java 命令编译，.class文件存放在jforum\WEB-INF\classes\net\jforum\sso下。
2、修改SystemGlobals.properties
有些JForum版本为jforum-custom.conf文件。
查找“SSO”字样，找到“SSO / User authentication”配置部分，将其修改为以下内容：
authentication.type = sso-----------特别注意：sso用小写，不能用大写
##...
sso.implementation = net.jforum.sso.CookieUserSSO----------你自己实现的SSO类
##...
sso.redirect=http://localhost:port/jforum---------------例如：sso.redirect=http://localhost:8082/jforum
3、在程序的登录或注销部分加入如下代码：
登录：
Cookie cookie = new Cookie("jforumSSOCookieNameUser",name);-------name为从登录界面取得的用户名，把它加入到cookie里面
cookie.setPath("/");
cookie.setMaxAge(-1);//设置cookie的生命周期为：会话级，即浏览器关闭，该cookie就消失了
response.addCookie(cookie);

注销：

Cookie cookie = newCookie(jforumSSOCookieNameUser, "");
cookie.setMaxAge(0); // delete the cookie.
response.addCookie(cookie);

4、在html/jsp页面加入超链接：
<a href="/jforum">转到论坛</a>

这就配置完成了。

说明：经过以上的过程后，把论坛与WEB应用集成了，如果说在WEB中有某个会员，而在论坛里没有此会员，则在会员第一次进入论坛时，会在论坛里自动的注册一个新会员，它的名字与WEB应用中的会员名字相同。

经过以上的配制，还会存在些问题：

第一，会员进入论坛后无法修改自己信息，他的初始密码，总是错误的，因为这些会员都是自动注册的。要怎么样在自动注册时给个初始密码呢？-------修改SystemGlobals.properties，

sso.default.password = e10adc3949ba59abbe56e057f20f883e，主意，jforum里会员的密码是有经过加密的，其中“e10adc3949ba59abbe56e057f20f883e”表示“123456”

第二，经过以前修改后，“游客”是无法访问论坛的，如果说想让“游客”也可以访问论坛，则修改CookieUserSSO类：

把if (myCookie != null) username = myCookie.getValue();

修改成

if(myCookie !=null){

username = myCookie.getValue();

}else{

myCookie =newCookie("jforumSSOCookieNameUser","Anonymous");

myCookie.setPath("/");

myCookie.setMaxAge(-1);//设置cookie的生命周期为：会话级，即浏览器关闭，该cookie就消失了

username ="Anonymous";

}

把if (SSOCookie != null) remoteUser = SSOCookie.getValue(); // jforum username
修改成

if(SSOCookie !=null){

remoteUser = SSOCookie.getValue();// jforum username

}else{

SSOCookie =newCookie("jforumSSOCookieNameUser","Anonymous");

SSOCookie.setPath("/");

SSOCookie.setMaxAge(-1);//设置cookie的生命周期为：会话级，即浏览器关闭，该cookie就消失了

remoteUser ="Anonymous";

}

JForum的安装与整合

论坛的安装

一 先建立数据库

二 将压缩包解压，放到tomcat下的webapp下

三 进入instal.jsp进行配置就行（配置文件的修改可以选择手动）

（也可以选择进入install.jsp修改，好用，但是配置文件不变，说明在程序的其他地方有进行判断并且有从别处读取的代码）

总结： 通过install.jsp页面与修改配置文件的作用一样，二者选一就可以了

论坛的整合

实现SSO

一 利用cookie传递用户

Cookie c=new Cookie("jforumUserInfo",name);

c.setPath("/");

response.addCookie(c);

response.sendRedirect("http://localhost:8080/JForum");

二 修改了systemglobal.properties文件，重启tomcat，没有效果。。

虽然改成了sso登陆，感觉还是用的default登录

而且Cookie能传过来

。。。。。

错误： 配置文件中sso应该是小写的。。。我写成大写的了

实现后结果：

如果访问论坛时，cookie里有用户，则在jforum数据库中加入用户

没有用户，则相当于anonymous用户在访问论坛

http://blog.csdn.net/zrchao/archive/2009/08/26/4486987.aspx

这两天再弄论坛，试了试jforum，遇到些问题，通过查阅资料基本上都已解决，现总结如下。

1. 修改了jforum配置文件
步骤：

找到C:\Program Files\tomcat-5.0.25\webapps\jforum\WEB-INF\config目录下SystemGlobals.properties文件。修改为以下内容：

authentication.type = sso特别注意：sso用小写，不能用大写

sso.implementation = net.jforum.sso.CookieUserSSO----------你自己实现的SSO类

sso.redirect=http://10.5.5.2:9080/jforu ­­—论坛访问路径

注：只是要解决cookie的传递问题

2. 修改了部署在eos域中的页面hidden_cookie.jsp文件

步骤：

D:\primetonLYDD\eosdomain\applications\eos4wl\default.war \lydd_pt\page

目录下hidden_cookie.jsp，修改代码如下所示：