使用openid4java

在项目中使用了openid4java进行开发,在开发过程中碰到过一些问题,在网上也找了很久仍然没有答案,最后通过查看原码才把问题解决,希望在此记录能帮助后来者。

1、推荐http://code.google.com/p/openid4java ,在这上面能下到源码及一些常用的使用说明。

2、转载一片开发过程中参考的文章:

OpenID4Java现在实现了OpenID1.1OpenID2.0规范。但是对于属性交换规范支持的不是很好,不过好像这也不能怪人家OpenID4Java,某些openid provider不按照规矩来(比如google),某些Provider是按照规矩来了,但是现在还处于测试期 (比如yahoo!),属性交换的功能只是提供给有限的几个站点(plaxoJyte)—可怜我捣鼓了两天之后才偶然间发现这个噩耗,呃无语

OpenID4Java现在由code.google.com来维护,可在http://code.google.com/p/openid4java/下载,当前版本是openid4java-0.9.2-bundle.jar。呃...刚想查一下版本号,突然发现怎么有个Deprecated标记,难道夭折了?

不管它了,还是看看OpenID4Java怎么使用比较重要,这才是本文的目的所在不是J

第一步:创建ConsumerManager对象,这个对象是保持与OP端的通信的,所以说在认证会话的整个生命周期中,RP需要保证ConsumerManager是同一个实例化对象。

    if(application.getAttribute("consumermanager") == null){
           ConsumerManager newmgr=new ConsumerManager();
            newmgr.setAssociations(new InMemoryConsumerAssociationStore());
            newmgr.setNonceVerifier(new InMemoryNonceVerifier(5000));
            application.setAttribute("consumermanager",newmgr);
    }

这里我们将对象设置为application范围,目的是将相关密钥保存在同一位置,以免在大量请求到来时,引起性能下降。setAssociations方法设置与OP的关联存放的位置,你可以把它存在内存或者数据库或者xml或者文件中,这个随你喜欢咯,这里我们将它存放在内存。setNonceVerifier方法设置记录response_nonce

的位置。

 

万事俱备,只欠redirect(如果你不需要什么特殊服务的话J)

现在RP可以将用户重定向到OP,当然你需要设置好return_url,告诉OP认证完成之后返回到哪个URL,我们在那个URL进行后续的处理。

Java代码 复制代码
  1. String returnToUrl = "http://xxx.xxx.com/openid_returnurl.jsp";   
  2. //比较重要,通过关联句柄以及returnURL准备OP需要的参数以及参数值   
  3. AuthRequest authReq = manager.authenticate(discovered, returnURL);   
  4. //重定向到OP认证   
  5. request.sendRedirect(authReq.getDestinationUrl(true));  
String returnToUrl = "http://xxx.xxx.com/openid_returnurl.jsp";
//比较重要,通过关联句柄以及returnURL准备OP需要的参数以及参数值
AuthRequest authReq = manager.authenticate(discovered, returnURL);
//重定向到OP认证
request.sendRedirect(authReq.getDestinationUrl(true));

以上这三行代码准备好op需要的参数以及参数值,将用户重定向到OP,在OP端,用户输入用户名密码或者其他方式登录系统,OP会询问用户是否同意RP的认证请求。

注意:以上代码只是在RP不需要用户提供其他信息的情况下的代码,如果要求用户提供其他信息,比如emailgenderdate of birthcountry等等需要在重定向之前添加额外的请求参数。比如RP可以要求用户必须提供email,有选择的提供性别,生日,国家等信息:

OpenID协议提供了两种方式获取用户信息:

第一种:

Java代码 复制代码
  1. AuthRequest authReq = manager.authenticate(discovered,returnToUrl);   
  2. FetchRequest fetch = FetchRequest.createFetchRequest();   
  3. fetch.addAttribute("email""http://axschema.org/contact/email"true);   
  4. fetch.addAttribute("gender"" http://schema.openid.net/contact/gender "false);   
  5. fetch.addAttribute("dob"" http://schema.openid.net/contact/language"false);   
  6. fetch.addAttribute("country"" http://schema.openid.net/contact/country"false);   
  7. authReq.addExtension(fetch);  
AuthRequest authReq = manager.authenticate(discovered,returnToUrl);
FetchRequest fetch = FetchRequest.createFetchRequest();
fetch.addAttribute("email", "http://axschema.org/contact/email", true);
fetch.addAttribute("gender", " http://schema.openid.net/contact/gender ", false);
fetch.addAttribute("dob", " http://schema.openid.net/contact/language", false);
fetch.addAttribute("country", " http://schema.openid.net/contact/country", false);
authReq.addExtension(fetch);

第二种:

Java代码 复制代码
  1. SRegRequest regReq = SRegRequest.createFetchRequest();   
  2. regReq.addAttribute("email",true);   
  3. regReq.addAttribute("gender",false);   
  4. regReq.addAttribute("dob",false);’   
  5. regReq.addAttribute("country",false);   
  6. authReq.addExtension(regReq);  
SRegRequest regReq = SRegRequest.createFetchRequest();
regReq.addAttribute("email",true);
regReq.addAttribute("gender",false);
regReq.addAttribute("dob",false);’
regReq.addAttribute("country",false);
authReq.addExtension(regReq);

