Set version to 1.6.1.Final

KEYCLOAK-2005 Fixed migration to take less time. Added UserProvider.g…

.gitattributes

@@ -0,0 +1,20 @@
+* text=auto
+
+*.html text eol=lf
+*.java text eol=lf
+*.js text eol=lf
+*.json text eol=lf
+*.jsp text eol=lf
+*.md text eol=lf
+*.properties text eol=lf
+*.svg text auto
+*.xml text eol=lf
+*.xsl text eol=lf
+
+*.png binary
+*.jpg binary
+*.gif binary
+*.ttf binary
+*.eot binary
+*.otf binary
+*.woff binary

.travis.yml

@@ -1,8 +1,19 @@
 language: java
 
+jdk:
+  - oraclejdk8
+
 cache:
     directories:
         - $HOME/.m2
-sudo: false
 
-after_script: 'misc/.travis/after.sh'
+before_cache:
+  - rm -rf $HOME/.m2/repository/org/keycloak
+
+install: mvn install -Pdistribution -DskipTests=true -B -V
+
+script:
+  - mvn test -B
+  - mvn -file testsuite/integration-arquillian test -B
+
+sudo: false

broker/core/pom.xml

@@ -1,50 +1,50 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-broker-core</artifactId>
+    <artifactId>keycloak-broker-core</artifactId>
-    <name>Keycloak Broker Core</name>
+    <name>Keycloak Broker Core</name>
-    <description/>
+    <description/>
-    <packaging>jar</packaging>
+    <packaging>jar</packaging>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-core</artifactId>
+            <artifactId>keycloak-core</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-model-api</artifactId>
+            <artifactId>keycloak-model-api</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-events-api</artifactId>
+            <artifactId>keycloak-events-api</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.jboss.resteasy</groupId>
+            <groupId>org.jboss.resteasy</groupId>
-            <artifactId>resteasy-jaxrs</artifactId>
+            <artifactId>resteasy-jaxrs</artifactId>
-            <exclusions>
+            <exclusions>
-                <exclusion>
+                <exclusion>
-                    <groupId>log4j</groupId>
+                    <groupId>log4j</groupId>
-                    <artifactId>log4j</artifactId>
+                    <artifactId>log4j</artifactId>
-                </exclusion>
+                </exclusion>
-                <exclusion>
+                <exclusion>
-                    <groupId>org.slf4j</groupId>
+                    <groupId>org.slf4j</groupId>
-                    <artifactId>slf4j-api</artifactId>
+                    <artifactId>slf4j-api</artifactId>
-                </exclusion>
+                </exclusion>
-                <exclusion>
+                <exclusion>
-                    <groupId>org.slf4j</groupId>
+                    <groupId>org.slf4j</groupId>
-                    <artifactId>slf4j-simple</artifactId>
+                    <artifactId>slf4j-simple</artifactId>
-                </exclusion>
+                </exclusion>
-            </exclusions>
+            </exclusions>
-        </dependency>
+        </dependency>
-    </dependencies>
+    </dependencies>
-
+
-</project>
+</project>

broker/core/src/main/java/org/keycloak/broker/provider/AbstractIdentityProvider.java

@@ -58,6 +58,11 @@ public abstract class AbstractIdentityProvider<C extends IdentityProviderModel>
         return null;
     }
 
+    @Override
+    public Response performLogin(AuthenticationRequest request) {
+        return null;
+    }
+
     @Override
     public Response keycloakInitiatedBrowserLogout(UserSessionModel userSession, UriInfo uriInfo, RealmModel realm) {
         return null;
@@ -73,6 +78,11 @@ public abstract class AbstractIdentityProvider<C extends IdentityProviderModel>
 
     }
 
+    @Override
+    public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context) {
+
+    }
+
     @Override
     public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context) {
 

broker/core/src/main/java/org/keycloak/broker/provider/AbstractIdentityProviderFactory.java

@@ -18,8 +18,10 @@
 package org.keycloak.broker.provider;
 
 import org.keycloak.Config;
+import org.keycloak.models.IdentityProviderModel;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.RealmModel;
 
 import java.io.InputStream;
 import java.util.HashMap;

broker/core/src/main/java/org/keycloak/broker/provider/AbstractIdentityProviderMapper.java

@@ -1,31 +1,38 @@
-package org.keycloak.broker.provider;
+package org.keycloak.broker.provider;
-
+
-import org.keycloak.broker.provider.IdentityProviderMapper;
+import org.keycloak.broker.provider.IdentityProviderMapper;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.KeycloakSession;
-
+import org.keycloak.models.KeycloakSessionFactory;
-/**
+import org.keycloak.models.RealmModel;
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+
- * @version $Revision: 1 $
+/**
- */
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-public abstract class AbstractIdentityProviderMapper implements IdentityProviderMapper {
+ * @version $Revision: 1 $
-    @Override
+ */
-    public void close() {
+public abstract class AbstractIdentityProviderMapper implements IdentityProviderMapper {
-
+    @Override
-    }
+    public void close() {
-
+
-    @Override
+    }
-    public IdentityProviderMapper create(KeycloakSession session) {
+
-        return null;
+    @Override
-    }
+    public IdentityProviderMapper create(KeycloakSession session) {
-
+        return null;
-    @Override
+    }
-    public void init(org.keycloak.Config.Scope config) {
+
-
+    @Override
-    }
+    public void init(org.keycloak.Config.Scope config) {
-
+
-    @Override
+    }
-    public void postInit(KeycloakSessionFactory factory) {
+
-
+    @Override
-    }
+    public void postInit(KeycloakSessionFactory factory) {
-}
+
+    }
+
+    @Override
+    public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+
+    }
+}

broker/core/src/main/java/org/keycloak/broker/provider/BrokeredIdentityContext.java

@@ -17,6 +17,7 @@
  */
 package org.keycloak.broker.provider;
 
+import org.keycloak.models.ClientSessionModel;
 import org.keycloak.models.IdentityProviderModel;
 
 import java.util.HashMap;
@@ -32,6 +33,7 @@ public class BrokeredIdentityContext {
 
     private String id;
     private String username;
+    private String modelUsername;
     private String email;
     private String firstName;
     private String lastName;
@@ -42,6 +44,7 @@ public class BrokeredIdentityContext {
     private IdentityProviderModel idpConfig;
     private IdentityProvider idp;
     private Map<String, Object> contextData = new HashMap<>();
+    private ClientSessionModel clientSession;
 
     public BrokeredIdentityContext(String id) {
         if (id == null) {
@@ -59,6 +62,11 @@ public class BrokeredIdentityContext {
         this.id = id;
     }
 
+    /**
+     * Username in remote idp
+     *
+     * @return
+     */
     public String getUsername() {
         return username;
     }
@@ -67,6 +75,19 @@ public class BrokeredIdentityContext {
         this.username = username;
     }
 
+    /**
+     * username to store in UserModel
+     *
+     * @return
+     */
+    public String getModelUsername() {
+        return modelUsername;
+    }
+
+    public void setModelUsername(String modelUsername) {
+        this.modelUsername = modelUsername;
+    }
+
     public String getEmail() {
         return email;
     }
@@ -147,6 +168,14 @@ public class BrokeredIdentityContext {
         this.lastName = lastName;
     }
 
+    public ClientSessionModel getClientSession() {
+        return clientSession;
+    }
+
+    public void setClientSession(ClientSessionModel clientSession) {
+        this.clientSession = clientSession;
+    }
+
     public void setName(String name) {
         if (name != null) {
             int i = name.lastIndexOf(' ');

broker/core/src/main/java/org/keycloak/broker/provider/HardcodedAttributeMapper.java

@@ -0,0 +1,89 @@
+package org.keycloak.broker.provider;
+
+import org.keycloak.models.ClientModel;
+import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.RoleModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.provider.ProviderConfigProperty;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class HardcodedAttributeMapper extends AbstractIdentityProviderMapper {
+    public static final String ATTRIBUTE = "attribute";
+    public static final String ATTRIBUTE_VALUE = "attribute.value";
+    protected static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+
+    static {
+        ProviderConfigProperty property;
+        property = new ProviderConfigProperty();
+        property.setName(ATTRIBUTE);
+        property.setLabel("User Attribute");
+        property.setHelpText("Name of user attribute you want to hardcode");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        configProperties.add(property);
+        property = new ProviderConfigProperty();
+        property.setName(ATTRIBUTE_VALUE);
+        property.setLabel("User Attribute Value");
+        property.setHelpText("Value you want to hardcode");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        configProperties.add(property);
+    }
+
+
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        return configProperties;
+    }
+
+    @Override
+    public String getDisplayCategory() {
+        return "Attribute Importer";
+    }
+
+    @Override
+    public String getDisplayType() {
+        return "Hardcoded Attribute";
+    }
+
+    public static final String[] COMPATIBLE_PROVIDERS = {ANY_PROVIDER};
+
+
+    public static final String PROVIDER_ID = "hardcoded-attribute-idp-mapper";
+
+    @Override
+    public String getId() {
+        return PROVIDER_ID;
+    }
+
+    @Override
+    public String[] getCompatibleProviders() {
+        return COMPATIBLE_PROVIDERS;
+    }
+
+    @Override
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String attribute = mapperModel.getConfig().get(ATTRIBUTE);
+        String attributeValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
+        user.setSingleAttribute(attribute, attributeValue);
+    }
+
+    @Override
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String attribute = mapperModel.getConfig().get(ATTRIBUTE);
+        String attributeValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
+        user.setSingleAttribute(attribute, attributeValue);
+    }
+
+    @Override
+    public String getHelpText() {
+        return "When user is imported from provider, hardcode a value to a specific user attribute.";
+    }
+}

broker/core/src/main/java/org/keycloak/broker/provider/HardcodedRoleMapper.java

@@ -1,110 +1,110 @@
-package org.keycloak.broker.provider;
+package org.keycloak.broker.provider;
-
+
-import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.IdentityBrokerException;
-import org.keycloak.models.ClientModel;
+import org.keycloak.models.ClientModel;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.RoleModel;
+import org.keycloak.models.RoleModel;
-import org.keycloak.models.UserModel;
+import org.keycloak.models.UserModel;
-import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigProperty;
-
+
-import java.util.ArrayList;
+import java.util.ArrayList;
-import java.util.List;
+import java.util.List;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class HardcodedRoleMapper extends AbstractIdentityProviderMapper {
+public class HardcodedRoleMapper extends AbstractIdentityProviderMapper {
-    public static final String ROLE = "role";
+    public static final String ROLE = "role";
-    protected static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    protected static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-
+
-    static {
+    static {
-        ProviderConfigProperty property;
+        ProviderConfigProperty property;
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(ROLE);
+        property.setName(ROLE);
-        property.setLabel("Role");
+        property.setLabel("Role");
-        property.setHelpText("Role to grant to user.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
+        property.setHelpText("Role to grant to user.  Click 'Select Role' button to browse roles, or just type it in the textbox.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.ROLE_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-    }
+    }
-
+
-
+
-
+
-    public static String[] parseRole(String role) {
+    public static String[] parseRole(String role) {
-        int scopeIndex = role.indexOf('.');
+        int scopeIndex = role.lastIndexOf('.');
-        if (scopeIndex > -1) {
+        if (scopeIndex > -1) {
-            String appName = role.substring(0, scopeIndex);
+            String appName = role.substring(0, scopeIndex);
-            role = role.substring(scopeIndex + 1);
+            role = role.substring(scopeIndex + 1);
-            String[] rtn = {appName, role};
+            String[] rtn = {appName, role};
-            return rtn;
+            return rtn;
-        } else {
+        } else {
-            String[] rtn = {null, role};
+            String[] rtn = {null, role};
-            return rtn;
+            return rtn;
-
+
-        }
+        }
-    }
+    }
-
+
-    public static RoleModel getRoleFromString(RealmModel realm, String roleName) {
+    public static RoleModel getRoleFromString(RealmModel realm, String roleName) {
-        String[] parsedRole = parseRole(roleName);
+        String[] parsedRole = parseRole(roleName);
-        RoleModel role = null;
+        RoleModel role = null;
-        if (parsedRole[0] == null) {
+        if (parsedRole[0] == null) {
-            role = realm.getRole(parsedRole[1]);
+            role = realm.getRole(parsedRole[1]);
-        } else {
+        } else {
-            ClientModel client = realm.getClientByClientId(parsedRole[0]);
+            ClientModel client = realm.getClientByClientId(parsedRole[0]);
-            role = client.getRole(parsedRole[1]);
+            role = client.getRole(parsedRole[1]);
-        }
+        }
-        return role;
+        return role;
-    }
+    }
-
+
-    @Override
+    @Override
-    public List<ProviderConfigProperty> getConfigProperties() {
+    public List<ProviderConfigProperty> getConfigProperties() {
-        return configProperties;
+        return configProperties;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayCategory() {
+    public String getDisplayCategory() {
-        return "Role Importer";
+        return "Role Importer";
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayType() {
+    public String getDisplayType() {
-        return "Hardcoded Role";
+        return "Hardcoded Role";
-    }
+    }
-
+
-    public static final String[] COMPATIBLE_PROVIDERS = {ANY_PROVIDER};
+    public static final String[] COMPATIBLE_PROVIDERS = {ANY_PROVIDER};
-
+
-
+
-    public static final String PROVIDER_ID = "oidc-hardcoded-role-idp-mapper";
+    public static final String PROVIDER_ID = "oidc-hardcoded-role-idp-mapper";
-
+
-    @Override
+    @Override
-    public String getId() {
+    public String getId() {
-        return PROVIDER_ID;
+        return PROVIDER_ID;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String[] getCompatibleProviders() {
+    public String[] getCompatibleProviders() {
-        return COMPATIBLE_PROVIDERS;
+        return COMPATIBLE_PROVIDERS;
-    }
+    }
-
+
-    @Override
+    @Override
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String roleName = mapperModel.getConfig().get(ROLE);
+        String roleName = mapperModel.getConfig().get(ROLE);
-        RoleModel role = getRoleFromString(realm, roleName);
+        RoleModel role = getRoleFromString(realm, roleName);
-        if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+        if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-        user.grantRole(role);
+        user.grantRole(role);
-    }
+    }
-
+
-    @Override
+    @Override
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-
+
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getHelpText() {
+    public String getHelpText() {
-        return "When user is imported from provider, hardcode a role mapping for it.";
+        return "When user is imported from provider, hardcode a role mapping for it.";
-    }
+    }
-}
+}

broker/core/src/main/java/org/keycloak/broker/provider/HardcodedUserSessionAttributeMapper.java

@@ -0,0 +1,87 @@
+package org.keycloak.broker.provider;
+
+import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.provider.ProviderConfigProperty;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class HardcodedUserSessionAttributeMapper extends AbstractIdentityProviderMapper {
+    public static final String ATTRIBUTE = "attribute";
+    public static final String ATTRIBUTE_VALUE = "attribute.value";
+    protected static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+
+    static {
+        ProviderConfigProperty property;
+        property = new ProviderConfigProperty();
+        property.setName(ATTRIBUTE);
+        property.setLabel("User Session Attribute");
+        property.setHelpText("Name of user session attribute you want to hardcode");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        configProperties.add(property);
+        property = new ProviderConfigProperty();
+        property.setName(ATTRIBUTE_VALUE);
+        property.setLabel("User Session Attribute Value");
+        property.setHelpText("Value you want to hardcode");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        configProperties.add(property);
+    }
+
+
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        return configProperties;
+    }
+
+    @Override
+    public String getDisplayCategory() {
+        return "Attribute Importer";
+    }
+
+    @Override
+    public String getDisplayType() {
+        return "Hardcoded User Session Attribute";
+    }
+
+    public static final String[] COMPATIBLE_PROVIDERS = {ANY_PROVIDER};
+
+
+    public static final String PROVIDER_ID = "hardcoded-user-session-attribute-idp-mapper";
+
+    @Override
+    public String getId() {
+        return PROVIDER_ID;
+    }
+
+    @Override
+    public String[] getCompatibleProviders() {
+        return COMPATIBLE_PROVIDERS;
+    }
+
+    @Override
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String attribute = mapperModel.getConfig().get(ATTRIBUTE);
+        String attributeValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
+        context.getClientSession().setUserSessionNote(attribute, attributeValue);
+    }
+
+    @Override
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String attribute = mapperModel.getConfig().get(ATTRIBUTE);
+        String attributeValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
+        context.getClientSession().setUserSessionNote(attribute, attributeValue);
+    }
+
+    @Override
+    public String getHelpText() {
+        return "When user is imported from provider, hardcode a value to a specific user session attribute.";
+    }
+}

broker/core/src/main/java/org/keycloak/broker/provider/IdentityProvider.java

@@ -20,6 +20,7 @@ package org.keycloak.broker.provider;
 import org.keycloak.events.EventBuilder;
 import org.keycloak.models.ClientSessionModel;
 import org.keycloak.models.FederatedIdentityModel;
+import org.keycloak.models.IdentityProviderMapperModel;
 import org.keycloak.models.IdentityProviderModel;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.RealmModel;
@@ -35,7 +36,7 @@ import javax.ws.rs.core.UriInfo;
  */
 public interface IdentityProvider<C extends IdentityProviderModel> extends Provider {
 
-    public interface AuthenticationCallback {
+    interface AuthenticationCallback {
         /**
          * This method should be called by provider after the JAXRS callback endpoint has finished authentication
          * with the remote IDP
@@ -43,9 +44,15 @@ public interface IdentityProvider<C extends IdentityProviderModel> extends Provi
          * @param context
          * @return
          */
-        public Response authenticated(BrokeredIdentityContext context);
+        Response authenticated(BrokeredIdentityContext context);
+
+        Response cancelled(String code);
+
+        Response error(String code, String message);
     }
 
+
+    void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context);
     void attachUserSession(UserSessionModel userSession, ClientSessionModel clientSession, BrokeredIdentityContext context);
     void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context);
     void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context);

broker/core/src/main/java/org/keycloak/broker/provider/IdentityProviderFactory.java

@@ -18,6 +18,8 @@
 package org.keycloak.broker.provider;
 
 import org.keycloak.models.IdentityProviderModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
 import org.keycloak.provider.ProviderFactory;
 
 import java.io.InputStream;

broker/core/src/main/java/org/keycloak/broker/provider/IdentityProviderMapper.java

@@ -1,26 +1,56 @@
-package org.keycloak.broker.provider;
+package org.keycloak.broker.provider;
-
+
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.UserModel;
+import org.keycloak.models.UserModel;
-import org.keycloak.provider.ConfiguredProvider;
+import org.keycloak.provider.ConfiguredProvider;
-import org.keycloak.provider.Provider;
+import org.keycloak.provider.Provider;
-import org.keycloak.provider.ProviderFactory;
+import org.keycloak.provider.ProviderFactory;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public interface IdentityProviderMapper extends Provider, ProviderFactory<IdentityProviderMapper>,ConfiguredProvider {
+public interface IdentityProviderMapper extends Provider, ProviderFactory<IdentityProviderMapper>,ConfiguredProvider {
-    public static final String ANY_PROVIDER = "*";
+    public static final String ANY_PROVIDER = "*";
-
+
-    String[] getCompatibleProviders();
+    String[] getCompatibleProviders();
-    String getDisplayCategory();
+    String getDisplayCategory();
-    String getDisplayType();
+    String getDisplayType();
-
+
-    void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context);
+    /**
-    void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context);
+     * Called to determine what keycloak username and email to use to process the login request from the external IDP
-
+     * Usually used to map BrokeredIdentityContet.username or email.
-
+     *
-}
+     * @param session
+     * @param realm
+     * @param mapperModel
+     * @param context
+     */
+    void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context);
+
+    /**
+     * Called after UserModel is created for first time for this user.
+     *
+     * @param session
+     * @param realm
+     * @param user
+     * @param mapperModel
+     * @param context
+     */
+    void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context);
+
+    /**
+     * Called when this user has logged in before and has already been imported.
+     *
+     * @param session
+     * @param realm
+     * @param user
+     * @param mapperModel
+     * @param context
+     */
+    void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context);
+
+
+}

broker/core/src/main/java/org/keycloak/broker/provider/IdentityProviderMapperSpi.java

@@ -9,6 +9,11 @@ import org.keycloak.provider.Spi;
  */
 public class IdentityProviderMapperSpi implements Spi {
 
+    @Override
+    public boolean isInternal() {
+        return true;
+    }
+
     @Override
     public String getName() {
         return "identity-provider-mapper";

broker/core/src/main/java/org/keycloak/broker/provider/IdentityProviderSpi.java

@@ -28,6 +28,11 @@ public class IdentityProviderSpi implements Spi {
 
     public static final String IDENTITY_PROVIDER_SPI_NAME = "identity_provider";
 
+    @Override
+    public boolean isInternal() {
+        return false;
+    }
+
     @Override
     public String getName() {
         return IDENTITY_PROVIDER_SPI_NAME;

broker/core/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderMapper

@@ -1 +1,3 @@
-org.keycloak.broker.provider.HardcodedRoleMapper
+org.keycloak.broker.provider.HardcodedRoleMapper
+org.keycloak.broker.provider.HardcodedAttributeMapper
+org.keycloak.broker.provider.HardcodedUserSessionAttributeMapper

broker/core/src/main/resources/META-INF/services/org.keycloak.provider.Spi

@@ -1,2 +1,2 @@
-org.keycloak.broker.provider.IdentityProviderSpi
+org.keycloak.broker.provider.IdentityProviderSpi
 org.keycloak.broker.provider.IdentityProviderMapperSpi

broker/oidc/pom.xml

@@ -1,58 +1,58 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-broker-oidc</artifactId>
+    <artifactId>keycloak-broker-oidc</artifactId>
-    <name>Keycloak Broker - OpenID Connect Identity Provider</name>
+    <name>Keycloak Broker - OpenID Connect Identity Provider</name>
-    <description/>
+    <description/>
-    <packaging>jar</packaging>
+    <packaging>jar</packaging>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-core</artifactId>
+            <artifactId>keycloak-core</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-broker-core</artifactId>
+            <artifactId>keycloak-broker-core</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.codehaus.jackson</groupId>
+            <groupId>org.codehaus.jackson</groupId>
-            <artifactId>jackson-core-asl</artifactId>
+            <artifactId>jackson-core-asl</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.codehaus.jackson</groupId>
+            <groupId>org.codehaus.jackson</groupId>
-            <artifactId>jackson-mapper-asl</artifactId>
+            <artifactId>jackson-mapper-asl</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-events-api</artifactId>
+            <artifactId>keycloak-events-api</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-services</artifactId>
+            <artifactId>keycloak-services</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.jboss.logging</groupId>
+            <groupId>org.jboss.logging</groupId>
-            <artifactId>jboss-logging</artifactId>
+            <artifactId>jboss-logging</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>junit</groupId>
+            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <artifactId>junit</artifactId>
-            <scope>test</scope>
+            <scope>test</scope>
-        </dependency>
+        </dependency>
-    </dependencies>
+    </dependencies>
-
+
-</project>
+</project>

broker/oidc/src/main/java/org/keycloak/broker/oidc/AbstractOAuth2IdentityProvider.java

@@ -20,7 +20,7 @@ package org.keycloak.broker.oidc;
 import org.codehaus.jackson.JsonNode;
 import org.codehaus.jackson.map.ObjectMapper;
 import org.jboss.logging.Logger;
-import org.keycloak.ClientConnection;
+import org.keycloak.common.ClientConnection;
 import org.keycloak.OAuth2Constants;
 import org.keycloak.broker.provider.util.SimpleHttp;
 import org.keycloak.broker.provider.AbstractIdentityProvider;
@@ -58,6 +58,7 @@ public abstract class AbstractOAuth2IdentityProvider<C extends OAuth2IdentityPro
     public static final String FEDERATED_ACCESS_TOKEN = "FEDERATED_ACCESS_TOKEN";
     public static final String FEDERATED_REFRESH_TOKEN = "FEDERATED_REFRESH_TOKEN";
     public static final String FEDERATED_TOKEN_EXPIRATION = "FEDERATED_TOKEN_EXPIRATION";
+    public static final String ACCESS_DENIED = "access_denied";
     protected static ObjectMapper mapper = new ObjectMapper();
 
     public static final String OAUTH2_PARAMETER_ACCESS_TOKEN = "access_token";
@@ -213,9 +214,11 @@ public abstract class AbstractOAuth2IdentityProvider<C extends OAuth2IdentityPro
                                      @QueryParam(OAuth2Constants.ERROR) String error) {
             if (error != null) {
                 //logger.error("Failed " + getConfig().getAlias() + " broker login: " + error);
-                event.event(EventType.LOGIN);
+                if (error.equals(ACCESS_DENIED)) {
-                event.error(error);
+                    return callback.cancelled(state);
-                return ErrorPage.error(session, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
+                } else {
+                    return callback.error(state, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
+                }
             }
 
             try {

broker/oidc/src/main/java/org/keycloak/broker/oidc/KeycloakOIDCIdentityProvider.java

@@ -1,114 +1,114 @@
-package org.keycloak.broker.oidc;
+package org.keycloak.broker.oidc;
-
+
-import org.keycloak.broker.provider.util.SimpleHttp;
+import org.keycloak.broker.provider.util.SimpleHttp;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.constants.AdapterConstants;
+import org.keycloak.constants.AdapterConstants;
-import org.keycloak.events.EventBuilder;
+import org.keycloak.events.EventBuilder;
-import org.keycloak.jose.jws.JWSInput;
+import org.keycloak.jose.jws.JWSInput;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.UserSessionModel;
+import org.keycloak.models.UserSessionModel;
-import org.keycloak.representations.AccessTokenResponse;
+import org.keycloak.representations.AccessTokenResponse;
-import org.keycloak.representations.JsonWebToken;
+import org.keycloak.representations.JsonWebToken;
-import org.keycloak.representations.adapters.action.AdminAction;
+import org.keycloak.representations.adapters.action.AdminAction;
-import org.keycloak.representations.adapters.action.LogoutAction;
+import org.keycloak.representations.adapters.action.LogoutAction;
-import org.keycloak.services.managers.AuthenticationManager;
+import org.keycloak.services.managers.AuthenticationManager;
-import org.keycloak.util.JsonSerialization;
+import org.keycloak.util.JsonSerialization;
-
+
-import javax.ws.rs.POST;
+import javax.ws.rs.POST;
-import javax.ws.rs.Path;
+import javax.ws.rs.Path;
-import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response;
-import java.io.IOException;
+import java.io.IOException;
-import java.security.PublicKey;
+import java.security.PublicKey;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class KeycloakOIDCIdentityProvider extends OIDCIdentityProvider {
+public class KeycloakOIDCIdentityProvider extends OIDCIdentityProvider {
-
+
-    public static final String VALIDATED_ACCESS_TOKEN = "VALIDATED_ACCESS_TOKEN";
+    public static final String VALIDATED_ACCESS_TOKEN = "VALIDATED_ACCESS_TOKEN";
-
+
-    public KeycloakOIDCIdentityProvider(OIDCIdentityProviderConfig config) {
+    public KeycloakOIDCIdentityProvider(OIDCIdentityProviderConfig config) {
-        super(config);
+        super(config);
-    }
+    }
-
+
-    @Override
+    @Override
-    public Object callback(RealmModel realm, AuthenticationCallback callback, EventBuilder event) {
+    public Object callback(RealmModel realm, AuthenticationCallback callback, EventBuilder event) {
-        return new KeycloakEndpoint(callback, realm, event);
+        return new KeycloakEndpoint(callback, realm, event);
-    }
+    }
-
+
-    @Override
+    @Override
-    protected void processAccessTokenResponse(BrokeredIdentityContext context, PublicKey idpKey, AccessTokenResponse response) {
+    protected void processAccessTokenResponse(BrokeredIdentityContext context, PublicKey idpKey, AccessTokenResponse response) {
-        JsonWebToken access = validateToken(idpKey, response.getToken());
+        JsonWebToken access = validateToken(idpKey, response.getToken());
-        context.getContextData().put(VALIDATED_ACCESS_TOKEN, access);
+        context.getContextData().put(VALIDATED_ACCESS_TOKEN, access);
-    }
+    }
-
+
-    protected class KeycloakEndpoint extends OIDCEndpoint {
+    protected class KeycloakEndpoint extends OIDCEndpoint {
-        public KeycloakEndpoint(AuthenticationCallback callback, RealmModel realm, EventBuilder event) {
+        public KeycloakEndpoint(AuthenticationCallback callback, RealmModel realm, EventBuilder event) {
-            super(callback, realm, event);
+            super(callback, realm, event);
-        }
+        }
-
+
-        @POST
+        @POST
-        @Path(AdapterConstants.K_LOGOUT)
+        @Path(AdapterConstants.K_LOGOUT)
-        public Response backchannelLogout(String input) {
+        public Response backchannelLogout(String input) {
-            JWSInput token = new JWSInput(input);
+            JWSInput token = new JWSInput(input);
-            PublicKey key = getExternalIdpKey();
+            PublicKey key = getExternalIdpKey();
-            if (key != null) {
+            if (key != null) {
-                if (!verify(token, key)) {
+                if (!verify(token, key)) {
-                    logger.warn("Failed to verify logout request");
+                    logger.warn("Failed to verify logout request");
-                    return Response.status(400).build();
+                    return Response.status(400).build();
-                }
+                }
-            }
+            }
-            LogoutAction action = null;
+            LogoutAction action = null;
-            try {
+            try {
-                action = JsonSerialization.readValue(token.getContent(), LogoutAction.class);
+                action = JsonSerialization.readValue(token.getContent(), LogoutAction.class);
-            } catch (IOException e) {
+            } catch (IOException e) {
-                throw new RuntimeException(e);
+                throw new RuntimeException(e);
-            }
+            }
-            if (!validateAction(action)) return Response.status(400).build();
+            if (!validateAction(action)) return Response.status(400).build();
-            if (action.getKeycloakSessionIds() != null) {
+            if (action.getKeycloakSessionIds() != null) {
-                for (String sessionId : action.getKeycloakSessionIds()) {
+                for (String sessionId : action.getKeycloakSessionIds()) {
-                    String brokerSessionId = getConfig().getAlias() + "." + sessionId;
+                    String brokerSessionId = getConfig().getAlias() + "." + sessionId;
-                    UserSessionModel userSession = session.sessions().getUserSessionByBrokerSessionId(realm, brokerSessionId);
+                    UserSessionModel userSession = session.sessions().getUserSessionByBrokerSessionId(realm, brokerSessionId);
-                    if (userSession != null
+                    if (userSession != null
-                            && userSession.getState() != UserSessionModel.State.LOGGING_OUT
+                            && userSession.getState() != UserSessionModel.State.LOGGING_OUT
-                            && userSession.getState() != UserSessionModel.State.LOGGED_OUT
+                            && userSession.getState() != UserSessionModel.State.LOGGED_OUT
-                            ) {
+                            ) {
-                        AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
+                        AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
-                    }
+                    }
-                }
+                }
-
+
-            }
+            }
-            return Response.ok().build();
+            return Response.ok().build();
-        }
+        }
-
+
-        protected boolean validateAction(AdminAction action)  {
+        protected boolean validateAction(AdminAction action)  {
-            if (!action.validate()) {
+            if (!action.validate()) {
-                logger.warn("admin request failed, not validated" + action.getAction());
+                logger.warn("admin request failed, not validated" + action.getAction());
-                return false;
+                return false;
-            }
+            }
-            if (action.isExpired()) {
+            if (action.isExpired()) {
-                logger.warn("admin request failed, expired token");
+                logger.warn("admin request failed, expired token");
-                return false;
+                return false;
-            }
+            }
-            if (!getConfig().getClientId().equals(action.getResource())) {
+            if (!getConfig().getClientId().equals(action.getResource())) {
-                logger.warn("Resource name does not match");
+                logger.warn("Resource name does not match");
-                return false;
+                return false;
-
+
-            }
+            }
-            return true;
+            return true;
-        }
+        }
-
+
-        @Override
+        @Override
-        public SimpleHttp generateTokenRequest(String authorizationCode) {
+        public SimpleHttp generateTokenRequest(String authorizationCode) {
-            return super.generateTokenRequest(authorizationCode)
+            return super.generateTokenRequest(authorizationCode)
-                    .param(AdapterConstants.CLIENT_SESSION_STATE, "n/a");  // hack to get backchannel logout to work
+                    .param(AdapterConstants.CLIENT_SESSION_STATE, "n/a");  // hack to get backchannel logout to work
-
+
-        }
+        }
-
+
-
+
-
+
-    }
+    }
-
+
-
+
-}
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/KeycloakOIDCIdentityProviderFactory.java

@@ -17,10 +17,15 @@
  */
 package org.keycloak.broker.oidc;
 
+import org.keycloak.broker.oidc.mappers.UsernameTemplateMapper;
 import org.keycloak.broker.provider.AbstractIdentityProviderFactory;
+import org.keycloak.models.IdentityProviderMapperModel;
 import org.keycloak.models.IdentityProviderModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
 
 import java.io.InputStream;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -50,4 +55,5 @@ public class KeycloakOIDCIdentityProviderFactory extends AbstractIdentityProvide
         return OIDCIdentityProviderFactory.parseOIDCConfig(inputStream);
 
     }
-}
+
+ }

broker/oidc/src/main/java/org/keycloak/broker/oidc/OIDCIdentityProvider.java

@@ -19,6 +19,7 @@ package org.keycloak.broker.oidc;
 
 import org.codehaus.jackson.JsonNode;
 import org.jboss.logging.Logger;
+import org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper;
 import org.keycloak.broker.oidc.util.JsonSimpleHttp;
 import org.keycloak.broker.provider.util.SimpleHttp;
 import org.keycloak.broker.provider.AuthenticationRequest;
@@ -41,7 +42,7 @@ import org.keycloak.services.messages.Messages;
 import org.keycloak.services.resources.IdentityBrokerService;
 import org.keycloak.services.resources.RealmsResource;
 import org.keycloak.util.JsonSerialization;
-import org.keycloak.util.PemUtils;
+import org.keycloak.common.util.PemUtils;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -50,6 +51,7 @@ import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.UriBuilder;
 import javax.ws.rs.core.UriInfo;
+
 import java.io.IOException;
 import java.security.PublicKey;
 
@@ -224,7 +226,7 @@ public class OIDCIdentityProvider extends AbstractOAuth2IdentityProvider<OIDCIde
                 name = getJsonProperty(userInfo, "name");
                 preferredUsername = getJsonProperty(userInfo, "preferred_username");
                 email = getJsonProperty(userInfo, "email");
-                identity.getContextData().put(USER_INFO, userInfo);
+                AbstractJsonUserAttributeMapper.storeUserProfileForMapper(identity, userInfo, getConfig().getAlias());
             }
             identity.getContextData().put(FEDERATED_ACCESS_TOKEN_RESPONSE, tokenResponse);
             identity.getContextData().put(VALIDATED_ID_TOKEN, idToken);
@@ -287,10 +289,9 @@ public class OIDCIdentityProvider extends AbstractOAuth2IdentityProvider<OIDCIde
             }
             JsonWebToken token = jws.readJsonContent(JsonWebToken.class);
 
-            String aud = token.getAudience();
             String iss = token.getIssuer();
 
-            if (aud != null && !aud.equals(getConfig().getClientId())) {
+            if (!token.hasAudience(getConfig().getClientId())) {
                 throw new IdentityBrokerException("Wrong audience from token.");
             }
 

broker/oidc/src/main/java/org/keycloak/broker/oidc/OIDCIdentityProviderFactory.java

@@ -17,11 +17,15 @@
  */
 package org.keycloak.broker.oidc;
 
+import org.keycloak.broker.oidc.mappers.UsernameTemplateMapper;
 import org.keycloak.broker.provider.util.SimpleHttp;
 import org.keycloak.broker.provider.AbstractIdentityProviderFactory;
 import org.keycloak.jose.jwk.JWK;
 import org.keycloak.jose.jwk.JWKParser;
+import org.keycloak.models.IdentityProviderMapperModel;
 import org.keycloak.models.IdentityProviderModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
 import org.keycloak.models.utils.KeycloakModelUtils;
 import org.keycloak.protocol.oidc.representations.JSONWebKeySet;
 import org.keycloak.protocol.oidc.representations.OIDCConfigurationRepresentation;
@@ -30,6 +34,7 @@ import org.keycloak.util.JsonSerialization;
 import java.io.IOException;
 import java.io.InputStream;
 import java.security.PublicKey;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -89,7 +94,7 @@ public class OIDCIdentityProviderFactory extends AbstractIdentityProviderFactory
 
                 }
             } catch (IOException e) {
-                throw new RuntimeException("F   ailed to query JWKSet from: " + uri, e);
+                throw new RuntimeException("Failed to query JWKSet from: " + uri, e);
             }
 
         }
@@ -99,4 +104,5 @@ public class OIDCIdentityProviderFactory extends AbstractIdentityProviderFactory
     protected static boolean keyTypeSupported(String type) {
         return type != null && type.equals("RSA");
     }
+
 }

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/AbstractClaimMapper.java

@@ -1,93 +1,97 @@
-package org.keycloak.broker.oidc.mappers;
+package org.keycloak.broker.oidc.mappers;
-
+
-import org.keycloak.broker.oidc.KeycloakOIDCIdentityProvider;
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProvider;
-import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigProperty;
-import org.keycloak.representations.JsonWebToken;
+import org.keycloak.representations.JsonWebToken;
-
+
-import java.util.List;
+import java.util.List;
-import java.util.Map;
+import java.util.Map;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public abstract class AbstractClaimMapper extends AbstractIdentityProviderMapper {
+public abstract class AbstractClaimMapper extends AbstractIdentityProviderMapper {
-    public static final String CLAIM = "claim";
+    public static final String CLAIM = "claim";
-    public static final String CLAIM_VALUE = "claim.value";
+    public static final String CLAIM_VALUE = "claim.value";
-
+
-    public static Object getClaimValue(JsonWebToken token, String claim) {
+    public static Object getClaimValue(JsonWebToken token, String claim) {
-        String[] split = claim.split("\\.");
+        String[] split = claim.split("\\.");
-        Map<String, Object> jsonObject = token.getOtherClaims();
+        Map<String, Object> jsonObject = token.getOtherClaims();
-        for (int i = 0; i < split.length; i++) {
+        for (int i = 0; i < split.length; i++) {
-            if (i == split.length - 1) {
+            if (i == split.length - 1) {
-                return jsonObject.get(split[i]);
+                return jsonObject.get(split[i]);
-            } else {
+            } else {
-                Object val = jsonObject.get(split[i]);
+                Object val = jsonObject.get(split[i]);
-                if (!(val instanceof Map)) return null;
+                if (!(val instanceof Map)) return null;
-                jsonObject = (Map<String, Object>)val;
+                jsonObject = (Map<String, Object>)val;
-            }
+            }
-        }
+        }
-        return null;
+        return null;
-    }
+    }
-
+
-    protected Object getClaimValue(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public static Object getClaimValue(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String claim = mapperModel.getConfig().get(CLAIM);
+        String claim = mapperModel.getConfig().get(CLAIM);
-        {  // search access token
+        return getClaimValue(context, claim);
-            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ACCESS_TOKEN);
+    }
-            if (token != null) {
+
-                Object value = getClaimValue(token, claim);
+    public static Object getClaimValue(BrokeredIdentityContext context, String claim) {
-                if (value != null) return value;
+        {  // search access token
-            }
+            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ACCESS_TOKEN);
-
+            if (token != null) {
-        }
+                Object value = getClaimValue(token, claim);
-        {  // search ID Token
+                if (value != null) return value;
-            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ID_TOKEN);
+            }
-            if (token != null) {
+
-                Object value = getClaimValue(token, claim);
+        }
-                if (value != null) return value;
+        {  // search ID Token
-            }
+            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ID_TOKEN);
-
+            if (token != null) {
-        }
+                Object value = getClaimValue(token, claim);
-        return null;
+                if (value != null) return value;
-    }
+            }
-
+
-
+        }
-    protected boolean hasClaimValue(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        return null;
-        Object value = getClaimValue(mapperModel, context);
+    }
-        String desiredValue = mapperModel.getConfig().get(CLAIM_VALUE);
+
-        return valueEquals(desiredValue, value);
+
-    }
+    protected boolean hasClaimValue(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-
+        Object value = getClaimValue(mapperModel, context);
-    public boolean valueEquals(String desiredValue, Object value) {
+        String desiredValue = mapperModel.getConfig().get(CLAIM_VALUE);
-        if (value instanceof String) {
+        return valueEquals(desiredValue, value);
-            if (desiredValue.equals(value)) return true;
+    }
-        } else if (value instanceof Double) {
+
-            try {
+    public boolean valueEquals(String desiredValue, Object value) {
-                if (Double.valueOf(desiredValue).equals(value)) return true;
+        if (value instanceof String) {
-            } catch (Exception e) {
+            if (desiredValue.equals(value)) return true;
-
+        } else if (value instanceof Double) {
-            }
+            try {
-        } else if (value instanceof Integer) {
+                if (Double.valueOf(desiredValue).equals(value)) return true;
-            try {
+            } catch (Exception e) {
-                if (Integer.valueOf(desiredValue).equals(value)) return true;
+
-            } catch (Exception e) {
+            }
-
+        } else if (value instanceof Integer) {
-            }
+            try {
-        } else if (value instanceof Boolean) {
+                if (Integer.valueOf(desiredValue).equals(value)) return true;
-            try {
+            } catch (Exception e) {
-                if (Boolean.valueOf(desiredValue).equals(value)) return true;
+
-            } catch (Exception e) {
+            }
-
+        } else if (value instanceof Boolean) {
-            }
+            try {
-        } else if (value instanceof List) {
+                if (Boolean.valueOf(desiredValue).equals(value)) return true;
-            List list = (List)value;
+            } catch (Exception e) {
-            for (Object val : list) {
+
-                return valueEquals(desiredValue, val);
+            }
-            }
+        } else if (value instanceof List) {
-        }
+            List list = (List)value;
-        return false;
+            for (Object val : list) {
-    }
+                return valueEquals(desiredValue, val);
-}
+            }
+        }
+        return false;
+    }
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/AbstractJsonUserAttributeMapper.java

