创建wss服务

问：

Workerman如何创建一个wss服务，使得客户端可以用过wss协来连接通讯，比如在微信小程序中连接服务端。

答：

wss协议实际是websocket+SSL，就是在websocket协议上加入SSL层，类似https(http+SSL)。 所以只需要在websocket协议的基础上开启SSL即可支持wss协议。

方法一 ，直接用Workerman开启SSL

准备工作：

1、Workerman版本>=3.3.7

2、PHP安装了openssl扩展

3、已经申请了证书（pem/crt文件及key文件）放在磁盘任意目录

代码：

  1. <?php
  2. use Workerman\Worker;
  3. use Workerman\Connection\TcpConnection;
  4. require_once __DIR__ . '/vendor/autoload.php';
  6. // 证书最好是申请的证书
  7. $context = array(
  8.     // 更多ssl选项请参考手册 http://php.net/manual/zh/context.ssl.php
  9.     'ssl' => array(
  10.         // 请使用绝对路径
  11.         'local_cert'        => '磁盘路径/server.pem', // 也可以是crt文件
  12.         'local_pk'          => '磁盘路径/server.key',
  13.         'verify_peer'       => false,
  14.         'allow_self_signed' => true, //如果是自签名证书需要开启此选项
  15.     )
  16. );
  17. // 这里设置的是websocket协议（端口任意，但是需要保证没被其它程序占用）
  18. $worker = new Worker('websocket://0.0.0.0:443', $context);
  19. // 设置transport开启ssl，websocket+ssl即wss
  20. $worker->transport = 'ssl';
  21. $worker->onMessage = function(TcpConnection $con, $msg) {
  22.     $con->send('ok');
  23. };
  25. Worker::runAll();

通过以上的代码，Workerman就监听了wss协议，客户端就可以通过wss协议来连接workerman实现安全即时通讯了。

测试

打开chrome浏览器，按F12打开调试控制台，在Console一栏输入(或者把下面代码放入到html页面用js运行)

  1. // 证书是会检查域名的，请使用域名连接
  2. ws = new WebSocket("wss://域名");
  3. ws.onopen = function() {
  4.     alert("连接成功");
  5.     ws.send('tom');
  6.     alert("给服务端发送一个字符串：tom");
  7. };
  8. ws.onmessage = function(e) {
  9.     alert("收到服务端的消息：" + e.data);
  10. };

注意：

1、如果无法启动，则一般是443端口被占用，请改成其它端口，注意改成其它端口后客户端连接时需要带上端口号，客户端连接时地址类似wss://domain.com:xxx ，xxx为端口号。如果必须使用443端口请使用方法二代理的方式实现wss。

2、wss端口只能通过wss协议访问，ws无法访问wss端口。

3、证书一般是与域名绑定的，所以测试的时候客户端请使用域名连接，不要使用ip去连。

4、如果出现无法访问的情况，请检查服务器防火墙。

5、此方法要求PHP版本>=5.6，因为微信小程序要求tls1.2，而PHP5.6以下版本不支持tls1.2。

方法二、利用nginx/apache代理SSL

除了用Workerman自身的SSL，也可以利用nginx/apache作为wss代理转发给workerman

注意 nginx/apache代理SSL和Workerman设置SSL二选一，不能同时开启。

通讯原理及流程是：

1、客户端发起wss连接连到nginx/apache

2、nginx/apache将wss协议的数据转换成ws协议数据并转发到Workerman的websocket协议端口

3、Workerman收到数据后做业务逻辑处理

4、Workerman给客户端发送消息时，则是相反的过程，数据经过nginx/apache转换成wss协议然后发给客户端

nginx配置参考

前提条件及准备工作：

1、已经安装nginx，版本不低于1.3

2、假设Workerman监听的是8282端口(websocket协议)

3、已经申请了证书（pem/crt文件及key文件）放在了/etc/nginx/conf.d/ssl下

4、打算利用nginx开启443端口对外提供wss代理服务（端口可以根据需要修改）

5、nginx一般作为网站服务器运行着其它服务，为了不影响原来的站点使用，这里使用地址 域名/wss 作为wss的代理入口。也就是客户端连接地址为 wss://域名/wss

nginx配置类似如下：

  1. server {
  2.   listen 443;
  4.   ssl on;
  5.   ssl_certificate /etc/ssl/server.pem;
  6.   ssl_certificate_key /etc/ssl/server.key;
  7.   ssl_session_timeout 5m;
  8.   ssl_session_cache shared:SSL:50m;
  9.   ssl_protocols SSLv3 SSLv2 TLSv1 TLSv1.1 TLSv1.2;
  10.   ssl_ciphers ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
  12.   location /wss
  13.   {
  14.     proxy_pass http://127.0.0.1:8282;
  15.     proxy_http_version 1.1;
  16.     proxy_set_header Upgrade $http_upgrade;
  17.     proxy_set_header Connection "Upgrade";
  18.     proxy_set_header X-Real-IP $remote_addr;
  19.   }
  21.   # location / {} 站点的其它配置...
  22. }

测试

  1. // 证书是会检查域名的，请使用域名连接
  2. ws = new WebSocket("wss://域名/wss");
  4. ws.onopen = function() {
  5.     alert("连接成功");
  6.     ws.send('tom');
  7.     alert("给服务端发送一个字符串：tom");
  8. };
  9. ws.onmessage = function(e) {
  10.     alert("收到服务端的消息：" + e.data);
  11. };

利用apache代理wss

也可以利用apache作为wss代理转发给workerman（注意如使用apache代理SSL，则workerman部分千万不要设置ssl，否则将无法连接）。

准备工作：

1、GatewayWorker 监听 8282 端口(websocket协议)

2、已经申请了ssl证书, 放在了/server/httpd/cert/ 下

3、利用apache转发443端口至指定端口8282

4、httpd-ssl.conf 已加载

5、openssl 已安装

启用 proxy_wstunnel_module 模块

  1. LoadModule proxy_module modules/mod_proxy.so
  2. LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so

配置SSL及代理

  1. #extra/httpd-ssl.conf
  2. DocumentRoot "/网站/目录"
  3. ServerName 域名
  5. # Proxy Config
  6. SSLProxyEngine on
  8. ProxyRequests Off
  9. ProxyPass /wss ws://127.0.0.1:8282/wss
  10. ProxyPassReverse /wss ws://127.0.0.1:8282/wss
  12. # 添加 SSL 协议支持协议,去掉不安全的协议
  13. SSLProtocol all -SSLv2 -SSLv3
  14. # 修改加密套件如下
  15. SSLCipherSuite HIGH:!RC4:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!EXP:+MEDIUM
  16. SSLHonorCipherOrder on
  17. # 证书公钥配置
  18. SSLCertificateFile /server/httpd/cert/your.pem
  19. # 证书私钥配置
  20. SSLCertificateKeyFile /server/httpd/cert/your.key
  21. # 证书链配置,
  22. SSLCertificateChainFile /server/httpd/cert/chain.pem

测试

  1. // 证书是会检查域名的，请使用域名连接
  2. ws = new WebSocket("wss://域名/wss");
  4. ws.onopen = function() {
  5.     alert("连接成功");
  6.     ws.send('tom');
  7.     alert("给服务端发送一个字符串：tom");
  8. };
  9. ws.onmessage = function(e) {
  10.     alert("收到服务端的消息：" + e.data);
  11. };

相关文章：
透过代理获取客户端真实ip
workerman的ssl上下文选项参考