Author: anil.saldhana(a)jboss.com Date: 2009-07-16 00:36:08 -0400 (Thu, 16 Jul 2009) New Revision: 642 Removed: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderInformation.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderList.java Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDConstants.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycle.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycleEvent.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDManager.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDRequest.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/exceptions/OpenIDGeneralException.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDParameterList.java identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDProviderManager.java identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDConsumerServlet.java identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDProviderServlet.java identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/LocalProviderOpenIDUnitTestCase.java identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/YadisMetadataUnitTestCase.java Log: JBID-131: openid integration refactor Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDConstants.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDConstants.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDConstants.java 2009-07-16 04:36:08 UTC (rev 642) @@ -22,7 +22,7 @@ package org.jboss.identity.federation.api.openid; /** - * OpenIDConstants + * OpenID URL based Constants * @author Anil.Saldhana(a)redhat.com * @since Jul 7, 2009 */ Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycle.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycle.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycle.java 2009-07-16 04:36:08 UTC (rev 642) @@ -25,7 +25,7 @@ /** * Denotes the lifecycle methods the OpenIDManager - * calls back + * calls back - Consumer Side * @author Anil.Saldhana(a)redhat.com * @since Jul 10, 2009 */ @@ -38,6 +38,11 @@ */ void handle(OpenIDLifecycleEvent event) throws OpenIDLifeCycleException; + /** + * Handle an array of lifecycle events from the OpenID Manager + * @param eventArr + * @throws OpenIDLifeCycleException + */ void handle(OpenIDLifecycleEvent[] eventArr) throws OpenIDLifeCycleException; /** Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycleEvent.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycleEvent.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDLifecycleEvent.java 2009-07-16 04:36:08 UTC (rev 642) @@ -63,21 +63,38 @@ this.attributeValue = val; } + /** + * Get the type of the event (session, lifecycle etc) + * @return + */ public TYPE getEventType() { return eventType; } + /** + * Get the operation we are dealing with (add,remove) + * @return + */ public OP getOperation() { return this.operation; } + /** + * Return the attribute name that needs + * to be dealt at the session level + * @return + */ public String getAttributeName() { return attributeName; } + /** + * Get the attribute value + * @return + */ public Object getAttributeValue() { return attributeValue; Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDManager.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDManager.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDManager.java 2009-07-16 04:36:08 UTC (rev 642) @@ -21,6 +21,7 @@ */ package org.jboss.identity.federation.api.openid; +import java.util.Collections; import java.util.List; import java.util.Map; @@ -49,7 +50,7 @@ import org.openid4java.message.sreg.SRegRequest; /** - * OpenID Manager + * OpenID Manager for consumers * @author Anil.Saldhana(a)redhat.com * @since Jul 6, 2009 */ @@ -120,6 +121,14 @@ return new OpenIDProviderList(discoveries); } + /** + * Associate with a list of open id providers + * @param adapter Protocol adapter (such as http) + * @param listOfProviders (a list of providers from discovery) + * @return + * @throws OpenIDConsumerException + * @throws OpenIDLifeCycleException + */ public OpenIDProviderInformation associate(OpenIDProtocolAdapter adapter, OpenIDProviderList listOfProviders) throws OpenIDConsumerException, OpenIDLifeCycleException @@ -150,6 +159,16 @@ return new OpenIDProviderInformation(discovered); } + /** + * Authenticate an user with the provider + * @param adapter protocol adapter + * @param providerInfo Information about a provider derived from discovery process + * @return + * @throws OpenIDDiscoveryException + * @throws OpenIDConsumerException + * @throws OpenIDMessageException + * @throws OpenIDProtocolException + */ @SuppressWarnings("unchecked") public boolean authenticate(OpenIDProtocolAdapter adapter, OpenIDProviderInformation providerInfo) throws OpenIDDiscoveryException, @@ -256,6 +275,17 @@ return false; } + /** + * Verify a previously authenticated user with the provider + * @param adapter protocol adapter + * @param parameterMap request parameters + * @param receivedURL url where the response will be received + * @return + * @throws OpenIDMessageException + * @throws OpenIDDiscoveryException + * @throws OpenIDAssociationException + * @throws OpenIDLifeCycleException + */ public boolean verify(OpenIDProtocolAdapter adapter, Map<String,String> parameterMap, String receivedURL) throws OpenIDMessageException, OpenIDDiscoveryException, OpenIDAssociationException, OpenIDLifeCycleException @@ -274,13 +304,6 @@ DiscoveryInformation discovered = (DiscoveryInformation) lifeCycle.getAttributeValue(CONST.OPENID_DISC.get()); - // extract the receiving URL from the HTTP request - /*StringBuffer receivingURL = request.getRequestURL(); - String queryString = request.getQueryString(); - if (queryString != null && queryString.length() > 0) - receivingURL.append("?").append(request.getQueryString());*/ - - // verify the response; ConsumerManager needs to be the same // (static) instance used to place the authentication request try @@ -296,6 +319,7 @@ AuthSuccess authSuccess = (AuthSuccess) verification.getAuthResponse(); + //Create an lifecycle event array OpenIDLifecycleEvent[] eventArr = new OpenIDLifecycleEvent[] { /**Store the id**/ @@ -330,6 +354,11 @@ return false; } + /** + * Log an user out from an openid provider + * @param adapter protocol adapter + * @throws OpenIDLifeCycleException + */ public void logout(OpenIDProtocolAdapter adapter) throws OpenIDLifeCycleException { OpenIDLifecycle lifeCycle = null; @@ -344,4 +373,47 @@ lifeCycle.handle(new OpenIDLifecycleEvent(TYPE.SESSION, OP.REMOVE, CONST.OPENID_CLAIMED.get(), null)); } } + + /** + * Information about a provider from the + * discovery process + */ + public class OpenIDProviderInformation + { + private DiscoveryInformation discovered; + + OpenIDProviderInformation(DiscoveryInformation di) + { + this.discovered = di; + } + + DiscoveryInformation get() + { + return this.discovered; + } + } + + /** + * List of OpenID providers + */ + public class OpenIDProviderList + { + private List<DiscoveryInformation> providers = null; + + OpenIDProviderList(List<DiscoveryInformation> providers) + { + this.providers = providers; + } + + List<DiscoveryInformation> get() + { + return Collections.unmodifiableList(providers); + } + + public int size() + { + return this.providers != null ? providers.size() : 0; + } + + } } \ No newline at end of file Deleted: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderInformation.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderInformation.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderInformation.java 2009-07-16 04:36:08 UTC (rev 642) @@ -1,44 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * Copyright 2008, Red Hat Middleware LLC, and individual contributors - * as indicated by the @author tags. See the copyright.txt file in the - * distribution for a full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.identity.federation.api.openid; - -import org.openid4java.discovery.DiscoveryInformation; - -/** - * Information about a provider after discovery - * @author Anil.Saldhana(a)redhat.com - * @since Jul 10, 2009 - */ -public class OpenIDProviderInformation -{ - private DiscoveryInformation discovered; - - public OpenIDProviderInformation(DiscoveryInformation di) - { - this.discovered = di; - } - - public DiscoveryInformation get() - { - return this.discovered; - } -} \ No newline at end of file Deleted: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderList.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderList.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDProviderList.java 2009-07-16 04:36:08 UTC (rev 642) @@ -1,48 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * Copyright 2008, Red Hat Middleware LLC, and individual contributors - * as indicated by the @author tags. See the copyright.txt file in the - * distribution for a full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.identity.federation.api.openid; - -import java.util.Collections; -import java.util.List; - -import org.openid4java.discovery.DiscoveryInformation; - -/** - * Holder of a list of open id providers - * @author Anil.Saldhana(a)redhat.com - * @since Jul 9, 2009 - */ -public class OpenIDProviderList -{ - private List<DiscoveryInformation> providers = null; - - public OpenIDProviderList(List<DiscoveryInformation> providers) - { - this.providers = providers; - } - - public List<DiscoveryInformation> get() - { - return Collections.unmodifiableList(providers); - } - -} \ No newline at end of file Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDRequest.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDRequest.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/OpenIDRequest.java 2009-07-16 04:36:08 UTC (rev 642) @@ -39,11 +39,20 @@ this.url = url; } + /** + * Get the username (openid url) + * @return + */ public String getURL() { return this.url; } + /** + * Set the username in the form of url + * @param url + * @return + */ public OpenIDRequest setURL(String url) { this.url = url; Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/exceptions/OpenIDGeneralException.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/exceptions/OpenIDGeneralException.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/exceptions/OpenIDGeneralException.java 2009-07-16 04:36:08 UTC (rev 642) @@ -24,6 +24,7 @@ import java.security.GeneralSecurityException; /** + * Base class for all OpenID exceptions * @author Anil.Saldhana(a)redhat.com * @since Jul 10, 2009 */ Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDParameterList.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDParameterList.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDParameterList.java 2009-07-16 04:36:08 UTC (rev 642) @@ -44,9 +44,4 @@ { super(parameterMap); } - - public OpenIDParameterList(ParameterList that) - { - super(that); - } } Modified: identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDProviderManager.java =================================================================== --- identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDProviderManager.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-fed-api/src/main/java/org/jboss/identity/federation/api/openid/provider/OpenIDProviderManager.java 2009-07-16 04:36:08 UTC (rev 642) @@ -37,23 +37,43 @@ { private ServerManager serverManager = new ServerManager(); + /** + * Initialize internal data structures + */ public void initialize() { serverManager.setSharedAssociations(new InMemoryServerAssociationStore()); serverManager.setPrivateAssociations(new InMemoryServerAssociationStore()); } + /** + * Get the end point where the provider is active + * @return string an url + */ public String getEndPoint() { return serverManager.getOPEndpointUrl(); } + /** + * Set the end point where the provider is active + * @param url + */ public void setEndPoint(String url) { serverManager.setOPEndpointUrl(url); } - public OpenIDMessage authResponse(ParameterList requestParams, + /** + * Process a request from the RP/Relying Party (or OpenID Consumer) + * for authenticating an user + * @param requestParams + * @param userSelId + * @param userSelClaimed + * @param authenticatedAndApproved + * @return + */ + public OpenIDMessage processAuthenticationRequest(ParameterList requestParams, String userSelId, String userSelClaimed, boolean authenticatedAndApproved) @@ -64,16 +84,32 @@ return new OpenIDMessage(authMessage); } - public OpenIDMessage associationResponse(ParameterList requestParams) + /** + * Process a request for association from the RP + * @param requestParams + * @return + */ + public OpenIDMessage processAssociationRequest(ParameterList requestParams) { return new OpenIDMessage(serverManager.associationResponse(requestParams)); } + /** + * Process a verification request from RP for an already + * authenticated user + * @param requestParams + * @return + */ public OpenIDMessage verify(ParameterList requestParams) { return new OpenIDMessage(serverManager.verify(requestParams)); } + /** + * Create an error message that needs to be passed to the RP + * @param msg + * @return + */ public OpenIDMessage getDirectError(String msg) { return new OpenIDMessage(DirectError.createDirectError(msg)); @@ -103,5 +139,4 @@ return message.keyValueFormEncoding(); } } - } \ No newline at end of file Modified: identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDConsumerServlet.java =================================================================== --- identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDConsumerServlet.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDConsumerServlet.java 2009-07-16 04:36:08 UTC (rev 642) @@ -31,10 +31,10 @@ import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; -import org.jboss.identity.federation.api.openid.OpenIDManager; -import org.jboss.identity.federation.api.openid.OpenIDProviderInformation; -import org.jboss.identity.federation.api.openid.OpenIDProviderList; +import org.jboss.identity.federation.api.openid.OpenIDManager; import org.jboss.identity.federation.api.openid.OpenIDRequest; +import org.jboss.identity.federation.api.openid.OpenIDManager.OpenIDProviderInformation; +import org.jboss.identity.federation.api.openid.OpenIDManager.OpenIDProviderList; import org.jboss.identity.federation.api.openid.exceptions.OpenIDGeneralException; import org.jboss.identity.federation.web.openid.HTTPOpenIDContext; import org.jboss.identity.federation.web.openid.HTTPProtocolAdaptor; Modified: identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDProviderServlet.java =================================================================== --- identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDProviderServlet.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-web/src/main/java/org/jboss/identity/federation/web/servlets/OpenIDProviderServlet.java 2009-07-16 04:36:08 UTC (rev 642) @@ -103,7 +103,7 @@ if ("associate".equals(mode)) { // --- process an association request --- - responsem = serverManager.associationResponse(requestp); + responsem = serverManager.processAssociationRequest(requestp); responseText = responsem.getResponseText(); } else if ("checkid_setup".equals(mode) @@ -132,7 +132,7 @@ } // --- process an authentication request --- - responsem = serverManager.authResponse(requestp, + responsem = serverManager.processAuthenticationRequest(requestp, userSelectedId, userSelectedClaimedId, authenticatedAndApproved.booleanValue()); Modified: identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/LocalProviderOpenIDUnitTestCase.java =================================================================== --- identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/LocalProviderOpenIDUnitTestCase.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/LocalProviderOpenIDUnitTestCase.java 2009-07-16 04:36:08 UTC (rev 642) @@ -29,10 +29,10 @@ import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; -import org.jboss.identity.federation.api.openid.OpenIDManager; -import org.jboss.identity.federation.api.openid.OpenIDProviderInformation; -import org.jboss.identity.federation.api.openid.OpenIDProviderList; +import org.jboss.identity.federation.api.openid.OpenIDManager; import org.jboss.identity.federation.api.openid.OpenIDRequest; +import org.jboss.identity.federation.api.openid.OpenIDManager.OpenIDProviderInformation; +import org.jboss.identity.federation.api.openid.OpenIDManager.OpenIDProviderList; import org.jboss.test.identity.federation.web.openid.InMemoryProtocolAdapter; import org.jboss.test.identity.federation.web.server.EmbeddedWebServerBase; import org.mortbay.jetty.servlet.Context; Modified: identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/YadisMetadataUnitTestCase.java =================================================================== --- identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/YadisMetadataUnitTestCase.java 2009-07-15 22:27:53 UTC (rev 641) +++ identity-federation/trunk/jboss-identity-web/src/test/java/org/jboss/test/identity/federation/web/integration/YadisMetadataUnitTestCase.java 2009-07-16 04:36:08 UTC (rev 642) @@ -28,9 +28,9 @@ import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; -import org.jboss.identity.federation.api.openid.OpenIDManager; -import org.jboss.identity.federation.api.openid.OpenIDProviderList; +import org.jboss.identity.federation.api.openid.OpenIDManager; import org.jboss.identity.federation.api.openid.OpenIDRequest; +import org.jboss.identity.federation.api.openid.OpenIDManager.OpenIDProviderList; import org.jboss.identity.federation.web.servlets.OpenIDYadisServlet; import org.jboss.test.identity.federation.web.server.EmbeddedWebServerBase; import org.mortbay.jetty.servlet.Context; @@ -65,7 +65,7 @@ OpenIDProviderList providers = idm.discoverProviders(); assertNotNull("Providers list is not null", providers); - assertEquals("1 provider", 1, providers.get().size()); + assertEquals("1 provider", 1, providers.size()); } /**