@@ -0,0 +1,206 @@
+package org.keycloak.broker.oidc.mappers;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.codehaus.jackson.JsonNode;
+import org.jboss.logging.Logger;
+import org.keycloak.broker.oidc.OIDCIdentityProvider;
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.provider.ProviderConfigProperty;
+
+/**
+ * Abstract class for Social Provider mappers which allow mapping of JSON user profile field into Keycloak user
+ * attribute. Concrete mapper classes with own ID and provider mapping must be implemented for each social provider who
+ * uses {@link JsonNode} user profile.
+ * 
+ * @author Vlastimil Elias (velias at redhat dot com)
+ */
+public abstract class AbstractJsonUserAttributeMapper extends AbstractIdentityProviderMapper {
+
+
+	protected static final Logger logger = Logger.getLogger(AbstractJsonUserAttributeMapper.class);
+
+	protected static final Logger LOGGER_DUMP_USER_PROFILE = Logger.getLogger("org.keycloak.social.user_profile_dump");
+
+	private static final String JSON_PATH_DELIMITER = ".";
+
+	/**
+	 * Config param where name of mapping source JSON User Profile field is stored.
+	 */
+	public static final String CONF_JSON_FIELD = "jsonField";
+	/**
+	 * Config param where name of mapping target USer attribute is stored.
+	 */
+	public static final String CONF_USER_ATTRIBUTE = "userAttribute";
+
+	/**
+	 * Key in {@link BrokeredIdentityContext#getContextData()} where {@link JsonNode} with user profile is stored.
+	 */
+	public static final String CONTEXT_JSON_NODE = OIDCIdentityProvider.USER_INFO;
+
+	private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+
+	static {
+		ProviderConfigProperty property;
+		ProviderConfigProperty property1;
+		property1 = new ProviderConfigProperty();
+		property1.setName(CONF_JSON_FIELD);
+		property1.setLabel("Social Profile JSON Field Path");
+		property1.setHelpText("Path of field in Social provider User Profile JSON data to get value from. You can use dot notation for nesting and square brackets for array index. Eg. 'contact.address[0].country'.");
+		property1.setType(ProviderConfigProperty.STRING_TYPE);
+		configProperties.add(property1);
+		property = new ProviderConfigProperty();
+		property.setName(CONF_USER_ATTRIBUTE);
+		property.setLabel("User Attribute Name");
+		property.setHelpText("User attribute name to store information into.");
+		property.setType(ProviderConfigProperty.STRING_TYPE);
+		configProperties.add(property);
+	}
+
+	/**
+	 * Store used profile JsonNode into user context for later use by this mapper. Profile data are dumped into special logger if enabled also to allow investigation of the structure. 
+	 * 
+	 * @param user context to store profile data into
+	 * @param profile to store into context
+	 * @param provider identification of social provider to be used in log dump
+	 * 
+	 * @see #importNewUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext)
+	 * @see BrokeredIdentityContext#getContextData()
+	 */
+	public static void storeUserProfileForMapper(BrokeredIdentityContext user, JsonNode profile, String provider) {
+		user.getContextData().put(AbstractJsonUserAttributeMapper.CONTEXT_JSON_NODE, profile);
+		if (LOGGER_DUMP_USER_PROFILE.isDebugEnabled())
+			LOGGER_DUMP_USER_PROFILE.debug("User Profile JSON Data for provider "+provider+": " + profile);
+	}
+
+	@Override
+	public List<ProviderConfigProperty> getConfigProperties() {
+		return configProperties;
+	}
+
+	@Override
+	public String getDisplayCategory() {
+		return "Attribute Importer";
+	}
+
+	@Override
+	public String getDisplayType() {
+		return "Attribute Importer";
+	}
+
+	@Override
+	public String getHelpText() {
+		return "Import user profile information if it exists in Social provider JSON data into the specified user attribute.";
+	}
+
+	@Override
+	public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+		String attribute = mapperModel.getConfig().get(CONF_USER_ATTRIBUTE);
+		if (attribute == null || attribute.trim().isEmpty()) {
+			logger.debug("Attribute is not configured");
+			return;
+		}
+		attribute = attribute.trim();
+
+		String value = getJsonValue(mapperModel, context);
+		if (value != null) {
+			user.setSingleAttribute(attribute, value);
+		}
+	}
+
+	@Override
+	public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+		// we do not update user profile from social provider
+	}
+
+	protected static String getJsonValue(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+
+		String jsonField = mapperModel.getConfig().get(CONF_JSON_FIELD);
+		if (jsonField == null || jsonField.trim().isEmpty()) {
+			logger.debug("JSON field path is not configured");
+			return null;
+		}
+		jsonField = jsonField.trim();
+
+		if (jsonField.startsWith(JSON_PATH_DELIMITER) || jsonField.endsWith(JSON_PATH_DELIMITER) || jsonField.startsWith("[")) {
+			logger.debug("JSON field path is invalid " + jsonField);
+			return null;
+		}
+
+		JsonNode profileJsonNode = (JsonNode) context.getContextData().get(CONTEXT_JSON_NODE);
+
+		String value = getJsonValue(profileJsonNode, jsonField);
+
+		if (value == null) {
+			logger.debug("User profile JSON value '" + jsonField + "' is not available.");
+		}
+
+		return value;
+	}
+
+	protected static String getJsonValue(JsonNode baseNode, String fieldPath) {
+		logger.debug("Going to process JsonNode path " + fieldPath + " on data " + baseNode);
+		if (baseNode != null) {
+
+			int idx = fieldPath.indexOf(JSON_PATH_DELIMITER);
+
+			String currentFieldName = fieldPath;
+			if (idx > 0) {
+				currentFieldName = fieldPath.substring(0, idx).trim();
+				if (currentFieldName.isEmpty()) {
+					logger.debug("JSON path is invalid " + fieldPath);
+					return null;
+				}
+			}
+
+			String currentNodeName = currentFieldName;
+			int arrayIndex = -1;
+			if (currentFieldName.endsWith("]")) {
+				int bi = currentFieldName.indexOf("[");
+				if (bi == -1) {
+					logger.debug("Invalid array index construct in " + currentFieldName);
+					return null;
+				}
+				try {
+				String is = currentFieldName.substring(bi+1, currentFieldName.length() - 1).trim();
+					arrayIndex = Integer.parseInt(is);
+				} catch (Exception e) {
+					logger.debug("Invalid array index construct in " + currentFieldName);
+					return null;
+				}
+				currentNodeName = currentFieldName.substring(0,bi).trim();
+			}
+
+			JsonNode currentNode = baseNode.get(currentNodeName);
+			if (arrayIndex > -1 && currentNode.isArray()) {
+				logger.debug("Going to take array node at index " + arrayIndex);
+				currentNode = currentNode.get(arrayIndex);
+			}
+
+			if (currentNode == null) {
+				logger.debug("JsonNode not found for name " + currentFieldName);
+				return null;
+			}
+
+			if (idx < 0) {
+				if (!currentNode.isValueNode()) {
+					logger.debug("JsonNode is not value node for name " + currentFieldName);
+					return null;
+				}
+				String ret = currentNode.asText();
+				if (ret != null && !ret.trim().isEmpty())
+					return ret.trim();
+			} else {
+				return getJsonValue(currentNode, fieldPath.substring(idx + 1));
+			}
+		}
+		return null;
+	}
+
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/ClaimToRoleMapper.java

@@ -1,105 +1,105 @@
-package org.keycloak.broker.oidc.mappers;
+package org.keycloak.broker.oidc.mappers;
-
+
-import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
-import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.HardcodedRoleMapper;
+import org.keycloak.broker.provider.HardcodedRoleMapper;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.IdentityBrokerException;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.RoleModel;
+import org.keycloak.models.RoleModel;
-import org.keycloak.models.UserModel;
+import org.keycloak.models.UserModel;
-import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigProperty;
-
+
-import java.util.ArrayList;
+import java.util.ArrayList;
-import java.util.List;
+import java.util.List;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class ClaimToRoleMapper extends AbstractClaimMapper {
+public class ClaimToRoleMapper extends AbstractClaimMapper {
-
+
-    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID};
+    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID};
-
+
-    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-
+
-    static {
+    static {
-        ProviderConfigProperty property;
+        ProviderConfigProperty property;
-        ProviderConfigProperty property1;
+        ProviderConfigProperty property1;
-        property1 = new ProviderConfigProperty();
+        property1 = new ProviderConfigProperty();
-        property1.setName(CLAIM);
+        property1.setName(CLAIM);
-        property1.setLabel("Claim");
+        property1.setLabel("Claim");
-        property1.setHelpText("Name of claim to search for in token.  You can reference nested claims using a '.', i.e. 'address.locality'.");
+        property1.setHelpText("Name of claim to search for in token.  You can reference nested claims using a '.', i.e. 'address.locality'.");
-        property1.setType(ProviderConfigProperty.STRING_TYPE);
+        property1.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property1);
+        configProperties.add(property1);
-        property1 = new ProviderConfigProperty();
+        property1 = new ProviderConfigProperty();
-        property1.setName(CLAIM_VALUE);
+        property1.setName(CLAIM_VALUE);
-        property1.setLabel("Claim Value");
+        property1.setLabel("Claim Value");
-        property1.setHelpText("Value the claim must have.  If the claim is an array, then the value must be contained in the array.");
+        property1.setHelpText("Value the claim must have.  If the claim is an array, then the value must be contained in the array.");
-        property1.setType(ProviderConfigProperty.STRING_TYPE);
+        property1.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property1);
+        configProperties.add(property1);
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(HardcodedRoleMapper.ROLE);
+        property.setName(HardcodedRoleMapper.ROLE);
-        property.setLabel("Role");
+        property.setLabel("Role");
-        property.setHelpText("Role to grant to user if claim is present.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
+        property.setHelpText("Role to grant to user if claim is present.  Click 'Select Role' button to browse roles, or just type it in the textbox.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.ROLE_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-    }
+    }
-
+
-    public static final String PROVIDER_ID = "oidc-role-idp-mapper";
+    public static final String PROVIDER_ID = "oidc-role-idp-mapper";
-
+
-
+
-    @Override
+    @Override
-    public List<ProviderConfigProperty> getConfigProperties() {
+    public List<ProviderConfigProperty> getConfigProperties() {
-        return configProperties;
+        return configProperties;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getId() {
+    public String getId() {
-        return PROVIDER_ID;
+        return PROVIDER_ID;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String[] getCompatibleProviders() {
+    public String[] getCompatibleProviders() {
-        return COMPATIBLE_PROVIDERS;
+        return COMPATIBLE_PROVIDERS;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayCategory() {
+    public String getDisplayCategory() {
-        return "Role Importer";
+        return "Role Importer";
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayType() {
+    public String getDisplayType() {
-        return "Claim to Role";
+        return "Claim to Role";
-    }
+    }
-
+
-    @Override
+    @Override
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
+        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
-        if (hasClaimValue(mapperModel, context)) {
+        if (hasClaimValue(mapperModel, context)) {
-            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
+            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
-            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-            user.grantRole(role);
+            user.grantRole(role);
-        }
+        }
-    }
+    }
-
+
-    @Override
+    @Override
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
+        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
-        if (!hasClaimValue(mapperModel, context)) {
+        if (!hasClaimValue(mapperModel, context)) {
-            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
+            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
-            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-            user.deleteRoleMapping(role);
+            user.deleteRoleMapping(role);
-        }
+        }
-
+
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getHelpText() {
+    public String getHelpText() {
-        return "If a claim exists, grant the user the specified realm or application role.";
+        return "If a claim exists, grant the user the specified realm or application role.";
-    }
+    }
-
+
-}
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/ExternalKeycloakRoleToRoleMapper.java

@@ -1,118 +1,118 @@
-package org.keycloak.broker.oidc.mappers;
+package org.keycloak.broker.oidc.mappers;
-
+
-import org.keycloak.broker.oidc.KeycloakOIDCIdentityProvider;
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProvider;
-import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
-import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.HardcodedRoleMapper;
+import org.keycloak.broker.provider.HardcodedRoleMapper;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.IdentityBrokerException;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.RoleModel;
+import org.keycloak.models.RoleModel;
-import org.keycloak.models.UserModel;
+import org.keycloak.models.UserModel;
-import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigProperty;
-import org.keycloak.representations.JsonWebToken;
+import org.keycloak.representations.JsonWebToken;
-
+
-import java.util.ArrayList;
+import java.util.ArrayList;
-import java.util.List;
+import java.util.List;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class ExternalKeycloakRoleToRoleMapper extends AbstractClaimMapper {
+public class ExternalKeycloakRoleToRoleMapper extends AbstractClaimMapper {
-
+
-    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID};
+    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID};
-
+
-    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-    private static final String EXTERNAL_ROLE = "external.role";
+    private static final String EXTERNAL_ROLE = "external.role";
-
+
-    static {
+    static {
-        ProviderConfigProperty property;
+        ProviderConfigProperty property;
-        ProviderConfigProperty property1;
+        ProviderConfigProperty property1;
-        property1 = new ProviderConfigProperty();
+        property1 = new ProviderConfigProperty();
-        property1.setName(EXTERNAL_ROLE);
+        property1.setName(EXTERNAL_ROLE);
-        property1.setLabel("External role");
+        property1.setLabel("External role");
-        property1.setHelpText("External role to check for.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole.");
+        property1.setHelpText("External role to check for.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole.");
-        property1.setType(ProviderConfigProperty.STRING_TYPE);
+        property1.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property1);
+        configProperties.add(property1);
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(HardcodedRoleMapper.ROLE);
+        property.setName(HardcodedRoleMapper.ROLE);
-        property.setLabel("Role");
+        property.setLabel("Role");
-        property.setHelpText("Role to grant to user if external role is present.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
+        property.setHelpText("Role to grant to user if external role is present.  Click 'Select Role' button to browse roles, or just type it in the textbox.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.ROLE_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-    }
+    }
-
+
-    public static final String PROVIDER_ID = "keycloak-oidc-role-to-role-idp-mapper";
+    public static final String PROVIDER_ID = "keycloak-oidc-role-to-role-idp-mapper";
-
+
-
+
-    @Override
+    @Override
-    public List<ProviderConfigProperty> getConfigProperties() {
+    public List<ProviderConfigProperty> getConfigProperties() {
-        return configProperties;
+        return configProperties;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getId() {
+    public String getId() {
-        return PROVIDER_ID;
+        return PROVIDER_ID;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String[] getCompatibleProviders() {
+    public String[] getCompatibleProviders() {
-        return COMPATIBLE_PROVIDERS;
+        return COMPATIBLE_PROVIDERS;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayCategory() {
+    public String getDisplayCategory() {
-        return "Role Importer";
+        return "Role Importer";
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayType() {
+    public String getDisplayType() {
-        return "External Role to Role";
+        return "External Role to Role";
-    }
+    }
-
+
-    @Override
+    @Override
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        RoleModel role = hasRole(realm, mapperModel, context);
+        RoleModel role = hasRole(realm, mapperModel, context);
-        if (role != null) {
+        if (role != null) {
-            user.grantRole(role);
+            user.grantRole(role);
-        }
+        }
-    }
+    }
-
+
-    private RoleModel hasRole(RealmModel realm,IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    private RoleModel hasRole(RealmModel realm,IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ACCESS_TOKEN);
+        JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ACCESS_TOKEN);
-        //if (token == null) return;
+        //if (token == null) return;
-        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
+        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
-        String[] parseRole = HardcodedRoleMapper.parseRole(mapperModel.getConfig().get(EXTERNAL_ROLE));
+        String[] parseRole = HardcodedRoleMapper.parseRole(mapperModel.getConfig().get(EXTERNAL_ROLE));
-        String externalRoleName = parseRole[1];
+        String externalRoleName = parseRole[1];
-        String claimName = null;
+        String claimName = null;
-        if (parseRole[0] == null) {
+        if (parseRole[0] == null) {
-            claimName = "realm_access.roles";
+            claimName = "realm_access.roles";
-        } else {
+        } else {
-            claimName = "resource_access." + parseRole[0] + ".roles";
+            claimName = "resource_access." + parseRole[0] + ".roles";
-        }
+        }
-        Object claim = getClaimValue(token, claimName);
+        Object claim = getClaimValue(token, claimName);
-        if (valueEquals(externalRoleName, claim)) {
+        if (valueEquals(externalRoleName, claim)) {
-            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
+            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
-            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-            return role;
+            return role;
-        }
+        }
-        return null;
+        return null;
-    }
+    }
-
+
-    @Override
+    @Override
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        RoleModel role = hasRole(realm, mapperModel, context);
+        RoleModel role = hasRole(realm, mapperModel, context);
-        if (role == null) {
+        if (role == null) {
-            user.deleteRoleMapping(role);
+            user.deleteRoleMapping(role);
-        }
+        }
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getHelpText() {
+    public String getHelpText() {
-        return "Looks for an external role in a keycloak access token.  If external role exists, grant the user the specified realm or application role.";
+        return "Looks for an external role in a keycloak access token.  If external role exists, grant the user the specified realm or application role.";
-    }
+    }
-
+
-}
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/UserAttributeMapper.java

@@ -1,100 +1,98 @@
-package org.keycloak.broker.oidc.mappers;
+package org.keycloak.broker.oidc.mappers;
-
+
-import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
-import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.ClientModel;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.UserModel;
-import org.keycloak.models.RealmModel;
+import org.keycloak.provider.ProviderConfigProperty;
-import org.keycloak.models.RoleModel;
+
-import org.keycloak.models.UserModel;
+import java.util.ArrayList;
-import org.keycloak.provider.ProviderConfigProperty;
+import java.util.Collection;
-
+import java.util.List;
-import java.util.ArrayList;
+
-import java.util.List;
+/**
-
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-/**
+ * @version $Revision: 1 $
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ */
- * @version $Revision: 1 $
+public class UserAttributeMapper extends AbstractClaimMapper {
- */
+
-public class UserAttributeMapper extends AbstractClaimMapper {
+    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID};
-
+
-    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID};
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-
+
-    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    public static final String USER_ATTRIBUTE = "user.attribute";
-
+
-    public static final String USER_ATTRIBUTE = "user.attribute";
+    static {
-
+        ProviderConfigProperty property;
-    static {
+        ProviderConfigProperty property1;
-        ProviderConfigProperty property;
+        property1 = new ProviderConfigProperty();
-        ProviderConfigProperty property1;
+        property1.setName(CLAIM);
-        property1 = new ProviderConfigProperty();
+        property1.setLabel("Claim");
-        property1.setName(CLAIM);
+        property1.setHelpText("Name of claim to search for in token.  You can reference nested claims using a '.', i.e. 'address.locality'.");
-        property1.setLabel("Claim");
+        property1.setType(ProviderConfigProperty.STRING_TYPE);
-        property1.setHelpText("Name of claim to search for in token.  You can reference nested claims using a '.', i.e. 'address.locality'.");
+        configProperties.add(property1);
-        property1.setType(ProviderConfigProperty.STRING_TYPE);
+        property = new ProviderConfigProperty();
-        configProperties.add(property1);
+        property.setName(USER_ATTRIBUTE);
-        property = new ProviderConfigProperty();
+        property.setLabel("User Attribute Name");
-        property.setName(USER_ATTRIBUTE);
+        property.setHelpText("User attribute name to store claim.");
-        property.setLabel("User Attribute Name");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        property.setHelpText("User attribute name to store claim.");
+        configProperties.add(property);
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+    }
-        configProperties.add(property);
+
-    }
+    public static final String PROVIDER_ID = "oidc-user-attribute-idp-mapper";
-
+
-    public static final String PROVIDER_ID = "oidc-user-attribute-idp-mapper";
+    @Override
-
+    public List<ProviderConfigProperty> getConfigProperties() {
-    @Override
+        return configProperties;
-    public List<ProviderConfigProperty> getConfigProperties() {
+    }
-        return configProperties;
+
-    }
+    @Override
-
+    public String getId() {
-    @Override
+        return PROVIDER_ID;
-    public String getId() {
+    }
-        return PROVIDER_ID;
+
-    }
+    @Override
-
+    public String[] getCompatibleProviders() {
-    @Override
+        return COMPATIBLE_PROVIDERS;
-    public String[] getCompatibleProviders() {
+    }
-        return COMPATIBLE_PROVIDERS;
+
-    }
+    @Override
-
+    public String getDisplayCategory() {
-    @Override
+        return "Attribute Importer";
-    public String getDisplayCategory() {
+    }
-        return "Attribute Importer";
+
-    }
+    @Override
-
+    public String getDisplayType() {
-    @Override
+        return "Attribute Importer";
-    public String getDisplayType() {
+    }
-        return "Attribute Importer";
+
-    }
+    @Override
-
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-    @Override
+        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        Object value = getClaimValue(mapperModel, context);
-        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
+        if (value != null) {
-        Object value = getClaimValue(mapperModel, context);
+            user.setSingleAttribute(attribute, value.toString());
-        if (value != null) {
+        }
-            user.setAttribute(attribute, value.toString());
+    }
-        }
+
-    }
+    @Override
-
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-    @Override
+        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        Object value = getClaimValue(mapperModel, context);
-        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
+        String current = user.getFirstAttribute(attribute);
-        Object value = getClaimValue(mapperModel, context);
+        if (value != null && !value.equals(current)) {
-        String current = user.getAttribute(attribute);
+            user.setSingleAttribute(attribute, value.toString());
-        if (value != null && !value.equals(current)) {
+        } else if (value == null) {
-            user.setAttribute(attribute, value.toString());
+            user.removeAttribute(attribute);
-        } else if (value == null) {
+        }
-            user.removeAttribute(attribute);
+    }
-        }
+
-    }
+    @Override
-
+    public String getHelpText() {
-    @Override
+        return "Import declared claim if it exists in ID or access token into the specified user attribute.";
-    public String getHelpText() {
+    }
-        return "Import declared claim if it exists in ID or access token into the specified user attribute.";
+
-    }
+}
-
-}

broker/oidc/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java

@@ -0,0 +1,109 @@
+package org.keycloak.broker.oidc.mappers;
+
+import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory;
+import org.keycloak.broker.oidc.OIDCIdentityProviderFactory;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.models.utils.KeycloakModelUtils;
+import org.keycloak.provider.ProviderConfigProperty;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class UsernameTemplateMapper extends AbstractClaimMapper {
+
+    public static final String[] COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID};
+
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+
+    public static final String TEMPLATE = "template";
+
+    static {
+        ProviderConfigProperty property;
+        property = new ProviderConfigProperty();
+        property.setName(TEMPLATE);
+        property.setLabel("Template");
+        property.setHelpText("Template to use to format the username to import.  Substitutions are enclosed in ${}.  For example: '${ALIAS}.${CLAIM.sub}'.  ALIAS is the provider alias.  CLAIM.<NAME> references an ID or Access token claim.");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setDefaultValue("${ALIAS}.${CLAIM.preferred_username}");
+        configProperties.add(property);
+    }
+
+    public static final String PROVIDER_ID = "oidc-username-idp-mapper";
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        return configProperties;
+    }
+
+    @Override
+    public String getId() {
+        return PROVIDER_ID;
+    }
+
+    @Override
+    public String[] getCompatibleProviders() {
+        return COMPATIBLE_PROVIDERS;
+    }
+
+    @Override
+    public String getDisplayCategory() {
+        return "Preprocessor";
+    }
+
+    @Override
+    public String getDisplayType() {
+        return "Username Template Importer";
+    }
+
+    @Override
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    }
+
+    @Override
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    }
+
+    static Pattern substitution = Pattern.compile("\\$\\{([^}]+)\\}");
+
+    @Override
+    public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String template = mapperModel.getConfig().get(TEMPLATE);
+        Matcher m = substitution.matcher(template);
+        StringBuffer sb = new StringBuffer();
+        while (m.find()) {
+            String variable = m.group(1);
+            if (variable.equals("ALIAS")) {
+                m.appendReplacement(sb, context.getIdpConfig().getAlias());
+            } else if (variable.equals("UUID")) {
+                m.appendReplacement(sb, KeycloakModelUtils.generateId());
+            } else if (variable.startsWith("CLAIM.")) {
+                String name = variable.substring("CLAIM.".length());
+                Object value = AbstractClaimMapper.getClaimValue(context, name);
+                if (value == null) value = "";
+                m.appendReplacement(sb, value.toString());
+            } else {
+                m.appendReplacement(sb, m.group(1));
+            }
+
+        }
+        m.appendTail(sb);
+        String username = sb.toString();
+        context.setModelUsername(username);
+
+    }
+
+    @Override
+    public String getHelpText() {
+        return "Format the username to import.";
+    }
+}

