Spring Cloud - Protezione dei servizi

1. Panoramica

Nell'articolo precedente, Spring Cloud - Bootstrapping, abbiamo creato un'applicazione Spring Cloud di base . Questo articolo mostra come proteggerlo.

Naturalmente useremo Spring Security per condividere sessioni utilizzando Spring Session e Redis . Questo metodo è semplice da configurare e facile da estendere a molti scenari aziendali. Se non hai familiarità con Spring Session , consulta questo articolo.

Le sessioni di condivisione ci danno la possibilità di registrare gli utenti nel nostro servizio gateway e propagare tale autenticazione a qualsiasi altro servizio del nostro sistema.

Se non hai familiarità con Redis o Spring Security , è una buona idea fare una rapida revisione di questi argomenti a questo punto. Sebbene gran parte dell'articolo sia pronto per il copia-incolla per un'applicazione, non c'è sostituto per capire cosa succede sotto il cofano.

Per un'introduzione a Redis, leggi questo tutorial. Per un'introduzione a Spring Security leggi spring-security-login, role-and-privilege-for-spring-security-registration e spring-security-session. Per avere una comprensione completa di Spring Security, dai un'occhiata alla lezione-primaverile-sicurezza-la-master-class.

2. Installazione di Maven

Iniziamo aggiungendo la dipendenza spring-boot-starter-security a ciascun modulo nel sistema:

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

Poiché utilizziamo la gestione delle dipendenze Spring , possiamo omettere le versioni per le dipendenze spring-boot-starter .

Come secondo passaggio, modifichiamo il pom.xml di ciascuna applicazione con le dipendenze spring-session, spring-boot-starter-data-redis:

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

Solo quattro delle nostre applicazioni si collegheranno a Spring Session : discovery , gateway , book-service e rating-service .

Successivamente, aggiungi una classe di configurazione della sessione in tutti e tre i servizi nella stessa directory del file dell'applicazione principale:

@EnableRedisHttpSession public class SessionConfig extends AbstractHttpSessionApplicationInitializer { }

Infine, aggiungi queste proprietà ai tre file * .properties nel nostro repository git:

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

Ora passiamo alla configurazione specifica del servizio.

3. Protezione del servizio di configurazione

Il servizio di configurazione contiene informazioni sensibili spesso correlate alle connessioni al database e alle chiavi API. Non possiamo compromettere queste informazioni, quindi immergiamoci e mettiamo al sicuro questo servizio.

Aggiungiamo le proprietà di sicurezza al file application.properties in src / main / resources del servizio di configurazione:

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

Questo imposterà il nostro servizio per accedere con discovery. Inoltre, stiamo configurando la nostra sicurezza con il file application.properties .

Configuriamo ora il nostro servizio di rilevamento.

4. Protezione del servizio di rilevamento

Il nostro servizio di rilevamento contiene informazioni sensibili sulla posizione di tutti i servizi nell'applicazione. Registra anche nuove istanze di tali servizi.

Se i client dannosi ottengono l'accesso, apprenderanno la posizione di rete di tutti i servizi nel nostro sistema e saranno in grado di registrare i propri servizi dannosi nella nostra applicazione. È fondamentale che il servizio di rilevamento sia protetto.

4.1. Configurazione della protezione

Aggiungiamo un filtro di sicurezza per proteggere gli endpoint che gli altri servizi useranno:

@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(); } }

Questo imposterà il nostro servizio con un utente " SYSTEM ". Questa è una configurazione di base di Spring Security con alcune modifiche. Diamo un'occhiata a questi colpi di scena:

  • @Order (1) - dice a Spring di cablare prima questo filtro di sicurezza in modo che venga tentato prima di qualsiasi altro
  • .sessionCreationPolicy : dice a Spring di creare sempre una sessione quando un utente accede a questo filtro
  • .requestMatchers : limita gli endpoint a cui si applica questo filtro

Il filtro di sicurezza, che abbiamo appena impostato, configura un ambiente di autenticazione isolato che riguarda solo il servizio di rilevamento.

4.2. Protezione di Eureka Dashboard

Poiché la nostra applicazione di rilevamento ha una bella interfaccia utente per visualizzare i servizi attualmente registrati, esponiamo che utilizzando un secondo filtro di sicurezza e colleghiamo questo all'autenticazione per il resto della nostra applicazione. Tieni presente che nessun tag @Order () significa che questo è l'ultimo filtro di sicurezza da valutare:

@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(); } }

Aggiungi questa classe di configurazione all'interno della classe SecurityConfig . Questo creerà un secondo filtro di sicurezza che controllerà l'accesso alla nostra interfaccia utente. Questo filtro ha alcune caratteristiche insolite, diamo un'occhiata a quelle:

  • httpBasic (). disable () - dice alla sicurezza di spring di disabilitare tutte le procedure di autenticazione per questo filtro
  • sessionCreationPolicy : lo impostiamo su MAI per indicare che è necessario che l'utente si sia già autenticato prima di accedere alle risorse protette da questo filtro

Questo filtro non imposterà mai una sessione utente e si basa su Redis per popolare un contesto di sicurezza condiviso. In quanto tale, dipende da un altro servizio, il gateway, per fornire l'autenticazione.

4.3. Autenticazione con il servizio di configurazione

Nel progetto di rilevamento, aggiungiamo due proprietà a bootstrap.properties in src / main / resources:

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

Queste proprietà consentiranno al servizio di rilevamento di autenticarsi con il servizio di configurazione all'avvio.

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.

Ora abbiamo un'applicazione cloud con sicurezza intorno ai nostri servizi. Utilizzando Zuul e Spring Session possiamo registrare gli utenti in un solo servizio e propagare l'autenticazione all'intera applicazione. Ciò significa che possiamo facilmente suddividere la nostra applicazione in domini appropriati e proteggere ciascuno di essi come riteniamo opportuno.

Come sempre puoi trovare il codice sorgente su GitHub.