跳到内容
Localtonet Localtonet 控制台

HTTP 隧道的单点登录

需要余额 HTTP 隧道

获取本页帮助
本页内容 10 个章节
  1. 适用场景
  2. 工作原理
  3. 开始之前
  4. 提供商
  5. 设置方法
  6. 添加提供商
  7. 为隧道开启它
  8. 测试
  9. 重定向 URI
  10. 访问规则
  11. 登录路径和退出路径
  12. 故障排除
  13. 自动化

单点登录(SSO)会在 HTTP 隧道前放置一个登录页面。访客需要先使用你选择的身份提供商(如 Google、GitHub、Microsoft 或 GitLab),或你定义的用户名和密码登录,之后请求才会到达你的服务。

适用场景 #

在你为 HTTP 隧道加以保护之前,任何知道其地址的人都可以访问。如果人们通过浏览器打开隧道,并且你想决定谁可以进入,SSO 就是合适的保护方式,例如管理面板、仪表盘、内部工具或预发布站点。你的服务无需任何改动,也不会接触到密码。

SSO 是为浏览器设计的。不带登录 Cookie 的请求会被重定向到登录页面,因此脚本、Webhook 和 API 客户端无法通过。对于这些情况,请只保护部分路径(参见登录路径),或使用访问控制中的选项。

工作原理 #

访客打开隧道 URL。Localtonet 服务器会将访客重定向到 auth.localtonet.com 上的登录页面,访客在那里使用身份提供商登录。随后访客会被送回隧道 URL,请求被转发到你的服务。 访客 浏览器 1. 打开 隧道 URL Localtonet 服务器 2. 重定向 登录页面 auth.localtonet.com 3. 登录 提供商 Google, GitHub… 4. 登录完成,返回隧道 5. 请求 你的服务 在你的设备上
登录发生在 Localtonet 的登录页面上,而不是在你的服务中。
  1. 访客打开隧道 URL。通过 HTTP 发出的请求会先被重定向到 HTTPS。
  2. 此时访客尚未登录,因此 Localtonet 服务器会将浏览器重定向到 auth.localtonet.com 上的登录页面。该页面的标题是 Sign in to continue,并提供你为此隧道启用的提供商。
  3. 访客选择一个提供商并在那里登录。对于用户名和密码提供商,表单就在登录页面上。
  4. Localtonet 检查你的访问规则,并将访客送回他们请求的地址。登录状态保存在隧道主机名对应的 Cookie 中。它是浏览器会话 Cookie,仅通过 HTTPS 发送。
  5. 此后,请求会照常转发到你的服务。当登录不再有效时,访客会再次被送到登录页面。

已登录但不被你的规则允许的访客会看到 403 - Access Denied,并附有文字 “You do not have permission to access this tunnel.”

/.well-known 下的路径永远不会被置于登录保护之后。

开始之前 #

  • 一个 HTTP 隧道。参见 HTTP / HTTPS。
  • 你的账户中有余额。没有余额时,保存提供商或开启登录会失败,并提示“你需要购买余额才能使用此功能。”参见套餐与余额和价格。
  • 对于外部提供商:在该提供商处拥有可以注册 OAuth 应用的账户。

SSO 在你的个人控制台中设置。团队隧道不显示 SSO 按钮和 SSO 提供商设置。

提供商 #

以下指南分步骤介绍最常见的选择:

控制台中的提供商类型列表包含:Username-Password、Google、GitHub、Microsoft、OpenID Connect、Discord、Twitter (X)、Custom、Facebook、Apple、LinkedIn、GitLab、Slack、Spotify、Twitch、Reddit、Bitbucket、Amazon 和 Yahoo。除 Username-Password 和 Custom 外,其他类型的端点都会自动填好。对于 OpenID Connect,自动填入的地址只是示例,你需要替换为你的提供商的端点。

设置方法 #