broker/oidc/src/main/java/org/keycloak/broker/oidc/util/JsonSimpleHttp.java

@@ -1,32 +1,32 @@
-package org.keycloak.broker.oidc.util;
+package org.keycloak.broker.oidc.util;
-
+
-import org.codehaus.jackson.JsonNode;
+import org.codehaus.jackson.JsonNode;
-import org.codehaus.jackson.map.ObjectMapper;
+import org.codehaus.jackson.map.ObjectMapper;
-import org.keycloak.broker.provider.util.SimpleHttp;
+import org.keycloak.broker.provider.util.SimpleHttp;
-
+
-import java.io.IOException;
+import java.io.IOException;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class JsonSimpleHttp extends SimpleHttp {
+public class JsonSimpleHttp extends SimpleHttp {
-    public JsonSimpleHttp(String url, String method) {
+    public JsonSimpleHttp(String url, String method) {
-        super(url, method);
+        super(url, method);
-    }
+    }
-
+
-    public static JsonSimpleHttp doGet(String url) {
+    public static JsonSimpleHttp doGet(String url) {
-        return new JsonSimpleHttp(url, "GET");
+        return new JsonSimpleHttp(url, "GET");
-    }
+    }
-
+
-    public static JsonSimpleHttp doPost(String url) {
+    public static JsonSimpleHttp doPost(String url) {
-        return new JsonSimpleHttp(url, "POST");
+        return new JsonSimpleHttp(url, "POST");
-    }
+    }
-
+
-    private static ObjectMapper mapper = new ObjectMapper();
+    private static ObjectMapper mapper = new ObjectMapper();
-
+
-    public static JsonNode asJson(SimpleHttp request) throws IOException {
+    public static JsonNode asJson(SimpleHttp request) throws IOException {
-        return mapper.readTree(request.asString());
+        return mapper.readTree(request.asString());
-    }
+    }
-
+
-}
+}

broker/oidc/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderFactory

@@ -1,2 +1,2 @@
-org.keycloak.broker.oidc.OIDCIdentityProviderFactory
+org.keycloak.broker.oidc.OIDCIdentityProviderFactory
 org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory

broker/oidc/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderMapper

@@ -1,3 +1,4 @@
-org.keycloak.broker.oidc.mappers.ClaimToRoleMapper
+org.keycloak.broker.oidc.mappers.ClaimToRoleMapper
-org.keycloak.broker.oidc.mappers.ExternalKeycloakRoleToRoleMapper
+org.keycloak.broker.oidc.mappers.ExternalKeycloakRoleToRoleMapper
-org.keycloak.broker.oidc.mappers.UserAttributeMapper
+org.keycloak.broker.oidc.mappers.UserAttributeMapper
+org.keycloak.broker.oidc.mappers.UsernameTemplateMapper

broker/oidc/src/test/java/org/keycloak/broker/oidc/mappers/AbstractJsonUserAttributeMapperTest.java

