Jak skonfigurować Spring Security, aby umożliwić dostęp do adresu URL Swaggera bez uwierzytelniania

Mój projekt ma Spring Security. Główny problem: nie można uzyskać dostępu do swagger URL pod adresem http: // localhost: 8080 / api / v2 / api-docs . Mówi o brakującym lub nieprawidłowym nagłówku autoryzacji.

Zrzut ekranu okna przeglądarki Mój pom.xml zawiera następujące wpisy

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

SwaggerConfig:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo());
}

private ApiInfo apiInfo() {
    ApiInfo apiInfo = new ApiInfo("My REST API", "Some custom description of API.", "API TOS", "Terms of service", "[email protected]", "License of API", "API license URL");
    return apiInfo;
}

AppConfig:

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "com.musigma.esp2" })
@Import(SwaggerConfig.class)
public class AppConfig extends WebMvcConfigurerAdapter {

// ========= Overrides ===========

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LocaleChangeInterceptor());
}

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("swagger-ui.html")
      .addResourceLocations("classpath:/META-INF/resources/");

    registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/");
}

Wpisy web.xml:

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>
        com.musigma.esp2.configuration.AppConfig
        com.musigma.esp2.configuration.WebSecurityConfiguration
        com.musigma.esp2.configuration.PersistenceConfig
        com.musigma.esp2.configuration.ACLConfig
        com.musigma.esp2.configuration.SwaggerConfig
    </param-value>
</context-param>

Konfiguracja WebSecurityConfig:

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ComponentScan(basePackages = { "com.musigma.esp2.service", "com.musigma.esp2.security" })
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
    protected void configure(HttpSecurity httpSecurity) throws Exception {
        httpSecurity
        .csrf()
            .disable()
        .exceptionHandling()
            .authenticationEntryPoint(this.unauthorizedHandler)
            .and()
        .sessionManagement()
            .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            .and()
        .authorizeRequests()
            .antMatchers("/auth/login", "/auth/logout").permitAll()
            .antMatchers("/api/**").authenticated()
            .anyRequest().authenticated();

        // custom JSON based authentication by POST of {"username":"<name>","password":"<password>"} which sets the token header upon authentication
        httpSecurity.addFilterBefore(loginFilter(), UsernamePasswordAuthenticationFilter.class);

        // custom Token based authentication based on the header previously given to the client
        httpSecurity.addFilterBefore(new StatelessTokenAuthenticationFilter(tokenAuthenticationService), UsernamePasswordAuthenticationFilter.class);
    }
}

Dodanie tego do klasy WebSecurityConfiguration powinno załatwić sprawę.

@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {

    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/v2/api-docs",
                                   "/configuration/ui",
                                   "/swagger-resources/**",
                                   "/configuration/security",
                                   "/swagger-ui.html",
                                   "/webjars/**");
    }

}

Zaktualizowałem / configuration / ** i / swagger-resources / ** i zadziałało.

@Override
public void configure(WebSecurity web) throws Exception {
    web.ignoring().antMatchers("/v2/api-docs", "/configuration/ui", "/swagger-resources/**", "/configuration/**", "/swagger-ui.html", "/webjars/**");

}

Miałem ten sam problem podczas używania Spring Boot 2.0.0.M7 + Spring Security + Springfox 2.8.0. I rozwiązałem problem, używając następującej konfiguracji zabezpieczeń, która umożliwia publiczny dostęp do zasobów interfejsu użytkownika Swaggera.

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true, securedEnabled = true)
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

    private static final String[] AUTH_WHITELIST = {
            // -- swagger ui
            "/v2/api-docs",
            "/swagger-resources",
            "/swagger-resources/**",
            "/configuration/ui",
            "/configuration/security",
            "/swagger-ui.html",
            "/webjars/**"
            // other public endpoints of your API may be appended to this array
    };


    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.
                // ... here goes your custom security configuration
                authorizeRequests().
                antMatchers(AUTH_WHITELIST).permitAll().  // whitelist Swagger UI resources
                // ... here goes your custom security configuration
                antMatchers("/**").authenticated();  // require authentication for any endpoint that's not whitelisted
    }

}

Dla tych, którzy używają nowszej wersji Swagger 3 org.springdoc:springdoc-openapi-ui

