Docker-STUN/TURN(Coturn)

coturn 是 TURN 和 STUN Server 的免费开源实现方案
TURN 服务器是 VoIP 媒体流量 NAT 遍历服务器和网关

工作时会优先使用 STUN打洞(客户端间直连)，打洞识别才会使用 TURN中继转发(客户端经过服务器转发)，中继转发时就会需要用到额外开放的端口了
- STUN：地址前缀均为 `stun:`，并且不需要用户名密码
- TURN(S)：地址前缀 未加密`turn:`TLS加密`turns:`，可以配置用户名和密码

**相关链接：**
- Coturn：
  - GitHub：https://github.com/coturn/coturn
  - Docker：https://hub.docker.com/r/coturn/coturn
  - WiKi：https://github.com/coturn/coturn/wiki
  - Coturn TURN 服务器 Docker 镜像：[GitHub](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md)、[quay.io](https://quay.io/repository/coturn/coturn)
- Ice测试(STUN/TURN)：
  - IceTest：[Demo](https://icetest.info/)，[GitHub](https://github.com/tgabi333/ice-test)
  - trickle-ice：[Demo](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/)， [GitHub](https://github.com/webrtc/samples/tree/gh-pages/src/content/peerconnection/trickle-ice)

## Docker 部署
```bash
# 快速部署(host)
docker run -d --network=host coturn/coturn
# 快速部署(开放 55000-55100)
docker run -d -p 3478:3478 -p 3478:3478/udp -p 5349:5349 -p 5349:5349/udp -p 55000-55100:55000-55100/udp coturn/coturn --min-port=55000 --max-port=55100
```

## docker-compose 部署
```bash
mkdir -p ssl  # 创建SSL证书文件夹
nano docker-compose.yml  # 编写 docker-compose.yml 配置文件
nano turnserver.conf  # 编写 Coturn 配置文件
docker-compose up -d  # 拉取并部署
```
部署完成后查看两个主端口是否正常开放(默认 3478 和 5349)
若是 TLS(默认 5349) 端口未开放，很可能就是证书问题(检查挂载路径和权限)
`docker-compose.yml`
```yaml
services:
  coturn_server:  # Coturn服务器(STUN/TURN 服务)
    container_name: coturn  # 自定义容器名称
    image: coturn/coturn:alpine  # alpine 轻量
    restart: always
    # network_mode: host  # 使用host模式，无需映射端口
    ports:
      # 均需和配置文件一致
      - 3478:3478  # 主监听端口(tcp)⭐
      - 3478:3478/udp  # 主监听端口(udp)⭐
      - 5349:5349  # TLS端口(tcp)⭐
      - 5349:5349/udp  # TLS端口(udp)⭐
      - 55000-55100:55000-55100/udp  # 客户端分配端口(udp)⭐
    volumes:
      - ./turnserver.conf:/etc/coturn/turnserver.conf  # 配置文件
      - ./ssl:/etc/coturn/ssl/  # SSL 证书⭐
```
`turnserver.conf`
```bash
# TURN 服务器域(随意)⭐
realm=nas.918178.xyz
# TURN 服务器名称(随意)
server-name=coturn

# TURN服务器的外部IP地址,如果Coturn位于NAT后面则需要配置
# external-ip=x.x.x.x
# TURN服务器监听的IP地址,0.0.0.0全部监听⭐
listening-ip=0.0.0.0
# 主端口用于STUN和TURN(根据实际情况修改),开放TCP/UDP⭐
listening-port=3478
# TLS加密的TURN(TURNS)(根据实际情况修改),开放TCP/UDP⭐
tls-listening-port=5349
# 其他开放的通信端口范围(根据实际情况修改),开放UDP⭐
min-port=55000
max-port=55100

# 启用指纹
fingerprint
# 启用长期凭据机制
lt-cred-mech
# 指定 TURN 认证的用户(用户名:密码，多用户则多条)⭐
user=zwzw:zwzw
# user=user:pass

# 启用详细日志记录
# verbose
# 日志文件路径，- 输出至 STDOUT，容器日志中可查看
log-file=-

# SSL 证书(如何提示文件找不到可能是权限不足)⭐
cert=/etc/coturn/ssl/<证书>.cer
pkey=/etc/coturn/ssl/<密钥>.key
# 命令生成(时间较长) openssl dhparam -out ./ssl/dhparams.pem 4096
# dh-file=/etc/coturn/ssl/dhparam.pem

# 为了安全起见，禁用旧的 ssl 和 tls 协议
# 其他推荐选项：https://github.com/coturn/coturn/blob/master/examples/etc/turnserver.conf
no-sslv3
no-tlsv1
no-tlsv1_1
no-tlsv1_2
no-rfc5780
no-stun-backward-compatibility
response-origin-only-with-rfc5780
no-cli
no-multicast-peers
no-software-attribute
check-origin-consistency
```

## TURN/TURNS 测试
另存为 `.html` 运行测试
```html
<html>
<head>
  <title>ICE测试</title>
</head>
<body>

<label for="serverAddress">服务器地址(仅支持turn/turns)</label>
<input id="serverAddress" value="turn:127.0.0.1:13902"/>
<br/>
<label for="username">用户名</label><input id="username" value="zwzw"/>
<br/>
<label for="password">密码</label><input id="password" value="zwzw"/>
<br/>

<button onclick="window.test()">测试(F12控制台查看测试结果)</button>

promiseResolved = false;

// 兼容不同浏览器的RTCPeerConnection
      let myPeerConnection = window.RTCPeerConnection || window.mozRTCPeerConnection || window.webkitRTCPeerConnection;
      // 创建一个RTCPeerConnection实例
      let pc = new myPeerConnection({iceServers: [turnConfig]});
      // 创建一个空的数据通道
      pc.createDataChannel("");
      // 创建一个offer
      pc.createOffer({}).then((offer) => {
        // 如果offer的sdp中包含typ relay,则说明TURN服务器可用
        if (offer.sdp.indexOf('typ relay') > -1) {
          promiseResolved = true;
          resolve(true);
        }
        // 设置本地描述
        pc.setLocalDescription(offer)
      })

// 监听ICE候选事件
      pc.onicecandidate = function (ice) {
        if (promiseResolved || !ice || !ice.candidate
          || !ice.candidate.candidate
          || !(ice.candidate.candidate.indexOf('typ relay') > -1)) return;

console.log("ICE候选=", ice.candidate)

// 如果找到一个relay类型的候选,则说明TURN服务器可用
        if (ice.candidate.type === "relay") {
          console.log("TURN服务器可达!");
        }

promiseResolved = true;
        resolve(true);
      };
    });
  }

// 测试函数
  window.test = () => {
    // 获取输入框中的值
    let serverAddress = document.getElementById("serverAddress").value;
    let username = document.getElementById("username").value;
    let password = document.getElementById("password").value;

console.log("触发ICE测试.服务器地址=", serverAddress,
      ", 用户名=", username, ", 密码=", password)

// 调用checkTURNServer函数检查TURN服务器
    checkTURNServer({
      urls: serverAddress,
      username: username,
      credential: password
    }).then(function (bool) {
      console.log('TURN/TURNS服务器是否活跃? ', bool ? '是' : '否');
    }).catch(console.error.bind(console));
  }
</script>
</body>
</html>
```