WireMock Admin API安全:standalone mode下如何配置apikey防止匿名访问
Standalone模式WireMock Admin API Apikey访问控制实现
原生内置方案(3.0.0及以上版本优先使用)
WireMock从3.0.0版本开始,原生支持Admin API的Token鉴权能力,不需要额外写代码或者搭中间层,直接通过启动参数就能配置:
- 启动Standalone服务时,追加
--admin-api-auth配置项,指定自定义的APIKEY值,格式为token=<你自己设置的密钥字符串> - 示例启动命令:
java -jar wiremock-standalone-3.5.4.jar --admin-api-auth token=your-random-secret-key-2024
配置完成后生效规则:
- 所有指向
/__admin/**路径的Admin API请求,必须在请求头中携带Authorization: Bearer your-random-secret-key-2024,缺失Token、Token不匹配的请求会直接返回401未授权,彻底拦截匿名访问 - 你自定义的所有业务Mock接口不会受鉴权规则影响,正常访问不需要携带Token
低版本适配方案(2.x及更早版本)
如果没法升级到3.x版本,可以根据实际运维条件选择两种适配方式:
- 反向代理旁路鉴权:在WireMock服务前方部署一层轻量反向代理(如Nginx、Caddy),针对
/__admin/**前缀的请求增加Apikey校验规则:只有请求头中携带匹配的自定义Apikey值时,才将请求转发到后端WireMock服务,其余非Admin路径的Mock请求直接放行转发,不做额外校验 - 自定义扩展过滤器:利用WireMock Standalone支持的扩展加载机制,实现一个简单的请求过滤器逻辑:识别路径为Admin API的请求时,校验请求头中的Apikey字段是否匹配预设值,校验不通过直接拦截返回401;将实现的扩展包通过
--extensions启动参数加载,即可在服务启动后生效
落地注意事项
- 配置Apikey后,所有通过Admin API做的Stub配置、请求日志查询、服务状态检查操作,都需要携带对应的Token请求头,否则会被拦截
- 建议不要把硬编码的Apikey提交到公共代码仓库,优先通过环境变量注入启动参数,避免密钥泄露
内容的提问来源于stack exchange,提问作者Seamus
相关产品推荐
相关产品推荐