@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {

    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/v3/api-docs/**", "/swagger-ui.html", "/swagger-ui/**");
    }
}

jeśli twoja wersja springfox wyższa niż 2.5 ， powinna zostać dodana do WebSecurityConfiguration jak poniżej:

@Override
public void configure(HttpSecurity http) throws Exception {
    // TODO Auto-generated method stub
    http.authorizeRequests()
        .antMatchers("/v2/api-docs", "/swagger-resources/configuration/ui", "/swagger-resources", "/swagger-resources/configuration/security", "/swagger-ui.html", "/webjars/**").permitAll()
        .and()
        .authorizeRequests()
        .anyRequest()
        .authenticated()
        .and()
        .csrf().disable();
}

Mniej więcej ta strona zawiera odpowiedzi, ale nie wszystkie są w jednym miejscu. Miałem do czynienia z tym samym problemem i spędziłem nad tym całkiem sporo czasu. Teraz lepiej rozumiem i chciałbym się tym podzielić tutaj:

I Włączanie interfejsu Swagger z zabezpieczeniem sieci Spring:

Jeśli domyślnie włączyłeś Spring Websecurity, zablokuje ono wszystkie żądania do Twojej aplikacji i zwróci 401. Jednakże, aby interfejs swagger załadował się w przeglądarce, swagger-ui.html wykonuje kilka wywołań w celu zebrania danych. Najlepszym sposobem debugowania jest otwarcie pliku swagger-ui.html w przeglądarce (np. Google Chrome) i użycie opcji programisty (klawisz „F12”). Możesz zobaczyć kilka wywołań wykonanych, gdy strona się ładuje, a jeśli swagger-ui nie ładuje się całkowicie, prawdopodobnie niektóre z nich zawodzą.

może być konieczne poinformowanie Spring websecurity, aby ignorowało uwierzytelnianie dla kilku wzorców ścieżek swagger. Używam swagger-ui 2.9.2 iw moim przypadku poniżej znajdują się wzorce, które musiałem zignorować:

Jeśli jednak używasz innej wersji, Twoja może się zmienić. być może będziesz musiał wymyślić swoją za pomocą opcji programisty w przeglądarce, jak powiedziałem wcześniej.

@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
public void configure(WebSecurity web) throws Exception {
    web.ignoring().antMatchers("/v2/api-docs", "/configuration/ui", 
            "/swagger-resources/**", "/configuration/**", "/swagger-ui.html"
            , "/webjars/**", "/csrf", "/");
}
}

II Włączanie swagger ui z interceptorem

Generalnie możesz nie chcieć przechwytywać żądań wysyłanych przez swagger-ui.html. Aby wykluczyć kilka wzorców dumy poniżej, jest kod:

W większości przypadków wzorzec bezpieczeństwa sieci i przechwytywacza będzie taki sam.

@Configuration
@EnableWebMvc
public class RetrieveCiamInterceptorConfiguration implements WebMvcConfigurer {

@Autowired
RetrieveInterceptor validationInterceptor;

@Override
public void addInterceptors(InterceptorRegistry registry) {

    registry.addInterceptor(validationInterceptor).addPathPatterns("/**")
    .excludePathPatterns("/v2/api-docs", "/configuration/ui", 
            "/swagger-resources/**", "/configuration/**", "/swagger-ui.html"
            , "/webjars/**", "/csrf", "/");
}

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("swagger-ui.html")
      .addResourceLocations("classpath:/META-INF/resources/");

    registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/");
}

}

Ponieważ być może będziesz musiał włączyć @EnableWebMvc, aby dodać przechwytywacze, być może będziesz musiał dodać programy obsługi zasobów do swagger, podobnie jak to zrobiłem w powyższym fragmencie kodu.

Ograniczając się tylko do zasobów związanych ze Swaggerem:

.antMatchers("/v2/api-docs", "/swagger-resources/**", "/swagger-ui.html", "/webjars/springfox-swagger-ui/**");

Oto kompletne rozwiązanie dla Swagger z Spring Security . Prawdopodobnie chcemy włączyć Swagger tylko w naszym środowisku programistycznym i QA i wyłączyć go w środowisku produkcyjnym. Tak więc używam property ( prop.swagger.enabled) jako flagi, aby ominąć uwierzytelnianie zabezpieczeń wiosny dla swagger-ui tylko w środowisku programistycznym / QA.

@Configuration
@EnableSwagger2
public class SwaggerConfiguration extends WebSecurityConfigurerAdapter implements WebMvcConfigurer {

@Value("${prop.swagger.enabled:false}")
private boolean enableSwagger;

@Bean
public Docket SwaggerConfig() {
    return new Docket(DocumentationType.SWAGGER_2)
            .enable(enableSwagger)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.your.controller"))
            .paths(PathSelectors.any())
            .build();
}

@Override
public void configure(WebSecurity web) throws Exception {
    if (enableSwagger)  
        web.ignoring().antMatchers("/v2/api-docs",
                               "/configuration/ui",
                               "/swagger-resources/**",
                               "/configuration/security",
                               "/swagger-ui.html",
                               "/webjars/**");
}

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (enableSwagger) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
  }
}

Używam Spring Boot 5. Mam ten kontroler, który powinien wywołać nieuwierzytelniony użytkownik.

  //Builds a form to send to devices   
@RequestMapping(value = "/{id}/ViewFormit", method = RequestMethod.GET)
@ResponseBody
String doFormIT(@PathVariable String id) {
    try
    {
        //Get a list of forms applicable to the current user
        FormService parent = new FormService();

Oto, co zrobiłem w konfiguracji.

  @Override
   protected void configure(HttpSecurity http) throws Exception {
    http
            .authorizeRequests()
            .antMatchers(
                    "/registration**",
                    "/{^[\\\\d]$}/ViewFormit",

Mam nadzieję że to pomoże....

Biorąc pod uwagę wszystkie żądania API, które znajdują się we wzorcu adresu URL /api/.., możesz powiedzieć Springowi, aby zabezpieczył tylko ten wzorzec adresu URL, używając poniższej konfiguracji. Co oznacza, że ​​mówisz wiosny, co ma zabezpieczyć, a nie co zignorować.

@Override
protected void configure(HttpSecurity http) throws Exception {
  http
    .csrf().disable()
     .authorizeRequests()
      .antMatchers("/api/**").authenticated()
      .anyRequest().permitAll()
      .and()
    .httpBasic().and()
    .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);
}