org.mitre.openid.connect.client.UserInfoFetcher.java Source code

Introduction

Here is the source code for org.mitre.openid.connect.client.UserInfoFetcher.java

Source

/*******************************************************************************
 * Copyright 2016 The MITRE Corporation
 *   and the MIT Internet Trust Consortium
 *
 * 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.mitre.openid.connect.client;

import java.io.IOException;
import java.net.URI;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;

import org.apache.http.client.HttpClient;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClientBuilder;
import org.mitre.openid.connect.config.ServerConfiguration;
import org.mitre.openid.connect.config.ServerConfiguration.UserInfoTokenMethod;
import org.mitre.openid.connect.model.DefaultUserInfo;
import org.mitre.openid.connect.model.PendingOIDCAuthenticationToken;
import org.mitre.openid.connect.model.UserInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpMethod;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;

import com.google.common.base.Strings;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.util.concurrent.UncheckedExecutionException;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

/**
 * Utility class to fetch userinfo from the userinfo endpoint, if available. Caches the results.
 * @author jricher
 *
 */
public class UserInfoFetcher {

    /**
     * Logger for this class
     */
    private static final Logger logger = LoggerFactory.getLogger(UserInfoFetcher.class);

    private LoadingCache<PendingOIDCAuthenticationToken, UserInfo> cache;

    public UserInfoFetcher() {
        this(HttpClientBuilder.create().useSystemProperties().build());
    }

    public UserInfoFetcher(HttpClient httpClient) {
        cache = CacheBuilder.newBuilder().expireAfterWrite(1, TimeUnit.HOURS) // expires 1 hour after fetch
                .maximumSize(100).build(new UserInfoLoader(httpClient));
    }

    public UserInfo loadUserInfo(final PendingOIDCAuthenticationToken token) {
        try {
            return cache.get(token);
        } catch (UncheckedExecutionException | ExecutionException e) {
            logger.warn("Couldn't load User Info from token: " + e.getMessage());
            return null;
        }

    }

    private class UserInfoLoader extends CacheLoader<PendingOIDCAuthenticationToken, UserInfo> {
        private HttpComponentsClientHttpRequestFactory factory;

        UserInfoLoader(HttpClient httpClient) {
            this.factory = new HttpComponentsClientHttpRequestFactory(httpClient);
        }

        public UserInfo load(final PendingOIDCAuthenticationToken token) {

            ServerConfiguration serverConfiguration = token.getServerConfiguration();

            if (serverConfiguration == null) {
                logger.warn("No server configuration found.");
                return null;
            }

            if (Strings.isNullOrEmpty(serverConfiguration.getUserInfoUri())) {
                logger.warn("No userinfo endpoint, not fetching.");
                return null;
            }

            try {

                String userInfoString = null;

                if (serverConfiguration.getUserInfoTokenMethod() == null
                        || serverConfiguration.getUserInfoTokenMethod().equals(UserInfoTokenMethod.HEADER)) {
                    RestTemplate restTemplate = new RestTemplate(factory) {

                        @Override
                        protected ClientHttpRequest createRequest(URI url, HttpMethod method) throws IOException {
                            ClientHttpRequest httpRequest = super.createRequest(url, method);
                            httpRequest.getHeaders().add("Authorization",
                                    String.format("Bearer %s", token.getAccessTokenValue()));
                            return httpRequest;
                        }
                    };

                    userInfoString = restTemplate.getForObject(serverConfiguration.getUserInfoUri(), String.class);

                } else if (serverConfiguration.getUserInfoTokenMethod().equals(UserInfoTokenMethod.FORM)) {
                    MultiValueMap<String, String> form = new LinkedMultiValueMap<>();
                    form.add("access_token", token.getAccessTokenValue());

                    RestTemplate restTemplate = new RestTemplate(factory);
                    userInfoString = restTemplate.postForObject(serverConfiguration.getUserInfoUri(), form,
                            String.class);
                } else if (serverConfiguration.getUserInfoTokenMethod().equals(UserInfoTokenMethod.QUERY)) {
                    URIBuilder builder = new URIBuilder(serverConfiguration.getUserInfoUri());
                    builder.setParameter("access_token", token.getAccessTokenValue());

                    RestTemplate restTemplate = new RestTemplate(factory);
                    userInfoString = restTemplate.getForObject(builder.toString(), String.class);
                }

                if (!Strings.isNullOrEmpty(userInfoString)) {

                    JsonObject userInfoJson = new JsonParser().parse(userInfoString).getAsJsonObject();

                    UserInfo userInfo = fromJson(userInfoJson);

                    return userInfo;
                } else {
                    // didn't get anything, return null
                    return null;
                }
            } catch (Exception e) {
                logger.warn("Error fetching userinfo", e);
                return null;
            }

        }
    }

    protected UserInfo fromJson(JsonObject userInfoJson) {
        return DefaultUserInfo.fromJson(userInfoJson);
    }
}