com.nimbusds.openid.connect.sdk.id.SectorIDURIValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.
There is a newer version: 11.20.1
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * 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 com.nimbusds.openid.connect.sdk.id;


import java.io.IOException;
import java.net.URI;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import com.nimbusds.jose.util.Resource;
import com.nimbusds.jose.util.ResourceRetriever;
import com.nimbusds.oauth2.sdk.GeneralException;
import com.nimbusds.oauth2.sdk.ciba.BackChannelTokenDeliveryMode;
import com.nimbusds.oauth2.sdk.util.JSONArrayUtils;
import com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata;


/**
 * Sector identifier URI validator.
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect Core 1.0, section 8.1.
 *     
OpenID Connect Dynamic Client Registration 1.0, section 5.
 *     
OpenID Connect CIBA Flow - Core 1.0, section 4.
 * 
 */
public class SectorIDURIValidator {
	

	/**
	 * The URL resource retriever.
	 */
	private final ResourceRetriever resourceRetriever;


	/**
	 * Creates a new sector ID URI validator.
	 *
	 * @param resourceRetriever The URL resource retriever to use. Must not
	 *                          be {@code null}.
	 */
	public SectorIDURIValidator(final ResourceRetriever resourceRetriever) {
		if (resourceRetriever == null) {
			throw new IllegalArgumentException("The resource retriever must not be null");
		}
		this.resourceRetriever = resourceRetriever;
	}


	/**
	 * Returns the URL resource retriever.
	 *
	 * @return The resource retriever.
	 */
	public ResourceRetriever getResourceRetriever() {
		return resourceRetriever;
	}


	/**
	 * Validates the specified URIs for being present in a sector ID
	 * document.
	 *
	 * @param sectorURI      The sector ID URI. Must not be {@code null}.
	 * @param urisToValidate The client URIs to check for being present in
	 *                       the sector ID JSON document. Must not be
	 *                       {@code null}.
	 *
	 * @throws GeneralException If validation failed.
	 */
	public void validate(final URI sectorURI, final Set urisToValidate)
		throws GeneralException {

		Resource resource;
		try {
			resource = resourceRetriever.retrieveResource(sectorURI.toURL());
		} catch (IOException e) {
			throw new GeneralException("Couldn't retrieve the sector ID JSON document: " + e.getMessage(), e);
		}

		if (resource.getContentType() == null) {
			throw new GeneralException("Couldn't validate sector ID: Missing HTTP Content-Type");
		}

		if (! resource.getContentType().toLowerCase().startsWith("application/json")) {
			throw new GeneralException("Couldn't validate sector ID: HTTP Content-Type must be application/json, found " + resource.getContentType());
		}

		List uriList = JSONArrayUtils.toURIList(JSONArrayUtils.parse(resource.getContent()));

		for (URI uri: urisToValidate) {

			if (! uriList.contains(uri)) {
				throw new GeneralException("Sector ID validation failed: URI " + uri + " not present at sector ID URI " + sectorURI);
			}
		}
	}
	
	
	/**
	 * Collects the client URIs for sector ID validation.
	 *
	 * For the OAuth 2.0 authorisation code and implicit grants:
	 * {@code redirect_uris}.
	 *
	 * For the OAuth 2.0 CIBA grant: {@code jwks_uri} for the poll and
	 * ping token delivery modes,
	 * {@code backchannel_client_notification_endpoint} for the push mode.
	 *
	 * @param clientMetadata The client metadata. Must not be {@code null}.
	 *
	 * @return The URIs for sector ID validation, empty set if none.
	 */
	public static Set collectURIsForValidation(final OIDCClientMetadata clientMetadata) {
		
		Set uris = new HashSet<>();
		
		// Grant types code, implicit
		if (clientMetadata.getRedirectionURIs() != null) {
			uris.addAll(clientMetadata.getRedirectionURIs());
		}
		
		// Grant type CIBA
		if (BackChannelTokenDeliveryMode.POLL.equals(clientMetadata.getBackChannelTokenDeliveryMode()) ||
		    BackChannelTokenDeliveryMode.PING.equals(clientMetadata.getBackChannelTokenDeliveryMode())) {
		
			if (clientMetadata.getJWKSetURI() != null) {
				uris.add(clientMetadata.getJWKSetURI());
			}
		}
		if (BackChannelTokenDeliveryMode.PUSH.equals(clientMetadata.getBackChannelTokenDeliveryMode())) {
			
			if (clientMetadata.getBackChannelClientNotificationEndpoint() != null) {
				uris.add(clientMetadata.getBackChannelClientNotificationEndpoint());
			}
		}
		
		return Collections.unmodifiableSet(uris);
	}
}