网页里的 SQLly:中继代理模式

功能的

通过你控制的中继在浏览器版本中运行自己的数据库——它持有凭证,因此页面从未看到密码。

这 浏览器构建 的 SQLly 通常只对你标签页里的示例数据运行,因为网页无法打开数据库套接字。 中继代理模式 为它提供真实服务器:一个 sqlly-relay 由你运行的实例会拿到一份 凭据文件,以及用该中继地址打开的浏览器版,它会查询文件里的每台服务器和每个数据库,对象资源管理器、IntelliSense、执行计划和行编辑一应俱全,而密码从不离开中继主机。

适用对象。 想要在页面、内部门户、支持控制台或教室中零安装使用 SQLly、连接由管理员控制的固定一组数据库的团队。它 不 桌面应用程序的 通过中继 路径:那条路径是端到端加密的,中继读不到你的流量。而在这里,凭据是刻意交由中继持有的,浏览器标签页永远不必经手。

各部分如何协同工作

browser (SQLly on a page)  --wss-->  sqlly-relay proxy  --local-->  SQLly engine  --TDS / PG / MySQL / ...-->  your databases
                                     holds the credential file        one per browser session
  • 中继提供一个凭证文件。 里面的每个连接——服务器、数据库、登录名和密码、共享登录、SSH 隧道和代理,以及客户端、项目和环境标签——就是浏览器能访问的全部。仅此而已。
  • 每个会话一个引擎。 每个浏览器会话都在中继主机上拥有自己的 SQLly 引擎,以受限模式启动,只打开来自文件的连接。凡是自带服务器或自带密码的请求都会被拒绝。
  • 浏览器拿到的是名称,而不是机密信息。 它收到的连接列表已剥离密码、隧道设置和令牌,而且它从不存储这份列表,由中继在每次页面加载时重新发送。
  • 中继的另一项职责不受影响。 代理是一个独立、可选开启的监听器。未启用它的中继会像以前一样转发 Via Relay 流量。

设置中继

在一台能访问这些数据库、并且装了 sqlly-cli 安装在旁边 sqlly-relay,就写一个凭据文件(从桌面应用导出一份,用 文件 → 导出连接及凭据…,或者手写一个)然后启动中继,在它平时的配置里加上代理标志:

sqlly-relay \
  --tls-cert /certs/relay.crt --tls-key /certs/relay.key \
  --proxy-credentials /etc/sqlly/browser-connections.json \
  --proxy-token 'a-long-random-secret' \
  --proxy-bind 0.0.0.0:8444 \
  --proxy-allowed-origins https://sqlly.app
标志作用
--proxy-credentials凭据文件。设置它才会开启代理。每个新的浏览器会话都会重新读取该文件,因此改动无需重启即可生效。
--proxy-token浏览器必须出示的共享密钥。必填:没有它,中继会拒绝启动,除非你传入 --proxy-insecure-no-token,它会把列出的每一个数据库暴露给任何能连上该端口的人。
--proxy-bind代理监听的位置;默认端口是 8444。它使用中继的 TLS 证书进行 wss://; --proxy-plain 提供 ws:// 用于本地测试,或放在 TLS 终结的反向代理后面。
--proxy-allowed-origins以逗号分隔、允许打开会话的网页来源,这样只有你托管的页面才能使用代理。不填则允许任何来源(令牌仍然适用)。
--proxy-max-sessions一次最多能打开多少个浏览器会话(每个会话对应一个引擎进程);默认值为 32。代理满载时会让新会话稍后再试。
--proxy-engine-binary位置 sqlly-cli 所在的位置(如果它既不在 sqlly-relay 或在 PATH.

每个标志都有环境变量形式(RELAY_PROXY_CREDENTIALS, RELAY_PROXY_TOKEN,等等)用于容器部署。中继容器镜像是否包含引擎,取决于构建时是否使用 --build-arg WITH_PROXY_ENGINE=1.

有两条规则与桌面端导入不同:共享登录和隧道配置必须定义在同一个文件中(中继没有已保存的连接可供回退),以及 via-relay 路由将被忽略,因为中继主机会自行拨号到每个服务器。

针对它打开浏览器版

将代理地址和令牌添加到浏览器构建的 URL 中:

https://sqlly.app/app/?proxy=wss://relay.example.com:8444/proxy&token=a-long-random-secret

嵌入该构建的页面可以设置 SQLLY_PROXY_URL 和 SQLLY_PROXY_TOKEN 在应用启动之前作为全局变量,而不是将它们放在地址栏中。加载时,应用会连接,状态行显示中继的名称以及它服务的连接数,这些连接会出现在浏览器资源管理器中,准备使用。在此模式下,示例数据库根本不会被下载。

自行托管该页面。 浏览器只允许页面向其安全策略允许的源打开套接字。sqlly.app 提供的构建只允许它自己的源;要把代理放在别的主机上,就得放宽这条策略,或者改用中继自己的域名来提供构建。如果页面加载了却提示连不上中继代理,首先就检查这里。

应用中的变化

  • 连接是只读的。 列表就是中继的列表。添加服务器、复制、删除和导入连接均已禁用;连接管理器的添加、删除、复制按钮以及客户端、项目和环境编辑器均已锁定;打开连接时会显示为 查看连接 “保存”被禁用,并附有说明:凭据由中继保管。要更改用户看到的内容,请更改中继上的凭据文件。
  • 测试连接仍然可用 - 它像任何查询一样通过代理运行,每个查询功能、对象资源管理器、IntelliSense 目录同步、执行计划、脚本和行编辑也是如此。
  • 标签也会一并带上。 来自文件的客户、项目和环境名称、颜色与安全开关,会像桌面版一样对资源管理器进行分组;为了保持页面轻量,图标没有展示。
  • 如果中继断开 - 状态栏会如此提示,且在页面重新加载之前,代理连接上的查询都会失败并给出明确的错误信息。