@@ -0,0 +1,120 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2015 Red Hat Inc. and/or its affiliates and other contributors
+ * as indicated by the @authors tag. All rights reserved.
+ */
+package org.keycloak.broker.oidc.mappers;
+
+import java.io.IOException;
+
+import org.codehaus.jackson.JsonNode;
+import org.codehaus.jackson.JsonProcessingException;
+import org.codehaus.jackson.map.ObjectMapper;
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Unit test for {@link AbstractJsonUserAttributeMapper}
+ * 
+ * @author Vlastimil Elias (velias at redhat dot com)
+ */
+public class AbstractJsonUserAttributeMapperTest {
+
+	private static ObjectMapper mapper = new ObjectMapper();
+
+	private static JsonNode baseNode;
+
+	private JsonNode getJsonNode() throws JsonProcessingException, IOException {
+		if (baseNode == null)
+			baseNode = mapper.readTree("{ \"value1\" : \"v1 \",\"value_empty\" : \"\", \"value_b\" : true, \"value_i\" : 454, " + " \"value_array\":[\"a1\",\"a2\"], " +" \"nest1\": {\"value1\": \" fgh \",\"value_empty\" : \"\", \"nest2\":{\"value_b\" : false, \"value_i\" : 43}}, "+ " \"nesta\": { \"a\":[{\"av1\": \"vala1\"},{\"av1\": \"vala2\"}]}"+" }");
+		return baseNode;
+	}
+
+	@Test
+	public void getJsonValue_invalidPath() throws JsonProcessingException, IOException {
+
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "."));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), ".."));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "...value1"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), ".value1"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value1."));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "[]"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "[value1"));
+	}
+
+	@Test
+	public void getJsonValue_simpleValues() throws JsonProcessingException, IOException {
+
+		//unknown field returns null
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_unknown"));
+		
+		// we check value is trimmed also!
+		Assert.assertEquals("v1", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_empty"));
+
+		Assert.assertEquals("true", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_b"));
+		Assert.assertEquals("454", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_i"));
+
+	}
+
+	@Test
+	public void getJsonValue_nestedSimpleValues() throws JsonProcessingException, IOException {
+
+		// null if path points to JSON object
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.nest2"));
+
+		//unknown field returns null
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.value_unknown"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.nest2.value_unknown"));
+
+		// we check value is trimmed also!
+		Assert.assertEquals("fgh", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.value1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.value_empty"));
+
+		Assert.assertEquals("false", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.nest2.value_b"));
+		Assert.assertEquals("43", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.nest2.value_i"));
+
+		// null if invalid nested path
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1."));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nest1.nest2."));
+	}
+
+	@Test
+	public void getJsonValue_simpleArray() throws JsonProcessingException, IOException {
+
+		// array field itself returns null if no index is provided
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array"));
+		// outside index returns null
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[2]"));
+
+		//corect index
+		Assert.assertEquals("a1", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[0]"));
+		Assert.assertEquals("a2", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[1]"));
+		
+		//incorrect array constructs
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[]"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array]"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array["));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[a]"));
+		Assert.assertNull(AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "value_array[-2]"));
+	}
+
+	@Test
+	public void getJsonValue_nestedArrayWithObjects() throws JsonProcessingException, IOException {
+		Assert.assertEquals("vala1", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[0].av1"));
+		Assert.assertEquals("vala2", AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[1].av1"));
+
+		//different path erros or nonexisting indexes or fields return null
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[2].av1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[0]"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[0].av_unknown"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[].av1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a.av1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a].av1"));
+		Assert.assertEquals(null, AbstractJsonUserAttributeMapper.getJsonValue(getJsonNode(), "nesta.a[.av1"));
+		
+	}
+
+}

broker/pom.xml

@@ -1,23 +1,23 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../pom.xml</relativePath>
+        <relativePath>../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-broker-parent</artifactId>
+    <artifactId>keycloak-broker-parent</artifactId>
-    <name>Keycloak Broker Parent</name>
+    <name>Keycloak Broker Parent</name>
-    <description/>
+    <description/>
-    <packaging>pom</packaging>
+    <packaging>pom</packaging>
-
+
-    <modules>
+    <modules>
-        <module>core</module>
+        <module>core</module>
-        <module>oidc</module>
+        <module>oidc</module>
-        <module>saml</module>
+        <module>saml</module>
-    </modules>
+    </modules>
-
+
-</project>
+</project>

broker/saml/pom.xml

@@ -1,50 +1,50 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-broker-saml</artifactId>
+    <artifactId>keycloak-broker-saml</artifactId>
-    <name>Keycloak Broker - SAML Identity Provider</name>
+    <name>Keycloak Broker - SAML Identity Provider</name>
-    <description/>
+    <description/>
-    <packaging>jar</packaging>
+    <packaging>jar</packaging>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-broker-core</artifactId>
+            <artifactId>keycloak-broker-core</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-saml-protocol</artifactId>
+            <artifactId>keycloak-saml-protocol</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-saml-core</artifactId>
+            <artifactId>keycloak-saml-core</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-services</artifactId>
+            <artifactId>keycloak-services</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-events-api</artifactId>
+            <artifactId>keycloak-events-api</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.jboss.logging</groupId>
+            <groupId>org.jboss.logging</groupId>
-            <artifactId>jboss-logging</artifactId>
+            <artifactId>jboss-logging</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-    </dependencies>
+    </dependencies>
-
+
-</project>
+</project>

broker/saml/src/main/java/org/keycloak/broker/saml/SAMLEndpoint.java

@@ -1,485 +1,438 @@
-package org.keycloak.broker.saml;
+package org.keycloak.broker.saml;
-
+
-import org.jboss.logging.Logger;
+import org.jboss.logging.Logger;
-import org.keycloak.ClientConnection;
+import org.keycloak.common.ClientConnection;
-import org.keycloak.VerificationException;
+import org.keycloak.common.VerificationException;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.IdentityBrokerException;
-import org.keycloak.broker.provider.IdentityProvider;
+import org.keycloak.broker.provider.IdentityProvider;
-import org.keycloak.dom.saml.v2.assertion.AssertionType;
+import org.keycloak.dom.saml.v2.assertion.AssertionType;
-import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
+import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
-import org.keycloak.dom.saml.v2.assertion.AttributeType;
+import org.keycloak.dom.saml.v2.assertion.AttributeType;
-import org.keycloak.dom.saml.v2.assertion.AuthnStatementType;
+import org.keycloak.dom.saml.v2.assertion.AuthnStatementType;
-import org.keycloak.dom.saml.v2.assertion.EncryptedAssertionType;
+import org.keycloak.dom.saml.v2.assertion.NameIDType;
-import org.keycloak.dom.saml.v2.assertion.NameIDType;
+import org.keycloak.dom.saml.v2.assertion.SubjectType;
-import org.keycloak.dom.saml.v2.assertion.SubjectType;
+import org.keycloak.dom.saml.v2.protocol.LogoutRequestType;
-import org.keycloak.dom.saml.v2.protocol.LogoutRequestType;
+import org.keycloak.dom.saml.v2.protocol.RequestAbstractType;
-import org.keycloak.dom.saml.v2.protocol.RequestAbstractType;
+import org.keycloak.dom.saml.v2.protocol.ResponseType;
-import org.keycloak.dom.saml.v2.protocol.ResponseType;
+import org.keycloak.dom.saml.v2.protocol.StatusResponseType;
-import org.keycloak.dom.saml.v2.protocol.StatusResponseType;
+import org.keycloak.events.Details;
-import org.keycloak.events.Details;
+import org.keycloak.events.Errors;
-import org.keycloak.events.Errors;
+import org.keycloak.events.EventBuilder;
-import org.keycloak.events.EventBuilder;
+import org.keycloak.events.EventType;
-import org.keycloak.events.EventType;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserSessionModel;
-import org.keycloak.models.UserSessionModel;
+import org.keycloak.protocol.saml.JaxrsSAML2BindingBuilder;
-import org.keycloak.protocol.saml.SAML2LogoutResponseBuilder;
+import org.keycloak.saml.SAML2LogoutResponseBuilder;
-import org.keycloak.protocol.saml.SAMLRequestParser;
+import org.keycloak.saml.SAMLRequestParser;
-import org.keycloak.protocol.saml.SamlProtocol;
+import org.keycloak.protocol.saml.SamlProtocol;
-import org.keycloak.protocol.saml.SamlProtocolUtils;
+import org.keycloak.protocol.saml.SamlProtocolUtils;
-import org.keycloak.saml.common.constants.GeneralConstants;
+import org.keycloak.saml.common.constants.GeneralConstants;
-import org.keycloak.saml.common.constants.JBossSAMLConstants;
+import org.keycloak.saml.common.constants.JBossSAMLURIConstants;
-import org.keycloak.saml.common.constants.JBossSAMLURIConstants;
+import org.keycloak.saml.common.exceptions.ConfigurationException;
-import org.keycloak.saml.common.exceptions.ConfigurationException;
+import org.keycloak.saml.common.exceptions.ProcessingException;
-import org.keycloak.saml.common.exceptions.ProcessingException;
+import org.keycloak.saml.processing.core.saml.v2.common.SAMLDocumentHolder;
-import org.keycloak.saml.common.util.DocumentUtil;
+import org.keycloak.saml.processing.core.saml.v2.constants.X500SAMLProfileConstants;
-import org.keycloak.saml.common.util.StaxParserUtil;
+import org.keycloak.saml.processing.core.saml.v2.util.AssertionUtil;
-import org.keycloak.saml.processing.api.saml.v2.response.SAML2Response;
+import org.keycloak.saml.processing.core.util.XMLSignatureUtil;
-import org.keycloak.saml.processing.core.parsers.saml.SAMLParser;
+import org.keycloak.saml.processing.web.util.PostBindingUtil;
-import org.keycloak.saml.processing.core.saml.v2.common.SAMLDocumentHolder;
+import org.keycloak.services.ErrorPage;
-import org.keycloak.saml.processing.core.saml.v2.constants.X500SAMLProfileConstants;
+import org.keycloak.services.managers.AuthenticationManager;
-import org.keycloak.saml.processing.core.util.JAXPValidationUtil;
+import org.keycloak.services.messages.Messages;
-import org.keycloak.saml.processing.core.util.XMLEncryptionUtil;
+
-import org.keycloak.saml.processing.core.util.XMLSignatureUtil;
+import javax.ws.rs.Consumes;
-import org.keycloak.saml.processing.web.util.PostBindingUtil;
+import javax.ws.rs.FormParam;
-import org.keycloak.services.ErrorPage;
+import javax.ws.rs.GET;
-import org.keycloak.services.managers.AuthenticationManager;
+import javax.ws.rs.POST;
-import org.keycloak.services.messages.Messages;
+import javax.ws.rs.QueryParam;
-import org.w3c.dom.Document;
+import javax.ws.rs.core.Context;
-import org.w3c.dom.Element;
+import javax.ws.rs.core.HttpHeaders;
-import org.w3c.dom.Node;
+import javax.ws.rs.core.MediaType;
-
+import javax.ws.rs.core.Response;
-import javax.ws.rs.Consumes;
+import javax.ws.rs.core.UriBuilder;
-import javax.ws.rs.FormParam;
+import javax.ws.rs.core.UriInfo;
-import javax.ws.rs.GET;
+import java.io.IOException;
-import javax.ws.rs.POST;
+import java.security.PublicKey;
-import javax.ws.rs.QueryParam;
+import java.security.cert.X509Certificate;
-import javax.ws.rs.core.Context;
+import java.util.List;
-import javax.ws.rs.core.HttpHeaders;
+
-import javax.ws.rs.core.MediaType;
+/**
-import javax.ws.rs.core.Response;
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-import javax.ws.rs.core.UriBuilder;
+ * @version $Revision: 1 $
-import javax.ws.rs.core.UriInfo;
+ */
-import javax.xml.namespace.QName;
+public class SAMLEndpoint {
-import java.io.IOException;
+    protected static final Logger logger = Logger.getLogger(SAMLEndpoint.class);
-import java.security.PrivateKey;
+    public static final String SAML_FEDERATED_SESSION_INDEX = "SAML_FEDERATED_SESSION_INDEX";
-import java.security.PublicKey;
+    public static final String SAML_FEDERATED_SUBJECT = "SAML_FEDERATED_SUBJECT";
-import java.security.cert.X509Certificate;
+    public static final String SAML_FEDERATED_SUBJECT_NAMEFORMAT = "SAML_FEDERATED_SUBJECT_NAMEFORMAT";
-import java.util.List;
+    public static final String SAML_LOGIN_RESPONSE = "SAML_LOGIN_RESPONSE";
-
+    public static final String SAML_ASSERTION = "SAML_ASSERTION";
-/**
+    public static final String SAML_AUTHN_STATEMENT = "SAML_AUTHN_STATEMENT";
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+    protected RealmModel realm;
- * @version $Revision: 1 $
+    protected EventBuilder event;
- */
+    protected SAMLIdentityProviderConfig config;
-public class SAMLEndpoint {
+    protected IdentityProvider.AuthenticationCallback callback;
-    protected static final Logger logger = Logger.getLogger(SAMLEndpoint.class);
+    protected SAMLIdentityProvider provider;
-    public static final String SAML_FEDERATED_SESSION_INDEX = "SAML_FEDERATED_SESSION_INDEX";
+
-    public static final String SAML_FEDERATED_SUBJECT = "SAML_FEDERATED_SUBJECT";
+    @Context
-    public static final String SAML_FEDERATED_SUBJECT_NAMEFORMAT = "SAML_FEDERATED_SUBJECT_NAMEFORMAT";
+    private UriInfo uriInfo;
-    public static final String SAML_LOGIN_RESPONSE = "SAML_LOGIN_RESPONSE";
+
-    public static final String SAML_ASSERTION = "SAML_ASSERTION";
+    @Context
-    public static final String SAML_AUTHN_STATEMENT = "SAML_AUTHN_STATEMENT";
+    private KeycloakSession session;
-    protected RealmModel realm;
+
-    protected EventBuilder event;
+    @Context
-    protected SAMLIdentityProviderConfig config;
+    private ClientConnection clientConnection;
-    protected IdentityProvider.AuthenticationCallback callback;
+
-    protected SAMLIdentityProvider provider;
+    @Context
-
+    private HttpHeaders headers;
-    @Context
+
-    private UriInfo uriInfo;
+
-
+    public SAMLEndpoint(RealmModel realm, SAMLIdentityProvider provider, SAMLIdentityProviderConfig config, IdentityProvider.AuthenticationCallback callback) {
-    @Context
+        this.realm = realm;
-    private KeycloakSession session;
+        this.config = config;
-
+        this.callback = callback;
-    @Context
+        this.provider = provider;
-    private ClientConnection clientConnection;
+    }
-
+
-    @Context
+    @GET
-    private HttpHeaders headers;
+    public Response redirectBinding(@QueryParam(GeneralConstants.SAML_REQUEST_KEY) String samlRequest,
-
+                                    @QueryParam(GeneralConstants.SAML_RESPONSE_KEY) String samlResponse,
-
+                                    @QueryParam(GeneralConstants.RELAY_STATE) String relayState)  {
-    public SAMLEndpoint(RealmModel realm, SAMLIdentityProvider provider, SAMLIdentityProviderConfig config, IdentityProvider.AuthenticationCallback callback) {
+        return new RedirectBinding().execute(samlRequest, samlResponse, relayState);
-        this.realm = realm;
+    }
-        this.config = config;
+
-        this.callback = callback;
+
-        this.provider = provider;
+    /**
-    }
+     */
-
+    @POST
-    @GET
+    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
-    public Response redirectBinding(@QueryParam(GeneralConstants.SAML_REQUEST_KEY) String samlRequest,
+    public Response postBinding(@FormParam(GeneralConstants.SAML_REQUEST_KEY) String samlRequest,
-                                    @QueryParam(GeneralConstants.SAML_RESPONSE_KEY) String samlResponse,
+                                @FormParam(GeneralConstants.SAML_RESPONSE_KEY) String samlResponse,
-                                    @QueryParam(GeneralConstants.RELAY_STATE) String relayState)  {
+                                @FormParam(GeneralConstants.RELAY_STATE) String relayState) {
-        return new RedirectBinding().execute(samlRequest, samlResponse, relayState);
+        return new PostBinding().execute(samlRequest, samlResponse, relayState);
-    }
+    }
-
+
-
+    protected abstract class Binding {
-    /**
+        private boolean checkSsl() {
-     */
+            if (uriInfo.getBaseUri().getScheme().equals("https")) {
-    @POST
+                return true;
-    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
+            } else {
-    public Response postBinding(@FormParam(GeneralConstants.SAML_REQUEST_KEY) String samlRequest,
+                return !realm.getSslRequired().isRequired(clientConnection);
-                                @FormParam(GeneralConstants.SAML_RESPONSE_KEY) String samlResponse,
+            }
-                                @FormParam(GeneralConstants.RELAY_STATE) String relayState) {
+        }
-        return new PostBinding().execute(samlRequest, samlResponse, relayState);
+
-    }
+        protected Response basicChecks(String samlRequest, String samlResponse) {
-
+            if (!checkSsl()) {
-    protected abstract class Binding {
+                event.event(EventType.LOGIN);
-        private boolean checkSsl() {
+                event.error(Errors.SSL_REQUIRED);
-            if (uriInfo.getBaseUri().getScheme().equals("https")) {
+                return ErrorPage.error(session, Messages.HTTPS_REQUIRED);
-                return true;
+            }
-            } else {
+            if (!realm.isEnabled()) {
-                return !realm.getSslRequired().isRequired(clientConnection);
+                event.event(EventType.LOGIN_ERROR);
-            }
+                event.error(Errors.REALM_DISABLED);
-        }
+                return ErrorPage.error(session, Messages.REALM_NOT_ENABLED);
-
+            }
-        protected Response basicChecks(String samlRequest, String samlResponse) {
+
-            if (!checkSsl()) {
+            if (samlRequest == null && samlResponse == null) {
-                event.event(EventType.LOGIN);
+                event.event(EventType.LOGIN);
-                event.error(Errors.SSL_REQUIRED);
+                event.error(Errors.INVALID_REQUEST);
-                return ErrorPage.error(session, Messages.HTTPS_REQUIRED);
+                return ErrorPage.error(session, Messages.INVALID_REQUEST);
-            }
+
-            if (!realm.isEnabled()) {
+            }
-                event.event(EventType.LOGIN_ERROR);
+            return null;
-                event.error(Errors.REALM_DISABLED);
+        }
-                return ErrorPage.error(session, Messages.REALM_NOT_ENABLED);
+
-            }
+        protected abstract String getBindingType();
-
+        protected abstract void verifySignature(String key, SAMLDocumentHolder documentHolder) throws VerificationException;
-            if (samlRequest == null && samlResponse == null) {
+        protected abstract SAMLDocumentHolder extractRequestDocument(String samlRequest);
-                event.event(EventType.LOGIN);
+        protected abstract SAMLDocumentHolder extractResponseDocument(String response);
-                event.error(Errors.INVALID_REQUEST);
+        protected PublicKey getIDPKey() {
-                return ErrorPage.error(session, Messages.INVALID_REQUEST);
+            X509Certificate certificate = null;
-
+            try {
-            }
+                certificate = XMLSignatureUtil.getX509CertificateFromKeyInfoString(config.getSigningCertificate().replaceAll("\\s", ""));
-            return null;
+            } catch (ProcessingException e) {
-        }
+                throw new RuntimeException(e);
-
+            }
-        protected abstract String getBindingType();
+            return certificate.getPublicKey();
-        protected abstract void verifySignature(SAMLDocumentHolder documentHolder) throws VerificationException;
+        }
-        protected abstract SAMLDocumentHolder extractRequestDocument(String samlRequest);
+
-        protected abstract SAMLDocumentHolder extractResponseDocument(String response);
+        public Response execute(String samlRequest, String samlResponse, String relayState) {
-        protected PublicKey getIDPKey() {
+            event = new EventBuilder(realm, session, clientConnection);
-            X509Certificate certificate = null;
+            Response response = basicChecks(samlRequest, samlResponse);
-            try {
+            if (response != null) return response;
-                certificate = XMLSignatureUtil.getX509CertificateFromKeyInfoString(config.getSigningCertificate().replaceAll("\\s", ""));
+            if (samlRequest != null) return handleSamlRequest(samlRequest, relayState);
-            } catch (ProcessingException e) {
+            else return handleSamlResponse(samlResponse, relayState);
-                throw new RuntimeException(e);
+        }
-            }
+
-            return certificate.getPublicKey();
+        protected Response handleSamlRequest(String samlRequest, String relayState) {
-        }
+            SAMLDocumentHolder holder = extractRequestDocument(samlRequest);
-
+            RequestAbstractType requestAbstractType = (RequestAbstractType) holder.getSamlObject();
-        public Response execute(String samlRequest, String samlResponse, String relayState) {
+            // validate destination
-            event = new EventBuilder(realm, session, clientConnection);
+            if (requestAbstractType.getDestination() != null && !uriInfo.getAbsolutePath().equals(requestAbstractType.getDestination())) {
-            Response response = basicChecks(samlRequest, samlResponse);
+                event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
-            if (response != null) return response;
+                event.detail(Details.REASON, "invalid_destination");
-            if (samlRequest != null) return handleSamlRequest(samlRequest, relayState);
+                event.error(Errors.INVALID_SAML_RESPONSE);
-            else return handleSamlResponse(samlResponse, relayState);
+                return ErrorPage.error(session, Messages.INVALID_REQUEST);
-        }
+            }
-
+            if (config.isValidateSignature()) {
-        protected Response handleSamlRequest(String samlRequest, String relayState) {
+                try {
-            SAMLDocumentHolder holder = extractRequestDocument(samlRequest);
+                    verifySignature(GeneralConstants.SAML_REQUEST_KEY, holder);
-            RequestAbstractType requestAbstractType = (RequestAbstractType) holder.getSamlObject();
+                } catch (VerificationException e) {
-            // validate destination
+                    logger.error("validation failed", e);
-            if (!uriInfo.getAbsolutePath().equals(requestAbstractType.getDestination())) {
+                    event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
-                event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
+                    event.error(Errors.INVALID_SIGNATURE);
-                event.error(Errors.INVALID_SAML_RESPONSE);
+                    return ErrorPage.error(session, Messages.INVALID_REQUESTER);
-                event.detail(Details.REASON, "invalid_destination");
+                }
-                return ErrorPage.error(session, Messages.INVALID_REQUEST);
+            }
-            }
+
-            if (config.isValidateSignature()) {
+            if (requestAbstractType instanceof LogoutRequestType) {
-                try {
+                logger.debug("** logout request");
-                    verifySignature(holder);
+                event.event(EventType.LOGOUT);
-                } catch (VerificationException e) {
+                LogoutRequestType logout = (LogoutRequestType) requestAbstractType;
-                    logger.error("validation failed", e);
+                return logoutRequest(logout, relayState);
-                    event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
+
-                    event.error(Errors.INVALID_SIGNATURE);
+            } else {
-                    return ErrorPage.error(session, Messages.INVALID_REQUESTER);
+                event.event(EventType.LOGIN);
-                }
+                event.error(Errors.INVALID_TOKEN);
-            }
+                return ErrorPage.error(session, Messages.INVALID_REQUEST);
-
+            }
-            if (requestAbstractType instanceof LogoutRequestType) {
+        }
-                logger.debug("** logout request");
+
-                event.event(EventType.LOGOUT);
+        protected Response logoutRequest(LogoutRequestType request, String relayState) {
-                LogoutRequestType logout = (LogoutRequestType) requestAbstractType;
+            String brokerUserId = config.getAlias() + "." + request.getNameID().getValue();
-                return logoutRequest(logout, relayState);
+            if (request.getSessionIndex() == null || request.getSessionIndex().isEmpty()) {
-
+                List<UserSessionModel> userSessions = session.sessions().getUserSessionByBrokerUserId(realm, brokerUserId);
-            } else {
+                for (UserSessionModel userSession : userSessions) {
-                event.event(EventType.LOGIN);
+                    if (userSession.getState() == UserSessionModel.State.LOGGING_OUT || userSession.getState() == UserSessionModel.State.LOGGED_OUT) {
-                event.error(Errors.INVALID_TOKEN);
+                        continue;
-                return ErrorPage.error(session, Messages.INVALID_REQUEST);
+                    }
-            }
+                    try {
-        }
+                        AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
-
+                    } catch (Exception e) {
-        protected Response logoutRequest(LogoutRequestType request, String relayState) {
+                        logger.warn("failed to do backchannel logout for userSession", e);
-            String brokerUserId = config.getAlias() + "." + request.getNameID().getValue();
+                    }
-            if (request.getSessionIndex() == null || request.getSessionIndex().isEmpty()) {
+                }
-                List<UserSessionModel> userSessions = session.sessions().getUserSessionByBrokerUserId(realm, brokerUserId);
+
-                for (UserSessionModel userSession : userSessions) {
+            }  else {
-                    try {
+                for (String sessionIndex : request.getSessionIndex()) {
-                        AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
+                    String brokerSessionId = brokerUserId + "." + sessionIndex;
-                    } catch (Exception e) {
+                    UserSessionModel userSession = session.sessions().getUserSessionByBrokerSessionId(realm, brokerSessionId);
-                        logger.warn("failed to do backchannel logout for userSession", e);
+                    if (userSession != null) {
-                    }
+                        if (userSession.getState() == UserSessionModel.State.LOGGING_OUT || userSession.getState() == UserSessionModel.State.LOGGED_OUT) {
-                }
+                            continue;
-
+                        }
-            }  else {
+                        try {
-                for (String sessionIndex : request.getSessionIndex()) {
+                            AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
-                    String brokerSessionId = brokerUserId + "." + sessionIndex;
+                        } catch (Exception e) {
-                    UserSessionModel userSession = session.sessions().getUserSessionByBrokerSessionId(realm, brokerSessionId);
+                            logger.warn("failed to do backchannel logout for userSession", e);
-                    if (userSession != null) {
+                        }
-                        try {
+                    }
-                            AuthenticationManager.backchannelLogout(session, realm, userSession, uriInfo, clientConnection, headers, false);
+                }
-                        } catch (Exception e) {
+            }
-                            logger.warn("failed to do backchannel logout for userSession", e);
+
-                        }
+            String issuerURL = getEntityId(uriInfo, realm);
-                    }
+            SAML2LogoutResponseBuilder builder = new SAML2LogoutResponseBuilder();
-                }
+            builder.logoutRequestID(request.getID());
-            }
+            builder.destination(config.getSingleLogoutServiceUrl());
-
+            builder.issuer(issuerURL);
-            String issuerURL = getEntityId(uriInfo, realm);
+            JaxrsSAML2BindingBuilder binding = new JaxrsSAML2BindingBuilder()
-            SAML2LogoutResponseBuilder builder = new SAML2LogoutResponseBuilder();
+                        .relayState(relayState);
-            builder.logoutRequestID(request.getID());
+            if (config.isWantAuthnRequestsSigned()) {
-            builder.destination(config.getSingleLogoutServiceUrl());
+                binding.signWith(realm.getPrivateKey(), realm.getPublicKey(), realm.getCertificate())
-            builder.issuer(issuerURL);
+                        .signatureAlgorithm(provider.getSignatureAlgorithm())
-            builder.relayState(relayState);
+                        .signDocument();
-            if (config.isWantAuthnRequestsSigned()) {
+            }
-                builder.signWith(realm.getPrivateKey(), realm.getPublicKey(), realm.getCertificate())
+            try {
-                        .signDocument();
+                if (config.isPostBindingResponse()) {
-            }
+                    return binding.postBinding(builder.buildDocument()).response(config.getSingleLogoutServiceUrl());
-            try {
+                } else {
-                if (config.isPostBindingResponse()) {
+                    return binding.redirectBinding(builder.buildDocument()).response(config.getSingleLogoutServiceUrl());
-                    return builder.postBinding().response();
+                }
-                } else {
+            } catch (ConfigurationException e) {
-                    return builder.redirectBinding().response();
+                throw new RuntimeException(e);
-                }
+            } catch (ProcessingException e) {
-            } catch (ConfigurationException e) {
+                throw new RuntimeException(e);
-                throw new RuntimeException(e);
+            } catch (IOException e) {
-            } catch (ProcessingException e) {
+                throw new RuntimeException(e);
-                throw new RuntimeException(e);
+            }
-            } catch (IOException e) {
+
-                throw new RuntimeException(e);
+        }
-            }
+
-
+        private String getEntityId(UriInfo uriInfo, RealmModel realm) {
-        }
+            return UriBuilder.fromUri(uriInfo.getBaseUri()).path("realms").path(realm.getName()).build().toString();
-
+        }
-        private String getEntityId(UriInfo uriInfo, RealmModel realm) {
+        protected Response handleLoginResponse(String samlResponse, SAMLDocumentHolder holder, ResponseType responseType, String relayState) {
-            return UriBuilder.fromUri(uriInfo.getBaseUri()).path("realms").path(realm.getName()).build().toString();
+
-        }
+            try {
-        protected Response handleLoginResponse(String samlResponse, SAMLDocumentHolder holder, ResponseType responseType, String relayState) {
+                AssertionType assertion = AssertionUtil.getAssertion(responseType, realm.getPrivateKey());
-
+                SubjectType subject = assertion.getSubject();
-            try {
+                SubjectType.STSubType subType = subject.getSubType();
-                AssertionType assertion = getAssertion(responseType);
+                NameIDType subjectNameID = (NameIDType) subType.getBaseID();
-                SubjectType subject = assertion.getSubject();
+                //Map<String, String> notes = new HashMap<>();
-                SubjectType.STSubType subType = subject.getSubType();
+                BrokeredIdentityContext identity = new BrokeredIdentityContext(subjectNameID.getValue());
-                NameIDType subjectNameID = (NameIDType) subType.getBaseID();
+                identity.setCode(relayState);
-                //Map<String, String> notes = new HashMap<>();
+                identity.getContextData().put(SAML_LOGIN_RESPONSE, responseType);
-                BrokeredIdentityContext identity = new BrokeredIdentityContext(subjectNameID.getValue());
+                identity.getContextData().put(SAML_ASSERTION, assertion);
-                identity.setCode(relayState);
+
-                identity.getContextData().put(SAML_LOGIN_RESPONSE, responseType);
+                identity.setUsername(subjectNameID.getValue());
-                identity.getContextData().put(SAML_ASSERTION, assertion);
+
-
+                //SAML Spec 2.2.2 Format is optional
-                identity.setUsername(subjectNameID.getValue());
+                if (subjectNameID.getFormat() != null && subjectNameID.getFormat().toString().equals(JBossSAMLURIConstants.NAMEID_FORMAT_EMAIL.get())) {
-
+                    identity.setEmail(subjectNameID.getValue());
-                if (subjectNameID.getFormat().toString().equals(JBossSAMLURIConstants.NAMEID_FORMAT_EMAIL.get())) {
+                }
-                    identity.setEmail(subjectNameID.getValue());
+
-                }
+                if (config.isStoreToken()) {
-
+                    identity.setToken(samlResponse);
-                if (config.isStoreToken()) {
+                }
-                    identity.setToken(samlResponse);
+
-                }
+                AuthnStatementType authn = null;
-
+                for (Object statement : assertion.getStatements()) {
-                AuthnStatementType authn = null;
+                    if (statement instanceof AuthnStatementType) {
-                for (Object statement : assertion.getStatements()) {
+                        authn = (AuthnStatementType)statement;
-                    if (statement instanceof AuthnStatementType) {
+                        identity.getContextData().put(SAML_AUTHN_STATEMENT, authn);
-                        authn = (AuthnStatementType)statement;
+                        break;
-                        identity.getContextData().put(SAML_AUTHN_STATEMENT, authn);
+                    }
-                        break;
+                }
-                    }
+                if (assertion.getAttributeStatements() != null ) {
-                }
+                    for (AttributeStatementType attrStatement : assertion.getAttributeStatements()) {
-                if (assertion.getAttributeStatements() != null ) {
+                        for (AttributeStatementType.ASTChoiceType choice : attrStatement.getAttributes()) {
-                    for (AttributeStatementType attrStatement : assertion.getAttributeStatements()) {
+                            AttributeType attribute = choice.getAttribute();
-                        for (AttributeStatementType.ASTChoiceType choice : attrStatement.getAttributes()) {
+                            if (X500SAMLProfileConstants.EMAIL.getFriendlyName().equals(attribute.getFriendlyName())
-                            AttributeType attribute = choice.getAttribute();
+                                    || X500SAMLProfileConstants.EMAIL.get().equals(attribute.getName())) {
-                            if (X500SAMLProfileConstants.EMAIL.getFriendlyName().equals(attribute.getFriendlyName())
+                                if (!attribute.getAttributeValue().isEmpty()) identity.setEmail(attribute.getAttributeValue().get(0).toString());
-                                    || X500SAMLProfileConstants.EMAIL.get().equals(attribute.getName())) {
+                            }
-                                if (!attribute.getAttributeValue().isEmpty()) identity.setEmail(attribute.getAttributeValue().get(0).toString());
+                        }
-                            }
+
-                        }
+                    }
-
+
-                    }
+                }
-
+                String brokerUserId = config.getAlias() + "." + subjectNameID.getValue();
-                }
+                identity.setBrokerUserId(brokerUserId);
-                String brokerUserId = config.getAlias() + "." + subjectNameID.getValue();
+                identity.setIdpConfig(config);
-                identity.setBrokerUserId(brokerUserId);
+                identity.setIdp(provider);
-                identity.setIdpConfig(config);
+                if (authn != null && authn.getSessionIndex() != null) {
-                identity.setIdp(provider);
+                    identity.setBrokerSessionId(identity.getBrokerUserId() + "." + authn.getSessionIndex());
-                if (authn != null && authn.getSessionIndex() != null) {
+                 }
-                    identity.setBrokerSessionId(identity.getBrokerUserId() + "." + authn.getSessionIndex());
+
-                 }
+
-
+                return callback.authenticated(identity);
-
+
-                return callback.authenticated(identity);
+            } catch (Exception e) {
-
+                throw new IdentityBrokerException("Could not process response from SAML identity provider.", e);
-            } catch (Exception e) {
+            }
-                throw new IdentityBrokerException("Could not process response from SAML identity provider.", e);
+        }
-            }
+
-        }
+
-
+
-
+
-
+        public Response handleSamlResponse(String samlResponse, String relayState) {
-        private AssertionType getAssertion(ResponseType responseType) throws ProcessingException {
+            SAMLDocumentHolder holder = extractResponseDocument(samlResponse);
-            List<ResponseType.RTChoiceType> assertions = responseType.getAssertions();
+            StatusResponseType statusResponse = (StatusResponseType)holder.getSamlObject();
-
+            // validate destination
-            if (assertions.isEmpty()) {
+            if (statusResponse.getDestination() != null && !uriInfo.getAbsolutePath().toString().equals(statusResponse.getDestination())) {
-                throw new IdentityBrokerException("No assertion from response.");
+                event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
-            }
+                event.detail(Details.REASON, "invalid_destination");
-
+                event.error(Errors.INVALID_SAML_RESPONSE);
-            ResponseType.RTChoiceType rtChoiceType = assertions.get(0);
+                return ErrorPage.error(session, Messages.INVALID_FEDERATED_IDENTITY_ACTION);
-            EncryptedAssertionType encryptedAssertion = rtChoiceType.getEncryptedAssertion();
+            }
-
+            if (config.isValidateSignature()) {
-            if (encryptedAssertion != null) {
+                try {
-                decryptAssertion(responseType, realm.getPrivateKey());
+                    verifySignature(GeneralConstants.SAML_RESPONSE_KEY, holder);
-
+                } catch (VerificationException e) {
-            }
+                    logger.error("validation failed", e);
-            return responseType.getAssertions().get(0).getAssertion();
+                    event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
-        }
+                    event.error(Errors.INVALID_SIGNATURE);
-
+                    return ErrorPage.error(session, Messages.INVALID_FEDERATED_IDENTITY_ACTION);
-        public Response handleSamlResponse(String samlResponse, String relayState) {
+                }
-            SAMLDocumentHolder holder = extractResponseDocument(samlResponse);
+            }
-            StatusResponseType statusResponse = (StatusResponseType)holder.getSamlObject();
+            if (statusResponse instanceof ResponseType) {
-            // validate destination
+                return handleLoginResponse(samlResponse, holder, (ResponseType)statusResponse, relayState);
-            if (!uriInfo.getAbsolutePath().toString().equals(statusResponse.getDestination())) {
+
-                event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
+            } else {
-                event.error(Errors.INVALID_SAML_RESPONSE);
+                // todo need to check that it is actually a LogoutResponse
-                event.detail(Details.REASON, "invalid_destination");
+                return handleLogoutResponse(holder, statusResponse, relayState);
-                return ErrorPage.error(session, Messages.INVALID_FEDERATED_IDENTITY_ACTION);
+            }
-            }
+            //throw new RuntimeException("Unknown response type");
-            if (config.isValidateSignature()) {
+
-                try {
+        }
-                    verifySignature(holder);
+
-                } catch (VerificationException e) {
+        protected Response handleLogoutResponse(SAMLDocumentHolder holder, StatusResponseType responseType, String relayState) {
-                    logger.error("validation failed", e);
+            if (relayState == null) {
-                    event.event(EventType.IDENTITY_PROVIDER_RESPONSE);
+                logger.error("no valid user session");
-                    event.error(Errors.INVALID_SIGNATURE);
+                event.event(EventType.LOGOUT);
-                    return ErrorPage.error(session, Messages.INVALID_FEDERATED_IDENTITY_ACTION);
+                event.error(Errors.USER_SESSION_NOT_FOUND);
-                }
+                return ErrorPage.error(session, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
-            }
+            }
-            if (statusResponse instanceof ResponseType) {
+            UserSessionModel userSession = session.sessions().getUserSession(realm, relayState);
-                return handleLoginResponse(samlResponse, holder, (ResponseType)statusResponse, relayState);
+            if (userSession == null) {
-
+                logger.error("no valid user session");
-            } else {
+                event.event(EventType.LOGOUT);
-                // todo need to check that it is actually a LogoutResponse
+                event.error(Errors.USER_SESSION_NOT_FOUND);
-                return handleLogoutResponse(holder, statusResponse, relayState);
+                return ErrorPage.error(session, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
-            }
+            }
-            //throw new RuntimeException("Unknown response type");
+            if (userSession.getState() != UserSessionModel.State.LOGGING_OUT) {
-
+                logger.error("usersession in different state");
-        }
+                event.event(EventType.LOGOUT);
-
+                event.error(Errors.USER_SESSION_NOT_FOUND);
-        protected Response handleLogoutResponse(SAMLDocumentHolder holder, StatusResponseType responseType, String relayState) {
+                return ErrorPage.error(session, Messages.SESSION_NOT_ACTIVE);
-            if (relayState == null) {
+            }
-                logger.error("no valid user session");
+            return AuthenticationManager.finishBrowserLogout(session, realm, userSession, uriInfo, clientConnection, headers);
-                event.event(EventType.LOGOUT);
+        }
-                event.error(Errors.USER_SESSION_NOT_FOUND);
+
-                return ErrorPage.error(session, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
+
-            }
+
-            UserSessionModel userSession = session.sessions().getUserSession(realm, relayState);
+
-            if (userSession == null) {
+
-                logger.error("no valid user session");
+    }
-                event.event(EventType.LOGOUT);
+
-                event.error(Errors.USER_SESSION_NOT_FOUND);
+    protected class PostBinding extends Binding {
-                return ErrorPage.error(session, Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR);
+        @Override
-            }
+        protected void verifySignature(String key, SAMLDocumentHolder documentHolder) throws VerificationException {
-            if (userSession.getState() != UserSessionModel.State.LOGGING_OUT) {
+            SamlProtocolUtils.verifyDocumentSignature(documentHolder.getSamlDocument(), getIDPKey());
-                logger.error("usersession in different state");
+        }
-                event.event(EventType.LOGOUT);
+
-                event.error(Errors.USER_SESSION_NOT_FOUND);
+        @Override
-                return ErrorPage.error(session, Messages.SESSION_NOT_ACTIVE);
+        protected SAMLDocumentHolder extractRequestDocument(String samlRequest) {
-            }
+            return SAMLRequestParser.parseRequestPostBinding(samlRequest);
-            return AuthenticationManager.finishBrowserLogout(session, realm, userSession, uriInfo, clientConnection, headers);
+        }
-        }
+        @Override
-
+        protected SAMLDocumentHolder extractResponseDocument(String response) {
-
+            byte[] samlBytes = PostBindingUtil.base64Decode(response);
-        protected ResponseType decryptAssertion(ResponseType responseType, PrivateKey privateKey) throws ProcessingException {
+            String xml = new String(samlBytes);
-            SAML2Response saml2Response = new SAML2Response();
+            return SAMLRequestParser.parseResponseDocument(samlBytes);
-
+        }
-            try {
+
-                Document doc = saml2Response.convert(responseType);
+        @Override
-                Element enc = DocumentUtil.getElement(doc, new QName(JBossSAMLConstants.ENCRYPTED_ASSERTION.get()));
+        protected String getBindingType() {
-
+            return SamlProtocol.SAML_POST_BINDING;
-                if (enc == null) {
+        }
-                    throw new IdentityBrokerException("No encrypted assertion found.");
+    }
-                }
+
-
+    protected class RedirectBinding extends Binding {
-                String oldID = enc.getAttribute(JBossSAMLConstants.ID.get());
+        @Override
-                Document newDoc = DocumentUtil.createDocument();
+        protected void verifySignature(String key, SAMLDocumentHolder documentHolder) throws VerificationException {
-                Node importedNode = newDoc.importNode(enc, true);
+            PublicKey publicKey = getIDPKey();
-                newDoc.appendChild(importedNode);
+            SamlProtocolUtils.verifyRedirectSignature(publicKey, uriInfo, key);
-
+        }
-                Element decryptedDocumentElement = XMLEncryptionUtil.decryptElementInDocument(newDoc, privateKey);
+
-                SAMLParser parser = new SAMLParser();
+
-
+
-                JAXPValidationUtil.checkSchemaValidation(decryptedDocumentElement);
+        @Override
-                AssertionType assertion = (AssertionType) parser.parse(StaxParserUtil.getXMLEventReader(DocumentUtil
+        protected SAMLDocumentHolder extractRequestDocument(String samlRequest) {
-                        .getNodeAsStream(decryptedDocumentElement)));
+            return SAMLRequestParser.parseRequestRedirectBinding(samlRequest);
-
+        }
-                responseType.replaceAssertion(oldID, new ResponseType.RTChoiceType(assertion));
+
-
+        @Override
-                return responseType;
+        protected SAMLDocumentHolder extractResponseDocument(String response) {
-            } catch (Exception e) {
+            return SAMLRequestParser.parseRequestRedirectBinding(response);
-                throw new IdentityBrokerException("Could not decrypt assertion.", e);
+        }
-            }
+
-        }
+        @Override
-
+        protected String getBindingType() {
-
+            return SamlProtocol.SAML_REDIRECT_BINDING;
-    }
+        }
-
+
-    protected class PostBinding extends Binding {
+    }
-        @Override
+
-        protected void verifySignature(SAMLDocumentHolder documentHolder) throws VerificationException {
+}
-            SamlProtocolUtils.verifyDocumentSignature(documentHolder.getSamlDocument(), getIDPKey());
-        }
-
-        @Override
-        protected SAMLDocumentHolder extractRequestDocument(String samlRequest) {
-            return SAMLRequestParser.parseRequestPostBinding(samlRequest);
-        }
-        @Override
-        protected SAMLDocumentHolder extractResponseDocument(String response) {
-            byte[] samlBytes = PostBindingUtil.base64Decode(response);
-            String xml = new String(samlBytes);
-            return SAMLRequestParser.parseResponseDocument(samlBytes);
-        }
-
-        @Override
-        protected String getBindingType() {
-            return SamlProtocol.SAML_POST_BINDING;
-        }
-    }
-
-    protected class RedirectBinding extends Binding {
-        @Override
-        protected void verifySignature(SAMLDocumentHolder documentHolder) throws VerificationException {
-            PublicKey publicKey = getIDPKey();
-            SamlProtocolUtils.verifyRedirectSignature(publicKey, uriInfo);
-        }
-
-
-
-        @Override
-        protected SAMLDocumentHolder extractRequestDocument(String samlRequest) {
-            return SAMLRequestParser.parseRequestRedirectBinding(samlRequest);
-        }
-
-        @Override
-        protected SAMLDocumentHolder extractResponseDocument(String response) {
-            return SAMLRequestParser.parseRequestRedirectBinding(response);
-        }
-
-        @Override
-        protected String getBindingType() {
-            return SamlProtocol.SAML_REDIRECT_BINDING;
-        }
-
-    }
-
-}

broker/saml/src/main/java/org/keycloak/broker/saml/SAMLIdentityProvider.java

@@ -33,20 +33,18 @@ import org.keycloak.models.ClientSessionModel;
 import org.keycloak.models.FederatedIdentityModel;
 import org.keycloak.models.RealmModel;
 import org.keycloak.models.UserSessionModel;
-import org.keycloak.protocol.saml.SAML2AuthnRequestBuilder;
+import org.keycloak.protocol.saml.JaxrsSAML2BindingBuilder;
-import org.keycloak.protocol.saml.SAML2LogoutRequestBuilder;
+import org.keycloak.saml.SAML2AuthnRequestBuilder;
-import org.keycloak.protocol.saml.SAML2NameIDPolicyBuilder;
+import org.keycloak.saml.SAML2LogoutRequestBuilder;
+import org.keycloak.saml.SAML2NameIDPolicyBuilder;
+import org.keycloak.saml.SignatureAlgorithm;
 import org.keycloak.saml.common.constants.GeneralConstants;
 import org.keycloak.saml.common.constants.JBossSAMLURIConstants;
-import org.keycloak.saml.common.exceptions.ConfigurationException;
-import org.keycloak.saml.common.exceptions.ParsingException;
-import org.keycloak.saml.common.exceptions.ProcessingException;
 
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.UriBuilder;
 import javax.ws.rs.core.UriInfo;
-import java.io.IOException;
 import java.security.KeyPair;
 import java.security.PrivateKey;
 import java.security.PublicKey;
@@ -92,7 +90,8 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
                     .issuer(issuerURL)
                     .forceAuthn(getConfig().isForceAuthn())
                     .protocolBinding(protocolBinding)
-                    .nameIdPolicy(SAML2NameIDPolicyBuilder.format(nameIDPolicyFormat))
+                    .nameIdPolicy(SAML2NameIDPolicyBuilder.format(nameIDPolicyFormat));
+            JaxrsSAML2BindingBuilder binding = new JaxrsSAML2BindingBuilder()
                     .relayState(request.getState());
 
             if (getConfig().isWantAuthnRequestsSigned()) {
@@ -109,14 +108,15 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
 
                 KeyPair keypair = new KeyPair(publicKey, privateKey);
 
-                authnRequestBuilder.signWith(keypair);
+                binding.signWith(keypair);
-                authnRequestBuilder.signDocument();
+                binding.signatureAlgorithm(getSignatureAlgorithm());
+                binding.signDocument();
             }
 
             if (getConfig().isPostBindingAuthnRequest()) {
-                return authnRequestBuilder.postBinding().request();
+                return binding.postBinding(authnRequestBuilder.toDocument()).request(destinationUrl);
             } else {
-                return authnRequestBuilder.redirectBinding().request();
+                return binding.redirectBinding(authnRequestBuilder.toDocument()).request(destinationUrl);
             }
         } catch (Exception e) {
             throw new IdentityBrokerException("Could not create authentication request.", e);
@@ -153,9 +153,10 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
         String singleLogoutServiceUrl = getConfig().getSingleLogoutServiceUrl();
         if (singleLogoutServiceUrl == null || singleLogoutServiceUrl.trim().equals("") || !getConfig().isBackchannelSupported()) return;
         SAML2LogoutRequestBuilder logoutBuilder = buildLogoutRequest(userSession, uriInfo, realm, singleLogoutServiceUrl);
+        JaxrsSAML2BindingBuilder binding = buildLogoutBinding(userSession, realm);
         try {
             int status = SimpleHttp.doPost(singleLogoutServiceUrl)
-                    .param(GeneralConstants.SAML_REQUEST_KEY, logoutBuilder.postBinding().encoded())
+                    .param(GeneralConstants.SAML_REQUEST_KEY, binding.postBinding(logoutBuilder.buildDocument()).encoded())
                     .param(GeneralConstants.RELAY_STATE, userSession.getId()).asStatus();
             boolean success = status >=200 && status < 400;
             if (!success) {
@@ -178,7 +179,8 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
        } else {
             try {
                 SAML2LogoutRequestBuilder logoutBuilder = buildLogoutRequest(userSession, uriInfo, realm, singleLogoutServiceUrl);
-                return logoutBuilder.postBinding().request();
+                JaxrsSAML2BindingBuilder binding = buildLogoutBinding(userSession, realm);
+                return binding.postBinding(logoutBuilder.buildDocument()).request(singleLogoutServiceUrl);
             } catch (Exception e) {
                 throw new RuntimeException(e);
             }
@@ -192,13 +194,19 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
                 .issuer(getEntityId(uriInfo, realm))
                 .sessionIndex(userSession.getNote(SAMLEndpoint.SAML_FEDERATED_SESSION_INDEX))
                 .userPrincipal(userSession.getNote(SAMLEndpoint.SAML_FEDERATED_SUBJECT), userSession.getNote(SAMLEndpoint.SAML_FEDERATED_SUBJECT_NAMEFORMAT))
-                .destination(singleLogoutServiceUrl)
+                .destination(singleLogoutServiceUrl);
+        return logoutBuilder;
+    }
+
+    private JaxrsSAML2BindingBuilder buildLogoutBinding(UserSessionModel userSession, RealmModel realm) {
+        JaxrsSAML2BindingBuilder binding = new JaxrsSAML2BindingBuilder()
                 .relayState(userSession.getId());
         if (getConfig().isWantAuthnRequestsSigned()) {
-            logoutBuilder.signWith(realm.getPrivateKey(), realm.getPublicKey(), realm.getCertificate())
+            binding.signWith(realm.getPrivateKey(), realm.getPublicKey(), realm.getCertificate())
+                    .signatureAlgorithm(getSignatureAlgorithm())
                     .signDocument();
         }
-        return logoutBuilder;
+        return binding;
     }
 
     @Override
@@ -220,7 +228,7 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
 
 
         String descriptor =
-                "<EntityDescriptor entityID=\"" + getEntityId(uriInfo, realm) + "\">\n" +
+                "<EntityDescriptor xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"" + getEntityId(uriInfo, realm) + "\">\n" +
                 "    <SPSSODescriptor AuthnRequestsSigned=\"" + getConfig().isWantAuthnRequestsSigned() + "\"\n" +
                 "            protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol urn:oasis:names:tc:SAML:1.1:protocol http://schemas.xmlsoap.org/ws/2003/07/secext\">\n" +
                 "        <NameIDFormat>" + getConfig().getNameIDPolicyFormat() + "\n" +
@@ -245,4 +253,14 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP
                 "</EntityDescriptor>\n";
         return Response.ok(descriptor, MediaType.APPLICATION_XML_TYPE).build();
     }
+
+    public SignatureAlgorithm getSignatureAlgorithm() {
+        String alg = getConfig().getSignatureAlgorithm();
+        if (alg != null) {
+            SignatureAlgorithm algorithm = SignatureAlgorithm.valueOf(alg);
+            if (algorithm != null) return algorithm;
+        }
+        return SignatureAlgorithm.RSA_SHA256;
+    }
+
 }

broker/saml/src/main/java/org/keycloak/broker/saml/SAMLIdentityProviderConfig.java

@@ -87,6 +87,14 @@ public class SAMLIdentityProviderConfig extends IdentityProviderModel {
         getConfig().put("wantAuthnRequestsSigned", String.valueOf(wantAuthnRequestsSigned));
     }
 
+    public String getSignatureAlgorithm() {
+        return getConfig().get("signatureAlgorithm");
+    }
+
+    public void setSignatureAlgorithm(String signatureAlgorithm) {
+        getConfig().put("signatureAlgorithm", signatureAlgorithm);
+    }
+
     public String getEncryptionPublicKey() {
         return getConfig().get("encryptionPublicKey");
     }

broker/saml/src/main/java/org/keycloak/broker/saml/SAMLIdentityProviderFactory.java

@@ -18,13 +18,17 @@
 package org.keycloak.broker.saml;
 
 import org.keycloak.broker.provider.AbstractIdentityProviderFactory;
+import org.keycloak.broker.saml.mappers.UsernameTemplateMapper;
 import org.keycloak.dom.saml.v2.metadata.EndpointType;
 import org.keycloak.dom.saml.v2.metadata.EntitiesDescriptorType;
 import org.keycloak.dom.saml.v2.metadata.EntityDescriptorType;
 import org.keycloak.dom.saml.v2.metadata.IDPSSODescriptorType;
 import org.keycloak.dom.saml.v2.metadata.KeyDescriptorType;
 import org.keycloak.dom.saml.v2.metadata.KeyTypes;
+import org.keycloak.models.IdentityProviderMapperModel;
 import org.keycloak.models.IdentityProviderModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
 import org.keycloak.saml.common.constants.JBossSAMLURIConstants;
 import org.keycloak.saml.common.exceptions.ParsingException;
 import org.keycloak.saml.common.util.DocumentUtil;
@@ -69,75 +73,79 @@ public class SAMLIdentityProviderFactory extends AbstractIdentityProviderFactory
             List<EntityDescriptorType.EDTChoiceType> choiceType = entityType.getChoiceType();
 
             if (!choiceType.isEmpty()) {
-                EntityDescriptorType.EDTChoiceType edtChoiceType = choiceType.get(0);
+                IDPSSODescriptorType idpDescriptor = null;
-                List<EntityDescriptorType.EDTDescriptorChoiceType> descriptors = edtChoiceType.getDescriptors();
 
-                if (!descriptors.isEmpty()) {
+                //Metadata documents can contain multiple Descriptors (See ADFS metadata documents) such as RoleDescriptor, SPSSODescriptor, IDPSSODescriptor.
-                    EntityDescriptorType.EDTDescriptorChoiceType edtDescriptorChoiceType = descriptors.get(0);
+                //So we need to loop through to find the IDPSSODescriptor.
-                    IDPSSODescriptorType idpDescriptor = edtDescriptorChoiceType.getIdpDescriptor();
+                for(EntityDescriptorType.EDTChoiceType edtChoiceType : entityType.getChoiceType()) {
+                    List<EntityDescriptorType.EDTDescriptorChoiceType> descriptors = edtChoiceType.getDescriptors();
 
-                    if (idpDescriptor != null) {
+                    if(!descriptors.isEmpty() && descriptors.get(0).getIdpDescriptor() != null) {
-                        SAMLIdentityProviderConfig samlIdentityProviderConfig = new SAMLIdentityProviderConfig();
+                        idpDescriptor = descriptors.get(0).getIdpDescriptor();
-                        String singleSignOnServiceUrl = null;
-                        boolean postBinding = false;
-                        for (EndpointType endpoint : idpDescriptor.getSingleSignOnService()) {
-                            if (endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_POST_BINDING.get())) {
-                                singleSignOnServiceUrl = endpoint.getLocation().toString();
-                                postBinding = true;
-                                break;
-                            } else if (endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_REDIRECT_BINDING.get())){
-                                singleSignOnServiceUrl = endpoint.getLocation().toString();
-                            }
-                        }
-                        String singleLogoutServiceUrl = null;
-                        for (EndpointType endpoint : idpDescriptor.getSingleLogoutService()) {
-                            if (postBinding && endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_POST_BINDING.get())) {
-                                singleLogoutServiceUrl = endpoint.getLocation().toString();
-                                break;
-                            } else if (!postBinding && endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_REDIRECT_BINDING.get())){
-                                singleLogoutServiceUrl = endpoint.getLocation().toString();
-                                break;
-                            }
-
-                        }
-                        samlIdentityProviderConfig.setSingleLogoutServiceUrl(singleLogoutServiceUrl);
-                        samlIdentityProviderConfig.setSingleSignOnServiceUrl(singleSignOnServiceUrl);
-                        samlIdentityProviderConfig.setWantAuthnRequestsSigned(idpDescriptor.isWantAuthnRequestsSigned());
-                        samlIdentityProviderConfig.setValidateSignature(idpDescriptor.isWantAuthnRequestsSigned());
-                        samlIdentityProviderConfig.setPostBindingResponse(postBinding);
-                        samlIdentityProviderConfig.setPostBindingAuthnRequest(postBinding);
-
-                        List<KeyDescriptorType> keyDescriptor = idpDescriptor.getKeyDescriptor();
-                        String defaultCertificate = null;
-
-                        if (keyDescriptor != null) {
-                            for (KeyDescriptorType keyDescriptorType : keyDescriptor) {
-                                Element keyInfo = keyDescriptorType.getKeyInfo();
-                                Element x509KeyInfo = DocumentUtil.getChildElement(keyInfo, new QName("dsig", "X509Certificate"));
-
-                                if (KeyTypes.SIGNING.equals(keyDescriptorType.getUse())) {
-                                    samlIdentityProviderConfig.setSigningCertificate(x509KeyInfo.getTextContent());
-                                } else if (KeyTypes.ENCRYPTION.equals(keyDescriptorType.getUse())) {
-                                    samlIdentityProviderConfig.setEncryptionPublicKey(x509KeyInfo.getTextContent());
-                                } else if (keyDescriptorType.getUse() ==  null) {
-                                    defaultCertificate = x509KeyInfo.getTextContent();
-                                }
-                            }
-                        }
-
-                        if (defaultCertificate != null) {
-                            if (samlIdentityProviderConfig.getSigningCertificate() == null) {
-                                samlIdentityProviderConfig.setSigningCertificate(defaultCertificate);
-                            }
-
-                            if (samlIdentityProviderConfig.getEncryptionPublicKey() == null) {
-                                samlIdentityProviderConfig.setEncryptionPublicKey(defaultCertificate);
-                            }
-                        }
-
-                        return samlIdentityProviderConfig.getConfig();
                     }
                 }
+
+                if (idpDescriptor != null) {
+                    SAMLIdentityProviderConfig samlIdentityProviderConfig = new SAMLIdentityProviderConfig();
+                    String singleSignOnServiceUrl = null;
+                    boolean postBinding = false;
+                    for (EndpointType endpoint : idpDescriptor.getSingleSignOnService()) {
+                        if (endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_POST_BINDING.get())) {
+                            singleSignOnServiceUrl = endpoint.getLocation().toString();
+                            postBinding = true;
+                            break;
+                        } else if (endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_REDIRECT_BINDING.get())){
+                            singleSignOnServiceUrl = endpoint.getLocation().toString();
+                        }
+                    }
+                    String singleLogoutServiceUrl = null;
+                    for (EndpointType endpoint : idpDescriptor.getSingleLogoutService()) {
+                        if (postBinding && endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_POST_BINDING.get())) {
+                            singleLogoutServiceUrl = endpoint.getLocation().toString();
+                            break;
+                        } else if (!postBinding && endpoint.getBinding().toString().equals(JBossSAMLURIConstants.SAML_HTTP_REDIRECT_BINDING.get())){
+                            singleLogoutServiceUrl = endpoint.getLocation().toString();
+                            break;
+                        }
+
+                    }
+                    samlIdentityProviderConfig.setSingleLogoutServiceUrl(singleLogoutServiceUrl);
+                    samlIdentityProviderConfig.setSingleSignOnServiceUrl(singleSignOnServiceUrl);
+                    samlIdentityProviderConfig.setWantAuthnRequestsSigned(idpDescriptor.isWantAuthnRequestsSigned());
+                    samlIdentityProviderConfig.setValidateSignature(idpDescriptor.isWantAuthnRequestsSigned());
+                    samlIdentityProviderConfig.setPostBindingResponse(postBinding);
+                    samlIdentityProviderConfig.setPostBindingAuthnRequest(postBinding);
+
+                    List<KeyDescriptorType> keyDescriptor = idpDescriptor.getKeyDescriptor();
+                    String defaultCertificate = null;
+
+                    if (keyDescriptor != null) {
+                        for (KeyDescriptorType keyDescriptorType : keyDescriptor) {
+                            Element keyInfo = keyDescriptorType.getKeyInfo();
+                            Element x509KeyInfo = DocumentUtil.getChildElement(keyInfo, new QName("dsig", "X509Certificate"));
+
+                            if (KeyTypes.SIGNING.equals(keyDescriptorType.getUse())) {
+                                samlIdentityProviderConfig.setSigningCertificate(x509KeyInfo.getTextContent());
+                            } else if (KeyTypes.ENCRYPTION.equals(keyDescriptorType.getUse())) {
+                                samlIdentityProviderConfig.setEncryptionPublicKey(x509KeyInfo.getTextContent());
+                            } else if (keyDescriptorType.getUse() ==  null) {
+                                defaultCertificate = x509KeyInfo.getTextContent();
+                            }
+                        }
+                    }
+
+                    if (defaultCertificate != null) {
+                        if (samlIdentityProviderConfig.getSigningCertificate() == null) {
+                            samlIdentityProviderConfig.setSigningCertificate(defaultCertificate);
+                        }
+
+                        if (samlIdentityProviderConfig.getEncryptionPublicKey() == null) {
+                            samlIdentityProviderConfig.setEncryptionPublicKey(defaultCertificate);
+                        }
+                    }
+
+                    return samlIdentityProviderConfig.getConfig();
+                }
             }
         } catch (ParsingException pe) {
             throw new RuntimeException("Could not parse IdP SAML Metadata", pe);
@@ -150,4 +158,5 @@ public class SAMLIdentityProviderFactory extends AbstractIdentityProviderFactory
     public String getId() {
         return PROVIDER_ID;
     }
+
 }

