MOA-ID version 1.1 (initial)

git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@19 d688527b-c9ab-4aba-bd8d-4036d912da1d

3 files changed, 475 insertions, 0 deletions

diff --git a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java
new file mode 100644
index 000000000..c9a13fee5
--- /dev/null
+++ b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java
@@ -0,0 +1,145 @@
+package at.gv.egovernment.moa.id.config.proxy;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Holds configuration data concerning an online application for use by the MOA-ID Proxy component.
+ * These include the login type (stateful or stateless), the HTTP authentication type,
+ * and information needed to add authentication parameters or headers for a URL connection 
+ * to the remote online application.
+ * @see <code>MOAIDConfiguration-1.1.xsd</code>, element <code>Configuration</code>
+ * 
+ * @author Stefan Knirsch
+ * @version $Id$
+ */
+public class OAConfiguration {
+
+  /** Constant for an login method */  
+  public static final String LOGINTYPE_STATEFUL = "stateful";
+  /** Constant for an login method */
+  public static final String LOGINTYPE_STATELESS = "stateless";
+  
+  /** Constant for an auth method */
+  public static final String BASIC_AUTH = "basic";
+  /** Constant for an auth method */
+  public static final String HEADER_AUTH = "header";
+  /** Constant for an auth method */
+  public static final String PARAM_AUTH = "param";
+  
+  /** login type: stateful or stateless */
+  String loginType;
+  /** authentication type: basic, header, or param */
+  String authType;
+  /** 
+   * mapping of parameter names to AuthenticationData field names
+   * in case of authentication type <code>"header-auth"</code>
+   */
+  Map paramAuthMapping;
+  /** 
+   * mapping of parameter names to AuthenticationData field names
+   * in case of authentication type <code>"param-auth"</code>
+   */
+  Map headerAuthMapping;
+  /** mapping for user ID to be used in case of authentication type <code>"basic-auth"</code> */
+  String basicAuthUserIDMapping;
+  /** mapping for password to be used in case of authentication type <code>"basic-auth"</code> */
+  String basicAuthPasswordMapping;
+  
+  /**
+   * Returns the basicAuthPasswordMapping.
+   * @return String
+   */
+  public String getBasicAuthPasswordMapping() {
+    return basicAuthPasswordMapping;
+  }
+  
+  /**
+   * Returns the basicAuthUserIDMapping.
+   * @return String
+   */
+  public String getBasicAuthUserIDMapping() {
+    return basicAuthUserIDMapping;
+  }
+  
+  /**
+   * Returns the headerAuthMapping.
+   * @return HashMap
+   */
+  public Map getHeaderAuthMapping() {
+    return headerAuthMapping;
+  }
+  
+  /**
+   * Returns the loginType.
+   * @return String
+   */
+  public String getLoginType() {
+    return loginType;
+  }
+  
+  /**
+   * Returns the paramAuthMapping.
+   * @return HashMap
+   */
+  public Map getParamAuthMapping() {
+    return paramAuthMapping;
+  }
+  
+  /**
+   * Sets the basicAuthPasswordMapping.
+   * @param basicAuthPasswordMapping The basicAuthPasswordMapping to set
+   */
+  public void setBasicAuthPasswordMapping(String basicAuthPassword) {
+    this.basicAuthPasswordMapping = basicAuthPassword;
+  }
+  
+  /**
+   * Sets the basicAuthUserIDMapping.
+   * @param basicAuthUserIDMapping The basicAuthUserIDMapping to set
+   */
+  public void setBasicAuthUserIDMapping(String basicAuthUserID) {
+    this.basicAuthUserIDMapping = basicAuthUserID;
+  }
+  
+  /**
+   * Sets the headerAuthMapping.
+   * @param headerAuthMapping The headerAuthMapping to set
+   */
+  public void setHeaderAuthMapping(HashMap headerAuth) {
+    this.headerAuthMapping = headerAuth;
+  }
+  
+  /**
+   * Sets the loginType.
+   * @param loginType The loginType to set
+   */
+  public void setLoginType(String loginType) {
+    this.loginType = loginType;
+  }
+  
+  /**
+   * Sets the paramAuthMapping.
+   * @param paramAuthMapping The paramAuthMapping to set
+   */
+  public void setParamAuthMapping(HashMap paramAuth) {
+    this.paramAuthMapping = paramAuth;
+  }
+  
+  /**
+   * Returns the authType.
+   * @return String
+   */
+  public String getAuthType() {
+    return authType;
+  }
+  
+  /**
+   * Sets the authType.
+   * @param authType The authType to set
+   */
+  public void setAuthType(String authLoginType) {
+    this.authType = authLoginType;
+  }
+
+}
diff --git a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java
new file mode 100644
index 000000000..f08c60736
--- /dev/null
+++ b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java
@@ -0,0 +1,160 @@
+package at.gv.egovernment.moa.id.config.proxy;
+
+import at.gv.egovernment.moa.id.config.ConnectionParameter;
+
+/**
+ * Configuration parameters belonging to an online application,
+ * to use with the MOA ID Proxy component.
+ * 
+ * @author Stefan Knirsch
+ * @version $Id$
+ */
+public class OAProxyParameter {
+
+	/**
+	 * public URL prefix of the online application
+	 */
+  private String publicURLPrefix;
+  /**
+   * URL of online application configuration file;
+   * defaults to relative URL <code>/moaconfig.xml</code>
+   */
+  private String configFileURL;
+  /**
+   * implementation of {@link  at.gv.egovernment.moa.id.proxy.LoginParameterResolver} interface
+   * to be used for authenticating the online application;
+   * defaults to {@link  at.gv.egovernment.moa.id.proxy.DefaultLoginParameterResolver}
+   */
+  private String loginParameterResolverImpl;
+  /**
+   * implementation of {@link  at.gv.egovernment.moa.id.proxy.ConnectionBuilder} interface
+   * to be used for connecting to the online application;
+   * defaults to {@link  at.gv.egovernment.moa.id.proxy.DefaultConnectionBuilder}
+   */
+  private String connectionBuilderImpl;
+  /**
+   * session time out to be used in case of a stateless online application
+   */
+  private int sessionTimeOut;
+  /**
+   * parameters regarding the connection from the proxy to the online application
+   */
+  private ConnectionParameter connectionParameter;
+  /**
+   * parameters for logging into the online application
+   */
+  private OAConfiguration oaConfiguration;
+
+  /**
+   * Returns the configFileURL.
+   * @return String
+   */
+  public String getConfigFileURL() {
+    return configFileURL;
+  }
+
+  /**
+   * Returns the sessionTimeOut.
+   * @return int
+   */
+  public int getSessionTimeOut() {
+    return sessionTimeOut;
+  }
+
+  /**
+   * Returns the connectionParameter.
+   * @return ConnectionParameter
+   */
+  public ConnectionParameter getConnectionParameter() {
+    return connectionParameter;
+  }
+
+  /**
+   * Sets the configFileURL.
+   * @param configFileURL The configFileURL to set
+   */
+  public void setConfigFileURL(String oaProxyConfigFileURL) {
+    this.configFileURL = oaProxyConfigFileURL;
+  }
+
+  /**
+   * Sets the sessionTimeOut.
+   * @param sessionTimeOut The sessionTimeOut to set
+   */
+  public void setSessionTimeOut(int oaProxySessionTimeOut) {
+    this.sessionTimeOut = oaProxySessionTimeOut;
+  }
+
+  /**
+   * Sets the connectionParameter.
+   * @param connectionParameter The connectionParameter to set
+   */
+  public void setConnectionParameter(ConnectionParameter proxyConnectionParameter) {
+    this.connectionParameter = proxyConnectionParameter;
+  }
+
+  /**
+   * Returns the publicURLPrefix.
+   * @return String
+   */
+  public String getPublicURLPrefix() {
+    return publicURLPrefix;
+  }
+
+  /**
+   * Sets the publicURLPrefix.
+   * @param publicURLPrefix The publicURLPrefix to set
+   */
+  public void setPublicURLPrefix(String url) {
+    this.publicURLPrefix = url;
+  }
+
+  /**
+   * Returns the connectionBuilderImpl.
+   * @return String
+   */
+  public String getConnectionBuilderImpl() {
+    return connectionBuilderImpl;
+  }
+
+  /**
+   * Returns the loginParameterResolverImpl.
+   * @return String
+   */
+  public String getLoginParameterResolverImpl() {
+    return loginParameterResolverImpl;
+  }
+
+  /**
+   * Sets the connectionBuilderImpl.
+   * @param connectionBuilderImpl The connectionBuilderImpl to set
+   */
+  public void setConnectionBuilderImpl(String connectionBuilderImp) {
+    this.connectionBuilderImpl = connectionBuilderImp;
+  }
+
+  /**
+   * Sets the loginParameterResolverImpl.
+   * @param loginParameterResolverImpl The loginParameterResolverImpl to set
+   */
+  public void setLoginParameterResolverImpl(String loginParameterResolverImpl) {
+    this.loginParameterResolverImpl = loginParameterResolverImpl;
+  }
+
+  /**
+   * Returns the oaConfiguration.
+   * @return OAConfiguration
+   */
+  public OAConfiguration getOaConfiguration() {
+    return oaConfiguration;
+  }
+
+  /**
+   * Sets the oaConfiguration.
+   * @param oaConfiguration The oaConfiguration to set
+   */
+  public void setOaConfiguration(OAConfiguration oaConfiguration) {
+    this.oaConfiguration = oaConfiguration;
+  }
+
+}
diff --git a/id.server/src/at/gv/egovernment/moa/id/config/proxy/ProxyConfigurationProvider.java b/id.server/src/at/gv/egovernment/moa/id/config/proxy/ProxyConfigurationProvider.java
new file mode 100644
index 000000000..897d14da9
--- /dev/null
+++ b/id.server/src/at/gv/egovernment/moa/id/config/proxy/ProxyConfigurationProvider.java
@@ -0,0 +1,170 @@
+package at.gv.egovernment.moa.id.config.proxy;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+
+import org.w3c.dom.Element;
+
+import at.gv.egovernment.moa.id.config.ConfigurationBuilder;
+import at.gv.egovernment.moa.id.config.ConfigurationException;
+import at.gv.egovernment.moa.id.config.ConfigurationProvider;
+import at.gv.egovernment.moa.id.config.ConnectionParameter;
+import at.gv.egovernment.moa.logging.Logger;
+import at.gv.egovernment.moa.util.DOMUtils;
+
+/**
+ * A class providing access to the Proxy Part of the MOA-ID configuration data.
+ * 
+ * <p>Configuration data is read from an XML file, whose location is given by
+ * the <code>moa.id.configuration</code> system property.</p>
+ * <p>This class implements the Singleton pattern. The <code>reload()</code>
+ * method can be used to update the configuration data. Therefore, it is not
+ * guaranteed that consecutive calls to <code>getInstance()</code> will return
+ * the same <code>ProxyConfigurationProvider</code> all the time. During the
+ * processing of a web service request, the current
+ * <code>TransactionContext</code> should be used to obtain the
+ * <code>ProxyConfigurationProvider</code> local to that request.</p>
+ * 
+ * @author Stefan Knirsch
+ */
+public class ProxyConfigurationProvider extends ConfigurationProvider {
+
+  /** Singleton instance. <code>null</code>, if none has been created. */
+  private static ProxyConfigurationProvider instance;
+
+  //
+  // configuration data
+  //
+  /**
+   * connection parameters for connection to MOA ID Auth component
+   */
+  private ConnectionParameter authComponentConnectionParameter;
+  /**
+   * configuration parameters for online applications
+   */
+  private OAProxyParameter[] onlineApplicationProxyParameter;
+
+  /**
+   * Return the single instance of configuration data.
+   * 
+   * @return ProxyConfigurationProvider The current configuration data.
+   * @throws ConfigurationException 
+   */
+  public static synchronized ProxyConfigurationProvider getInstance()
+    throws ConfigurationException {
+
+    if (instance == null) {
+      reload();
+    }
+    return instance;
+  }
+
+  /**
+   * Reload the configuration data and set it if successful.
+   * 
+   * @return ProxyConfigurationProvider The loaded configuration data.
+   * @throws ConfigurationException Failure to load the configuration data.
+   */
+  public static synchronized ProxyConfigurationProvider reload()
+    throws ConfigurationException {
+    String fileName = System.getProperty(CONFIG_PROPERTY_NAME);
+    if (fileName == null) {
+      throw new ConfigurationException("config.01", null);
+    }
+    Logger.info("Loading MOA-ID-PROXY configuration " + fileName);
+
+    instance = new ProxyConfigurationProvider(fileName);
+    return instance;
+  }
+
+  /**
+   * Constructor for ProxyConfigurationProvider.
+   */
+  public ProxyConfigurationProvider(String fileName)
+    throws ConfigurationException {
+
+    load(fileName);
+  }
+
+  /**
+   * Load the configuration data from XML file with the given name and build
+   * the internal data structures representing the MOA configuration.
+   * 
+   * @param fileName The name of the XML file to load.
+   * @throws ConfigurationException The MOA configuration could not be
+   * read/built.
+   */
+  private void load(String fileName) throws ConfigurationException {
+    FileInputStream stream = null;
+    Element configElem;
+    ConfigurationBuilder builder;
+
+    try {
+      // load the main config file
+      stream = new FileInputStream(fileName);
+      configElem = DOMUtils.parseXmlValidating(stream);
+    } 
+    catch (Throwable t) {
+      throw new ConfigurationException("config.03", null, t);
+    } 
+    finally {
+      try {
+        if (stream != null) {
+          stream.close();
+        }
+      } 
+      catch (IOException e) {
+      }
+    }
+		try {
+      // build the internal datastructures
+      builder = new ConfigurationBuilder(configElem);
+      authComponentConnectionParameter = builder.buildAuthComponentConnectionParameter();
+      onlineApplicationProxyParameter = builder.buildOnlineApplicationProxyParameters();  
+      genericConfiguration = builder.buildGenericConfiguration();
+      defaultChainingMode = builder.getDefaultChainingMode();
+      chainingModes = builder.buildChainingModes();  
+      trustedCACertificates = builder.getTrustedCACertificates();
+    } 
+    catch (Throwable t) {
+      throw new ConfigurationException("config.02", null, t);
+    }
+  }
+
+ /**
+   * Return a bean containing all information about the ProxyComponent
+   * @return The ConnectionParameter for the Proxy Component
+   */
+  public ConnectionParameter getAuthComponentConnectionParameter() {
+    return authComponentConnectionParameter;
+  }
+  
+  /**
+   * Build an array of OnlineApplication Parameter Beans containing all
+   * information about the proxy component of the online application
+   * @return An OAProxyParameter array containing beans
+   * with all relevant information for the proxy component of the online 
+   * application
+   */
+  public OAProxyParameter[] getOnlineApplicationParameters() {
+    return onlineApplicationProxyParameter;
+  }
+  /**
+   * Provides configuration information regarding the online application behind
+   * the given URL, relevant to the MOA-ID Proxy component.
+   * 
+   * @param oaURL URL requested for an online application
+   * @return an <code>OAProxyParameter</code>, or <code>null</code>
+   * 					if none is applicable
+   */
+  public OAProxyParameter getOnlineApplicationParameter(String oaURL) {
+  	OAProxyParameter[] oaParams = getOnlineApplicationParameters();
+  	for (int i = 0; i < oaParams.length; i++) {
+  		OAProxyParameter oaParam = oaParams[i];
+  		if (oaURL.startsWith(oaParam.getPublicURLPrefix()))
+  			return oaParam;
+  	}
+    return null;
+  }
+
+}
\ No newline at end of file