Skip to content

Commit

Permalink
Merge pull request #86 from Open-EO/feature/basic-auth
Browse files Browse the repository at this point in the history 
Feature/basic auth
  • Loading branch information
@pierocampa
pierocampa committed Aug 30, 2023
2 parents b23781b + f46275b commit 1124ccf
Show file tree
Hide file tree
Showing 84 changed files with 3,365 additions and 600 deletions.
153 changes: 99 additions & 54 deletions pom.xml
View file
Original file line number Diff line number Diff line change
@@ -1,36 +1,48 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>
<groupId>org.openeo</groupId>
<artifactId>openeo-spring-driver</artifactId>
<packaging>jar</packaging>
<name>openeo-spring-driver</name>
<version>1.0.0</version>
<version>1.1.0</version>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.1</version>
<!--
2.5.1 -> Spring Framework v5.3.8
2.5.1 -> Spring Security v5.5.0
2.6.1 -> Spring Framework v5.3.13
2.6.1 -> Spring Security v5.6.0
See : https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-dependencies/2.5.1/spring-boot-dependencies-2.5.1.pom
-->
</parent>

<properties>
<java.version>11</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<springfox-version>3.0.0</springfox-version>
<springdoc-version>1.4.6</springdoc-version>
<gdal.path>/usr/share/java/gdal.jar</gdal.path>
<gdal.version>3.1.0</gdal.version>
<springdoc-version>1.5.13</springdoc-version>
<!--gdal.path>/usr/share/java/gdal.jar</gdal.path-->
<gdal.version>3.4.0</gdal.version>
<netcdfJavaVersion>5.2.0</netcdfJavaVersion>
<log4JVersion>2.17.0</log4JVersion>
<commonsio.version>2.8.0</commonsio.version>
<json.version>20200518</json.version>
<json.version>20230618</json.version>
<keycloak.version>12.0.4</keycloak.version>
<tomcat.dbcp.version>9.0.37</tomcat.dbcp.version>
<jackson.nullable.version>0.2.1</jackson.nullable.version>
<spring.security.version>5.5.1</spring.security.version>
<spring.test.version>2.7.4</spring.test.version>
<jjwt.version>0.11.5</jjwt.version>
<maven.test.skip>false</maven.test.skip>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.1</version>
</parent>

<build>
<sourceDirectory>src/main/java</sourceDirectory>
<plugins>
Expand Down Expand Up @@ -75,20 +87,11 @@
<outputDir>${project.build.directory}</outputDir>
</configuration>
</plugin>
<!--plugin>
<artifactId>maven-surefire-plugin</artifactId>
<executions>
<execution>
<phase>test</phase>
<goals>
<goal>test</goal>
</goals>
</execution>
</executions>
</plugin-->
</plugins>
</build>

<dependencies>
<!-- Spring Boot -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
Expand All @@ -115,6 +118,41 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<!-- JsonObject implementation selection -->
<exclusion>
<groupId>com.vaadin.external.google</groupId>
<artifactId>android-json</artifactId>
</exclusion>
<!-- Force Junit 5 -->
<exclusion>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>

<!-- deprecated Keycloak adapters -->
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-spring-security-adapter</artifactId>
Expand All @@ -125,21 +163,40 @@
<artifactId>keycloak-authz-client</artifactId>
<version>${keycloak.version}</version>
</dependency>

