extremeshok/xmysql-https-auth

docker-xmysql-https-auth

镜像概述和主要用途

docker-xmysql-https-auth是一个集成了HTTPS和多种身份验证机制的xmysql镜像。xmysql可将MySQL数据库自动转换为RESTful API，本镜像在此基础上增加了HTTPS加密、API密钥、HTTP基本认证（htpasswd）和IP白名单等安全特性，适用于需要通过API安全访问MySQL数据库的场景。

核心功能和特性

• MySQL就绪检测：xmysql会每2秒检查MySQL服务状态，直至其启动完成
• 强制HTTPS：仅开放443端口提供HTTPS服务，80端口的所有请求自动重定向至HTTPS
• 自动证书管理：若未找到/certs/cert.pem或/certs/${API_HOSTNAME}/fullchain.pem，自动生成自签名证书
• DHPARAM生成：若未找到/certs/dhparam.pem，自动生成4096位DHPARAM（首次运行可能需要几分钟）
• 动态配置重载：证书文件更新时自动重载nginx服务

API_FILTERTABLES 和 API_IGNORETABLES

用于控制API暴露的数据库表，两者同时指定时，API_FILTERTABLES会覆盖API_IGNORETABLES。

API_FILTERTABLES

逗号分隔的表名列表，仅包含列出的表，未列出的表将被忽略。
示例：API_FILTERTABLES=table1,table3

API_IGNORETABLES

逗号分隔的表名列表，排除列出的表，未列出的表将被包含。
示例：API_IGNORETABLES=table2,table4

身份验证方法

身份验证配置在docker-compose.yml中（详见源码仓库的docker-compose-sample.yml）。API_KEY、API_HTTP_AUTH和API_ALLOW_IP均为可选，可启用一种或多种，若启用多种则需全部通过验证。

API密钥认证（请求头X-API-KEY）

通过请求头X-API-KEY传递密钥进行验证。
配置示例：API_KEY=asecurekey（替换为实际安全密钥）

HTTP基本认证（htpasswd）

支持加密密码和明文密码两种格式：

• 加密密码：使用htpasswd生成的加密密码
  示例：API_HTTP_AUTH=user:encryptedpassword
• 明文密码：使用{plain}标记的明文密码
  示例：API_HTTP_AUTH=user:{plain}password

IP白名单认证

限制仅允许指定IP或IP段访问：

• 带子网掩码的IP段：API_ALLOW_IP=11.22.33.0/24
• 单个IP：API_ALLOW_IP=11.22.33.44
• 多个IP/IP段：API_ALLOW_IP=11.22.33.44,11.22.33.0/24（逗号分隔）

使用方法

查看示例配置

完整使用示例请参考源码仓库中的docker-compose-sample.yml。

基本Docker Compose配置示例

yaml
version: '3'
services:
  xmysql-https-auth:
    image: extremeshok/xmysql-https-auth
    environment:
      - API_KEY=your_secure_api_key
      - API_HTTP_AUTH=admin:{plain}secure_password
      - API_ALLOW_IP=192.168.1.0/24,127.0.0.1
      - API_FILTERTABLES=users,products
      - MYSQL_HOST=mysql
      - MYSQL_PORT=3306
      - MYSQL_USER=dbuser
      - MYSQL_PASSWORD=dbpass
      - MYSQL_DATABASE=dbname
    volumes:
      - ./certs:/certs  # 挂载证书目录（可选，自动生成则无需挂载）
    ports:
      - "443:443"
    depends_on:
      - mysql
  mysql:
    image: mysql:5.7
    environment:
      - MYSQL_ROOT_PASSWORD=rootpass
      - MYSQL_DATABASE=dbname
      - MYSQL_USER=dbuser
      - MYSQL_PASSWORD=dbpass
    volumes:
      - mysql-data:/var/lib/mysql
volumes:
  mysql-data: