Spring Cloud - Sichern von Diensten

1. Übersicht

Im vorherigen Artikel, Spring Cloud - Bootstrapping, haben wir eine grundlegende Spring Cloud- Anwendung erstellt. Dieser Artikel zeigt, wie Sie es sichern.

Wir werden natürlich Spring Security verwenden , um Sitzungen mit Spring Session und Redis zu teilen . Diese Methode ist einfach einzurichten und auf viele Geschäftsszenarien auszudehnen. Wenn Sie mit Spring Session nicht vertraut sind, lesen Sie diesen Artikel.

Durch die gemeinsame Nutzung von Sitzungen können wir Benutzer in unserem Gateway-Dienst anmelden und diese Authentifizierung an jeden anderen Dienst unseres Systems weitergeben.

Wenn Sie mit Redis oder Spring Security nicht vertraut sind , sollten Sie an dieser Stelle einen kurzen Überblick über diese Themen geben. Während ein Großteil des Artikels für eine Anwendung zum Kopieren und Einfügen bereit ist, gibt es keinen Ersatz dafür, zu verstehen, was unter der Haube passiert.

Eine Einführung in Redis finden Sie in diesem Tutorial. Eine Einführung in Spring Security finden Sie unter Spring-Security-Login, Rolle und Berechtigung für Spring-Security-Registrierung und Spring-Security-Sitzung. Um ein umfassendes Verständnis von Spring Security zu erhalten, werfen Sie einen Blick auf die Klasse Learn-Spring-Security-the-Master.

2. Maven Setup

Beginnen wir mit dem Hinzufügen der Spring-Boot-Starter-Sicherheitsabhängigkeit zu jedem Modul im System:

 org.springframework.boot spring-boot-starter-security 

Da wir das Spring- Abhängigkeitsmanagement verwenden, können wir die Versionen für Spring-Boot-Starter- Abhängigkeiten weglassen .

Als zweiten Schritt ändern wir die pom.xml jeder Anwendung mit Spring-Session-, Spring-Boot-Starter-Data-Redis-Abhängigkeiten:

 org.springframework.session spring-session   org.springframework.boot spring-boot-starter-data-redis 

Nur vier unserer Anwendungen werden in die Frühjahrssitzung eingebunden : Discovery , Gateway , Buchservice und Bewertungsservice .

Fügen Sie als Nächstes eine Sitzungskonfigurationsklasse in allen drei Diensten im selben Verzeichnis wie die Hauptanwendungsdatei hinzu:

@EnableRedisHttpSession public class SessionConfig extends AbstractHttpSessionApplicationInitializer { }

Zuletzt fügen Sie diese Eigenschaften zu den drei * .properties- Dateien in unserem Git-Repository hinzu:

spring.redis.host=localhost spring.redis.port=6379

Lassen Sie uns nun in die dienstspezifische Konfiguration springen.

3. Sichern des Konfigurationsdienstes

Der Konfigurationsdienst enthält vertrauliche Informationen, die sich häufig auf Datenbankverbindungen und API-Schlüssel beziehen. Wir können diese Informationen nicht kompromittieren. Lassen Sie uns also direkt in diesen Service eintauchen und ihn sichern.

Fügen wir der Datei application.properties in src / main / resources des Konfigurationsdienstes Sicherheitseigenschaften hinzu :

eureka.client.serviceUrl.defaultZone= //discUser:[email protected]:8082/eureka/ security.user.name=configUser security.user.password=configPassword security.user.role=SYSTEM

Dadurch wird unser Service so eingerichtet, dass er sich mit Discovery anmeldet. Darüber hinaus konfigurieren wir unsere Sicherheit mit der Datei application.properties .

Lassen Sie uns nun unseren Discovery-Service konfigurieren.

4. Sichern des Erkennungsdienstes

Unser Discovery-Service enthält vertrauliche Informationen zum Speicherort aller Services in der Anwendung. Es werden auch neue Instanzen dieser Dienste registriert.

Wenn böswillige Clients Zugriff erhalten, erfahren sie den Netzwerkstandort aller Dienste in unserem System und können ihre eigenen böswilligen Dienste in unserer Anwendung registrieren. Es ist wichtig, dass der Erkennungsdienst gesichert ist.

4.1. Sicherheitskonfiguration

Fügen wir einen Sicherheitsfilter hinzu, um die Endpunkte zu schützen, die die anderen Dienste verwenden:

