traefik/whoamitcp

WhoamiTCP

https://github.com/traefik/whoamitcp/workflows/Main/badge.svg?branch=master](https://github.com/traefik/whoamitcp/actions)

镜像概述与主要用途

WhoamiTCP 是一个轻量级的基于 Go 语言开发的 TCP 服务器工具。其核心功能是接收客户端的 TCP 连接请求，并将服务器的操作系统信息（如主机名、架构等）及客户端请求详情（如源 IP、端口等）打印到标准输出。该工具设计简洁高效，适用于快速验证 TCP 连接、调试网络请求或测试 TCP 服务配置。

核心功能与特性

• 轻量级设计：基于 Go 语言开发，镜像体积小，资源占用低，启动速度快。
• TCP 协议支持：专注于 TCP 协议处理，提供基础的 TCP 连接接收与响应能力。
• 信息打印：自动输出服务器操作系统信息（主机名、OS 类型、架构等）及客户端请求详情（源 IP、端口、连接时间等）。
• TLS 加密支持：可通过配置证书文件启用 TLS 加密，保障 TCP 通信安全。
• 自定义配置：支持设置服务名称、连接横幅（banner）等参数，满足个性化需求。

使用场景与适用范围

• 网络调试：快速验证 TCP 连接是否正常建立，查看客户端请求来源及基本信息。
• TCP 服务测试：作为测试目标服务，验证负载均衡器、反向代理等中间件的 TCP 转发功能。
• 请求信息收集：收集客户端连接的源 IP、端口等基础信息，辅助网络流量分析。
• 教学与演示：演示 TCP 协议通信流程、服务器信息获取等基础网络编程概念。

使用方法与配置说明

基本使用

通过 Docker 运行 WhoamiTCP 容器的基本命令如下：

bash
docker run -p 8080:8080 traefik/whoamitcp

上述命令将启动容器并映射主机 8080 端口到容器内 8080 端口（默认监听端口）。客户端可通过 telnet localhost 8080 或 nc localhost 8080 建立 TCP 连接，服务器将输出相关信息。

配置参数详解

WhoamiTCP 支持通过命令行参数配置服务行为，参数说明如下表：

高级配置示例

1. 自定义端口与服务名称

指定服务监听 9090 端口，并设置服务名称为 test-tcp-server：

bash
docker run -p 9090:9090 traefik/whoamitcp --port :9090 --name test-tcp-server

2. 启用连接横幅

开启横幅功能，客户端连接时将先接收横幅信息：

bash
docker run -p 8080:8080 traefik/whoamitcp --banner true

3. 启用 TLS 加密

若需启用 TLS 加密，需将证书文件（如 server.crt）和密钥文件（如 server.key）挂载到容器内，并通过参数指定路径：

bash
# 假设主机证书路径为 ./certs/server.crt 和 ./certs/server.key
docker run -p 8443:8443 \
  -v $(pwd)/certs:/certs \
  traefik/whoamitcp \
  --port :8443 \
  --certFile /certs/server.crt \
  --keyFile /certs/server.key

客户端需使用 TLS 工具（如 openssl s_client -connect localhost:8443）建立加密连接。

Docker Compose 配置示例

通过 docker-compose.yml 配置文件启动服务，示例如下：

yaml
version: '3'

services:
  whoamitcp:
    image: traefik/whoamitcp
    ports:
      - "8080:8080"  # 主机端口:容器端口
    command: 
      - --port :8080  # 监听端口
      - --name my-tcp-service  # 自定义服务名称
      - --banner true  # 启用连接横幅
    # 如需启用 TLS，添加以下挂载配置
    # volumes:
    #   - ./certs:/certs  # 挂载证书目录到容器内 /certs
    # command:
    #   - --port :8443
    #   - --certFile /certs/server.crt
    #   - --keyFile /certs/server.key

启动服务：

bash
docker-compose up -d

总结

WhoamiTCP 是一款轻量、易用的 TCP 服务器工具，通过 Docker 容器化部署，可快速满足网络调试、TCP 服务测试等场景需求。其简洁的配置与丰富的信息输出能力，使其成为开发者和运维人员的实用工具。