KEYCLOAK-2348 - Social login provider for Microsoft account - KC master

branch

services/src/main/java/org/keycloak/social/microsoft/MicrosoftIdentityProvider.java

@@ -0,0 +1,77 @@
+package org.keycloak.social.microsoft;
+
+import java.net.URLEncoder;
+
+import org.jboss.logging.Logger;
+import org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider;
+import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig;
+import org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper;
+import org.keycloak.broker.oidc.util.JsonSimpleHttp;
+import org.keycloak.broker.provider.BrokeredIdentityContext;
+import org.keycloak.broker.provider.IdentityBrokerException;
+import org.keycloak.broker.provider.util.SimpleHttp;
+import org.keycloak.broker.social.SocialIdentityProvider;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+/**
+ * 
+ * Identity provider for Microsoft account. Uses OAuth 2 protocol of Windows Live Services as documented at <a href="https://msdn.microsoft.com/en-us/library/hh243647.aspx">https://msdn.microsoft.com/en-us/library/hh243647.aspx</a>  
+ * 
+ * @author Vlastimil Elias (velias at redhat dot com)
+ */
+public class MicrosoftIdentityProvider extends AbstractOAuth2IdentityProvider implements SocialIdentityProvider {
+
+    private static final Logger log = Logger.getLogger(MicrosoftIdentityProvider.class);
+
+    public static final String AUTH_URL = "https://login.live.com/oauth20_authorize.srf";
+    public static final String TOKEN_URL = "https://login.live.com/oauth20_token.srf";
+    public static final String PROFILE_URL = "https://apis.live.net/v5.0/me";
+    public static final String DEFAULT_SCOPE = "wl.basic,wl.emails";
+
+    public MicrosoftIdentityProvider(OAuth2IdentityProviderConfig config) {
+        super(config);
+        config.setAuthorizationUrl(AUTH_URL);
+        config.setTokenUrl(TOKEN_URL);
+        config.setUserInfoUrl(PROFILE_URL);
+    }
+
+    @Override
+    protected BrokeredIdentityContext doGetFederatedIdentity(String accessToken) {
+        try {
+            String URL = PROFILE_URL + "?access_token=" + URLEncoder.encode(accessToken, "UTF-8");
+            if (log.isDebugEnabled()) {
+                log.debug("Microsoft Live user profile request to: " + URL);
+            }
+            JsonNode profile = JsonSimpleHttp.asJson(SimpleHttp.doGet(URL));
+
+            String id = getJsonProperty(profile, "id");
+
+            String email = null;
+            if (profile.has("emails")) {
+                email = getJsonProperty(profile.get("emails"), "preferred");
+            }
+
+            BrokeredIdentityContext user = new BrokeredIdentityContext(id);
+
+            user.setUsername(email != null ? email : id);
+            user.setFirstName(getJsonProperty(profile, "first_name"));
+            user.setLastName(getJsonProperty(profile, "last_name"));
+            if (email != null)
+                user.setEmail(email);
+            user.setIdpConfig(getConfig());
+            user.setIdp(this);
+
+            AbstractJsonUserAttributeMapper.storeUserProfileForMapper(user, profile, getConfig().getAlias());
+
+            return user;
+        } catch (Exception e) {
+            throw new IdentityBrokerException("Could not obtain user profile from Microsoft Live ID.", e);
+        }
+    }
+
+    @Override
+    protected String getDefaultScopes() {
+        return DEFAULT_SCOPE;
+    }
+}

services/src/main/java/org/keycloak/social/microsoft/MicrosoftIdentityProviderFactory.java

@@ -0,0 +1,46 @@
+/*
+ * JBoss, Home of Professional Open Source
+ *
+ * Copyright 2013 Red Hat, Inc. and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.keycloak.social.microsoft;
+
+import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig;
+import org.keycloak.broker.provider.AbstractIdentityProviderFactory;
+import org.keycloak.broker.social.SocialIdentityProviderFactory;
+import org.keycloak.models.IdentityProviderModel;
+
+/**
+ * @author Vlastimil Elias (velias at redhat dot com)
+ */
+public class MicrosoftIdentityProviderFactory extends AbstractIdentityProviderFactory<MicrosoftIdentityProvider> implements SocialIdentityProviderFactory<MicrosoftIdentityProvider> {
+
+    public static final String PROVIDER_ID = "microsoft";
+
+    @Override
+    public String getName() {
+        return "Microsoft";
+    }
+
+    @Override
+    public MicrosoftIdentityProvider create(IdentityProviderModel model) {
+        return new MicrosoftIdentityProvider(new OAuth2IdentityProviderConfig(model));
+    }
+
+    @Override
+    public String getId() {
+        return PROVIDER_ID;
+    }
+}

services/src/main/java/org/keycloak/social/microsoft/MicrosoftUserAttributeMapper.java

@@ -0,0 +1,29 @@
+/*
+ * 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.social.microsoft;
+
+import org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper;
+
+/**
+ * User attribute mapper.
+ * 
+ * @author Vlastimil Elias (velias at redhat dot com)
+ */
+public class MicrosoftUserAttributeMapper extends AbstractJsonUserAttributeMapper {
+
+	private static final String[] cp = new String[] { MicrosoftIdentityProviderFactory.PROVIDER_ID };
+
+	@Override
+	public String[] getCompatibleProviders() {
+		return cp;
+	}
+
+	@Override
+	public String getId() {
+		return "microsoft-user-attribute-mapper";
+	}
+
+}

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

@@ -12,4 +12,5 @@ org.keycloak.social.facebook.FacebookUserAttributeMapper
 org.keycloak.social.github.GitHubUserAttributeMapper
 org.keycloak.social.google.GoogleUserAttributeMapper
 org.keycloak.social.linkedin.LinkedInUserAttributeMapper
-org.keycloak.social.stackoverflow.StackoverflowUserAttributeMapper
+org.keycloak.social.stackoverflow.StackoverflowUserAttributeMapper
+org.keycloak.social.microsoft.MicrosoftUserAttributeMapper

services/src/main/resources/META-INF/services/org.keycloak.broker.social.SocialIdentityProviderFactory

@@ -3,4 +3,5 @@ org.keycloak.social.github.GitHubIdentityProviderFactory
 org.keycloak.social.google.GoogleIdentityProviderFactory
 org.keycloak.social.linkedin.LinkedInIdentityProviderFactory
 org.keycloak.social.stackoverflow.StackoverflowIdentityProviderFactory
-org.keycloak.social.twitter.TwitterIdentityProviderFactory
+org.keycloak.social.twitter.TwitterIdentityProviderFactory
+org.keycloak.social.microsoft.MicrosoftIdentityProviderFactory