<!--
Spring Boot - OAuth2 libraries
@see https://www.baeldung.com/spring-boot-keycloak
-->
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-core</artifactId>
<version>${spring.security.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-web</artifactId>
<version>${spring.security.version}</version>
</dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-config</artifactId>
<version>${spring.security.version}</version>
</dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>

<!-- JWT (Bearer Token) Dependencies -->
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-api</artifactId>
<version>${jjwt.version}</version>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-impl</artifactId>
<version>${jjwt.version}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-jackson</artifactId>
<version>${jjwt.version}</version>
<scope>runtime</scope>
</dependency>

<!-- Spring Misc -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
Expand All @@ -148,8 +205,10 @@
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
<version>${springfox-version}</version>
</dependency>

<!-- Misc -->
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
Expand Down Expand Up @@ -190,12 +249,6 @@
<artifactId>json</artifactId>
<version>${json.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
Expand All @@ -219,18 +272,8 @@
<artifactId>log4j2-ecs-layout</artifactId>
<version>1.2.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<version>${spring.test.version}</version>
<scope>test</scope>
</dependency>
<!--dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency-->
</dependencies>

<dependencyManagement>
<dependencies>
<dependency>
Expand All @@ -242,6 +285,7 @@
</dependency>
</dependencies>
</dependencyManagement>

<repositories>
<repository>
<id>unidata-all</id>
Expand All @@ -254,4 +298,5 @@
<url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
</repository>
</repositories>

</project>
36 changes: 17 additions & 19 deletions src/main/java/org/openeo/spring/ApiFilter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,30 @@ public class ApiFilter extends OncePerRequestFilter {
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletResponse res = (HttpServletResponse) response;
HttpServletRequest req = (HttpServletRequest) request;

HttpServletResponse res = response;
HttpServletRequest req = request;
log.debug("Filter: URL" + " called: "+req.getRequestURL().toString());
Enumeration<String> headerEnum = req.getHeaderNames();

Enumeration<String> headerEnum = req.getHeaderNames();
while(headerEnum.hasMoreElements()) {
String headerName = headerEnum.nextElement();
log.trace(headerName + " = " + req.getHeader(headerName));
}

String clientIp = req.getHeader("Origin");
if(clientIp == null) {
clientIp = req.getHeader("X-Forwarded-For");
if(clientIp == null) {
clientIp = request.getRemoteHost();
log.debug("Got direct request from the following client: " + clientIp);
}else {
log.debug("Got proxy forwared request from the following client: " + clientIp);
}
}else {
log.debug("Got request from the following js client: " + clientIp);
}
res.addHeader("Access-Control-Allow-Origin", clientIp);
res.addHeader("Access-Control-Allow-Methods", "OPTIONS, GET, POST, DELETE, PUT, PATCH");
res.addHeader("Access-Control-Allow-Headers", "origin, content-type, accept, authorization");
res.addHeader("Access-Control-Allow-Credentials", "true");
res.addHeader("Access-Control-Expose-Headers", "Location, OpenEO-Identifier, OpenEO-Costs");
clientIp = req.getHeader("X-Forwarded-For");
if(clientIp == null) {
clientIp = request.getRemoteHost();
log.debug("Got direct request from the following client: " + clientIp);
} else {
log.debug("Got proxy forwared request from the following client: " + clientIp);
}
} else {
log.debug("Got request from the following js client: " + clientIp);
}

chain.doFilter(request, response);
}

}
36 changes: 36 additions & 0 deletions src/main/java/org/openeo/spring/FaviconConfig.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package org.openeo.spring;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;

/**
* Handler of the favicon.ico request.
*
* TODO: Spring Boot should automatically serve static content in resources
* classpath, but without this explicit handler nothing happens on {@code GET /favicon.ico}.
*/
@Configuration
public class FaviconConfig {

@Bean
public SimpleUrlHandlerMapping customFaviconHandlerMapping() {
SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
mapping.setOrder(Integer.MIN_VALUE);
mapping.setUrlMap(Collections.singletonMap("/favicon.ico", faviconRequestHandler()));
return mapping;
}

@Bean
protected ResourceHttpRequestHandler faviconRequestHandler() {
ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
List<String> locations = Arrays.asList("classpath:static/");
requestHandler.setLocationValues(locations);
return requestHandler;
}
}
2 changes: 1 addition & 1 deletion ...java/org/openeo/spring/HibernateConf.java → ...va/org/openeo/spring/HibernateConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

@Configuration
@EnableTransactionManagement
public class HibernateConf {
public class HibernateConfig {

@Autowired
private Environment env;
Expand Down
19 changes: 15 additions & 4 deletions src/main/java/org/openeo/spring/OpenAPI2SpringBoot.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.openeo.spring;

import org.openapitools.jackson.nullable.JsonNullableModule;
import org.openeo.spring.security.CorsConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.ExitCodeGenerator;
Expand All @@ -10,10 +11,13 @@
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.fasterxml.jackson.databind.Module;

@EnableWebMvc
@SpringBootApplication(exclude = {HibernateJpaAutoConfiguration.class})
@ComponentScan(basePackages = {"org.openeo.spring" , "org.openapitools.configuration", "org.openeo.wcps", "org.openeo.spring.api"})
public class OpenAPI2SpringBoot implements CommandLineRunner {
Expand Down Expand Up @@ -49,16 +53,23 @@ public int getExitCode() {
}

@Bean
public FilterRegistrationBean<ApiFilter> apifilter()
{
public FilterRegistrationBean<ApiFilter> openeoApiFilter() {
FilterRegistrationBean<ApiFilter> registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(new ApiFilter());
registrationBean.addUrlPatterns("/*");
registrationBean.setOrder(1);
return registrationBean;
}



@Bean
public FilterRegistrationBean<CorsFilter> corsFilterRegistration() {
FilterRegistrationBean<CorsFilter> registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(CorsConfig.corsFilter());
registrationBean.addUrlPatterns("/*");
registrationBean.setOrder(2);
return registrationBean;
}

@Bean
public WebMvcConfigurer webConfigurer() {
return new WebMvcConfigurer() {};
Expand Down
Loading

0 comments on commit 1124ccf

Please sign in to comment.