springboot项目关闭swagger防止漏洞扫描

2024-06-04 3773阅读

为了应对安全扫描,再生产环境下关闭swagger ui

1、项目中关闭swagger

在这里用的是config配置index.php/tags-522.html" class="superseo">文件的方式关闭的

@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
    @Value("${swagger.enable}")
    private Boolean enable;
    @Bean
    public Docket swaggerPersonApi10() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(enable)    //配置在该处生效
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.unidata.cloud.logservice.api.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .version("1.0")
                .title("")
                .contact(new Contact("", "", ""))
                .description("")
                .build();
    }
}

在application.properties中增加

swagger.enable: false

来控制关闭,如果想开启就改为true

2、到这里其实已经关闭swagger 了,但是安全扫描还是不能通过,因为访问swagger-ui.html路径会跳出提示swagger已关闭的页面,而安全扫描只要返回的页面中含有swagger的字符,就会不通过,这里还需要一步,让访问swagger-ui.html页面直接返回404

首先新增一个监听config

public class SwaggerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestUri = request.getRequestURI();
        if (requestUri.contains("swagger-ui")) {
            response.sendRedirect("/404"); // 可以重定向到自定义的错误页面
            return false;
        }
        return true;
    }
}

然后在之前的config中添加一段代码

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SwaggerInterceptor()).addPathPatterns("/**");
    }

好的,到这里就已经彻底关闭swagger了


    免责声明:我们致力于保护作者版权,注重分享,被刊用文章因无法核实真实出处,未能及时与作者取得联系,或有版权异议的,请联系管理员,我们会立即处理! 部分文章是来自自研大数据AI进行生成,内容摘自(百度百科,百度知道,头条百科,中国民法典,刑法,牛津词典,新华词典,汉语词典,国家院校,科普平台)等数据,内容仅供学习参考,不准确地方联系删除处理! 图片声明:本站部分配图来自人工智能系统AI生成,觅知网授权图片,PxHere摄影无版权图库和百度,360,搜狗等多加搜索引擎自动关键词搜索配图,如有侵权的图片,请第一时间联系我们,邮箱:ciyunidc@ciyunshuju.com。本站只作为美观性配图使用,无任何非法侵犯第三方意图,一切解释权归图片著作权方,本站不承担任何责任。如有恶意碰瓷者,必当奉陪到底严惩不贷!

    目录[+]