broker/saml/src/main/java/org/keycloak/broker/saml/mappers/AttributeToRoleMapper.java

@@ -1,140 +1,140 @@
-package org.keycloak.broker.saml.mappers;
+package org.keycloak.broker.saml.mappers;
-
+
-import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.HardcodedRoleMapper;
+import org.keycloak.broker.provider.HardcodedRoleMapper;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.IdentityBrokerException;
-import org.keycloak.broker.saml.SAMLEndpoint;
+import org.keycloak.broker.saml.SAMLEndpoint;
-import org.keycloak.broker.saml.SAMLIdentityProviderFactory;
+import org.keycloak.broker.saml.SAMLIdentityProviderFactory;
-import org.keycloak.dom.saml.v2.assertion.AssertionType;
+import org.keycloak.dom.saml.v2.assertion.AssertionType;
-import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
+import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
-import org.keycloak.dom.saml.v2.assertion.AttributeType;
+import org.keycloak.dom.saml.v2.assertion.AttributeType;
-import org.keycloak.models.ClientModel;
+import org.keycloak.models.ClientModel;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.RoleModel;
+import org.keycloak.models.RoleModel;
-import org.keycloak.models.UserModel;
+import org.keycloak.models.UserModel;
-import org.keycloak.provider.ProviderConfigProperty;
+import org.keycloak.provider.ProviderConfigProperty;
-import org.keycloak.representations.JsonWebToken;
+import org.keycloak.representations.JsonWebToken;
-
+
-import java.util.ArrayList;
+import java.util.ArrayList;
-import java.util.List;
+import java.util.List;
-import java.util.Map;
+import java.util.Map;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class AttributeToRoleMapper extends AbstractIdentityProviderMapper {
+public class AttributeToRoleMapper extends AbstractIdentityProviderMapper {
-
+
-    public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID};
+    public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID};
-
+
-    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-
+
-    public static final String ATTRIBUTE_NAME = "attribute.name";
+    public static final String ATTRIBUTE_NAME = "attribute.name";
-    public static final String ATTRIBUTE_FRIENDLY_NAME = "attribute.friendly.name";
+    public static final String ATTRIBUTE_FRIENDLY_NAME = "attribute.friendly.name";
-    public static final String ATTRIBUTE_VALUE = "attribute.value";
+    public static final String ATTRIBUTE_VALUE = "attribute.value";
-
+
-    static {
+    static {
-        ProviderConfigProperty property;
+        ProviderConfigProperty property;
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(ATTRIBUTE_NAME);
+        property.setName(ATTRIBUTE_NAME);
-        property.setLabel("Attribute Name");
+        property.setLabel("Attribute Name");
-        property.setHelpText("Name of attribute to search for in assertion.  You can leave this blank and specify a friendly name instead.");
+        property.setHelpText("Name of attribute to search for in assertion.  You can leave this blank and specify a friendly name instead.");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(ATTRIBUTE_FRIENDLY_NAME);
+        property.setName(ATTRIBUTE_FRIENDLY_NAME);
-        property.setLabel("Friendly Name");
+        property.setLabel("Friendly Name");
-        property.setHelpText("Friendly name of attribute to search for in assertion.  You can leave this blank and specify a name instead.");
+        property.setHelpText("Friendly name of attribute to search for in assertion.  You can leave this blank and specify a name instead.");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(ATTRIBUTE_VALUE);
+        property.setName(ATTRIBUTE_VALUE);
-        property.setLabel("Attribute Value");
+        property.setLabel("Attribute Value");
-        property.setHelpText("Value the attribute must have.  If the attribute is a list, then the value must be contained in the list.");
+        property.setHelpText("Value the attribute must have.  If the attribute is a list, then the value must be contained in the list.");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-        property = new ProviderConfigProperty();
+        property = new ProviderConfigProperty();
-        property.setName(HardcodedRoleMapper.ROLE);
+        property.setName(HardcodedRoleMapper.ROLE);
-        property.setLabel("Role");
+        property.setLabel("Role");
-        property.setHelpText("Role to grant to user.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
+        property.setHelpText("Role to grant to user.  Click 'Select Role' button to browse roles, or just type it in the textbox.  To reference an application role the syntax is appname.approle, i.e. myapp.myrole");
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setType(ProviderConfigProperty.ROLE_TYPE);
-        configProperties.add(property);
+        configProperties.add(property);
-    }
+    }
-
+
-    public static final String PROVIDER_ID = "saml-role-idp-mapper";
+    public static final String PROVIDER_ID = "saml-role-idp-mapper";
-
+
-    @Override
+    @Override
-    public List<ProviderConfigProperty> getConfigProperties() {
+    public List<ProviderConfigProperty> getConfigProperties() {
-        return configProperties;
+        return configProperties;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getId() {
+    public String getId() {
-        return PROVIDER_ID;
+        return PROVIDER_ID;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String[] getCompatibleProviders() {
+    public String[] getCompatibleProviders() {
-        return COMPATIBLE_PROVIDERS;
+        return COMPATIBLE_PROVIDERS;
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayCategory() {
+    public String getDisplayCategory() {
-        return "Role Mapper";
+        return "Role Mapper";
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getDisplayType() {
+    public String getDisplayType() {
-        return "SAML Attribute to Role";
+        return "SAML Attribute to Role";
-    }
+    }
-
+
-    @Override
+    @Override
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
+        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
-        if (isAttributePresent(mapperModel, context)) {
+        if (isAttributePresent(mapperModel, context)) {
-            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
+            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
-            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-            user.grantRole(role);
+            user.grantRole(role);
-        }
+        }
-    }
+    }
-
+
-    protected boolean isAttributePresent(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    protected boolean isAttributePresent(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String name = mapperModel.getConfig().get(ATTRIBUTE_NAME);
+        String name = mapperModel.getConfig().get(ATTRIBUTE_NAME);
-        if (name != null && name.trim().equals("")) name = null;
+        if (name != null && name.trim().equals("")) name = null;
-        String friendly = mapperModel.getConfig().get(ATTRIBUTE_FRIENDLY_NAME);
+        String friendly = mapperModel.getConfig().get(ATTRIBUTE_FRIENDLY_NAME);
-        if (friendly != null && friendly.trim().equals("")) friendly = null;
+        if (friendly != null && friendly.trim().equals("")) friendly = null;
-        String desiredValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
+        String desiredValue = mapperModel.getConfig().get(ATTRIBUTE_VALUE);
-        AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
+        AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
-        for (AttributeStatementType statement : assertion.getAttributeStatements()) {
+        for (AttributeStatementType statement : assertion.getAttributeStatements()) {
-            for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
+            for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
-                AttributeType attr = choice.getAttribute();
+                AttributeType attr = choice.getAttribute();
-                if (name != null && !name.equals(attr.getName())) continue;
+                if (name != null && !name.equals(attr.getName())) continue;
-                if (friendly != null && !name.equals(attr.getFriendlyName())) continue;
+                if (friendly != null && !name.equals(attr.getFriendlyName())) continue;
-                for (Object val : attr.getAttributeValue()) {
+                for (Object val : attr.getAttributeValue()) {
-                    if (val.equals(desiredValue)) return true;
+                    if (val.equals(desiredValue)) return true;
-                }
+                }
-            }
+            }
-        }
+        }
-        return false;
+        return false;
-    }
+    }
-
+
-    @Override
+    @Override
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
+        String roleName = mapperModel.getConfig().get(HardcodedRoleMapper.ROLE);
-        if (!isAttributePresent(mapperModel, context)) {
+        if (!isAttributePresent(mapperModel, context)) {
-            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
+            RoleModel role = HardcodedRoleMapper.getRoleFromString(realm, roleName);
-            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
+            if (role == null) throw new IdentityBrokerException("Unable to find role: " + roleName);
-            user.deleteRoleMapping(role);
+            user.deleteRoleMapping(role);
-        }
+        }
-
+
-    }
+    }
-
+
-    @Override
+    @Override
-    public String getHelpText() {
+    public String getHelpText() {
-        return "If a claim exists, grant the user the specified realm or application role.";
+        return "If a claim exists, grant the user the specified realm or application role.";
-    }
+    }
-
+
-}
+}

broker/saml/src/main/java/org/keycloak/broker/saml/mappers/UserAttributeMapper.java

@@ -1,132 +1,129 @@
-package org.keycloak.broker.saml.mappers;
+package org.keycloak.broker.saml.mappers;
-
+
-import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
-import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
-import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.saml.SAMLEndpoint;
-import org.keycloak.broker.saml.SAMLEndpoint;
+import org.keycloak.broker.saml.SAMLIdentityProviderFactory;
-import org.keycloak.broker.saml.SAMLIdentityProviderFactory;
+import org.keycloak.dom.saml.v2.assertion.AssertionType;
-import org.keycloak.dom.saml.v2.assertion.AssertionType;
+import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
-import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
+import org.keycloak.dom.saml.v2.assertion.AttributeType;
-import org.keycloak.dom.saml.v2.assertion.AttributeType;
+import org.keycloak.models.IdentityProviderMapperModel;
-import org.keycloak.models.ClientModel;
+import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.RealmModel;
-import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.UserModel;
-import org.keycloak.models.RealmModel;
+import org.keycloak.provider.ProviderConfigProperty;
-import org.keycloak.models.RoleModel;
+
-import org.keycloak.models.UserModel;
+import java.util.ArrayList;
-import org.keycloak.provider.ProviderConfigProperty;
+import java.util.List;
-
+
-import java.util.ArrayList;
+/**
-import java.util.List;
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-
+ * @version $Revision: 1 $
-/**
+ */
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+public class UserAttributeMapper extends AbstractIdentityProviderMapper {
- * @version $Revision: 1 $
+
- */
+    public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID};
-public class UserAttributeMapper extends AbstractIdentityProviderMapper {
+
-
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
-    public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID};
+
-
+    public static final String ATTRIBUTE_NAME = "attribute.name";
-    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+    public static final String ATTRIBUTE_FRIENDLY_NAME = "attribute.friendly.name";
-
+    public static final String USER_ATTRIBUTE = "user.attribute";
-    public static final String ATTRIBUTE_NAME = "attribute.name";
+
-    public static final String ATTRIBUTE_FRIENDLY_NAME = "attribute.friendly.name";
+    static {
-    public static final String USER_ATTRIBUTE = "user.attribute";
+        ProviderConfigProperty property;
-
+        property = new ProviderConfigProperty();
-    static {
+        property.setName(ATTRIBUTE_NAME);
-        ProviderConfigProperty property;
+        property.setLabel("Attribute Name");
-        property = new ProviderConfigProperty();
+        property.setHelpText("Name of attribute to search for in assertion.  You can leave this blank and specify a friendly name instead.");
-        property.setName(ATTRIBUTE_NAME);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        property.setLabel("Attribute Name");
+        configProperties.add(property);
-        property.setHelpText("Name of attribute to search for in assertion.  You can leave this blank and specify a friendly name instead.");
+        property = new ProviderConfigProperty();
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setName(ATTRIBUTE_FRIENDLY_NAME);
-        configProperties.add(property);
+        property.setLabel("Friendly Name");
-        property = new ProviderConfigProperty();
+        property.setHelpText("Friendly name of attribute to search for in assertion.  You can leave this blank and specify a name instead.");
-        property.setName(ATTRIBUTE_FRIENDLY_NAME);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        property.setLabel("Friendly Name");
+        configProperties.add(property);
-        property.setHelpText("Friendly name of attribute to search for in assertion.  You can leave this blank and specify a name instead.");
+        property = new ProviderConfigProperty();
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setName(USER_ATTRIBUTE);
-        configProperties.add(property);
+        property.setLabel("User Attribute Name");
-        property = new ProviderConfigProperty();
+        property.setHelpText("User attribute name to store saml attribute.");
-        property.setName(USER_ATTRIBUTE);
+        property.setType(ProviderConfigProperty.STRING_TYPE);
-        property.setLabel("User Attribute Name");
+        configProperties.add(property);
-        property.setHelpText("User attribute name to store saml attribute.");
+    }
-        property.setType(ProviderConfigProperty.STRING_TYPE);
+
-        configProperties.add(property);
+    public static final String PROVIDER_ID = "saml-user-attribute-idp-mapper";
-    }
+
-
+    @Override
-    public static final String PROVIDER_ID = "saml-user-attribute-idp-mapper";
+    public List<ProviderConfigProperty> getConfigProperties() {
-
+        return configProperties;
-    @Override
+    }
-    public List<ProviderConfigProperty> getConfigProperties() {
+
-        return configProperties;
+    @Override
-    }
+    public String getId() {
-
+        return PROVIDER_ID;
-    @Override
+    }
-    public String getId() {
+
-        return PROVIDER_ID;
+    @Override
-    }
+    public String[] getCompatibleProviders() {
-
+        return COMPATIBLE_PROVIDERS;
-    @Override
+    }
-    public String[] getCompatibleProviders() {
+
-        return COMPATIBLE_PROVIDERS;
+    @Override
-    }
+    public String getDisplayCategory() {
-
+        return "Attribute Importer";
-    @Override
+    }
-    public String getDisplayCategory() {
+
-        return "Attribute Importer";
+    @Override
-    }
+    public String getDisplayType() {
-
+        return "Attribute Importer";
-    @Override
+    }
-    public String getDisplayType() {
+
-        return "Attribute Importer";
+    @Override
-    }
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-
+        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
-    @Override
+        Object value = getAttribute(mapperModel, context);
-    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        if (value != null) {
-        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
+            user.setSingleAttribute(attribute, value.toString());
-        Object value = getAttribute(mapperModel, context);
+        }
-        if (value != null) {
+    }
-            user.setAttribute(attribute, value.toString());
+
-        }
+    protected String getAttribute(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-    }
+        String name = mapperModel.getConfig().get(ATTRIBUTE_NAME);
-
+        if (name != null && name.trim().equals("")) name = null;
-    protected String getAttribute(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String friendly = mapperModel.getConfig().get(ATTRIBUTE_FRIENDLY_NAME);
-        String name = mapperModel.getConfig().get(ATTRIBUTE_NAME);
+        if (friendly != null && friendly.trim().equals("")) friendly = null;
-        if (name != null && name.trim().equals("")) name = null;
+        AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
-        String friendly = mapperModel.getConfig().get(ATTRIBUTE_FRIENDLY_NAME);
+        for (AttributeStatementType statement : assertion.getAttributeStatements()) {
-        if (friendly != null && friendly.trim().equals("")) friendly = null;
+            for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
-        AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
+                AttributeType attr = choice.getAttribute();
-        for (AttributeStatementType statement : assertion.getAttributeStatements()) {
+                if (name != null && !name.equals(attr.getName())) continue;
-            for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
+                if (friendly != null && !friendly.equals(attr.getFriendlyName())) continue;
-                AttributeType attr = choice.getAttribute();
+
-                if (name != null && !name.equals(attr.getName())) continue;
+                List<Object> attributeValue = attr.getAttributeValue();
-                if (friendly != null && !name.equals(attr.getFriendlyName())) continue;
+                if (attributeValue == null || attributeValue.isEmpty()) return null;
-
+                return attributeValue.get(0).toString();
-                List<Object> attributeValue = attr.getAttributeValue();
+            }
-                if (attributeValue == null || attributeValue.isEmpty()) return null;
+        }
-                return attributeValue.get(0).toString();
+        return null;
-            }
+    }
-        }
+
-        return null;
+    @Override
-    }
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
-
+        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
-    @Override
+        Object value = getAttribute(mapperModel, context);
-    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        String current = user.getFirstAttribute(attribute);
-        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
+        if (value != null && !value.equals(current)) {
-        Object value = getAttribute(mapperModel, context);
+            user.setSingleAttribute(attribute, value.toString());
-        String current = user.getAttribute(attribute);
+        } else if (value == null) {
-        if (value != null && !value.equals(current)) {
+            user.removeAttribute(attribute);
-            user.setAttribute(attribute, value.toString());
+        }
-        } else if (value == null) {
+
-            user.removeAttribute(attribute);
+    }
-        }
+
-
+    @Override
-    }
+    public String getHelpText() {
-
+        return "Import declared saml attribute if it exists in assertion into the specified user attribute.";
-    @Override
+    }
-    public String getHelpText() {
+
-        return "Import declared saml attribute if it exists in assertion into the specified user attribute.";
+}
-    }
-
-}

broker/saml/src/main/java/org/keycloak/broker/saml/mappers/UsernameTemplateMapper.java