需要注意的是并不是所有的OP都支持两种方式获取用户信息。通过google提供的OpenID API可以看到google只支持第一种方式,而且要求参数必须是openid.ns.ext1 openid.ext1.modeopenid.ext1.type.emailopenid.ext1.required,可以看到google要求参数名必须是ext1的形式而且查看openid4java的源代码可以看到使用addExtension方法并不是很好。所以建议如果需要获取用户信息可以将两种获取信息的方式都加上,而且最好是第一种在前,第二种在后。如果将第一种放在后面,最后提交给OP数就会变成ext0的形式。google就会认为不是合法的请求,所以不提供email(当前google只提供用户的email信息,其他信息暂时无法提供)

有关google openid api的具体信息可以参考http://code.google.com/intl/zh-CN/apis/accounts/docs/OpenID.html

另外如果不想受两种获取信息方法顺序的限制,还可以有两种办法解决参数问题:

1重写或者重载Message.addExtension(MessageExtension extension)方法修改参数生成规则。

2 regReq.getParameters().set(new Parameter("openid.ext1.required ","email"));直接设置必须的参数。

另外:openid4java-0.9.2(也就是最新版本)中使用的属性交换协议是http://openid.net/srv/ax/1.0-draft,而google要求属性交换协议要求是http://openid.net/srv/ax/1.0需要单独设置,如果设置不正确,仍然不能获取到用户信息。

用户同意RP的认证请求之后,OP便将用户重定向到RP,并发送认证信息给RPRP需要接受认证信息,检查是否认证通过,获取用户信息,然后进行后续的处理。

Java代码 复制代码
  1. //获取ConsumerManager认证对象   
  2. ConsumerManager manager=(ConsumerManager)application.getAttribute("consumermanager");   
  3. //获取响应参数列表   
  4. ParameterList params = new ParameterList(request.getParameterMap());   
  5. DiscoveryInformation discovered = (DiscoveryInformation)session.getAttribute("discovered");   
  6. StringBuffer url = request.getRequestURL();   
  7. String query = request.getQueryString();   
  8. if(StringUtils.isNotBlank(query)){   
  9.     url.append("?").append(query);   
  10. }   
  11. //根据参数列表,关联句柄以及url_query验证是否通过认证   
  12. VerificationResult verification = manager.verify(url.toString(),params,discovered);   
  13. Ientifier verified = verification.getVerifiedId();  
//获取ConsumerManager认证对象
ConsumerManager manager=(ConsumerManager)application.getAttribute("consumermanager");
//获取响应参数列表
ParameterList params = new ParameterList(request.getParameterMap());
DiscoveryInformation discovered = (DiscoveryInformation)session.getAttribute("discovered");
StringBuffer url = request.getRequestURL();
String query = request.getQueryString();
if(StringUtils.isNotBlank(query)){
	url.append("?").append(query);
}
//根据参数列表,关联句柄以及url_query验证是否通过认证
VerificationResult verification = manager.verify(url.toString(),params,discovered);
Ientifier verified = verification.getVerifiedId();

上面谈到的两种获取用户属性的方式处理是不同的,所以在return_url中这两种方式都要考虑到

Java代码 复制代码
  1. if(verified != null){   
  2.     String email = null;   
  3.     AuthSuccess authSuccess = (AuthSuccess)verification.getAuthResponse();   
  4.     if(authSuccess.hasExtension(SRegMessage.OPENID_NS_SREG)){   
  5.     MessageExtension ext = authSuccess.getExtension(SRegMessage.OPENID_NS_SREG);   
  6.     if(ext instanceof SRegResponse){   
  7.         SRegResponse regResp = (SRegResponse)ext;   
  8.         email = regResp.getAttributeValue("email");   
  9.         }   
  10.     }   
  11.     else if (authSuccess.hasExtension(AxMessage.OPENID_NS_AX)){   
  12.         MessageExtension ext = authSuccess.getExtension(AxMessage.OPENID_NS_AX);   
  13.         if (ext instanceof FetchResponse){   
  14.             FetchResponse fetchResp = (FetchResponse) ext;   
  15.             email = (String)fetchResp.getAttributeValues("email").get(0);   
  16.         }   
  17.     }   
  18.     if(StringUtils.isBlank(email));// OpenID中没有提供Email信息   
  19.     //后续的处理   
  20. }   
if(verified != null){
	String email = null;
	AuthSuccess authSuccess = (AuthSuccess)verification.getAuthResponse();
	if(authSuccess.hasExtension(SRegMessage.OPENID_NS_SREG)){
	MessageExtension ext = authSuccess.getExtension(SRegMessage.OPENID_NS_SREG);
	if(ext instanceof SRegResponse){
		SRegResponse regResp = (SRegResponse)ext;
		email = regResp.getAttributeValue("email");
		}
	}
	else if (authSuccess.hasExtension(AxMessage.OPENID_NS_AX)){
		MessageExtension ext = authSuccess.getExtension(AxMessage.OPENID_NS_AX);
		if (ext instanceof FetchResponse){
		    FetchResponse fetchResp = (FetchResponse) ext;
		    email = (String)fetchResp.getAttributeValues("email").get(0);
		}
	}
	if(StringUtils.isBlank(email));// OpenID中没有提供Email信息
	//后续的处理
} 

以上是RP ConsumerOP的交互过程,这个过程能保证与大部分的OP通信没有问题,但是有少数号称完全遵守规范OpenID2.0OP站点仍然有一些小问题(比如yahoo!),当然使用这段代码还是可以通过认证的,但是yahoo!会给用户一个大大的提示:Warning: This website does not meet Yahoo!'s requirements for website address. Do not share any personal information with this website unless you are certain that it is legitimate.

3、遇到的问题:

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值