分为两部分。你只需添加一次提供商,之后它就可用于你所有的 HTTP 隧道。然后,对每个想要保护的隧道开启它。已保存的提供商在有隧道使用它之前不会保护任何东西。

  1. 添加提供商 #

    打开 我的隧道 › HTTP,选择页面顶部的 SSO(其提示文字为 SSO 提供商设置)。SSO 提供商对话框随即打开。选择添加提供商,填写表单,然后选择保存提供商。每个提供商单独保存。

    字段含义说明
    提供商名称在隧道设置中用来识别此提供商的名称。必填。例如 Company Google。
    提供商类型登录方式。新建的提供商默认是 Google。更改已保存提供商的类型会清空客户端 ID,因此请重新输入客户端 ID 和客户端密钥。
    已启用使该提供商可供隧道使用。当你将提供商切换为停用并保存时,它也会在所有使用过它的隧道上被关闭。
    客户端 ID你在提供商处注册的应用的 ID。除 Username-Password 和 Custom 外,所有类型都必填。
    客户端密钥该应用的密钥。保存后不会再显示。之后留空即可保留已保存的密钥。
    端点与回调授权端点、令牌端点、用户信息端点和回调路径。标准提供商会自动填写。只有在指南要求时才更改它们。
    邮箱访问规则允许的邮箱域名、阻止的邮箱域名和阻止的邮箱地址。可选。参见访问规则。
    登录用户用户名和密码。仅适用于 Username-Password 和 Custom 类型。

    要移除提供商,请选择删除提供商。这会将它从你的账户以及你隧道的 SSO 设置中移除。

  2. 为隧道开启它 #

    在你的隧道下,选择该隧道的设置。在隧道设置面板中找到 SSO 提供商,然后选择管理。单点登录对话框随即打开。

    设置项作用
    要求登录为此隧道开启 SSO。未登录的访客会先被送到登录页面。
    提供商为你每个已启用的提供商提供一个开关。请至少开启一个。如果开启了多个,访客在登录页面上选择。
    谁可以登录此隧道可选的邮箱地址、邮箱域名和用户名列表。
    登录和退出路径可选的登录路径和退出路径。

    选择保存。

  3. 测试 #

    在隐私浏览窗口中打开隧道 URL。你应该会进入 Sign in to continue 页面,登录后进入你的服务。

重定向 URI #

外部提供商会询问登录后可以把用户送到哪里。对每个隧道而言,这都是 Localtonet 登录主机上的一个地址,而不是你的隧道地址。请准确注册这个值:

重定向 URI
http://auth.localtonet.com/auth/callback

每个提供商指南都会告诉你在哪里输入它。

值填写位置
上面的重定向 URI在提供商处:Authorized redirect URIs(Google)、Authorization callback URL(GitHub)、Redirect URI(Microsoft、GitLab)。
回调路径,例如 /auth/callback/google在 Localtonet 中,位于端点与回调下。它已自动填好,保持原样即可。

提供商会将重定向 URI 与已注册的值逐字比对,因此请按此处显示的内容原样复制。

访问规则 #

登录证明了访客是谁。规则则决定这个人是否可以打开隧道。规则分为两个层级,两者都会生效。

位置列表控制台中的说明
提供商允许的邮箱域名留空表示不限制域名。通配符是否可用取决于提供商。
提供商阻止的邮箱域名阻止来自这些邮箱域名的登录。
提供商阻止的邮箱地址阻止这些单独的邮箱地址。
隧道邮箱地址、邮箱域名、用户名将列表留空即可跳过相应检查。这些列表适用于为该隧道开启的所有提供商。

每行输入一项,或用逗号分隔。域名不带 @,例如 example.com。

更改规则后,已经放行的访客最多可以保留五分钟的访问权限。被拒绝的访客会在一分钟后重新检查。

登录路径和退出路径 #

设置项行为示例
登录路径为空:隧道的每个路径都需要登录。已填写:只有路径以其中某一项开头的请求才需要登录。/admin 涵盖 /admin 和 /admin/users,但不涵盖 /administrator。
退出路径打开它会移除此隧道的登录状态,并将访客送到隧道的起始页,或送到 returnUrl 查询参数中的地址。/sso/logout

路径以斜杠开头。不区分大小写。

只要填写了登录路径列表,其他一切路径都是开放的。列表中有 /admin 时,只有 /admin 受保护,其他所有路径无需登录即可访问。若要保护整个隧道,请将列表留空。

退出路径只会让访客退出隧道,不会让他们退出 Google、GitHub 或其他身份提供商。

故障排除 #

“你需要购买余额才能使用此功能。”

SSO 需要余额。请充值余额,然后再次保存。没有余额时,你仍然可以打开对话框并关闭要求登录。

“请先添加提供商,再开启登录。”

你还没有已启用的提供商。请在对话框中选择添加提供商,或使用 HTTP 页面顶部的 SSO 按钮。

“请至少启用一个提供商,或关闭登录。”

要求登录已开启,但没有开启任何提供商开关。你设为停用的提供商会在其隧道上被关闭,也不再列出。

登录页面显示 “No authentication providers are currently configured for this tunnel.”

需要登录,但此隧道没有开启任何提供商。在该隧道上打开 SSO 提供商 › 管理,并开启一个。

隧道打开时不要求登录

请检查要求登录是否已开启并保存。如果填写了登录路径,则只有这些路径受保护。也请在隐私窗口中测试:你自己的浏览器可能仍处于登录状态。

登录后出现 “403 - Access Denied”

登录成功了,但有规则拒绝了该账户。请检查提供商的邮箱访问规则和隧道的谁可以登录列表。更正规则后,请等待一分钟再重新加载。

Webhook 或 API 客户端得到的是重定向而不是响应

不带登录 Cookie 的请求会被重定向到登录页面。请只把面向用户的页面放入登录路径,或为机器流量使用单独的隧道。

自动化 #

提供商和隧道的 SSO 设置也可以通过 /api/v2/sso-providers 下的 API 以及 MCP 服务器进行管理。

支持