@@ -0,0 +1,133 @@
+package org.keycloak.broker.saml.mappers;
+
+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.saml.SAMLEndpoint;
+import org.keycloak.broker.saml.SAMLIdentityProviderFactory;
+import org.keycloak.dom.saml.v2.assertion.AssertionType;
+import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;
+import org.keycloak.dom.saml.v2.assertion.AttributeType;
+import org.keycloak.dom.saml.v2.assertion.NameIDType;
+import org.keycloak.dom.saml.v2.assertion.SubjectType;
+import org.keycloak.models.IdentityProviderMapperModel;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.models.utils.KeycloakModelUtils;
+import org.keycloak.provider.ProviderConfigProperty;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class UsernameTemplateMapper extends AbstractIdentityProviderMapper {
+
+    public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID};
+
+    private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
+
+    public static final String TEMPLATE = "template";
+
+    static {
+        ProviderConfigProperty property;
+        property = new ProviderConfigProperty();
+        property.setName(TEMPLATE);
+        property.setLabel("Template");
+        property.setHelpText("Template to use to format the username to import.  Substitutions are enclosed in ${}.  For example: '${ALIAS}.${NAMEID}'.  ALIAS is the provider alias.  NAMEID is that SAML name id assertion.  ATTRIBUTE.<NAME> references a SAML attribute where name is the attribute name or friendly name.");
+        property.setType(ProviderConfigProperty.STRING_TYPE);
+        property.setDefaultValue("${ALIAS}.${NAMEID}");
+        configProperties.add(property);
+    }
+
+    public static final String PROVIDER_ID = "saml-username-idp-mapper";
+
+    @Override
+    public List<ProviderConfigProperty> getConfigProperties() {
+        return configProperties;
+    }
+
+    @Override
+    public String getId() {
+        return PROVIDER_ID;
+    }
+
+    @Override
+    public String[] getCompatibleProviders() {
+        return COMPATIBLE_PROVIDERS;
+    }
+
+    @Override
+    public String getDisplayCategory() {
+        return "Preprocessor";
+    }
+
+    @Override
+    public String getDisplayType() {
+        return "Username Template Importer";
+    }
+
+    @Override
+    public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+
+    }
+
+    @Override
+    public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+
+    }
+    static Pattern substitution = Pattern.compile("\\$\\{([^}]+)\\}");
+
+    @Override
+    public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
+        AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
+        String template = mapperModel.getConfig().get(TEMPLATE);
+        Matcher m = substitution.matcher(template);
+        StringBuffer sb = new StringBuffer();
+        while (m.find()) {
+            String variable = m.group(1);
+            if (variable.equals("ALIAS")) {
+                m.appendReplacement(sb, context.getIdpConfig().getAlias());
+            } else if (variable.equals("UUID")) {
+                m.appendReplacement(sb, KeycloakModelUtils.generateId());
+            } else if (variable.equals("NAMEID")) {
+                SubjectType subject = assertion.getSubject();
+                SubjectType.STSubType subType = subject.getSubType();
+                NameIDType subjectNameID = (NameIDType) subType.getBaseID();
+                m.appendReplacement(sb, subjectNameID.getValue());
+            } else if (variable.startsWith("ATTRIBUTE.")) {
+                String name = variable.substring("ATTRIBUTE.".length());
+                String value = "";
+                for (AttributeStatementType statement : assertion.getAttributeStatements()) {
+                    for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
+                        AttributeType attr = choice.getAttribute();
+                        if (name.equals(attr.getName()) || name.equals(attr.getFriendlyName())) {
+                            List<Object> attributeValue = attr.getAttributeValue();
+                            if (attributeValue != null && !attributeValue.isEmpty()) {
+                                value = attributeValue.get(0).toString();
+                            }
+                            break;
+                        }
+                    }
+                }
+                m.appendReplacement(sb, value);
+            } else {
+                m.appendReplacement(sb, m.group(1));
+            }
+
+        }
+        m.appendTail(sb);
+        context.setModelUsername(sb.toString());
+
+    }
+
+    @Override
+    public String getHelpText() {
+        return "Format the username to import.";
+    }
+
+}

broker/saml/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderMapper

@@ -1,2 +1,3 @@
-org.keycloak.broker.saml.mappers.AttributeToRoleMapper
+org.keycloak.broker.saml.mappers.AttributeToRoleMapper
-org.keycloak.broker.saml.mappers.UserAttributeMapper
+org.keycloak.broker.saml.mappers.UserAttributeMapper
+org.keycloak.broker.saml.mappers.UsernameTemplateMapper

client-api/pom.xml

@@ -1,29 +1,31 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+    </parent>
-    </parent>
+    <modelVersion>4.0.0</modelVersion>
-    <modelVersion>4.0.0</modelVersion>
+
-
+    <artifactId>keycloak-client-api</artifactId>
-    <artifactId>keycloak-model-sessions-mem</artifactId>
+    <name>Keycloak Client API</name>
-    <name>Keycloak Model Sessions Mem</name>
+    <description/>
-    <description/>
+
-
+    <dependencies>
-    <dependencies>
+        <dependency>
-        <dependency>
+            <groupId>org.keycloak</groupId>
-            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-core</artifactId>
-            <artifactId>keycloak-core</artifactId>
+        </dependency>
-            <scope>provided</scope>
+        <dependency>
-        </dependency>
+            <groupId>org.apache.httpcomponents</groupId>
-        <dependency>
+            <artifactId>httpclient</artifactId>
-            <groupId>org.keycloak</groupId>
+        </dependency>
-            <artifactId>keycloak-model-api</artifactId>
+        <dependency>
-            <scope>provided</scope>
+            <groupId>junit</groupId>
-        </dependency>
+            <artifactId>junit</artifactId>
-    </dependencies>
+            <scope>test</scope>
-
+        </dependency>
-</project>
+    </dependencies>
+
+</project>

client-api/src/main/java/org/keycloak/client/registration/ClientRegistration.java

@@ -0,0 +1,275 @@
+package org.keycloak.client.registration;
+
+import org.apache.http.HttpHeaders;
+import org.apache.http.HttpRequest;
+import org.apache.http.HttpResponse;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpDelete;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpPut;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.keycloak.representations.idm.ClientRepresentation;
+import org.keycloak.common.util.Base64;
+import org.keycloak.util.JsonSerialization;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public class ClientRegistration {
+
+    private String clientRegistrationUrl;
+    private HttpClient httpClient;
+    private Auth auth;
+
+    public static ClientRegistrationBuilder create() {
+        return new ClientRegistrationBuilder();
+    }
+
+    private ClientRegistration() {
+    }
+
+    public ClientRepresentation create(ClientRepresentation client) throws ClientRegistrationException {
+        String content = serialize(client);
+        InputStream resultStream = doPost(content);
+        return deserialize(resultStream, ClientRepresentation.class);
+    }
+
+    public ClientRepresentation get() throws ClientRegistrationException {
+        if (auth instanceof ClientIdSecretAuth) {
+            String clientId = ((ClientIdSecretAuth) auth).clientId;
+            return get(clientId);
+        } else {
+            throw new ClientRegistrationException("Requires client authentication");
+        }
+    }
+
+    public ClientRepresentation get(String clientId) throws ClientRegistrationException {
+        InputStream resultStream = doGet(clientId);
+        return resultStream != null ? deserialize(resultStream, ClientRepresentation.class) : null;
+    }
+
+    public void update(ClientRepresentation client) throws ClientRegistrationException {
+        String content = serialize(client);
+        doPut(content, client.getClientId());
+    }
+
+    public void delete() throws ClientRegistrationException {
+        if (auth instanceof ClientIdSecretAuth) {
+            String clientId = ((ClientIdSecretAuth) auth).clientId;
+            delete(clientId);
+        } else {
+            throw new ClientRegistrationException("Requires client authentication");
+        }
+    }
+
+    public void delete(String clientId) throws ClientRegistrationException {
+        doDelete(clientId);
+    }
+
+    public void close() throws ClientRegistrationException {
+        if (httpClient instanceof CloseableHttpClient) {
+            try {
+                ((CloseableHttpClient) httpClient).close();
+            } catch (IOException e) {
+                throw new ClientRegistrationException("Failed to close http client", e);
+            }
+        }
+    }
+
+    private InputStream doPost(String content) throws ClientRegistrationException {
+        try {
+            HttpPost request = new HttpPost(clientRegistrationUrl);
+
+            request.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
+            request.setHeader(HttpHeaders.ACCEPT, "application/json");
+            request.setEntity(new StringEntity(content));
+
+            auth.addAuth(request);
+
+            HttpResponse response = httpClient.execute(request);
+            InputStream responseStream = null;
+            if (response.getEntity() != null) {
+                responseStream = response.getEntity().getContent();
+            }
+
+            if (response.getStatusLine().getStatusCode() == 201) {
+                return responseStream;
+            } else {
+                responseStream.close();
+                throw new HttpErrorException(response.getStatusLine());
+            }
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to send request", e);
+        }
+    }
+
+    private InputStream doGet(String endpoint) throws ClientRegistrationException {
+        try {
+            HttpGet request = new HttpGet(clientRegistrationUrl + "/" + endpoint);
+
+            request.setHeader(HttpHeaders.ACCEPT, "application/json");
+
+            auth.addAuth(request);
+
+            HttpResponse response = httpClient.execute(request);
+            InputStream responseStream = null;
+            if (response.getEntity() != null) {
+                responseStream = response.getEntity().getContent();
+            }
+
+            if (response.getStatusLine().getStatusCode() == 200) {
+                return responseStream;
+            } else if (response.getStatusLine().getStatusCode() == 404) {
+                responseStream.close();
+                return null;
+            } else {
+                responseStream.close();
+                throw new HttpErrorException(response.getStatusLine());
+            }
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to send request", e);
+        }
+    }
+
+    private void doPut(String content, String endpoint) throws ClientRegistrationException {
+        try {
+            HttpPut request = new HttpPut(clientRegistrationUrl + "/" + endpoint);
+
+            request.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
+            request.setHeader(HttpHeaders.ACCEPT, "application/json");
+            request.setEntity(new StringEntity(content));
+
+            auth.addAuth(request);
+
+            HttpResponse response = httpClient.execute(request);
+            if (response.getEntity() != null) {
+                response.getEntity().getContent().close();
+            }
+
+            if (response.getStatusLine().getStatusCode() != 200) {
+                throw new HttpErrorException(response.getStatusLine());
+            }
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to send request", e);
+        }
+    }
+
+    private void doDelete(String endpoint) throws ClientRegistrationException {
+        try {
+            HttpDelete request = new HttpDelete(clientRegistrationUrl + "/" + endpoint);
+
+            auth.addAuth(request);
+
+            HttpResponse response = httpClient.execute(request);
+            if (response.getEntity() != null) {
+                response.getEntity().getContent().close();
+            }
+
+            if (response.getStatusLine().getStatusCode() != 200) {
+                throw new HttpErrorException(response.getStatusLine());
+            }
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to send request", e);
+        }
+    }
+
+    private String serialize(ClientRepresentation client) throws ClientRegistrationException {
+        try {
+            return JsonSerialization.writeValueAsString(client);
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to write json object", e);
+        }
+    }
+
+    private <T> T deserialize(InputStream inputStream, Class<T> clazz) throws ClientRegistrationException {
+        try {
+            return JsonSerialization.readValue(inputStream, clazz);
+        } catch (IOException e) {
+            throw new ClientRegistrationException("Failed to read json object", e);
+        }
+    }
+
+    public static class ClientRegistrationBuilder {
+
+        private String realm;
+
+        private String authServerUrl;
+
+        private Auth auth;
+
+        private HttpClient httpClient;
+
+        public ClientRegistrationBuilder realm(String realm) {
+            this.realm = realm;
+            return this;
+        }
+        public ClientRegistrationBuilder authServerUrl(String authServerUrl) {
+            this.authServerUrl = authServerUrl;
+            return this;
+        }
+
+        public ClientRegistrationBuilder auth(String token) {
+            this.auth = new TokenAuth(token);
+            return this;
+        }
+
+        public ClientRegistrationBuilder auth(String clientId, String clientSecret) {
+            this.auth = new ClientIdSecretAuth(clientId, clientSecret);
+            return this;
+        }
+
+        public ClientRegistrationBuilder httpClient(HttpClient httpClient) {
+            this.httpClient = httpClient;
+            return this;
+        }
+
+        public ClientRegistration build() {
+            ClientRegistration clientRegistration = new ClientRegistration();
+            clientRegistration.clientRegistrationUrl = authServerUrl + "/realms/" + realm + "/client-registration/default";
+
+            clientRegistration.httpClient = httpClient != null ? httpClient : HttpClients.createDefault();
+            clientRegistration.auth = auth;
+
+            return clientRegistration;
+        }
+
+    }
+
+    public interface Auth {
+        void addAuth(HttpRequest httpRequest);
+    }
+
+    public static class AuthorizationHeaderAuth implements Auth {
+        private String credentials;
+
+        public AuthorizationHeaderAuth(String credentials) {
+            this.credentials = credentials;
+        }
+
+        public void addAuth(HttpRequest httpRequest) {
+            httpRequest.setHeader(HttpHeaders.AUTHORIZATION, credentials);
+        }
+    }
+
+    public static class TokenAuth extends AuthorizationHeaderAuth {
+        public TokenAuth(String token) {
+            super("Bearer " + token);
+        }
+    }
+
+    public static class ClientIdSecretAuth extends AuthorizationHeaderAuth {
+        private String clientId;
+
+        public ClientIdSecretAuth(String clientId, String clientSecret) {
+            super("Basic " + Base64.encodeBytes((clientId + ":" + clientSecret).getBytes()));
+            this.clientId = clientId;
+        }
+    }
+
+}

client-api/src/main/java/org/keycloak/client/registration/ClientRegistrationException.java

@@ -0,0 +1,16 @@
+package org.keycloak.client.registration;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public class ClientRegistrationException extends Exception {
+
+    public ClientRegistrationException(String s, Throwable throwable) {
+        super(s, throwable);
+    }
+
+    public ClientRegistrationException(String s) {
+        super(s);
+    }
+
+}

client-api/src/main/java/org/keycloak/client/registration/HttpErrorException.java

@@ -0,0 +1,22 @@
+package org.keycloak.client.registration;
+
+import org.apache.http.StatusLine;
+
+import java.io.IOException;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public class HttpErrorException extends IOException {
+
+    private StatusLine statusLine;
+
+    public HttpErrorException(StatusLine statusLine) {
+        this.statusLine = statusLine;
+    }
+
+    public StatusLine getStatusLine() {
+        return statusLine;
+    }
+
+}

common/pom.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <parent>
+        <artifactId>keycloak-parent</artifactId>
+        <groupId>org.keycloak</groupId>
+        <version>1.6.1.Final</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>keycloak-common</artifactId>
+    <name>Keycloak Common</name>
+    <packaging>jar</packaging>
+    <description>Common library and dependencies shared with server and all adapters</description>
+
+    <properties>
+        <timestamp>${maven.build.timestamp}</timestamp>
+        <maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
+        <keycloak.osgi.export>
+            org.keycloak.common.*
+        </keycloak.osgi.export>
+        <keycloak.osgi.import>
+            *;resolution:=optional
+        </keycloak.osgi.import>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.bouncycastle</groupId>
+            <artifactId>bcprov-jdk15on</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.bouncycastle</groupId>
+            <artifactId>bcpkix-jdk15on</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>${maven.compiler.source}</source>
+                    <target>${maven.compiler.target}</target>
+                </configuration>
+            </plugin>
+
+            <!-- Adding OSGI metadata to the JAR without changing the packaging type. -->
+            <plugin>
+                <artifactId>maven-jar-plugin</artifactId>
+                <configuration>
+                    <archive>
+                        <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
+                    </archive>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <extensions>true</extensions>
+                <executions>
+                    <execution>
+                        <id>bundle-manifest</id>
+                        <phase>process-classes</phase>
+                        <goals>
+                            <goal>manifest</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <instructions>
+                        <Bundle-ClassPath>.</Bundle-ClassPath>
+                        <Bundle-Name>${project.name}</Bundle-Name>
+                        <Bundle-SymbolicName>${project.groupId}.${project.artifactId}</Bundle-SymbolicName>
+                        <Import-Package>${keycloak.osgi.import}</Import-Package>
+                        <Export-Package>${keycloak.osgi.export}</Export-Package>
+                    </instructions>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

common/src/main/java/org/keycloak/common/ClientConnection.java

@@ -1,13 +1,13 @@
-package org.keycloak;
+package org.keycloak.common;
-
+
-/**
+/**
- * Information about the client connection
+ * Information about the client connection
- *
+ *
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public interface ClientConnection {
+public interface ClientConnection {
-    String getRemoteAddr();
+    String getRemoteAddr();
-    String getRemoteHost();
+    String getRemoteHost();
-    int getReportPort();
+    int getReportPort();
-}
+}

common/src/main/java/org/keycloak/common/VerificationException.java

@@ -1,4 +1,4 @@
-package org.keycloak;
+package org.keycloak.common;
 
 /**
  * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>

common/src/main/java/org/keycloak/common/Version.java

@@ -0,0 +1,37 @@
+package org.keycloak.common;
+
+import org.keycloak.common.util.Time;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class Version {
+    public static final String UNKNOWN = "UNKNOWN";
+    public static String VERSION;
+    public static String RESOURCES_VERSION;
+    public static String BUILD_TIME;
+
+    static {
+        Properties props = new Properties();
+        InputStream is = Version.class.getResourceAsStream("/keycloak-version.properties");
+        try {
+            props.load(is);
+            Version.VERSION = props.getProperty("version");
+            Version.BUILD_TIME = props.getProperty("build-time");
+            Version.RESOURCES_VERSION = Version.VERSION.toLowerCase();
+            if (Version.RESOURCES_VERSION.endsWith("-snapshot")) {
+                Version.RESOURCES_VERSION = Version.RESOURCES_VERSION.replace("-snapshot", "-" + Time.currentTime());
+            }
+        } catch (IOException e) {
+            Version.VERSION= Version.UNKNOWN;
+            Version.BUILD_TIME= Version.UNKNOWN;
+        }
+
+    }
+
+}

common/src/main/java/org/keycloak/common/constants/GenericConstants.java

@@ -1,4 +1,4 @@
-package org.keycloak.constants;
+package org.keycloak.common.constants;
 
 /**
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>

common/src/main/java/org/keycloak/common/constants/KerberosConstants.java

@@ -1,4 +1,4 @@
-package org.keycloak.constants;
+package org.keycloak.common.constants;
 
 /**
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>

common/src/main/java/org/keycloak/common/constants/ServiceAccountConstants.java

@@ -0,0 +1,19 @@
+package org.keycloak.common.constants;
+
+/**
+ * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
+ */
+public interface ServiceAccountConstants {
+
+    String CLIENT_AUTH = "client_auth";
+
+    String SERVICE_ACCOUNT_USER_PREFIX = "service-account-";
+
+    String CLIENT_ID_PROTOCOL_MAPPER = "Client ID";
+    String CLIENT_HOST_PROTOCOL_MAPPER = "Client Host";
+    String CLIENT_ADDRESS_PROTOCOL_MAPPER = "Client IP Address";
+    String CLIENT_ID = "clientId";
+    String CLIENT_HOST = "clientHost";
+    String CLIENT_ADDRESS = "clientAddress";
+
+}

common/src/main/java/org/keycloak/common/enums/RelativeUrlsUsed.java

@@ -1,4 +1,4 @@
-package org.keycloak.enums;
+package org.keycloak.common.enums;
 
 /**
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>

common/src/main/java/org/keycloak/common/enums/SslRequired.java

@@ -1,6 +1,6 @@
-package org.keycloak.enums;
+package org.keycloak.common.enums;
 
-import org.keycloak.ClientConnection;
+import org.keycloak.common.ClientConnection;
 
 import java.net.InetAddress;
 import java.net.UnknownHostException;

common/src/main/java/org/keycloak/common/util/Base64Url.java

@@ -1,44 +1,42 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-
+
-import net.iharder.Base64;
+/**
-
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-/**
+ * @version $Revision: 1 $
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ */
- * @version $Revision: 1 $
+public class Base64Url {
- */
+    public static String encode(byte[] bytes) {
-public class Base64Url {
+        String s = Base64.encodeBytes(bytes);
-    public static String encode(byte[] bytes) {
+        s = s.split("=")[0]; // Remove any trailing '='s
-        String s = Base64.encodeBytes(bytes);
+        s = s.replace('+', '-'); // 62nd char of encoding
-        s = s.split("=")[0]; // Remove any trailing '='s
+        s = s.replace('/', '_'); // 63rd char of encoding
-        s = s.replace('+', '-'); // 62nd char of encoding
+        return s;
-        s = s.replace('/', '_'); // 63rd char of encoding
+    }
-        return s;
+
-    }
+    public static byte[] decode(String s) {
-
+        s = s.replace('-', '+'); // 62nd char of encoding
-    public static byte[] decode(String s) {
+        s = s.replace('_', '/'); // 63rd char of encoding
-        s = s.replace('-', '+'); // 62nd char of encoding
+        switch (s.length() % 4) // Pad with trailing '='s
-        s = s.replace('_', '/'); // 63rd char of encoding
+        {
-        switch (s.length() % 4) // Pad with trailing '='s
+            case 0:
-        {
+                break; // No pad chars in this case
-            case 0:
+            case 2:
-                break; // No pad chars in this case
+                s += "==";
-            case 2:
+                break; // Two pad chars
-                s += "==";
+            case 3:
-                break; // Two pad chars
+                s += "=";
-            case 3:
+                break; // One pad char
-                s += "=";
+            default:
-                break; // One pad char
+                throw new RuntimeException(
-            default:
+                        "Illegal base64url string!");
-                throw new RuntimeException(
+        }
-                        "Illegal base64url string!");
+        try {
-        }
+            return Base64.decode(s);
-        try {
+        } catch (Exception e) {
-            return Base64.decode(s);
+            throw new RuntimeException(e);
-        } catch (Exception e) {
+        }
-            throw new RuntimeException(e);
+    }
-        }
+
-    }
+
-
+}
-
-}

common/src/main/java/org/keycloak/common/util/BouncyIntegration.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 

common/src/main/java/org/keycloak/common/util/CertificateUtils.java

