/*
 * Copyright 2002-2020 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.web.cors;

import javax.servlet.http.HttpServletRequest;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.lang.Nullable;
import org.springframework.util.ObjectUtils;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;

Utility class for CORS request handling based on the CORS W3C recommendation.
Author:Sebastien Deleuze
Since:4.2
/** * Utility class for CORS request handling based on the * <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>. * * @author Sebastien Deleuze * @since 4.2 */
public abstract class CorsUtils {
Returns true if the request is a valid CORS one by checking Origin header presence and ensuring that origins are different.
/** * Returns {@code true} if the request is a valid CORS one by checking {@code Origin} * header presence and ensuring that origins are different. */
public static boolean isCorsRequest(HttpServletRequest request) { String origin = request.getHeader(HttpHeaders.ORIGIN); if (origin == null) { return false; } UriComponents originUrl = UriComponentsBuilder.fromOriginHeader(origin).build(); String scheme = request.getScheme(); String host = request.getServerName(); int port = request.getServerPort(); return !(ObjectUtils.nullSafeEquals(scheme, originUrl.getScheme()) && ObjectUtils.nullSafeEquals(host, originUrl.getHost()) && getPort(scheme, port) == getPort(originUrl.getScheme(), originUrl.getPort())); } private static int getPort(@Nullable String scheme, int port) { if (port == -1) { if ("http".equals(scheme) || "ws".equals(scheme)) { port = 80; } else if ("https".equals(scheme) || "wss".equals(scheme)) { port = 443; } } return port; }
Returns true if the request is a valid CORS pre-flight one by checking {code OPTIONS} method with Origin and Access-Control-Request-Method headers presence.
/** * Returns {@code true} if the request is a valid CORS pre-flight one by checking {code OPTIONS} method with * {@code Origin} and {@code Access-Control-Request-Method} headers presence. */
public static boolean isPreFlightRequest(HttpServletRequest request) { return (HttpMethod.OPTIONS.matches(request.getMethod()) && request.getHeader(HttpHeaders.ORIGIN) != null && request.getHeader(HttpHeaders.ACCESS_CONTROL_REQUEST_METHOD) != null); } }