i386/api-firewall

注意：这是https://hub.docker.com/_/api-firewall的`i386`架构构建版本的"每架构"仓库——更多信息请参见官方镜像文档中的https://github.com/docker-library/official-images#architectures-other-than-amd64和官方镜像FAQ中的https://github.com/docker-library/faq#an-images-source-changed-in-git-now-what。

快速参考

• 维护者：
  Wallarm团队

• 获取帮助：
  https://dockr.ly/comm-slack、Server Fault、https://unix.stackexchange.com/help/on-topic或https://stackoverflow.com/help/on-topic

支持的标签及对应的Dockerfile链接

• https://github.com/wallarm/api-firewall-docker/blob/b764f4908aeb542d2a7595b0cca70d14dac976cb/0.9.6/Dockerfile

快速参考（续）

• 问题反馈：
  https://github.com/wallarm/api-firewall/issues?q=

• 支持的架构：(https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/api-firewall/、https://hub.docker.com/r/arm64v8/api-firewall/、https://hub.docker.com/r/i386/api-firewall/

• 镜像制品详情：
  https://github.com/docker-library/repo-info/blob/master/repos/api-firewall（https://github.com/docker-library/repo-info/commits/master/repos/api-firewall）
  （镜像元数据、传输大小等）

• 镜像更新：
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fapi-firewall
  https://github.com/docker-library/official-images/blob/master/library/api-firewall（https://github.com/docker-library/official-images/commits/master/library/api-firewall）

• 本描述的来源：
  https://github.com/docker-library/docs/tree/master/api-firewall（https://github.com/docker-library/docs/commits/master/api-firewall）

什么是API Firewall？

Wallarm API Firewall是一款开源轻量级代理，旨在通过基于严格OpenAPI/Swagger模式验证的强化手段，保护云原生环境中的REST API端点。它采用正向安全模型，仅允许与预定义API规范匹配的请求和响应，拒绝所有其他流量。

核心功能包括：

• 通过阻止不符合OAS/Swagger模式的请求和响应来保护REST API端点
• 发现影子API端点
• 若使用基于OAuth 2.0协议的认证，可验证访问令牌
• 部署和配置快速简便
• 自定义请求和响应处理模式、响应代码及日志格式

使用场景

• 阻止不符合OpenAPI 3.0规范的异常请求和响应（当API Firewall运行在阻塞模式时）
• 发现影子API和未记录的端点（当API Firewall运行在日志模式时）
• 记录不符合OpenAPI 3.0规范的异常请求和响应（当API Firewall运行在日志模式时）

API模式验证与正向安全模型

启动API Firewall时，需提供待保护应用的https://swagger.io/specification/。启动后的API Firewall将作为反向代理运行，验证请求和响应是否与规范中定义的模式匹配。

不符合模式的流量将通过https://docs.docker.com/config/containers/logging/记录或被阻止（取决于配置的API Firewall运行模式）。若运行在日志模式且检测到规范中未包含的端点流量，API Firewall也会将这些端点记录为影子端点（返回404代码的端点除外）。

提供的API模式需使用https://swagger.io/specification/以YAML或JSON文件（`.yaml`、`.yml`、`.json`扩展名）描述。

通过允许使用OpenAPI 3.0规范设置流量要求，Wallarm API Firewall基于正向安全模型工作。

技术特性

API Firewall作为内置OpenAPI 3.0请求和响应验证器的反向代理运行。验证器采用Go语言编写，针对极致性能和接近零的额外延迟进行了优化。

启动API Firewall

要在Docker上下载、安装和启动Wallarm API Firewall，请参见说明文档。

演示环境

您可以通过运行部署了受Wallarm API Firewall保护的示例应用的演示环境来试用API Firewall。有两个可用的演示环境：

• https://github.com/wallarm/api-firewall/tree/main/demo/docker-compose
• https://github.com/wallarm/api-firewall/tree/main/demo/kubernetes

与API Firewall相关的Wallarm博客文章

• 使用API Firewall发现影子API
• Wallarm API Firewall在生产环境中性能优于NGINX

性能

在开发API Firewall时，我们优先考虑速度和效率，以确保客户拥有尽可能快的API。最新测试表明，API Firewall处理一个请求的平均时间为1.339毫秒：

console
$ ab -c 200 -n 10000 -p ./large.json -T application/json http://127.0.0.1:8282/test/signup

Document Path:          /test/signup
Document Length:        20 bytes

Concurrency Level:      200
Time taken for tests:   0.769 seconds
Complete requests:      10000
Failed requests:        0
Total transferred:      2150000 bytes
Total body sent:        283770000
HTML transferred:       200000 bytes
Requests per second:    13005.81 [#/sec] (mean)
Time per request:       15.378 [ms] (mean)
Time per request:       0.077 [ms] (mean, across all concurrent requests)
Transfer rate:          2730.71 [Kbytes/sec] received
                        360415.95 kb/s sent
                        363146.67 kb/s total

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:        0    5   1.6      5      12
Processing:     2   10   5.4      9      59
Waiting:        2    8   5.2      7      56
Total:          3   15   5.7     14      68

Percentage of the requests served within a certain time (ms)
  50%     14
  66%     15
  75%     16
  80%     17
  90%     18
  95%     23
  98%     36
  99%     44
  100%     68 (longest request)

这些性能结果并非API Firewall测试中的唯一结果。其他结果以及用于提升API Firewall性能的方法在这篇Wallarm博客文章中有所描述。

许可证

查看此镜像中包含的软件的https://www.mozilla.org/en-US/MPL/2.0/。

与所有Docker镜像一样，这些镜像可能还包含其他受其他许可证约束的软件（如基础发行版中的Bash等，以及主要包含软件的任何直接或间接依赖项）。

一些能够自动检测到的额外许可证信息可能位于https://github.com/docker-library/repo-info/tree/master/repos/api-firewall中。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用都符合其中包含的所有软件的相关许可证。