@@ -1,166 +1,165 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-import java.math.BigInteger;
+import java.math.BigInteger;
-import java.security.KeyPair;
+import java.security.KeyPair;
-import java.security.PrivateKey;
+import java.security.PrivateKey;
-import java.security.SecureRandom;
+import java.security.SecureRandom;
-import java.security.Security;
+import java.security.cert.X509Certificate;
-import java.security.cert.X509Certificate;
+import java.util.Calendar;
-import java.util.Calendar;
+import java.util.Date;
-import java.util.Date;
+
-
+import org.bouncycastle.asn1.ASN1Sequence;
-import org.bouncycastle.asn1.ASN1Sequence;
+import org.bouncycastle.asn1.oiw.OIWObjectIdentifiers;
-import org.bouncycastle.asn1.oiw.OIWObjectIdentifiers;
+import org.bouncycastle.asn1.x500.X500Name;
-import org.bouncycastle.asn1.x500.X500Name;
+import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
-import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
+import org.bouncycastle.asn1.x509.BasicConstraints;
-import org.bouncycastle.asn1.x509.BasicConstraints;
+import org.bouncycastle.asn1.x509.ExtendedKeyUsage;
-import org.bouncycastle.asn1.x509.ExtendedKeyUsage;
+import org.bouncycastle.asn1.x509.Extension;
-import org.bouncycastle.asn1.x509.Extension;
+import org.bouncycastle.asn1.x509.KeyPurposeId;
-import org.bouncycastle.asn1.x509.KeyPurposeId;
+import org.bouncycastle.asn1.x509.KeyUsage;
-import org.bouncycastle.asn1.x509.KeyUsage;
+import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo;
-import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo;
+import org.bouncycastle.cert.X509CertificateHolder;
-import org.bouncycastle.cert.X509CertificateHolder;
+import org.bouncycastle.cert.X509ExtensionUtils;
-import org.bouncycastle.cert.X509ExtensionUtils;
+import org.bouncycastle.cert.X509v1CertificateBuilder;
-import org.bouncycastle.cert.X509v1CertificateBuilder;
+import org.bouncycastle.cert.X509v3CertificateBuilder;
-import org.bouncycastle.cert.X509v3CertificateBuilder;
+import org.bouncycastle.cert.jcajce.JcaX509CertificateConverter;
-import org.bouncycastle.cert.jcajce.JcaX509CertificateConverter;
+import org.bouncycastle.crypto.util.PrivateKeyFactory;
-import org.bouncycastle.crypto.util.PrivateKeyFactory;
+import org.bouncycastle.operator.ContentSigner;
-import org.bouncycastle.operator.ContentSigner;
+import org.bouncycastle.operator.DefaultDigestAlgorithmIdentifierFinder;
-import org.bouncycastle.operator.DefaultDigestAlgorithmIdentifierFinder;
+import org.bouncycastle.operator.DefaultSignatureAlgorithmIdentifierFinder;
-import org.bouncycastle.operator.DefaultSignatureAlgorithmIdentifierFinder;
+import org.bouncycastle.operator.DigestCalculator;
-import org.bouncycastle.operator.DigestCalculator;
+import org.bouncycastle.operator.bc.BcDigestCalculatorProvider;
-import org.bouncycastle.operator.bc.BcDigestCalculatorProvider;
+import org.bouncycastle.operator.bc.BcRSAContentSignerBuilder;
-import org.bouncycastle.operator.bc.BcRSAContentSignerBuilder;
+import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
-import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
+
-
+/**
-/**
+ * The Class CertificateUtils provides utility functions for generation of V1 and V3 {@link java.security.cert.X509Certificate}
- * The Class CertificateUtils provides utility functions for generation of V1 and V3 {@link java.security.cert.X509Certificate}
+ *
- *
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:giriraj.sharma27@gmail.com">Giriraj Sharma</a>
- * @author <a href="mailto:giriraj.sharma27@gmail.com">Giriraj Sharma</a>
+ * @version $Revision: 2 $
- * @version $Revision: 2 $
+ */
- */
+public class CertificateUtils {
-public class CertificateUtils {
+    static {
-    static {
+        BouncyIntegration.init();
-        BouncyIntegration.init();
+    }
-    }
+
-
+    /**
-    /**
+     * Generates version 3 {@link java.security.cert.X509Certificate}.
-     * Generates version 3 {@link java.security.cert.X509Certificate}.
+     *
-     *
+     * @param keyPair the key pair
-     * @param keyPair the key pair
+     * @param caPrivateKey the CA private key
-     * @param caPrivateKey the CA private key
+     * @param caCert the CA certificate
-     * @param caCert the CA certificate
+     * @param subject the subject name
-     * @param subject the subject name
+     * 
-     * 
+     * @return the x509 certificate
-     * @return the x509 certificate
+     * 
-     * 
+     * @throws Exception the exception
-     * @throws Exception the exception
+     */
-     */
+    public static X509Certificate generateV3Certificate(KeyPair keyPair, PrivateKey caPrivateKey, X509Certificate caCert,
-    public static X509Certificate generateV3Certificate(KeyPair keyPair, PrivateKey caPrivateKey, X509Certificate caCert,
+            String subject) throws Exception {
-            String subject) throws Exception {
+
-
+        try {
-        try {
+            X500Name subjectDN = new X500Name("CN=" + subject);
-            X500Name subjectDN = new X500Name("CN=" + subject);
+
-
+            // Serial Number
-            // Serial Number
+            SecureRandom random = SecureRandom.getInstance("SHA1PRNG");
-            SecureRandom random = SecureRandom.getInstance("SHA1PRNG");
+            BigInteger serialNumber = BigInteger.valueOf(Math.abs(random.nextInt()));
-            BigInteger serialNumber = BigInteger.valueOf(Math.abs(random.nextInt()));
+
-
+            // Validity
-            // Validity
+            Date notBefore = new Date(System.currentTimeMillis());
-            Date notBefore = new Date(System.currentTimeMillis());
+            Date notAfter = new Date(System.currentTimeMillis() + (((1000L * 60 * 60 * 24 * 30)) * 12) * 3);
-            Date notAfter = new Date(System.currentTimeMillis() + (((1000L * 60 * 60 * 24 * 30)) * 12) * 3);
+
-
+            // SubjectPublicKeyInfo
-            // SubjectPublicKeyInfo
+            SubjectPublicKeyInfo subjPubKeyInfo = new SubjectPublicKeyInfo(ASN1Sequence.getInstance(keyPair.getPublic()
-            SubjectPublicKeyInfo subjPubKeyInfo = new SubjectPublicKeyInfo(ASN1Sequence.getInstance(keyPair.getPublic()
+                    .getEncoded()));
-                    .getEncoded()));
+
-
+            X509v3CertificateBuilder certGen = new X509v3CertificateBuilder(new X500Name(caCert.getSubjectDN().getName()),
-            X509v3CertificateBuilder certGen = new X509v3CertificateBuilder(new X500Name(caCert.getSubjectDN().getName()),
+                    serialNumber, notBefore, notAfter, subjectDN, subjPubKeyInfo);
-                    serialNumber, notBefore, notAfter, subjectDN, subjPubKeyInfo);
+
-
+            DigestCalculator digCalc = new BcDigestCalculatorProvider()
-            DigestCalculator digCalc = new BcDigestCalculatorProvider()
+                    .get(new AlgorithmIdentifier(OIWObjectIdentifiers.idSHA1));
-                    .get(new AlgorithmIdentifier(OIWObjectIdentifiers.idSHA1));
+            X509ExtensionUtils x509ExtensionUtils = new X509ExtensionUtils(digCalc);
-            X509ExtensionUtils x509ExtensionUtils = new X509ExtensionUtils(digCalc);
+
-
+            // Subject Key Identifier
-            // Subject Key Identifier
+            certGen.addExtension(Extension.subjectKeyIdentifier, false,
-            certGen.addExtension(Extension.subjectKeyIdentifier, false,
+                    x509ExtensionUtils.createSubjectKeyIdentifier(subjPubKeyInfo));
-                    x509ExtensionUtils.createSubjectKeyIdentifier(subjPubKeyInfo));
+
-
+            // Authority Key Identifier
-            // Authority Key Identifier
+            certGen.addExtension(Extension.authorityKeyIdentifier, false,
-            certGen.addExtension(Extension.authorityKeyIdentifier, false,
+                    x509ExtensionUtils.createAuthorityKeyIdentifier(subjPubKeyInfo));
-                    x509ExtensionUtils.createAuthorityKeyIdentifier(subjPubKeyInfo));
+
-
+            // Key Usage
-            // Key Usage
+            certGen.addExtension(Extension.keyUsage, false, new KeyUsage(KeyUsage.digitalSignature | KeyUsage.keyCertSign
-            certGen.addExtension(Extension.keyUsage, false, new KeyUsage(KeyUsage.digitalSignature | KeyUsage.keyCertSign
+                    | KeyUsage.cRLSign));
-                    | KeyUsage.cRLSign));
+
-
+            // Extended Key Usage
-            // Extended Key Usage
+            KeyPurposeId[] EKU = new KeyPurposeId[2];
-            KeyPurposeId[] EKU = new KeyPurposeId[2];
+            EKU[0] = KeyPurposeId.id_kp_emailProtection;
-            EKU[0] = KeyPurposeId.id_kp_emailProtection;
+            EKU[1] = KeyPurposeId.id_kp_serverAuth;
-            EKU[1] = KeyPurposeId.id_kp_serverAuth;
+
-
+            certGen.addExtension(Extension.extendedKeyUsage, false, new ExtendedKeyUsage(EKU));
-            certGen.addExtension(Extension.extendedKeyUsage, false, new ExtendedKeyUsage(EKU));
+
-
+            // Basic Constraints
-            // Basic Constraints
+            certGen.addExtension(Extension.basicConstraints, true, new BasicConstraints(0));
-            certGen.addExtension(Extension.basicConstraints, true, new BasicConstraints(0));
+
-
+            // Content Signer
-            // Content Signer
+            ContentSigner sigGen = new JcaContentSignerBuilder("SHA1WithRSAEncryption").setProvider("BC").build(caPrivateKey);
-            ContentSigner sigGen = new JcaContentSignerBuilder("SHA1WithRSAEncryption").setProvider("BC").build(caPrivateKey);
+
-
+            // Certificate
-            // Certificate
+            return new JcaX509CertificateConverter().setProvider("BC").getCertificate(certGen.build(sigGen));
-            return new JcaX509CertificateConverter().setProvider("BC").getCertificate(certGen.build(sigGen));
+        } catch (Exception e) {
-        } catch (Exception e) {
+            throw new RuntimeException("Error creating X509v3Certificate.", e);
-            throw new RuntimeException("Error creating X509v3Certificate.", e);
+        }
-        }
+    }
-    }
+
-
+    /**
-    /**
+     * Generate version 1 self signed {@link java.security.cert.X509Certificate}..
-     * Generate version 1 self signed {@link java.security.cert.X509Certificate}..
+     *
-     *
+     * @param caKeyPair the CA key pair
-     * @param caKeyPair the CA key pair
+     * @param subject the subject name
-     * @param subject the subject name
+     * 
-     * 
+     * @return the x509 certificate
-     * @return the x509 certificate
+     * 
-     * 
+     * @throws Exception the exception
-     * @throws Exception the exception
+     */
-     */
+    public static X509Certificate generateV1SelfSignedCertificate(KeyPair caKeyPair, String subject) throws Exception {
-    public static X509Certificate generateV1SelfSignedCertificate(KeyPair caKeyPair, String subject) throws Exception {
+
-
+        try {
-        try {
+            X500Name subjectDN = new X500Name("CN=" + subject);
-            X500Name subjectDN = new X500Name("CN=" + subject);
+            BigInteger serialNumber = BigInteger.valueOf(System.currentTimeMillis());
-            BigInteger serialNumber = BigInteger.valueOf(System.currentTimeMillis());
+            Date validityStartDate = new Date(System.currentTimeMillis() - 100000);
-            Date validityStartDate = new Date(System.currentTimeMillis() - 100000);
+            Calendar calendar = Calendar.getInstance();
-            Calendar calendar = Calendar.getInstance();
+            calendar.add(Calendar.YEAR, 10);
-            calendar.add(Calendar.YEAR, 10);
+            Date validityEndDate = new Date(calendar.getTime().getTime());
-            Date validityEndDate = new Date(calendar.getTime().getTime());
+            SubjectPublicKeyInfo subPubKeyInfo = SubjectPublicKeyInfo.getInstance(caKeyPair.getPublic().getEncoded());
-            SubjectPublicKeyInfo subPubKeyInfo = SubjectPublicKeyInfo.getInstance(caKeyPair.getPublic().getEncoded());
+
-
+            X509v1CertificateBuilder builder = new X509v1CertificateBuilder(subjectDN, serialNumber, validityStartDate,
-            X509v1CertificateBuilder builder = new X509v1CertificateBuilder(subjectDN, serialNumber, validityStartDate,
+                    validityEndDate, subjectDN, subPubKeyInfo);
-                    validityEndDate, subjectDN, subPubKeyInfo);
+            X509CertificateHolder holder = builder.build(createSigner(caKeyPair.getPrivate()));
-            X509CertificateHolder holder = builder.build(createSigner(caKeyPair.getPrivate()));
+
-
+            return new JcaX509CertificateConverter().getCertificate(holder);
-            return new JcaX509CertificateConverter().getCertificate(holder);
+        } catch (Exception e) {
-        } catch (Exception e) {
+            throw new RuntimeException("Error creating X509v1Certificate.", e);
-            throw new RuntimeException("Error creating X509v1Certificate.", e);
+        }
-        }
+    }
-    }
+
-
+    /**
-    /**
+     * Creates the content signer for generation of Version 1 {@link java.security.cert.X509Certificate}.
-     * Creates the content signer for generation of Version 1 {@link java.security.cert.X509Certificate}.
+     *
-     *
+     * @param privateKey the private key
-     * @param privateKey the private key
+     *
-     *
+     * @return the content signer
-     * @return the content signer
+     */
-     */
+    public static ContentSigner createSigner(PrivateKey privateKey) {
-    public static ContentSigner createSigner(PrivateKey privateKey) {
+        try {
-        try {
+            AlgorithmIdentifier sigAlgId = new DefaultSignatureAlgorithmIdentifierFinder().find("SHA256WithRSAEncryption");
-            AlgorithmIdentifier sigAlgId = new DefaultSignatureAlgorithmIdentifierFinder().find("SHA256WithRSAEncryption");
+            AlgorithmIdentifier digAlgId = new DefaultDigestAlgorithmIdentifierFinder().find(sigAlgId);
-            AlgorithmIdentifier digAlgId = new DefaultDigestAlgorithmIdentifierFinder().find(sigAlgId);
+
-
+            return new BcRSAContentSignerBuilder(sigAlgId, digAlgId)
-            return new BcRSAContentSignerBuilder(sigAlgId, digAlgId)
+                    .build(PrivateKeyFactory.createKey(privateKey.getEncoded()));
-                    .build(PrivateKeyFactory.createKey(privateKey.getEncoded()));
+        } catch (Exception e) {
-        } catch (Exception e) {
+            throw new RuntimeException("Could not create content signer.", e);
-            throw new RuntimeException("Could not create content signer.", e);
+        }
-        }
+    }
-    }
+}
-}

common/src/main/java/org/keycloak/common/util/CollectionUtil.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.util.Collection;
 import java.util.Iterator;

common/src/main/java/org/keycloak/common/util/DerUtils.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.DataInputStream;
 import java.io.InputStream;

common/src/main/java/org/keycloak/common/util/Encode.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;

common/src/main/java/org/keycloak/common/util/EnvUtil.java

@@ -1,37 +1,37 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-import java.util.regex.Matcher;
+import java.util.regex.Matcher;
-import java.util.regex.Pattern;
+import java.util.regex.Pattern;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public final class EnvUtil {
+public final class EnvUtil {
-    private static final Pattern p = Pattern.compile("[$][{]([^}]+)[}]");
+    private static final Pattern p = Pattern.compile("[$][{]([^}]+)[}]");
-
+
-    private EnvUtil() {
+    private EnvUtil() {
-
+
-    }
+    }
-
+
-    /**
+    /**
-     * Replaces any ${} strings with their corresponding environent variable.
+     * Replaces any ${} strings with their corresponding environent variable.
-     *
+     *
-     * @param val
+     * @param val
-     * @return
+     * @return
-     */
+     */
-    public static String replace(String val) {
+    public static String replace(String val) {
-        Matcher matcher = p.matcher(val);
+        Matcher matcher = p.matcher(val);
-        StringBuffer buf = new StringBuffer();
+        StringBuffer buf = new StringBuffer();
-        while (matcher.find()) {
+        while (matcher.find()) {
-            String envVar = matcher.group(1);
+            String envVar = matcher.group(1);
-            String envVal = System.getProperty(envVar);
+            String envVal = System.getProperty(envVar);
-            if (envVal == null) envVal = "NOT-SPECIFIED";
+            if (envVal == null) envVal = "NOT-SPECIFIED";
-            matcher.appendReplacement(buf, envVal.replace("\\", "\\\\"));
+            matcher.appendReplacement(buf, envVal.replace("\\", "\\\\"));
-        }
+        }
-        matcher.appendTail(buf);
+        matcher.appendTail(buf);
-        return buf.toString();
+        return buf.toString();
-    }
+    }
-}
+}
-
+
-
+

common/src/main/java/org/keycloak/common/util/FindFile.java

@@ -1,37 +1,37 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-import org.keycloak.constants.GenericConstants;
+import org.keycloak.common.constants.GenericConstants;
-
+
-import java.io.FileInputStream;
+import java.io.FileInputStream;
-import java.io.FileNotFoundException;
+import java.io.FileNotFoundException;
-import java.io.InputStream;
+import java.io.InputStream;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class FindFile {
+public class FindFile {
-    public static InputStream findFile(String keycloakConfigFile) {
+    public static InputStream findFile(String keycloakConfigFile) {
-        if (keycloakConfigFile.startsWith(GenericConstants.PROTOCOL_CLASSPATH)) {
+        if (keycloakConfigFile.startsWith(GenericConstants.PROTOCOL_CLASSPATH)) {
-            String classPathLocation = keycloakConfigFile.replace(GenericConstants.PROTOCOL_CLASSPATH, "");
+            String classPathLocation = keycloakConfigFile.replace(GenericConstants.PROTOCOL_CLASSPATH, "");
-            // Try current class classloader first
+            // Try current class classloader first
-            InputStream is = FindFile.class.getClassLoader().getResourceAsStream(classPathLocation);
+            InputStream is = FindFile.class.getClassLoader().getResourceAsStream(classPathLocation);
-            if (is == null) {
+            if (is == null) {
-                is = Thread.currentThread().getContextClassLoader().getResourceAsStream(classPathLocation);
+                is = Thread.currentThread().getContextClassLoader().getResourceAsStream(classPathLocation);
-            }
+            }
-
+
-            if (is != null) {
+            if (is != null) {
-                return is;
+                return is;
-            } else {
+            } else {
-                throw new RuntimeException("Unable to find config from classpath: " + keycloakConfigFile);
+                throw new RuntimeException("Unable to find config from classpath: " + keycloakConfigFile);
-            }
+            }
-        } else {
+        } else {
-            // Fallback to file
+            // Fallback to file
-            try {
+            try {
-                return new FileInputStream(keycloakConfigFile);
+                return new FileInputStream(keycloakConfigFile);
-            } catch (FileNotFoundException fnfe) {
+            } catch (FileNotFoundException fnfe) {
-                throw new RuntimeException(fnfe);
+                throw new RuntimeException(fnfe);
-            }
+            }
-        }
+        }
-    }
+    }
-}
+}

common/src/main/java/org/keycloak/common/util/HostUtils.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.net.InetAddress;
 import java.net.UnknownHostException;

common/src/main/java/org/keycloak/common/util/HtmlUtils.java

@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 /**
  * @author pedroigor
@@ -34,7 +34,17 @@ public class HtmlUtils {
         for (int i = 0; i < value.length(); i++) {
             char chr = value.charAt(i);
 
-            if (chr != '\'' && chr != '"' && chr != '<' && chr != '>' && chr != '/') {
+            if (chr == '<') {
+                escaped.append("&lt;");
+            } else if (chr == '>') {
+                escaped.append("&gt;");
+            } else if (chr == '"') {
+                escaped.append("&quot;");
+            } else if (chr == '\'') {
+                escaped.append("&apos;");
+            } else if (chr == '&') {
+                escaped.append("&amp;");
+            } else {
                 escaped.append(chr);
             }
         }

common/src/main/java/org/keycloak/common/util/KerberosSerializationUtils.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -12,13 +12,12 @@ import java.lang.reflect.Method;
 
 import javax.security.auth.kerberos.KerberosTicket;
 
-import net.iharder.Base64;
 import org.ietf.jgss.GSSCredential;
 import org.ietf.jgss.GSSException;
 import org.ietf.jgss.GSSManager;
 import org.ietf.jgss.Oid;
-import org.keycloak.constants.KerberosConstants;
+import org.keycloak.common.constants.KerberosConstants;
-import org.keycloak.util.reflections.Reflections;
+import org.keycloak.common.util.reflections.Reflections;
 import sun.security.jgss.GSSCredentialImpl;
 import sun.security.jgss.GSSManagerImpl;
 import sun.security.jgss.krb5.Krb5InitCredential;

common/src/main/java/org/keycloak/common/util/KeystoreUtil.java

@@ -0,0 +1,56 @@
+package org.keycloak.common.util;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.security.KeyStore;
+import java.security.PrivateKey;
+
+import org.keycloak.common.constants.GenericConstants;
+
+/**
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @version $Revision: 1 $
+ */
+public class KeystoreUtil {
+    static {
+        BouncyIntegration.init();
+    }
+
+    public enum KeystoreFormat {
+        JKS,
+        PKCS12
+    }
+
+    public static KeyStore loadKeyStore(String filename, String password) throws Exception {
+        KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());
+        InputStream trustStream = (filename.startsWith(GenericConstants.PROTOCOL_CLASSPATH))
+                ?KeystoreUtil.class.getResourceAsStream(filename.replace(GenericConstants.PROTOCOL_CLASSPATH, ""))
+                :new FileInputStream(new File(filename));
+        trustStore.load(trustStream, password.toCharArray());
+        trustStream.close();
+        return trustStore;
+    }
+
+    public static PrivateKey loadPrivateKeyFromKeystore(String keystoreFile, String storePassword, String keyPassword, String keyAlias, KeystoreFormat format) {
+        InputStream stream = FindFile.findFile(keystoreFile);
+
+        try {
+            KeyStore keyStore = null;
+            if (format == KeystoreFormat.JKS) {
+                keyStore = KeyStore.getInstance(format.toString());
+            } else {
+                keyStore = KeyStore.getInstance(format.toString(), "BC");
+            }
+
+            keyStore.load(stream, storePassword.toCharArray());
+            PrivateKey key = (PrivateKey) keyStore.getKey(keyAlias, keyPassword.toCharArray());
+            if (key == null) {
+                throw new RuntimeException("Couldn't load key with alias '" + keyAlias + "' from keystore");
+            }
+            return key;
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to load private key: " + e.getMessage(), e);
+        }
+    }
+}

common/src/main/java/org/keycloak/common/util/MimeTypeUtil.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import javax.activation.MimetypesFileTypeMap;
 import java.io.File;

common/src/main/java/org/keycloak/common/util/MultivaluedHashMap.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.util.ArrayList;
 import java.util.Collection;

common/src/main/java/org/keycloak/common/util/NetworkUtils.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 /*
  * JBoss, Home of Professional Open Source.

common/src/main/java/org/keycloak/common/util/ObjectUtil.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 /**
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>

common/src/main/java/org/keycloak/common/util/PathHelper.java

@@ -1,7 +1,7 @@
 /**
  *
  */
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.util.regex.Pattern;
 

common/src/main/java/org/keycloak/common/util/PemUtils.java

@@ -1,110 +1,108 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-
+
-import net.iharder.Base64;
+import java.io.ByteArrayInputStream;
-
+import java.io.DataInputStream;
-import java.io.ByteArrayInputStream;
+import java.io.IOException;
-import java.io.DataInputStream;
+import java.io.InputStream;
-import java.io.IOException;
+import java.security.PrivateKey;
-import java.io.InputStream;
+import java.security.PublicKey;
-import java.security.PrivateKey;
+import java.security.cert.X509Certificate;
-import java.security.PublicKey;
+
-import java.security.cert.X509Certificate;
+/**
-
+ * Utility classes to extract PublicKey, PrivateKey, and X509Certificate from openssl generated PEM files
-/**
+ *
- * Utility classes to extract PublicKey, PrivateKey, and X509Certificate from openssl generated PEM files
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- *
+ * @version $Revision: 1 $
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ */
- * @version $Revision: 1 $
+public final class PemUtils {
- */
+    static {
-public final class PemUtils {
+        BouncyIntegration.init();
-    static {
+    }
-        BouncyIntegration.init();
+
-    }
+    private PemUtils() {
-
+    }
-    private PemUtils() {
+
-    }
+    public static X509Certificate decodeCertificate(InputStream is) throws Exception {
-
+        byte[] der = pemToDer(is);
-    public static X509Certificate decodeCertificate(InputStream is) throws Exception {
+        ByteArrayInputStream bis = new ByteArrayInputStream(der);
-        byte[] der = pemToDer(is);
+        return DerUtils.decodeCertificate(bis);
-        ByteArrayInputStream bis = new ByteArrayInputStream(der);
+    }
-        return DerUtils.decodeCertificate(bis);
+
-    }
+    public static X509Certificate decodeCertificate(String cert) throws Exception {
-
+        byte[] der = pemToDer(cert);
-    public static X509Certificate decodeCertificate(String cert) throws Exception {
+        ByteArrayInputStream bis = new ByteArrayInputStream(der);
-        byte[] der = pemToDer(cert);
+        return DerUtils.decodeCertificate(bis);
-        ByteArrayInputStream bis = new ByteArrayInputStream(der);
+    }
-        return DerUtils.decodeCertificate(bis);
+
-    }
+
-
+    /**
-
+     * Extract a public key from a PEM string
-    /**
+     *
-     * Extract a public key from a PEM string
+     * @param pem
-     *
+     * @return
-     * @param pem
+     * @throws Exception
-     * @return
+     */
-     * @throws Exception
+    public static PublicKey decodePublicKey(String pem) throws Exception {
-     */
+        byte[] der = pemToDer(pem);
-    public static PublicKey decodePublicKey(String pem) throws Exception {
+        return DerUtils.decodePublicKey(der);
-        byte[] der = pemToDer(pem);
+    }
-        return DerUtils.decodePublicKey(der);
+
-    }
+    /**
-
+     * Extract a private key that is a PKCS8 pem string (base64 encoded PKCS8)
-    /**
+     *
-     * Extract a private key that is a PKCS8 pem string (base64 encoded PKCS8)
+     * @param pem
-     *
+     * @return
-     * @param pem
+     * @throws Exception
-     * @return
+     */
-     * @throws Exception
+    public static PrivateKey decodePrivateKey(String pem) throws Exception {
-     */
+        byte[] der = pemToDer(pem);
-    public static PrivateKey decodePrivateKey(String pem) throws Exception {
+        return DerUtils.decodePrivateKey(der);
-        byte[] der = pemToDer(pem);
+    }
-        return DerUtils.decodePrivateKey(der);
+
-    }
+    public static PrivateKey decodePrivateKey(InputStream is) throws Exception {
-
+        String pem = pemFromStream(is);
-    public static PrivateKey decodePrivateKey(InputStream is) throws Exception {
+        return decodePrivateKey(pem);
-        String pem = pemFromStream(is);
+    }
-        return decodePrivateKey(pem);
+
-    }
+    /**
-
+     * Decode a PEM file to DER format
-    /**
+     *
-     * Decode a PEM file to DER format
+     * @param is
-     *
+     * @return
-     * @param is
+     * @throws java.io.IOException
-     * @return
+     */
-     * @throws java.io.IOException
+    public static byte[] pemToDer(InputStream is) throws IOException {
-     */
+        String pem = pemFromStream(is);
-    public static byte[] pemToDer(InputStream is) throws IOException {
+        return pemToDer(pem);
-        String pem = pemFromStream(is);
+    }
-        return pemToDer(pem);
+
-    }
+    /**
-
+     * Decode a PEM string to DER format
-    /**
+     *
-     * Decode a PEM string to DER format
+     * @param pem
-     *
+     * @return
-     * @param pem
+     * @throws java.io.IOException
-     * @return
+     */
-     * @throws java.io.IOException
+    public static byte[] pemToDer(String pem) throws IOException {
-     */
+        pem = removeBeginEnd(pem);
-    public static byte[] pemToDer(String pem) throws IOException {
+        return Base64.decode(pem);
-        pem = removeBeginEnd(pem);
+    }
-        return Base64.decode(pem);
+
-    }
+    public static String removeBeginEnd(String pem) {
-
+        pem = pem.replaceAll("-----BEGIN (.*)-----", "");
-    public static String removeBeginEnd(String pem) {
+        pem = pem.replaceAll("-----END (.*)----", "");
-        pem = pem.replaceAll("-----BEGIN (.*)-----", "");
+        pem = pem.replaceAll("\r\n", "");
-        pem = pem.replaceAll("-----END (.*)----", "");
+        pem = pem.replaceAll("\n", "");
-        pem = pem.replaceAll("\r\n", "");
+        return pem.trim();
-        pem = pem.replaceAll("\n", "");
+    }
-        return pem.trim();
+
-    }
+
-
+    public static String pemFromStream(InputStream is) throws IOException {
-
+        DataInputStream dis = new DataInputStream(is);
-    public static String pemFromStream(InputStream is) throws IOException {
+        byte[] keyBytes = new byte[dis.available()];
-        DataInputStream dis = new DataInputStream(is);
+        dis.readFully(keyBytes);
-        byte[] keyBytes = new byte[dis.available()];
+        dis.close();
-        dis.readFully(keyBytes);
+        return new String(keyBytes, "utf-8");
-        dis.close();
+    }
-        return new String(keyBytes, "utf-8");
+}
-    }
-}

common/src/main/java/org/keycloak/common/util/ServerCookie.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.Serializable;
 import java.text.DateFormat;

common/src/main/java/org/keycloak/common/util/StreamUtil.java

@@ -1,35 +1,35 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
-
+
-import java.io.BufferedReader;
+import java.io.BufferedReader;
-import java.io.IOException;
+import java.io.IOException;
-import java.io.InputStream;
+import java.io.InputStream;
-import java.io.InputStreamReader;
+import java.io.InputStreamReader;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public final class StreamUtil {
+public final class StreamUtil {
-
+
-    private StreamUtil() {
+    private StreamUtil() {
-    }
+    }
-
+
-    public static String readString(InputStream in) throws IOException
+    public static String readString(InputStream in) throws IOException
-    {
+    {
-        char[] buffer = new char[1024];
+        char[] buffer = new char[1024];
-        StringBuilder builder = new StringBuilder();
+        StringBuilder builder = new StringBuilder();
-        BufferedReader reader = new BufferedReader(new InputStreamReader(in));
+        BufferedReader reader = new BufferedReader(new InputStreamReader(in));
-        int wasRead;
+        int wasRead;
-        do
+        do
-        {
+        {
-            wasRead = reader.read(buffer, 0, 1024);
+            wasRead = reader.read(buffer, 0, 1024);
-            if (wasRead > 0)
+            if (wasRead > 0)
-            {
+            {
-                builder.append(buffer, 0, wasRead);
+                builder.append(buffer, 0, wasRead);
-            }
+            }
-        }
+        }
-        while (wasRead > -1);
+        while (wasRead > -1);
-
+
-        return builder.toString();
+        return builder.toString();
-    }
+    }
-}
+}

common/src/main/java/org/keycloak/common/util/StringPropertyReplacer.java

@@ -19,7 +19,7 @@
   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   */
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.File;
 import java.util.Properties;

common/src/main/java/org/keycloak/common/util/SystemEnvProperties.java

@@ -0,0 +1,25 @@
+package org.keycloak.common.util;
+
+import java.util.Properties;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public class SystemEnvProperties extends Properties {
+
+    @Override
+    public String getProperty(String key) {
+        if (key.startsWith("env.")) {
+            return System.getenv().get(key.substring(4));
+        } else {
+            return System.getProperty(key);
+        }
+    }
+
+    @Override
+    public String getProperty(String key, String defaultValue) {
+        String value = getProperty(key);
+        return value != null ? value : defaultValue;
+    }
+
+}

common/src/main/java/org/keycloak/common/util/Time.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.util.Date;
 

common/src/main/java/org/keycloak/common/util/UriUtils.java

@@ -1,4 +1,4 @@
-package org.keycloak.util;
+package org.keycloak.common.util;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URI;

common/src/main/java/org/keycloak/common/util/reflections/Reflections.java

@@ -1,4 +1,4 @@
-package org.keycloak.util.reflections;
+package org.keycloak.common.util.reflections;
 
 import java.beans.Introspector;
 import java.io.Serializable;

common/src/main/java/org/keycloak/common/util/reflections/SetAccessiblePrivilegedAction.java

@@ -1,4 +1,4 @@
-package org.keycloak.util.reflections;
+package org.keycloak.common.util.reflections;
 
 import java.lang.reflect.AccessibleObject;
 import java.security.PrivilegedAction;

common/src/main/java/org/keycloak/common/util/reflections/Types.java

@@ -1,4 +1,4 @@
-package org.keycloak.util.reflections;
+package org.keycloak.common.util.reflections;
 
 import java.lang.reflect.Type;
 

common/src/main/resources/keycloak-version.properties

@@ -0,0 +1,2 @@
+version=${product.version}
+build-time=${product.build-time}

connections/file/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <artifactId>keycloak-parent</artifactId>
         <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

connections/file/src/main/java/org/keycloak/connections/file/DefaultFileConnectionProviderFactory.java

@@ -90,18 +90,7 @@ public class DefaultFileConnectionProviderFactory implements FileConnectionProvi
                 ImportUtils.importFromStream(session, JsonSerialization.mapper, fis, Strategy.IGNORE_EXISTING);
                 session.realms().getMigrationModel().setStoredVersion(model.getModelVersion());
 
