Spring Cloud - Защитни услуги

1. Общ преглед

В предишната статия Spring Cloud - Bootstrapping създадохме основно приложение Spring Cloud . Тази статия показва как да го защитите.

Естествено ще използваме Spring Security, за да споделяме сесии, използвайки Spring Session и Redis . Този метод е лесен за настройка и лесен за разширяване до много бизнес сценарии. Ако не сте запознати с пролетната сесия , разгледайте тази статия.

Споделянето на сесии ни дава възможност да регистрираме потребителите в нашата шлюзова услуга и да разпространяваме това удостоверяване до всяка друга услуга на нашата система.

Ако не сте запознати с Redis или Spring Security , добре е да направите бърз преглед на тези теми на този етап. Въпреки че голяма част от статията е подготвена за копиране и поставяне на приложение, няма заместител за разбиране какво се случва под капака.

За въведение в Redis прочетете този урок. За въведение в Spring Security прочетете spring-security-login, role-and-privilege-for-spring-security-registration и spring-security-session. За да получите пълно разбиране за Spring Security, разгледайте майсторския клас learn-spring-security-the-master.

2. Настройка на Maven

Нека започнем с добавяне на зависимостта spring-boot-starter-security към всеки модул в системата:

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

Тъй като използваме управление на пролетни зависимости, можем да пропуснем версиите за зависимостите spring-boot-starter .

Като втора стъпка, нека модифицираме pom.xml на всяко приложение със зависимости spring-session, spring-boot-starter-data-redis:

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

Само четири от нашите приложения ще бъдат обвързани с Spring Session : discovery , gateway , book-service и rating-service .

След това добавете клас за конфигуриране на сесия във всичките три услуги в същата директория като основния файл на приложението:

@EnableRedisHttpSession public class SessionConfig extends AbstractHttpSessionApplicationInitializer { }

И накрая, добавете тези свойства към трите * .properties файла в нашето git хранилище:

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

Сега нека да преминем към специфична за услугата конфигурация.

3. Осигуряване на услугата за конфигуриране

Услугата за конфигуриране съдържа чувствителна информация, често свързана с връзки към база данни и API ключове. Не можем да компрометираме тази информация, така че нека да се потопим право и да защитим тази услуга.

Нека добавим свойства на защитата към файла application.properties в src / main / resources на конфигурационната услуга:

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

Това ще настрои нашата услуга за влизане с откриване. Освен това конфигурираме нашата сигурност с файла application.properties .

Нека сега конфигурираме нашата услуга за откриване.

4. Осигуряване на услугата Discovery

Нашата услуга за откриване съдържа поверителна информация за местоположението на всички услуги в приложението. Той също така регистрира нови случаи на тези услуги.

Ако злонамерените клиенти получат достъп, те ще научат местоположението в мрежата на всички услуги в нашата система и ще могат да регистрират свои собствени злонамерени услуги в нашето приложение. От решаващо значение е услугата за откриване да бъде защитена.

4.1. Конфигурация на защитата

Нека добавим филтър за защита, за да защитим крайните точки, които другите услуги ще използват:

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

Това ще настрои нашата услуга с потребител на „ СИСТЕМА “. Това е основна конфигурация Spring Security с няколко обрата. Нека да разгледаме тези обрати:

  • @Order (1) - казва на Spring да свърже първо този защитен филтър, така че да бъде направен опит преди други
  • .sessionCreationPolicy - казва на Spring винаги да създава сесия, когато потребителят влезе в този филтър
  • .requestMatchers - ограничава крайните точки, за които се прилага този филтър

Филтърът за защита, който току-що настроихме, конфигурира изолирана среда за удостоверяване, която се отнася само до услугата за откриване.

4.2. Осигуряване на таблото за управление на Eureka

Тъй като нашето приложение за откриване има приятен потребителски интерфейс за преглед на регистрираните понастоящем услуги, нека изложим това, като използваме втори филтър за защита и свържем този с удостоверяването за останалата част от нашето приложение. Имайте предвид, че без таг @Order () означава, че това е последният оценен филтър за защита:

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

Добавете този конфигурационен клас в класа SecurityConfig . Това ще създаде втори защитен филтър, който ще контролира достъпа до нашия потребителски интерфейс. Този филтър има няколко необичайни характеристики, нека разгледаме тези:

  • httpBasic (). disable () - казва на пролетната защита да деактивира всички процедури за удостоверяване за този филтър
  • sessionCreationPolicy - задаваме това на НИКОГА, за да покажем, че изискваме потребителят да е вече удостоверил преди достъп до ресурси, защитени от този филтър

Този филтър никога няма да зададе потребителска сесия и разчита на Redis да попълва споделен контекст на защитата. Като такова зависи от друга услуга, шлюза, за осигуряване на удостоверяване.

4.3. Удостоверяване с услугата за конфигуриране

В проекта за откриване нека добавим две свойства към bootstrap.properties в src / main / resources:

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

Тези свойства ще позволят на услугата за откриване да се удостоверява с услугата за конфигуриране при стартиране.

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.

Вече имаме облачно приложение със сигурност около нашите услуги. Използвайки Zuul и Spring Session, ние можем да регистрираме потребителите само в една услуга и да разпространяваме това удостоверяване в цялото ни приложение. Това означава, че можем лесно да разделим нашето приложение на правилни домейни и да защитим всеки от тях, както сметнем за добре.

Както винаги можете да намерите изходния код на GitHub.