[picketlink-commits] Picketlink SVN: r617 - in federation/trunk/picketlink-fed-core/src: main/java/org/picketlink/identity/federation/core/wstrust and 2 other directories.

Author: anil.saldhana(a)jboss.com Date: 2010-12-22 14:06:56 -0500 (Wed, 22 Dec 2010) New Revision: 617 Added: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/interfaces/SecurityTokenProvider.java Removed: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/SecurityTokenProvider.java Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/PicketLinkSTSConfiguration.java federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/STSConfiguration.java federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/StandardRequestHandler.java federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustRequestContext.java federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustServiceFactory.java federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/plugins/saml/SAML20TokenProvider.java federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/PicketLinkSTSUnitTestCase.java federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/SpecialTokenProvider.java federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/WSTrustServiceFactoryUnitTestCase.java Log: abstract the token provider interface Added: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/interfaces/SecurityTokenProvider.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/interfaces/SecurityTokenProvider.java (rev 0) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/interfaces/SecurityTokenProvider.java 2010-12-22 19:06:56 UTC (rev 617) @@ -0,0 +1,97 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2009, 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.picketlink.identity.federation.core.interfaces; + +import java.util.Map; + +import org.picketlink.identity.federation.core.wstrust.WSTrustException; + +/** + * <p> + * This interface defines the methods that must be implemented by security token providers. + * </p> + * + * @author <a href="mailto:sguilhen@redhat.com">Stefan Guilhen</a> + */ +public interface SecurityTokenProvider +{ + /** + * <p> + * Initializes the {@code SecurityTokenProvider} using the specified properties map. + * </p> + * + * @param properties a {@code Map<String, String>} that contains the properties that have been configured for + * this {@code SecurityTokenProvider}. + */ + public void initialize(Map<String, String> properties); + + /** + * Specify whether this token provider supports a particular namespace + * @param namespace a string value representing a namespace + * @return + */ + public boolean supports( String namespace ); + + /** + * <p> + * Generates a security token using the information contained in the specified request context and stores the + * newly-created token in the context itself. + * </p> + * + * @param context the {@code ProtocolContext} to be used when generating the token. + * @throws WSTrustException if an error occurs while creating the security token. + */ + public void issueToken( ProtocolContext context) throws WSTrustException; + + /** + * <p> + * Renews the security token contained in the specified request context. This method is used when a previously + * generated token has expired, generating a new version of the same token with different expiration semantics. + * </p> + * + * @param context the {@code ProtocolContext} that contains the token to be renewed. + * @throws WSTrustException if an error occurs while renewing the security token. + */ + public void renewToken( ProtocolContext context) throws WSTrustException; + + /** + * <p> + * Cancels the token contained in the specified request context. A security token is usually canceled when one wants + * to make sure that the token will not be used anymore. A security token can't be renewed once it has been canceled. + * </p> + * + * @param context the {@code ProtocolContext} that contains the token to be canceled. + * @throws WSTrustException if an error occurs while canceling the security token. + */ + public void cancelToken( ProtocolContext context) throws WSTrustException; + + /** + * <p> + * Evaluates the validity of the token contained in the specified request context and sets the result in the context + * itself. The result can be a status, a new token, or both. + * </p> + * + * @param context the {@code ProtocolContext} that contains the token to be validated. + * @throws WSTrustException if an error occurs while validating the security token. + */ + public void validateToken( ProtocolContext context) throws WSTrustException; +} \ No newline at end of file Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/PicketLinkSTSConfiguration.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/PicketLinkSTSConfiguration.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/PicketLinkSTSConfiguration.java 2010-12-22 19:06:56 UTC (rev 617) @@ -39,6 +39,7 @@ import org.picketlink.identity.federation.core.config.ServiceProvidersType; import org.picketlink.identity.federation.core.config.TokenProviderType; import org.picketlink.identity.federation.core.config.TokenProvidersType; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.interfaces.TrustKeyManager; import org.picketlink.identity.federation.core.util.CoreConfigUtil; Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/STSConfiguration.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/STSConfiguration.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/STSConfiguration.java 2010-12-22 19:06:56 UTC (rev 617) @@ -25,6 +25,8 @@ import java.security.PublicKey; import java.security.cert.Certificate; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; + /** * <p> * The {@code STSConfiguration} interface allows access to the security token service (STS) configuration attributes. Deleted: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/SecurityTokenProvider.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/SecurityTokenProvider.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/SecurityTokenProvider.java 2010-12-22 19:06:56 UTC (rev 617) @@ -1,88 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * Copyright 2009, 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.picketlink.identity.federation.core.wstrust; - -import java.util.Map; - -/** - * <p> - * This interface defines the methods that must be implemented by security token providers. - * </p> - * - * @author <a href="mailto:sguilhen@redhat.com">Stefan Guilhen</a> - */ -public interface SecurityTokenProvider -{ - /** - * <p> - * Initializes the {@code SecurityTokenProvider} using the specified properties map. - * </p> - * - * @param properties a {@code Map<String, String>} that contains the properties that have been configured for - * this {@code SecurityTokenProvider}. - */ - public void initialize(Map<String, String> properties); - - /** - * <p> - * Generates a security token using the information contained in the specified request context and stores the - * newly-created token in the context itself. - * </p> - * - * @param context the {@code WSTrustRequestContext} to be used when generating the token. - * @throws WSTrustException if an error occurs while creating the security token. - */ - public void issueToken(WSTrustRequestContext context) throws WSTrustException; - - /** - * <p> - * Renews the security token contained in the specified request context. This method is used when a previously - * generated token has expired, generating a new version of the same token with different expiration semantics. - * </p> - * - * @param context the {@code WSTrustRequestContext} that contains the token to be renewed. - * @throws WSTrustException if an error occurs while renewing the security token. - */ - public void renewToken(WSTrustRequestContext context) throws WSTrustException; - - /** - * <p> - * Cancels the token contained in the specified request context. A security token is usually canceled when one wants - * to make sure that the token will not be used anymore. A security token can't be renewed once it has been canceled. - * </p> - * - * @param context the {@code WSTrustRequestContext} that contains the token to be canceled. - * @throws WSTrustException if an error occurs while canceling the security token. - */ - public void cancelToken(WSTrustRequestContext context) throws WSTrustException; - - /** - * <p> - * Evaluates the validity of the token contained in the specified request context and sets the result in the context - * itself. The result can be a status, a new token, or both. - * </p> - * - * @param context the {@code WSTrustRequestContext} that contains the token to be validated. - * @throws WSTrustException if an error occurs while validating the security token. - */ - public void validateToken(WSTrustRequestContext context) throws WSTrustException; -} Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/StandardRequestHandler.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/StandardRequestHandler.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/StandardRequestHandler.java 2010-12-22 19:06:56 UTC (rev 617) @@ -30,6 +30,7 @@ import org.apache.log4j.Logger; import org.picketlink.identity.federation.core.exceptions.ProcessingException; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.saml.v2.util.DocumentUtil; import org.picketlink.identity.federation.core.util.Base64; import org.picketlink.identity.federation.core.util.XMLEncryptionUtil; Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustRequestContext.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustRequestContext.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustRequestContext.java 2010-12-22 19:06:56 UTC (rev 617) @@ -25,6 +25,7 @@ import java.security.PublicKey; import java.util.Map; +import org.picketlink.identity.federation.core.interfaces.ProtocolContext; import org.picketlink.identity.federation.core.wstrust.wrappers.RequestSecurityToken; import org.picketlink.identity.federation.ws.trust.RequestedReferenceType; import org.picketlink.identity.federation.ws.trust.StatusType; @@ -39,7 +40,7 @@ * * @author <a href="mailto:sguilhen@redhat.com">Stefan Guilhen</a> */ -public class WSTrustRequestContext +public class WSTrustRequestContext implements ProtocolContext { // information supplied by the request handler. Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustServiceFactory.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustServiceFactory.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/WSTrustServiceFactory.java 2010-12-22 19:06:56 UTC (rev 617) @@ -24,6 +24,8 @@ import java.security.PrivilegedActionException; import java.util.Map; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; + /** * <p> * Factory class used for instantiating pluggable services, such as the {@code WSTrustRequestHandler} and Modified: federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/plugins/saml/SAML20TokenProvider.java =================================================================== --- federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/plugins/saml/SAML20TokenProvider.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/main/java/org/picketlink/identity/federation/core/wstrust/plugins/saml/SAML20TokenProvider.java 2010-12-22 19:06:56 UTC (rev 617) @@ -27,12 +27,13 @@ import javax.xml.namespace.QName; import org.apache.log4j.Logger; +import org.picketlink.identity.federation.core.interfaces.ProtocolContext; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.saml.v2.common.IDGenerator; import org.picketlink.identity.federation.core.saml.v2.factories.SAMLAssertionFactory; import org.picketlink.identity.federation.core.saml.v2.util.AssertionUtil; import org.picketlink.identity.federation.core.saml.v2.util.StatementUtil; import org.picketlink.identity.federation.core.wstrust.SecurityToken; -import org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider; import org.picketlink.identity.federation.core.wstrust.StandardSecurityToken; import org.picketlink.identity.federation.core.wstrust.WSTrustConstants; import org.picketlink.identity.federation.core.wstrust.WSTrustException; @@ -179,8 +180,10 @@ * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider# * cancelToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void cancelToken(WSTrustRequestContext context) throws WSTrustException + public void cancelToken( ProtocolContext protoContext) throws WSTrustException { + WSTrustRequestContext context = (WSTrustRequestContext) protoContext; + // get the assertion that must be canceled. Element token = (Element) context.getRequestSecurityToken().getCancelTargetElement(); if (token == null) @@ -200,8 +203,9 @@ * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider# * issueToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void issueToken(WSTrustRequestContext context) throws WSTrustException + public void issueToken( ProtocolContext protoContext) throws WSTrustException { + WSTrustRequestContext context = (WSTrustRequestContext) protoContext; // generate an id for the new assertion. String assertionID = IDGenerator.create("ID_"); @@ -295,8 +299,9 @@ * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider# * renewToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void renewToken(WSTrustRequestContext context) throws WSTrustException + public void renewToken( ProtocolContext protoContext ) throws WSTrustException { + WSTrustRequestContext context = (WSTrustRequestContext) protoContext; // get the specified assertion that must be renewed. Element token = (Element) context.getRequestSecurityToken().getRenewTargetElement(); if (token == null) @@ -365,8 +370,9 @@ * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider# * validateToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void validateToken(WSTrustRequestContext context) throws WSTrustException + public void validateToken( ProtocolContext protoContext ) throws WSTrustException { + WSTrustRequestContext context = (WSTrustRequestContext) protoContext; if (logger.isTraceEnabled()) logger.trace("SAML V2.0 token validation started"); @@ -441,4 +447,11 @@ && WSTrustConstants.SAML2_ASSERTION_NS.equals(element.getNamespaceURI()); } + /** + * @see {@code SecurityTokenProvider#supports(String)} + */ + public boolean supports(String namespace) + { + return WSTrustConstants.BASE_NAMESPACE.equals(namespace); + } } \ No newline at end of file Modified: federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/PicketLinkSTSUnitTestCase.java =================================================================== --- federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/PicketLinkSTSUnitTestCase.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/PicketLinkSTSUnitTestCase.java 2010-12-22 19:06:56 UTC (rev 617) @@ -47,6 +47,7 @@ import org.picketlink.identity.federation.core.config.STSType; import org.picketlink.identity.federation.core.exceptions.ConfigurationException; import org.picketlink.identity.federation.core.exceptions.ParsingException; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.parsers.wst.WSTrustParser; import org.picketlink.identity.federation.core.saml.v2.common.IDGenerator; import org.picketlink.identity.federation.core.saml.v2.util.DocumentUtil; @@ -54,7 +55,6 @@ import org.picketlink.identity.federation.core.wstrust.PicketLinkSTS; import org.picketlink.identity.federation.core.wstrust.PicketLinkSTSConfiguration; import org.picketlink.identity.federation.core.wstrust.STSConfiguration; -import org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider; import org.picketlink.identity.federation.core.wstrust.StandardRequestHandler; import org.picketlink.identity.federation.core.wstrust.WSTrustConstants; import org.picketlink.identity.federation.core.wstrust.WSTrustException; Modified: federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/SpecialTokenProvider.java =================================================================== --- federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/SpecialTokenProvider.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/SpecialTokenProvider.java 2010-12-22 19:06:56 UTC (rev 617) @@ -26,11 +26,13 @@ import java.util.Map; import org.picketlink.identity.federation.core.exceptions.ConfigurationException; +import org.picketlink.identity.federation.core.interfaces.ProtocolContext; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.saml.v2.common.IDGenerator; import org.picketlink.identity.federation.core.saml.v2.util.DocumentUtil; import org.picketlink.identity.federation.core.wstrust.SecurityToken; -import org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider; import org.picketlink.identity.federation.core.wstrust.StandardSecurityToken; +import org.picketlink.identity.federation.core.wstrust.WSTrustConstants; import org.picketlink.identity.federation.core.wstrust.WSTrustException; import org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext; import org.w3c.dom.Document; @@ -63,7 +65,7 @@ * * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider#cancelToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void cancelToken(WSTrustRequestContext context) throws WSTrustException + public void cancelToken( ProtocolContext protoContext ) throws WSTrustException { } @@ -72,8 +74,10 @@ * * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider#issueToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void issueToken(WSTrustRequestContext context) throws WSTrustException + public void issueToken( ProtocolContext protoContext) throws WSTrustException { + WSTrustRequestContext context = (WSTrustRequestContext) protoContext; + // create a simple sample token using the info from the request. String caller = context.getCallerPrincipal() == null ? "anonymous" : context.getCallerPrincipal().getName(); URI tokenType = context.getRequestSecurityToken().getTokenType(); @@ -119,7 +123,7 @@ * * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider#renewToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void renewToken(WSTrustRequestContext context) throws WSTrustException + public void renewToken( ProtocolContext protoContext ) throws WSTrustException { } @@ -128,7 +132,7 @@ * * @see org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider#validateToken(org.picketlink.identity.federation.core.wstrust.WSTrustRequestContext) */ - public void validateToken(WSTrustRequestContext context) throws WSTrustException + public void validateToken( ProtocolContext protoContext ) throws WSTrustException { } @@ -143,4 +147,9 @@ { return this.properties; } -} + + public boolean supports(String namespace) + { + return WSTrustConstants.BASE_NAMESPACE.equals(namespace); + } +} \ No newline at end of file Modified: federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/WSTrustServiceFactoryUnitTestCase.java =================================================================== --- federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/WSTrustServiceFactoryUnitTestCase.java 2010-12-21 19:41:30 UTC (rev 616) +++ federation/trunk/picketlink-fed-core/src/test/java/org/picketlink/test/identity/federation/core/wstrust/WSTrustServiceFactoryUnitTestCase.java 2010-12-22 19:06:56 UTC (rev 617) @@ -27,9 +27,9 @@ import junit.framework.TestCase; +import org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider; import org.picketlink.identity.federation.core.wstrust.PicketLinkSTSConfiguration; import org.picketlink.identity.federation.core.wstrust.STSConfiguration; -import org.picketlink.identity.federation.core.wstrust.SecurityTokenProvider; import org.picketlink.identity.federation.core.wstrust.StandardRequestHandler; import org.picketlink.identity.federation.core.wstrust.WSTrustRequestHandler; import org.picketlink.identity.federation.core.wstrust.WSTrustServiceFactory;