@Configuration @EnableWebSecurity @Order(1) public class SecurityConfig extends WebSecurityConfigurerAdapter { @Autowired public void configureGlobal(AuthenticationManagerBuilder auth) { auth.inMemoryAuthentication().withUser("discUser") .password("discPassword").roles("SYSTEM"); } @Override protected void configure(HttpSecurity http) { http.sessionManagement() .sessionCreationPolicy(SessionCreationPolicy.ALWAYS) .and().requestMatchers().antMatchers("/eureka/**") .and().authorizeRequests().antMatchers("/eureka/**") .hasRole("SYSTEM").anyRequest().denyAll().and() .httpBasic().and().csrf().disable(); } }

Dadurch wird unser Service mit einem ' SYSTEM' -Benutzer eingerichtet. Dies ist eine grundlegende Spring Security- Konfiguration mit einigen Änderungen. Werfen wir einen Blick auf diese Wendungen:

  • @Order (1) - Weist Spring an, diesen Sicherheitsfilter zuerst zu verkabeln , damit er vor allen anderen versucht wird
  • .sessionCreationPolicy - Weist Spring an, immer eine Sitzung zu erstellen, wenn sich ein Benutzer bei diesem Filter anmeldet
  • .requestMatchers - begrenzt, auf welche Endpunkte dieser Filter angewendet wird

Der soeben eingerichtete Sicherheitsfilter konfiguriert eine isolierte Authentifizierungsumgebung, die nur den Erkennungsdienst betrifft.

4.2. Sichern des Eureka-Dashboards

Da unsere Erkennungsanwendung über eine schöne Benutzeroberfläche zum Anzeigen der aktuell registrierten Dienste verfügt, können Sie diese mithilfe eines zweiten Sicherheitsfilters verfügbar machen und diesen in die Authentifizierung für den Rest unserer Anwendung einbinden. Beachten Sie, dass kein @ Order () -Tag bedeutet, dass dies der letzte Sicherheitsfilter ist, der ausgewertet wird:

@Configuration public static class AdminSecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) { http.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.NEVER) .and().httpBasic().disable().authorizeRequests() .antMatchers(HttpMethod.GET, "/").hasRole("ADMIN") .antMatchers("/info", "/health").authenticated().anyRequest() .denyAll().and().csrf().disable(); } }

Fügen Sie diese Konfigurationsklasse innerhalb der SecurityConfig- Klasse hinzu. Dadurch wird ein zweiter Sicherheitsfilter erstellt, der den Zugriff auf unsere Benutzeroberfläche steuert. Dieser Filter hat einige ungewöhnliche Eigenschaften. Schauen wir uns diese an:

  • httpBasic (). disable () - Weist Spring Security an, alle Authentifizierungsverfahren für diesen Filter zu deaktivieren
  • sessionCreationPolicy - Wir setzen dies auf NIE, um anzuzeigen, dass der Benutzer sich bereits authentifiziert haben muss, bevor er auf Ressourcen zugreifen kann, die durch diesen Filter geschützt sind

Dieser Filter legt niemals eine Benutzersitzung fest und verlässt sich auf Redis , um einen gemeinsam genutzten Sicherheitskontext zu füllen. Daher ist es für die Bereitstellung der Authentifizierung von einem anderen Dienst, dem Gateway, abhängig.

4.3. Authentifizierung mit dem Konfigurationsdienst

Fügen Sie im Discovery-Projekt zwei Eigenschaften an die bootstrap.properties in src / main / resources an:

spring.cloud.config.username=configUser spring.cloud.config.password=configPassword

Mit diesen Eigenschaften kann sich der Erkennungsdienst beim Start beim Konfigurationsdienst authentifizieren.

Let's update our discovery.properties in our Git repository

eureka.client.serviceUrl.defaultZone= //discUser:[email protected]:8082/eureka/ eureka.client.register-with-eureka=false eureka.client.fetch-registry=false

We have added basic authentication credentials to our discovery service to allow it to communicate with the config service. Additionally, we configure Eureka to run in standalone mode by telling our service not to register with itself.

Let's commit the file to the git repository. Otherwise, the changes will not be detected.

5. Securing Gateway Service

Our gateway service is the only piece of our application we want to expose to the world. As such it will need security to ensure that only authenticated users can access sensitive information.

5.1. Security Configuration

Let's create a SecurityConfig class like our discovery service and overwrite the methods with this content:

@Autowired public void configureGlobal(AuthenticationManagerBuilder auth) { auth.inMemoryAuthentication().withUser("user").password("password") .roles("USER").and().withUser("admin").password("admin") .roles("ADMIN"); } @Override protected void configure(HttpSecurity http) { http.authorizeRequests().antMatchers("/book-service/books") .permitAll().antMatchers("/eureka/**").hasRole("ADMIN") .anyRequest().authenticated().and().formLogin().and() .logout().permitAll().logoutSuccessUrl("/book-service/books") .permitAll().and().csrf().disable(); }