-                List<RealmRepresentation> realmReps = new ArrayList<RealmRepresentation>();
+                ImportUtils.importRealms(session, model.getRealms(), Strategy.IGNORE_EXISTING);
-                for (RealmRepresentation realmRep : model.getRealms()) {
-                    if (Config.getAdminRealm().equals(realmRep.getRealm())) {
-                        realmReps.add(0, realmRep);
-                    } else {
-                        realmReps.add(realmRep);
-                    }
-                }
-                for (RealmRepresentation realmRep : realmReps) {
-                    ImportUtils.importRealm(session, realmRep, Strategy.IGNORE_EXISTING);
-                }
-
             } catch (IOException ioe) {
                 logger.error("Unable to read model file " + kcdata.getAbsolutePath(), ioe);
             } finally {

connections/file/src/main/java/org/keycloak/connections/file/FileConnectionSpi.java

@@ -9,6 +9,11 @@ import org.keycloak.provider.Spi;
  */
 public class FileConnectionSpi implements Spi {
 
+    @Override
+    public boolean isInternal() {
+        return true;
+    }
+
     @Override
     public String getName() {
         return "connectionsFile";

connections/file/src/main/java/org/keycloak/connections/file/Model.java

@@ -1,30 +1,30 @@
-package org.keycloak.connections.file;
+package org.keycloak.connections.file;
-
+
-import org.keycloak.representations.idm.RealmRepresentation;
+import org.keycloak.representations.idm.RealmRepresentation;
-
+
-import java.util.List;
+import java.util.List;
-
+
-/**
+/**
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class Model {
+public class Model {
-    private String modelVersion;
+    private String modelVersion;
-    private List<RealmRepresentation> realms;
+    private List<RealmRepresentation> realms;
-
+
-    public String getModelVersion() {
+    public String getModelVersion() {
-        return modelVersion;
+        return modelVersion;
-    }
+    }
-
+
-    public void setModelVersion(String modelVersion) {
+    public void setModelVersion(String modelVersion) {
-        this.modelVersion = modelVersion;
+        this.modelVersion = modelVersion;
-    }
+    }
-
+
-    public List<RealmRepresentation> getRealms() {
+    public List<RealmRepresentation> getRealms() {
-        return realms;
+        return realms;
-    }
+    }
-
+
-    public void setRealms(List<RealmRepresentation> realms) {
+    public void setRealms(List<RealmRepresentation> realms) {
-        this.realms = realms;
+        this.realms = realms;
-    }
+    }
-}
+}

connections/http-client/pom.xml

@@ -1,36 +1,36 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-connections-http-client</artifactId>
+    <artifactId>keycloak-connections-http-client</artifactId>
-    <name>Keycloak Connections Apache HttpClient</name>
+    <name>Keycloak Connections Apache HttpClient</name>
-    <description/>
+    <description/>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-core</artifactId>
+            <artifactId>keycloak-core</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-model-api</artifactId>
+            <artifactId>keycloak-model-api</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
+            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
+            <artifactId>httpclient</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.jboss.logging</groupId>
+            <groupId>org.jboss.logging</groupId>
-            <artifactId>jboss-logging</artifactId>
+            <artifactId>jboss-logging</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-    </dependencies>
+    </dependencies>
-</project>
+</project>

connections/http-client/src/main/java/org/keycloak/connections/httpclient/DefaultHttpClientFactory.java

@@ -12,8 +12,8 @@ import org.jboss.logging.Logger;
 import org.keycloak.Config;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.KeycloakSessionFactory;
-import org.keycloak.util.EnvUtil;
+import org.keycloak.common.util.EnvUtil;
-import org.keycloak.util.KeystoreUtil;
+import org.keycloak.common.util.KeystoreUtil;
 
 import java.io.IOException;
 import java.io.InputStream;

connections/http-client/src/main/java/org/keycloak/connections/httpclient/HttpClientBuilder.java

@@ -1,281 +1,281 @@
-package org.keycloak.connections.httpclient;
+package org.keycloak.connections.httpclient;
-
+
-import org.apache.http.client.config.RequestConfig;
+import org.apache.http.client.config.RequestConfig;
-import org.apache.http.conn.ssl.AllowAllHostnameVerifier;
+import org.apache.http.conn.ssl.AllowAllHostnameVerifier;
-import org.apache.http.conn.ssl.BrowserCompatHostnameVerifier;
+import org.apache.http.conn.ssl.BrowserCompatHostnameVerifier;
-import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
+import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
-import org.apache.http.conn.ssl.SSLContexts;
+import org.apache.http.conn.ssl.SSLContexts;
-import org.apache.http.conn.ssl.StrictHostnameVerifier;
+import org.apache.http.conn.ssl.StrictHostnameVerifier;
-import org.apache.http.conn.ssl.X509HostnameVerifier;
+import org.apache.http.conn.ssl.X509HostnameVerifier;
-import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.CloseableHttpClient;
-import org.apache.http.impl.client.HttpClients;
+import org.apache.http.impl.client.HttpClients;
-
+
-import javax.net.ssl.HostnameVerifier;
+import javax.net.ssl.HostnameVerifier;
-import javax.net.ssl.SSLContext;
+import javax.net.ssl.SSLContext;
-import javax.net.ssl.SSLException;
+import javax.net.ssl.SSLException;
-import javax.net.ssl.SSLSession;
+import javax.net.ssl.SSLSession;
-import javax.net.ssl.SSLSocket;
+import javax.net.ssl.SSLSocket;
-import javax.net.ssl.TrustManager;
+import javax.net.ssl.TrustManager;
-import javax.net.ssl.X509TrustManager;
+import javax.net.ssl.X509TrustManager;
-import java.io.IOException;
+import java.io.IOException;
-import java.security.KeyManagementException;
+import java.security.KeyManagementException;
-import java.security.KeyStore;
+import java.security.KeyStore;
-import java.security.KeyStoreException;
+import java.security.KeyStoreException;
-import java.security.NoSuchAlgorithmException;
+import java.security.NoSuchAlgorithmException;
-import java.security.SecureRandom;
+import java.security.SecureRandom;
-import java.security.UnrecoverableKeyException;
+import java.security.UnrecoverableKeyException;
-import java.security.cert.CertificateException;
+import java.security.cert.CertificateException;
-import java.security.cert.X509Certificate;
+import java.security.cert.X509Certificate;
-import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeUnit;
-
+
-/**
+/**
- * Abstraction for creating HttpClients. Allows SSL configuration.
+ * Abstraction for creating HttpClients. Allows SSL configuration.
- *
+ *
- * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+ * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
- * @version $Revision: 1 $
+ * @version $Revision: 1 $
- */
+ */
-public class HttpClientBuilder {
+public class HttpClientBuilder {
-    public static enum HostnameVerificationPolicy {
+    public static enum HostnameVerificationPolicy {
-        /**
+        /**
-         * Hostname verification is not done on the server's certificate
+         * Hostname verification is not done on the server's certificate
-         */
+         */
-        ANY,
+        ANY,
-        /**
+        /**
-         * Allows wildcards in subdomain names i.e. *.foo.com
+         * Allows wildcards in subdomain names i.e. *.foo.com
-         */
+         */
-        WILDCARD,
+        WILDCARD,
-        /**
+        /**
-         * CN must match hostname connecting to
+         * CN must match hostname connecting to
-         */
+         */
-        STRICT
+        STRICT
-    }
+    }
-
+
-
+
-    /**
+    /**
-     * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
+     * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
-     * @version $Revision: 1 $
+     * @version $Revision: 1 $
-     */
+     */
-    private static class PassthroughTrustManager implements X509TrustManager {
+    private static class PassthroughTrustManager implements X509TrustManager {
-        public void checkClientTrusted(X509Certificate[] chain,
+        public void checkClientTrusted(X509Certificate[] chain,
-                                       String authType) throws CertificateException {
+                                       String authType) throws CertificateException {
-        }
+        }
-
+
-        public void checkServerTrusted(X509Certificate[] chain,
+        public void checkServerTrusted(X509Certificate[] chain,
-                                       String authType) throws CertificateException {
+                                       String authType) throws CertificateException {
-        }
+        }
-
+
-        public X509Certificate[] getAcceptedIssuers() {
+        public X509Certificate[] getAcceptedIssuers() {
-            return null;
+            return null;
-        }
+        }
-    }
+    }
-
+
-    protected KeyStore truststore;
+    protected KeyStore truststore;
-    protected KeyStore clientKeyStore;
+    protected KeyStore clientKeyStore;
-    protected String clientPrivateKeyPassword;
+    protected String clientPrivateKeyPassword;
-    protected boolean disableTrustManager;
+    protected boolean disableTrustManager;
-    protected HostnameVerificationPolicy policy = HostnameVerificationPolicy.WILDCARD;
+    protected HostnameVerificationPolicy policy = HostnameVerificationPolicy.WILDCARD;
-    protected SSLContext sslContext;
+    protected SSLContext sslContext;
-    protected int connectionPoolSize = 100;
+    protected int connectionPoolSize = 100;
-    protected int maxPooledPerRoute = 0;
+    protected int maxPooledPerRoute = 0;
-    protected long connectionTTL = -1;
+    protected long connectionTTL = -1;
-    protected TimeUnit connectionTTLUnit = TimeUnit.MILLISECONDS;
+    protected TimeUnit connectionTTLUnit = TimeUnit.MILLISECONDS;
-    protected HostnameVerifier verifier = null;
+    protected HostnameVerifier verifier = null;
-    protected long socketTimeout = -1;
+    protected long socketTimeout = -1;
-    protected TimeUnit socketTimeoutUnits = TimeUnit.MILLISECONDS;
+    protected TimeUnit socketTimeoutUnits = TimeUnit.MILLISECONDS;
-    protected long establishConnectionTimeout = -1;
+    protected long establishConnectionTimeout = -1;
-    protected TimeUnit establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS;
+    protected TimeUnit establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS;
-    protected boolean disableCookies = false;
+    protected boolean disableCookies = false;
-
+
-
+
-    /**
+    /**
-     * Socket inactivity timeout
+     * Socket inactivity timeout
-     *
+     *
-     * @param timeout
+     * @param timeout
-     * @param unit
+     * @param unit
-     * @return
+     * @return
-     */
+     */
-    public HttpClientBuilder socketTimeout(long timeout, TimeUnit unit)
+    public HttpClientBuilder socketTimeout(long timeout, TimeUnit unit)
-    {
+    {
-        this.socketTimeout = timeout;
+        this.socketTimeout = timeout;
-        this.socketTimeoutUnits = unit;
+        this.socketTimeoutUnits = unit;
-        return this;
+        return this;
-    }
+    }
-
+
-    /**
+    /**
-     * When trying to make an initial socket connection, what is the timeout?
+     * When trying to make an initial socket connection, what is the timeout?
-     *
+     *
-     * @param timeout
+     * @param timeout
-     * @param unit
+     * @param unit
-     * @return
+     * @return
-     */
+     */
-    public HttpClientBuilder establishConnectionTimeout(long timeout, TimeUnit unit)
+    public HttpClientBuilder establishConnectionTimeout(long timeout, TimeUnit unit)
-    {
+    {
-        this.establishConnectionTimeout = timeout;
+        this.establishConnectionTimeout = timeout;
-        this.establishConnectionTimeoutUnits = unit;
+        this.establishConnectionTimeoutUnits = unit;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder connectionTTL(long ttl, TimeUnit unit) {
+    public HttpClientBuilder connectionTTL(long ttl, TimeUnit unit) {
-        this.connectionTTL = ttl;
+        this.connectionTTL = ttl;
-        this.connectionTTLUnit = unit;
+        this.connectionTTLUnit = unit;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder maxPooledPerRoute(int maxPooledPerRoute) {
+    public HttpClientBuilder maxPooledPerRoute(int maxPooledPerRoute) {
-        this.maxPooledPerRoute = maxPooledPerRoute;
+        this.maxPooledPerRoute = maxPooledPerRoute;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder connectionPoolSize(int connectionPoolSize) {
+    public HttpClientBuilder connectionPoolSize(int connectionPoolSize) {
-        this.connectionPoolSize = connectionPoolSize;
+        this.connectionPoolSize = connectionPoolSize;
-        return this;
+        return this;
-    }
+    }
-
+
-    /**
+    /**
-     * Disable trust management and hostname verification. <i>NOTE</i> this is a security
+     * Disable trust management and hostname verification. <i>NOTE</i> this is a security
-     * hole, so only set this option if you cannot or do not want to verify the identity of the
+     * hole, so only set this option if you cannot or do not want to verify the identity of the
-     * host you are communicating with.
+     * host you are communicating with.
-     */
+     */
-    public HttpClientBuilder disableTrustManager() {
+    public HttpClientBuilder disableTrustManager() {
-        this.disableTrustManager = true;
+        this.disableTrustManager = true;
-        return this;
+        return this;
-    }
+    }
-
+
-    /**
+    /**
-     * Disable cookie management.
+     * Disable cookie management.
-     */
+     */
-    public HttpClientBuilder disableCookies(boolean disable) {
+    public HttpClientBuilder disableCookies(boolean disable) {
-        this.disableTrustManager = disable;
+        this.disableTrustManager = disable;
-        return this;
+        return this;
-    }
+    }
-
+
-    /**
+    /**
-     * SSL policy used to verify hostnames
+     * SSL policy used to verify hostnames
-     *
+     *
-     * @param policy
+     * @param policy
-     * @return
+     * @return
-     */
+     */
-    public HttpClientBuilder hostnameVerification(HostnameVerificationPolicy policy) {
+    public HttpClientBuilder hostnameVerification(HostnameVerificationPolicy policy) {
-        this.policy = policy;
+        this.policy = policy;
-        return this;
+        return this;
-    }
+    }
-
+
-
+
-    public HttpClientBuilder sslContext(SSLContext sslContext) {
+    public HttpClientBuilder sslContext(SSLContext sslContext) {
-        this.sslContext = sslContext;
+        this.sslContext = sslContext;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder trustStore(KeyStore truststore) {
+    public HttpClientBuilder trustStore(KeyStore truststore) {
-        this.truststore = truststore;
+        this.truststore = truststore;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder keyStore(KeyStore keyStore, String password) {
+    public HttpClientBuilder keyStore(KeyStore keyStore, String password) {
-        this.clientKeyStore = keyStore;
+        this.clientKeyStore = keyStore;
-        this.clientPrivateKeyPassword = password;
+        this.clientPrivateKeyPassword = password;
-        return this;
+        return this;
-    }
+    }
-
+
-    public HttpClientBuilder keyStore(KeyStore keyStore, char[] password) {
+    public HttpClientBuilder keyStore(KeyStore keyStore, char[] password) {
-        this.clientKeyStore = keyStore;
+        this.clientKeyStore = keyStore;
-        this.clientPrivateKeyPassword = new String(password);
+        this.clientPrivateKeyPassword = new String(password);
-        return this;
+        return this;
-    }
+    }
-
+
-
+
-    static class VerifierWrapper implements X509HostnameVerifier {
+    static class VerifierWrapper implements X509HostnameVerifier {
-        protected HostnameVerifier verifier;
+        protected HostnameVerifier verifier;
-
+
-        VerifierWrapper(HostnameVerifier verifier) {
+        VerifierWrapper(HostnameVerifier verifier) {
-            this.verifier = verifier;
+            this.verifier = verifier;
-        }
+        }
-
+
-        @Override
+        @Override
-        public void verify(String host, SSLSocket ssl) throws IOException {
+        public void verify(String host, SSLSocket ssl) throws IOException {
-            if (!verifier.verify(host, ssl.getSession())) throw new SSLException("Hostname verification failure");
+            if (!verifier.verify(host, ssl.getSession())) throw new SSLException("Hostname verification failure");
-        }
+        }
-
+
-        @Override
+        @Override
-        public void verify(String host, X509Certificate cert) throws SSLException {
+        public void verify(String host, X509Certificate cert) throws SSLException {
-            throw new SSLException("This verification path not implemented");
+            throw new SSLException("This verification path not implemented");
-        }
+        }
-
+
-        @Override
+        @Override
-        public void verify(String host, String[] cns, String[] subjectAlts) throws SSLException {
+        public void verify(String host, String[] cns, String[] subjectAlts) throws SSLException {
-            throw new SSLException("This verification path not implemented");
+            throw new SSLException("This verification path not implemented");
-        }
+        }
-
+
-        @Override
+        @Override
-        public boolean verify(String s, SSLSession sslSession) {
+        public boolean verify(String s, SSLSession sslSession) {
-            return verifier.verify(s, sslSession);
+            return verifier.verify(s, sslSession);
-        }
+        }
-    }
+    }
-
+
-    public CloseableHttpClient build() {
+    public CloseableHttpClient build() {
-        X509HostnameVerifier verifier = null;
+        X509HostnameVerifier verifier = null;
-        if (this.verifier != null) verifier = new VerifierWrapper(this.verifier);
+        if (this.verifier != null) verifier = new VerifierWrapper(this.verifier);
-        else {
+        else {
-            switch (policy) {
+            switch (policy) {
-                case ANY:
+                case ANY:
-                    verifier = new AllowAllHostnameVerifier();
+                    verifier = new AllowAllHostnameVerifier();
-                    break;
+                    break;
-                case WILDCARD:
+                case WILDCARD:
-                    verifier = new BrowserCompatHostnameVerifier();
+                    verifier = new BrowserCompatHostnameVerifier();
-                    break;
+                    break;
-                case STRICT:
+                case STRICT:
-                    verifier = new StrictHostnameVerifier();
+                    verifier = new StrictHostnameVerifier();
-                    break;
+                    break;
-            }
+            }
-        }
+        }
-        try {
+        try {
-            SSLConnectionSocketFactory sslsf = null;
+            SSLConnectionSocketFactory sslsf = null;
-            SSLContext theContext = sslContext;
+            SSLContext theContext = sslContext;
-            if (disableTrustManager) {
+            if (disableTrustManager) {
-                theContext = SSLContext.getInstance("TLS");
+                theContext = SSLContext.getInstance("TLS");
-                theContext.init(null, new TrustManager[]{new PassthroughTrustManager()},
+                theContext.init(null, new TrustManager[]{new PassthroughTrustManager()},
-                        new SecureRandom());
+                        new SecureRandom());
-                verifier = new AllowAllHostnameVerifier();
+                verifier = new AllowAllHostnameVerifier();
-                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
+                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
-            } else if (theContext != null) {
+            } else if (theContext != null) {
-                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
+                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
-            } else if (clientKeyStore != null || truststore != null) {
+            } else if (clientKeyStore != null || truststore != null) {
-                theContext = createSslContext("TLS", clientKeyStore, clientPrivateKeyPassword, truststore, null);
+                theContext = createSslContext("TLS", clientKeyStore, clientPrivateKeyPassword, truststore, null);
-                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
+                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
-            } else {
+            } else {
-                final SSLContext tlsContext = SSLContext.getInstance("TLS");
+                final SSLContext tlsContext = SSLContext.getInstance("TLS");
-                tlsContext.init(null, null, null);
+                tlsContext.init(null, null, null);
-                sslsf = new SSLConnectionSocketFactory(tlsContext, verifier);
+                sslsf = new SSLConnectionSocketFactory(tlsContext, verifier);
-            }
+            }
-            RequestConfig requestConfig = RequestConfig.custom()
+            RequestConfig requestConfig = RequestConfig.custom()
-                    .setConnectTimeout((int) establishConnectionTimeout)
+                    .setConnectTimeout((int) establishConnectionTimeout)
-                    .setSocketTimeout((int) socketTimeout).build();
+                    .setSocketTimeout((int) socketTimeout).build();
-
+
-            org.apache.http.impl.client.HttpClientBuilder builder = HttpClients.custom()
+            org.apache.http.impl.client.HttpClientBuilder builder = HttpClients.custom()
-                    .setDefaultRequestConfig(requestConfig)
+                    .setDefaultRequestConfig(requestConfig)
-                    .setSSLSocketFactory(sslsf)
+                    .setSSLSocketFactory(sslsf)
-                    .setMaxConnTotal(connectionPoolSize)
+                    .setMaxConnTotal(connectionPoolSize)
-                    .setMaxConnPerRoute(maxPooledPerRoute);
+                    .setMaxConnPerRoute(maxPooledPerRoute);
-            if (disableCookies) builder.disableCookieManagement();
+            if (disableCookies) builder.disableCookieManagement();
-            return builder.build();
+            return builder.build();
-        } catch (Exception e) {
+        } catch (Exception e) {
-            throw new RuntimeException(e);
+            throw new RuntimeException(e);
-        }
+        }
-    }
+    }
-
+
-    private SSLContext createSslContext(
+    private SSLContext createSslContext(
-            final String algorithm,
+            final String algorithm,
-            final KeyStore keystore,
+            final KeyStore keystore,
-            final String keyPassword,
+            final String keyPassword,
-            final KeyStore truststore,
+            final KeyStore truststore,
-            final SecureRandom random)
+            final SecureRandom random)
-            throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, UnrecoverableKeyException {
+            throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, UnrecoverableKeyException {
-        return SSLContexts.custom()
+        return SSLContexts.custom()
-                        .useProtocol(algorithm)
+                        .useProtocol(algorithm)
-                        .setSecureRandom(random)
+                        .setSecureRandom(random)
-                        .loadKeyMaterial(keystore, keyPassword != null ? keyPassword.toCharArray() : null)
+                        .loadKeyMaterial(keystore, keyPassword != null ? keyPassword.toCharArray() : null)
-                        .loadTrustMaterial(truststore)
+                        .loadTrustMaterial(truststore)
-                        .build();
+                        .build();
-    }
+    }
-
+
 }

connections/http-client/src/main/java/org/keycloak/connections/httpclient/HttpClientSpi.java

@@ -9,6 +9,11 @@ import org.keycloak.provider.Spi;
  */
 public class HttpClientSpi implements Spi {
 
+    @Override
+    public boolean isInternal() {
+        return true;
+    }
+
     @Override
     public String getName() {
         return "connectionsHttpClient";

connections/infinispan/pom.xml

@@ -1,31 +1,32 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-connections-infinispan</artifactId>
+    <artifactId>keycloak-connections-infinispan</artifactId>
-    <name>Keycloak Connections Infinispan</name>
+    <name>Keycloak Connections Infinispan</name>
-    <description/>
+    <description/>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-core</artifactId>
+            <artifactId>keycloak-core</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-model-api</artifactId>
+            <artifactId>keycloak-model-api</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.infinispan</groupId>
+            <groupId>org.infinispan</groupId>
-            <artifactId>infinispan-core</artifactId>
+            <artifactId>infinispan-core</artifactId>
-            <scope>provided</scope>
+            <scope>provided</scope>
-        </dependency>
+        </dependency>
-    </dependencies>
+
-</project>
+    </dependencies>
+</project>

connections/infinispan/src/main/java/org/keycloak/connections/infinispan/DefaultInfinispanConnectionProviderFactory.java

@@ -66,6 +66,19 @@ public class DefaultInfinispanConnectionProviderFactory implements InfinispanCon
                     } else {
                         initEmbedded();
                     }
+
+                    // Backwards compatibility
+                    if (cacheManager.getCacheConfiguration(InfinispanConnectionProvider.OFFLINE_SESSION_CACHE_NAME) == null) {
+                        logger.warnf("No configuration provided for '%s' cache. Using '%s' configuration as template",
+                                InfinispanConnectionProvider.OFFLINE_SESSION_CACHE_NAME, InfinispanConnectionProvider.SESSION_CACHE_NAME);
+
+                        Configuration sessionCacheConfig = cacheManager.getCacheConfiguration(InfinispanConnectionProvider.SESSION_CACHE_NAME);
+                        if (sessionCacheConfig != null) {
+                            ConfigurationBuilder confBuilder = new ConfigurationBuilder().read(sessionCacheConfig);
+                            Configuration offlineSessionConfig = confBuilder.build();
+                            cacheManager.defineConfiguration(InfinispanConnectionProvider.OFFLINE_SESSION_CACHE_NAME, offlineSessionConfig);
+                        }
+                    }
                 }
             }
         }

connections/infinispan/src/main/java/org/keycloak/connections/infinispan/InfinispanConnectionProvider.java

@@ -11,6 +11,7 @@ public interface InfinispanConnectionProvider extends Provider {
     static final String REALM_CACHE_NAME = "realms";
     static final String USER_CACHE_NAME = "users";
     static final String SESSION_CACHE_NAME = "sessions";
+    static final String OFFLINE_SESSION_CACHE_NAME = "offlineSessions";
     static final String LOGIN_FAILURE_CACHE_NAME = "loginFailures";
 
     <K, V> Cache<K, V> getCache(String name);

connections/infinispan/src/main/java/org/keycloak/connections/infinispan/InfinispanConnectionSpi.java

@@ -9,6 +9,11 @@ import org.keycloak.provider.Spi;
  */
 public class InfinispanConnectionSpi implements Spi {
 
+    @Override
+    public boolean isInternal() {
+        return true;
+    }
+
     @Override
     public String getName() {
         return "connectionsInfinispan";

connections/jpa-liquibase/pom.xml

@@ -1,76 +1,76 @@
-<?xml version="1.0"?>
+<?xml version="1.0"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <parent>
+    <parent>
-        <artifactId>keycloak-parent</artifactId>
+        <artifactId>keycloak-parent</artifactId>
-        <groupId>org.keycloak</groupId>
+        <groupId>org.keycloak</groupId>
-        <version>1.2.0.RC1-SNAPSHOT</version>
+        <version>1.6.1.Final</version>
-        <relativePath>../../pom.xml</relativePath>
+        <relativePath>../../pom.xml</relativePath>
-    </parent>
+    </parent>
-    <modelVersion>4.0.0</modelVersion>
+    <modelVersion>4.0.0</modelVersion>
-
+
-    <artifactId>keycloak-connections-jpa-liquibase</artifactId>
+    <artifactId>keycloak-connections-jpa-liquibase</artifactId>
-    <name>Keycloak Connections JPA Liquibase Updater</name>
+    <name>Keycloak Connections JPA Liquibase Updater</name>
-    <description/>
+    <description/>
-
+
-    <dependencies>
+    <dependencies>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-connections-jpa</artifactId>
+            <artifactId>keycloak-connections-jpa</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-model-api</artifactId>
+            <artifactId>keycloak-model-api</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.liquibase</groupId>
+            <groupId>org.liquibase</groupId>
-            <artifactId>liquibase-core</artifactId>
+            <artifactId>liquibase-core</artifactId>
-            <exclusions>
+            <exclusions>
-                <exclusion>
+                <exclusion>
-                    <groupId>org.yaml</groupId>
+                    <groupId>org.yaml</groupId>
-                    <artifactId>snakeyaml</artifactId>
+                    <artifactId>snakeyaml</artifactId>
-                </exclusion>
+                </exclusion>
-            </exclusions>
+            </exclusions>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.jboss.logging</groupId>
+            <groupId>org.jboss.logging</groupId>
-            <artifactId>jboss-logging</artifactId>
+            <artifactId>jboss-logging</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>org.keycloak</groupId>
+            <groupId>org.keycloak</groupId>
-            <artifactId>keycloak-services</artifactId>
+            <artifactId>keycloak-services</artifactId>
-        </dependency>
+        </dependency>
-        <dependency>
+        <dependency>
-            <groupId>com.h2database</groupId>
+            <groupId>com.h2database</groupId>
-            <artifactId>h2</artifactId>
+            <artifactId>h2</artifactId>
-        </dependency>
+        </dependency>
-    </dependencies>
+    </dependencies>
-
+
-    <build>
+    <build>
-        <plugins>
+        <plugins>
-            <plugin>
+            <plugin>
-                <groupId>org.liquibase</groupId>
+                <groupId>org.liquibase</groupId>
-                <artifactId>liquibase-maven-plugin</artifactId>
+                <artifactId>liquibase-maven-plugin</artifactId>
-                <configuration>
+                <configuration>
-                    <changeLogFile>META-INF/jpa-changelog-master.xml</changeLogFile>
+                    <changeLogFile>META-INF/jpa-changelog-master.xml</changeLogFile>
-
+
-                    <url>${url}</url>
+                    <url>${project.url}</url>
-                    <driver>${driver}</driver>
+                    <driver>${driver}</driver>
-                    <username>${username}</username>
+                    <username>${username}</username>
-                    <password>${password}</password>
+                    <password>${password}</password>
-
+
-                    <referenceUrl>${referenceUrl}</referenceUrl>
+                    <referenceUrl>${referenceUrl}</referenceUrl>
-                    <referenceDriver>${driver}</referenceDriver>
+                    <referenceDriver>${driver}</referenceDriver>
-                    <referenceUsername>${username}</referenceUsername>
+                    <referenceUsername>${username}</referenceUsername>
-                    <referencePassword>${password}</referencePassword>
+                    <referencePassword>${password}</referencePassword>
-                </configuration>
+                </configuration>
-            </plugin>
+            </plugin>
-        </plugins>
+        </plugins>
-    </build>
+    </build>
-
+
-    <properties>
+    <properties>
-        <username>sa</username>
+        <username>sa</username>
-        <password></password>
+        <password></password>
-        <driver>org.h2.Driver</driver>
+        <driver>org.h2.Driver</driver>
-    </properties>
+    </properties>
-</project>
+</project>

connections/jpa-liquibase/src/main/java/org/keycloak/connections/jpa/updater/liquibase/LiquibaseJpaUpdaterProvider.java

@@ -46,26 +46,26 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider {
     private static final String CHANGELOG = "META-INF/jpa-changelog-master.xml";
 
     @Override
-    public String getCurrentVersionSql() {
+    public String getCurrentVersionSql(String defaultSchema) {
-        return "SELECT ID from DATABASECHANGELOG ORDER BY DATEEXECUTED DESC LIMIT 1";
+        return "SELECT ID from " + getTable("DATABASECHANGELOG", defaultSchema) + " ORDER BY DATEEXECUTED DESC LIMIT 1";
     }
 
     @Override
-    public void update(KeycloakSession session, Connection connection) {
+    public void update(KeycloakSession session, Connection connection, String defaultSchema) {
         logger.debug("Starting database update");
 
         // Need ThreadLocal as liquibase doesn't seem to have API to inject custom objects into tasks
         ThreadLocalSessionContext.setCurrentSession(session);
 
         try {
-            Liquibase liquibase = getLiquibase(connection);
+            Liquibase liquibase = getLiquibase(connection, defaultSchema);
 
             List<ChangeSet> changeSets = liquibase.listUnrunChangeSets((Contexts) null);
             if (!changeSets.isEmpty()) {
                 if (changeSets.get(0).getId().equals(FIRST_VERSION)) {
                     Statement statement = connection.createStatement();
                     try {
-                        statement.executeQuery("SELECT id FROM REALM");
+                        statement.executeQuery("SELECT id FROM " + getTable("REALM", defaultSchema));
 
                         logger.infov("Updating database from {0} to {1}", FIRST_VERSION, changeSets.get(changeSets.size() - 1).getId());
                         liquibase.markNextChangeSetRan(null);
@@ -93,9 +93,9 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider {
     }
 
     @Override
-    public void validate(Connection connection) {
+    public void validate(Connection connection, String defaultSchema) {
         try {
-            Liquibase liquibase = getLiquibase(connection);
+            Liquibase liquibase = getLiquibase(connection, defaultSchema);
 
             liquibase.validate();
         } catch (Exception e) {
@@ -103,7 +103,7 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider {
         }
     }
 
-    private Liquibase getLiquibase(Connection connection) throws Exception {
+    private Liquibase getLiquibase(Connection connection, String defaultSchema) throws Exception {
         ServiceLocator sl = ServiceLocator.getInstance();
 
         if (!System.getProperties().containsKey("liquibase.scan.packages")) {
@@ -125,6 +125,9 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider {
 
         LogFactory.setInstance(new LogWrapper());
         Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(new JdbcConnection(connection));
+        if (defaultSchema != null) {
+            database.setDefaultSchemaName(defaultSchema);
+        }
         return new Liquibase(CHANGELOG, new ClassLoaderResourceAccessor(getClass().getClassLoader()), database);
     }
 
@@ -228,4 +231,8 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider {
 
     }
 
+    public static String getTable(String table, String defaultSchema) {
+        return defaultSchema != null ? defaultSchema + "." + table : table;
+    }
+
 }