fiware/pep-proxy

FIWARE PEP Proxy (Wilma) Docker镜像文档

镜像概述和主要用途

FIWARE PEP Proxy (Wilma) 是FIWARE通用使能器（GE）之一，作为策略执行点（PEP）代理，主要用于在FIWARE生态系统中实现访问控制和安全策略 enforcement。该Docker镜像提供了便捷的部署方式，可通过构建本地镜像或直接使用Docker Hub上的官方镜像运行，确保后端服务的安全访问。

核心功能和特性

• 策略执行：基于预定义策略对请求进行访问控制检查
• 身份管理集成：与FIWARE IDM（如Keyrock）集成，处理身份验证和授权
• 灵活配置：支持通过配置文件或环境变量自定义代理行为
• CORS支持：可配置跨域资源共享策略
• 多模式部署：支持HTTP/HTTPS协议，可根据需求配置端口和SSL
• 公共路径设置：允许指定无需认证的公共访问路径

使用场景和适用范围

• FIWARE生态系统中微服务的访问控制保护
• 需要与身份管理系统集成的API网关
• 企业级应用中需要细粒度访问控制的场景
• 快速部署安全代理服务的开发和测试环境

使用方法和配置说明

前提条件

确保本地已安装Docker。

选项1：构建本地镜像并运行容器

1. 下载代码并准备环境

从GitHub下载Wilma代码：

console
git clone https://github.com/ging/fiware-pep-proxy.git
cd fiware-pep-proxy/extras/docker

2. 构建Docker镜像

执行以下命令构建本地镜像：

console
sudo docker build -t pep-proxy-image .

注意：若不想使用sudo，可参考Docker安装文档配置Docker用户组。

构建完成后，可通过以下命令查看本地镜像：

console
sudo docker images

3. 运行容器

使用以下命令运行容器，需挂载本地配置文件并映射端口：

console
sudo docker run -d --name pep-proxy-container -v [本地配置文件路径]:/opt/fiware-pep-proxy/config.js -p [主机端口]:[容器端口] pep-proxy-image

参数说明：

• -d：以守护进程模式运行容器
• --name：指定容器名称（可自定义）
• -v：挂载本地配置文件到容器内，配置文件需遵循https://github.com/ging/fiware-pep-proxy/blob/master/config.js.template
• -p：映射主机端口与容器端口，容器端口需与配置文件中config.app_port一致（若启用HTTPS则使用HTTPS端口）

示例命令：

console
sudo docker run -d --name pep-proxy -v /home/user/config.js:/opt/fiware-pep-proxy/config.js -p 80:80 pep-proxy-image

4. 容器管理

查看日志：

console
sudo docker logs -f pep-proxy

停止容器：

console
sudo docker stop pep-proxy

选项2：使用Docker Hub镜像运行容器

直接使用Docker Hub上的官方镜像（https://hub.docker.com/r/fiware/pep-proxy/%EF%BC%89%EF%BC%9A

console
sudo docker run -d --name pep-proxy-container -v [本地配置文件路径]:/opt/fiware-pep-proxy/config.js -p [主机端口]:[容器端口] fiware/pep-proxy[:版本号]

注意：若不指定版本号，默认使用latest标签。

配置参数和环境变量

可通过环境变量配置PEP Proxy，常用变量如下：

环境变量使用示例：

console
sudo docker run -d --name pep-proxy -e PEP_PROXY_APP_ID=myapp -e PEP_PROXY_USERNAME=admin -e PEP_PASSWORD=secret -p 80:80 fiware/pep-proxy