All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.phasetwo.service.resource.Cors Maven / Gradle / Ivy

There is a newer version: 0.79
Show newest version
package io.phasetwo.service.resource;

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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.services.resources;

import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.ResponseBuilder;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.function.BiConsumer;
import org.jboss.logging.Logger;
import org.keycloak.common.util.CollectionUtil;
import org.keycloak.http.HttpRequest;
import org.keycloak.http.HttpResponse;
import org.keycloak.models.ClientModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.protocol.oidc.utils.WebOriginsUtils;
import org.keycloak.representations.AccessToken;

/**
 * @author Stian Thorgersen
 */
public class Cors {

  private static final Logger logger = Logger.getLogger(Cors.class);

  public static final long DEFAULT_MAX_AGE = TimeUnit.HOURS.toSeconds(1);
  public static final String DEFAULT_ALLOW_METHODS = "GET, HEAD, OPTIONS";
  public static final String DEFAULT_ALLOW_HEADERS =
      "X-PINGOTHER, Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers";

  public static final String ORIGIN_HEADER = "Origin";
  public static final String AUTHORIZATION_HEADER = "Authorization";

  public static final String ACCESS_CONTROL_ALLOW_ORIGIN = "Access-Control-Allow-Origin";
  public static final String ACCESS_CONTROL_ALLOW_METHODS = "Access-Control-Allow-Methods";
  public static final String ACCESS_CONTROL_ALLOW_HEADERS = "Access-Control-Allow-Headers";
  public static final String ACCESS_CONTROL_EXPOSE_HEADERS = "Access-Control-Expose-Headers";
  public static final String ACCESS_CONTROL_ALLOW_CREDENTIALS = "Access-Control-Allow-Credentials";
  public static final String ACCESS_CONTROL_MAX_AGE = "Access-Control-Max-Age";

  public static final String ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD = "*";
  public static final String INCLUDE_REDIRECTS = "+";

  private HttpRequest request;
  private ResponseBuilder builder;
  private Set allowedOrigins;
  private Set allowedMethods;
  private Set exposedHeaders;

  private boolean preflight;
  private boolean auth;

  public Cors(HttpRequest request, ResponseBuilder response) {
    this.request = request;
    this.builder = response;
  }

  public Cors(HttpRequest request) {
    this.request = request;
  }

  public static Cors add(HttpRequest request, ResponseBuilder response) {
    return new Cors(request, response);
  }

  public static Cors add(HttpRequest request) {
    return new Cors(request);
  }

  public Cors builder(ResponseBuilder builder) {
    this.builder = builder;
    return this;
  }

  public Cors preflight() {
    preflight = true;
    return this;
  }

  public Cors auth() {
    auth = true;
    return this;
  }

  public Cors allowAllOrigins() {
    allowedOrigins = Collections.singleton(ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD);
    return this;
  }

  public Cors allowedOrigins(KeycloakSession session, ClientModel client) {
    if (client != null) {
      allowedOrigins = WebOriginsUtils.resolveValidWebOrigins(session, client);
    }
    return this;
  }

  public Cors allowedOrigins(AccessToken token) {
    if (token != null) {
      allowedOrigins = token.getAllowedOrigins();
    }
    return this;
  }

  public Cors allowedOrigins(String... allowedOrigins) {
    if (allowedOrigins != null && allowedOrigins.length > 0) {
      this.allowedOrigins = new HashSet<>(Arrays.asList(allowedOrigins));
    }
    return this;
  }

  public Cors allowedMethods(String... allowedMethods) {
    this.allowedMethods = new HashSet<>(Arrays.asList(allowedMethods));
    return this;
  }

  public Cors exposedHeaders(String... exposedHeaders) {
    this.exposedHeaders = new HashSet<>(Arrays.asList(exposedHeaders));
    return this;
  }

  public Response build() {
    build(builder::header);
    logger.debug("Added CORS headers to response");
    return builder.build();
  }

  public void build(HttpResponse response) {
    build(response::addHeader);
    logger.debug("Added CORS headers to response");
  }

  public void build(BiConsumer addHeader) {
    String origin = request.getHttpHeaders().getRequestHeaders().getFirst(ORIGIN_HEADER);
    if (origin == null) {
      logger.trace("No origin header ignoring");
      return;
    }

    if (!preflight
        && (allowedOrigins == null
            || (!allowedOrigins.contains(origin)
                && !allowedOrigins.contains(ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD)))) {
      if (logger.isDebugEnabled()) {
        logger.debugv(
            "Invalid CORS request: origin {0} not in allowed origins {1}", origin, allowedOrigins);
      }
      return;
    }

    addHeader.accept(ACCESS_CONTROL_ALLOW_ORIGIN, origin);

    if (preflight) {
      if (allowedMethods != null) {
        addHeader.accept(ACCESS_CONTROL_ALLOW_METHODS, CollectionUtil.join(allowedMethods));
      } else {
        addHeader.accept(ACCESS_CONTROL_ALLOW_METHODS, DEFAULT_ALLOW_METHODS);
      }
    }

    if (!preflight && exposedHeaders != null) {
      addHeader.accept(ACCESS_CONTROL_EXPOSE_HEADERS, CollectionUtil.join(exposedHeaders));
    }

    addHeader.accept(ACCESS_CONTROL_ALLOW_CREDENTIALS, Boolean.toString(auth));

    if (preflight) {
      if (auth) {
        addHeader.accept(
            ACCESS_CONTROL_ALLOW_HEADERS,
            String.format("%s, %s", DEFAULT_ALLOW_HEADERS, AUTHORIZATION_HEADER));
      } else {
        addHeader.accept(ACCESS_CONTROL_ALLOW_HEADERS, DEFAULT_ALLOW_HEADERS);
      }
    }

    if (preflight) {
      addHeader.accept(ACCESS_CONTROL_MAX_AGE, String.valueOf(DEFAULT_MAX_AGE));
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy