将 Swagger 基本身份验证添加到Spring启动应用程序

Question

要求：

• Spring启动应用程序与Spring狐狸
• 将基本身份验证添加到 Swagger
• 传递所有其他请求

代码:已实现

@EnableWebSecurity
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/swagger-resources/*", "*.html", "/api/v1/swagger.json")
                .hasAuthority("SWAGGER")
                .anyRequest().permitAll()
            .and()
                .httpBasic()
            .and()
                .csrf().disable();
    }

    @Autowired
    public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
        auth.inMemoryAuthentication().withUser("admin").password("admin").authorities("SWAGGER");
    }
}

然而，这段代码无法工作-您可以自由浏览/炫耀ui。html#/没有任何授权。

问题是-为什么BASIC身份验证和用户不适用于swagger uiendpoint？

Answer 1

您的配置很奇怪。你可以尝试这样的事情：

public static void configure(HttpSecurity http) throws Exception {
    http.csrf().disable()
    .antMatcher("/swagger-ui.html")
    .authorizeRequests()
        .anyRequest().hasAnyRole("SWAGGER")
        .and()
    .httpBasic();
}

这确保了对swagger ui的授权。htmlpath（具有SWAGGER角色）。

Answer 2

你可以做如下事情

昂首阔步的代码如下。

    private List<SecurityScheme> basicScheme() {
        List<SecurityScheme> schemeList = new ArrayList<>();
        schemeList.add(new BasicAuth("basicAuth"));
        return schemeList;
    }

    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .
            .
            .
            .securitySchemes(basicScheme());
    }

用于安全配置

    public void configureGlobal(final AuthenticationManagerBuilder auth)
        throws Exception {
        auth.inMemoryAuthentication()
                .withUser("USER")
                .password("PASSWORD")
                .roles("ADMIN");
    }
    .
    .
    .
    @Override
    protected void configure(final HttpSecurity httpSecurity) throws Exception {
        httpSecurity.csrf().disable().authorizeRequests()
    .anyRequest().authenticated().and().sessionManagement()
            .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            .and().httpBasic();
    }
    .
    .
    .
    @Override
    public void configure(final WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/v2/api-docs",
            "/configuration/ui",
            "/swagger-resources/**",
            "/webjars/**",
            "/configuration/security",
            "/swagger-ui.html");
    }

下面使用 swagger 将授权传递给方法。

   @PutMapping("/registration/{id}")
    @ApiOperation(value = "Update registration detail",
                  authorizations = { @Authorization(value="basicAuth") })
    public ResponseEntity<RegistrationModel> updateRegistration(

在你的pom.xml，你将需要：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

基本上就是这样。

Answer 3

您应该使用. Authated（）而不是. permitAll（）：

.authorizeRequests()
    .antMatchers("/swagger-resources/*", "*.html", "/api/v1/swagger.json")
        .hasRole("SWAGGER")
    .anyRequest()
        .authenticated()

这将:

> < li>

限制对匹配< code >/swagger-resources/* ，< code>*的所有资源的访问。html和< code >/API/v1/swagger . JSON

允许对所有其他资源进行未经身份验证的访问

为了澄清为什么您的配置不起作用，这是因为您没有像应该阅读的那样阅读Spring-Security。

您的旧配置如下所示:

.authorizeRequests() // allow requests
    .antMatchers(...) // that matches this
        .hasAuthority("SWAGGER") // with SWAGGER authority
    .anyRequest() // All requests above
        .permitAll() // grant full access 

换句话说，您正在向具有 SWAGGER 权限的用户授予完全访问权限，但您忽略了的是，默认情况下，他们已经有权访问它。更准确地说，除非您另有说明，否则每个人都可以访问它。

通过使用 .身份验证 （）。你告诉Spring，你希望所有匹配的请求都仅限于具有适当角色或权限的人。

新配置:

.authorizeRequests() // allow requests
    .antMatchers(...) // that matches this
        .hasRole("SWAGGER") // with role SWAGGER
    .anyRequest() // all requests above
        .authenticated() // needs authentication

关于您的/swagger resources、/swaggers resources/configuration/securityreturning 401问题：

您应该将/swagger resources/*替换为/swaggerresources/**。

在配置末尾添加以下内容，以允许所有不匹配的请求:

.authorizeRequests()
    .anyRequest()
        .permitAll();