This configuration is pretty straightforward. We declare a security filter with form login that secures a variety of endpoints.

The security on /eureka/** is to protect some static resources we will serve from our gateway service for the Eureka status page. If you are building the project with the article, copy the resource/static folder from the gateway project on Github to your project.

Now we modify the @EnableRedisHttpSession annotation on our config class:

@EnableRedisHttpSession( redisFlushMode = RedisFlushMode.IMMEDIATE)

We set the flush mode to immediate to persist any changes on the session immediately. This helps in preparing the authentication token for redirection.

Finally, let's add a ZuulFilter that will forward our authentication token after login:

@Component public class SessionSavingZuulPreFilter extends ZuulFilter { @Autowired private SessionRepository repository; @Override public boolean shouldFilter() { return true; } @Override public Object run() { RequestContext context = RequestContext.getCurrentContext(); HttpSession httpSession = context.getRequest().getSession(); Session session = repository.getSession(httpSession.getId()); context.addZuulRequestHeader( "Cookie", "SESSION=" + httpSession.getId()); return null; } @Override public String filterType() { return "pre"; } @Override public int filterOrder() { return 0; } }

This filter will grab the request as it is redirected after login and add the session key as a cookie in the header. This will propagate authentication to any backing service after login.

5.2. Authenticating With Config and Discovery Service

Let us add the following authentication properties to the bootstrap.properties file in src/main/resources of the gateway service:

spring.cloud.config.username=configUser spring.cloud.config.password=configPassword eureka.client.serviceUrl.defaultZone= //discUser:[email protected]:8082/eureka/

Next, let's update our gateway.properties in our Git repository

management.security.sessions=always zuul.routes.book-service.path=/book-service/** zuul.routes.book-service.sensitive-headers=Set-Cookie,Authorization hystrix.command.book-service.execution.isolation.thread .timeoutInMilliseconds=600000 zuul.routes.rating-service.path=/rating-service/** zuul.routes.rating-service.sensitive-headers=Set-Cookie,Authorization hystrix.command.rating-service.execution.isolation.thread .timeoutInMilliseconds=600000 zuul.routes.discovery.path=/discovery/** zuul.routes.discovery.sensitive-headers=Set-Cookie,Authorization zuul.routes.discovery.url=//localhost:8082 hystrix.command.discovery.execution.isolation.thread .timeoutInMilliseconds=600000

We have added session management to always generate sessions because we only have one security filter we can set that in the properties file. Next, we add our Redis host and server properties.

In addition, we added a route that will redirect requests to our discovery service. Since a standalone discovery service will not register with itself we must locate that service with a URL scheme.

We can remove the serviceUrl.defaultZone property from the gateway.properties file in our configuration git repository. This value is duplicated in the bootstrap file.

Let's commit the file to the Git repository, otherwise, the changes will not be detected.

6. Securing Book Service

The book service server will hold sensitive information controlled by various users. This service must be secured to prevent leaks of protected information in our system.

6.1. Security Configuration

To secure our book service we will copy the SecurityConfig class from the gateway and overwrite the method with this content:

@Override protected void configure(HttpSecurity http) { http.httpBasic().disable().authorizeRequests() .antMatchers("/books").permitAll() .antMatchers("/books/*").hasAnyRole("USER", "ADMIN") .authenticated().and().csrf().disable(); }

6.2. Properties

Add these properties to the bootstrap.properties file in src/main/resources of the book service:

spring.cloud.config.username=configUser spring.cloud.config.password=configPassword eureka.client.serviceUrl.defaultZone= //discUser:[email protected]:8082/eureka/

Let's add properties to our book-service.properties file in our git repository:

management.security.sessions=never

We can remove the serviceUrl.defaultZone property from the book-service.properties file in our configuration git repository. This value is duplicated in the bootstrap file.

Remember to commit these changes so the book-service will pick them up.

7. Securing Rating Service

The rating service also needs to be secured.

7.1. Security Configuration

To secure our rating service we will copy the SecurityConfig class from the gateway and overwrite the method with this content:

@Override protected void configure(HttpSecurity http) { http.httpBasic().disable().authorizeRequests() .antMatchers("/ratings").hasRole("USER") .antMatchers("/ratings/all").hasAnyRole("USER", "ADMIN").anyRequest() .authenticated().and().csrf().disable(); }

We can delete the configureGlobal() method from the gateway service.

7.2. Properties

Add these properties to the bootstrap.properties file in src/main/resources of the rating service:

spring.cloud.config.username=configUser spring.cloud.config.password=configPassword eureka.client.serviceUrl.defaultZone= //discUser:[email protected]:8082/eureka/

Let's add properties to our rating-service.properties file in our git repository:

management.security.sessions=never

We can remove the serviceUrl.defaultZone property from the rating-service.properties file in our configuration git repository. This value is duplicated in the bootstrap file.

Remember to commit these changes so the rating service will pick them up.

8. Running and Testing

Start Redis and all the services for the application: config, discovery, gateway, book-service, and rating-service. Now let's test!

First, let's create a test class in our gateway project and create a method for our test:

public class GatewayApplicationLiveTest { @Test public void testAccess() { ... } }

Next, let's set up our test and validate that we can access our unprotected /book-service/books resource by adding this code snippet inside our test method:

TestRestTemplate testRestTemplate = new TestRestTemplate(); String testUrl = "//localhost:8080"; ResponseEntity response = testRestTemplate .getForEntity(testUrl + "/book-service/books", String.class); Assert.assertEquals(HttpStatus.OK, response.getStatusCode()); Assert.assertNotNull(response.getBody());

Run this test and verify the results. If we see failures confirm that the entire application started successfully and that configurations were loaded from our configuration git repository.

Now let's test that our users will be redirected to log in when visiting a protected resource as an unauthenticated user by appending this code to the end of the test method:

response = testRestTemplate .getForEntity(testUrl + "/book-service/books/1", String.class); Assert.assertEquals(HttpStatus.FOUND, response.getStatusCode()); Assert.assertEquals("//localhost:8080/login", response.getHeaders() .get("Location").get(0));

Run the test again and confirm that it succeeds.

Next, let's actually log in and then use our session to access the user protected result:

MultiValueMap form = new LinkedMultiValueMap(); form.add("username", "user"); form.add("password", "password"); response = testRestTemplate .postForEntity(testUrl + "/login", form, String.class); 

now, let us extract the session from the cookie and propagate it to the following request:

String sessionCookie = response.getHeaders().get("Set-Cookie") .get(0).split(";")[0]; HttpHeaders headers = new HttpHeaders(); headers.add("Cookie", sessionCookie); HttpEntity httpEntity = new HttpEntity(headers); 

and request the protected resource:

response = testRestTemplate.exchange(testUrl + "/book-service/books/1", HttpMethod.GET, httpEntity, String.class); Assert.assertEquals(HttpStatus.OK, response.getStatusCode()); Assert.assertNotNull(response.getBody());

Run the test again to confirm the results.

Now, let's try to access the admin section with the same session:

response = testRestTemplate.exchange(testUrl + "/rating-service/ratings/all", HttpMethod.GET, httpEntity, String.class); Assert.assertEquals(HttpStatus.FORBIDDEN, response.getStatusCode());

Run the test again, and as expected we are restricted from accessing admin areas as a plain old user.

The next test will validate that we can log in as the admin and access the admin protected resource:

form.clear(); form.add("username", "admin"); form.add("password", "admin"); response = testRestTemplate .postForEntity(testUrl + "/login", form, String.class); sessionCookie = response.getHeaders().get("Set-Cookie").get(0).split(";")[0]; headers = new HttpHeaders(); headers.add("Cookie", sessionCookie); httpEntity = new HttpEntity(headers); response = testRestTemplate.exchange(testUrl + "/rating-service/ratings/all", HttpMethod.GET, httpEntity, String.class); Assert.assertEquals(HttpStatus.OK, response.getStatusCode()); Assert.assertNotNull(response.getBody());

Our test is getting big! But we can see when we run it that by logging in as the admin we gain access to the admin resource.

Our final test is accessing our discovery server through our gateway. To do this add this code to the end of our test:

response = testRestTemplate.exchange(testUrl + "/discovery", HttpMethod.GET, httpEntity, String.class); Assert.assertEquals(HttpStatus.OK, response.getStatusCode());

Run this test one last time to confirm that everything is working. Success!!!

Did you miss that? Because we logged in on our gateway service and viewed content on our book, rating, and discovery services without having to log in on four separate servers!

By utilizing Spring Session to propagate our authentication object between servers we are able to log in once on the gateway and use that authentication to access controllers on any number of backing services.

9. Conclusion

Security in the cloud certainly becomes more complicated. But with the help of Spring Security and Spring Session, we can easily solve this critical issue.

Wir haben jetzt eine Cloud-Anwendung mit Sicherheit rund um unsere Dienste. Mit Zuul und Spring Session können wir Benutzer in nur einem Dienst anmelden und diese Authentifizierung an unsere gesamte Anwendung weitergeben. Dies bedeutet, dass wir unsere Anwendung leicht in geeignete Domänen aufteilen und jede von ihnen nach eigenem Ermessen sichern können.

Wie immer finden Sie den Quellcode auf GitHub.