如何使用 Python 构建 SAML 登录

给我们的新朋友:

Logto 是一个为现代应用和 SaaS 产品设计的 Auth0 替代方案。它提供 Cloud 和开源服务，帮助你快速启动身份和管理 (IAM) 系统。享受认证 (Authentication)、授权 (Authorization) 和多租户管理一体化。

我们建议从 Logto Cloud 上的免费开发租户开始。这可以让你轻松探索所有功能。

在本文中，我们将介绍使用 Python 和 Logto 快速构建 SAML 登录体验（用户认证 (Authentication)）的步骤。

先决条件

一个正在运行的 Logto 实例。查看介绍页面以开始。
Python 的基本知识。
一个可用的 SAML 账户。

在 Logto 中创建一个应用程序

Logto 基于 OpenID Connect (OIDC) 认证 (Authentication) 和 OAuth 2.0 授权 (Authorization)。它支持跨多个应用程序的联合身份管理，通常称为单点登录 (SSO)。

要创建你的 Traditional web 应用程序，只需按照以下步骤操作：

打开 Logto Console。在“开始使用”部分，点击“查看全部”链接以打开应用程序框架列表。或者，你可以导航到 Logto Console > Applications，然后点击“创建应用程序”按钮。
在打开的模态窗口中，点击“Traditional web”部分，或使用左侧的快速过滤复选框过滤所有可用的“Traditional web”框架。点击 "Flask" 框架卡片以开始创建你的应用程序。
输入应用程序名称，例如“Bookstore”，然后点击“创建应用程序”。

🎉 太棒了！你刚刚在 Logto 中创建了你的第一个应用程序。你将看到一个祝贺页面，其中包含详细的集成指南。按照指南查看你的应用程序中的体验将会是什么样的。

集成 Flask SDK

提示:

示例使用 Flask，但概念对于其他框架是相同的。
Python 示例项目可在我们的 Python SDK 仓库中找到。
Logto SDK 利用协程，调用异步函数时请记得使用 await。

安装

在项目根目录执行：

pip install logto # 或者 `poetry add logto` 或者你使用的其他工具

初始化 LogtoClient

首先，创建一个 Logto 配置：

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # 用你的 Logto endpoint 替换
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

提示:

你可以在管理控制台的应用详情页面找到并复制“应用密钥”：

还可以将默认的内存存储替换为持久存储，例如：

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

查看 Storage 了解更多详情。

在你的 Web 应用中，添加一个路由来正确处理用户的登录请求。我们以 /sign-in 为例：

flask.py
@app.route("/sign-in")
async def sign_in():
  # 获取登录 URL 并重定向用户到该 URL
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

将 http://localhost:3000/callback 替换为你在 Logto Console 中为此应用设置的回调 URL。

如果你想在第一个屏幕显示注册页面，可以将 interactionMode 设置为 signUp：

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # 在第一个屏幕显示注册页面
  ))

现在，每当你的用户访问 http://localhost:3000/sign-in 时，就会启动一个新的登录尝试，并将用户重定向到 Logto 登录页面。

注意创建一个登录路由并不是启动登录尝试的唯一方法。你可以随时使用 signIn 方法获取登录 URL 并将用户重定向到该 URL。

在用户发出注销请求后，Logto 将清除会话中的所有用户认证 (Authentication) 信息。

要清理 Python 会话和 Logto 会话，可以实现一个注销路由，如下所示：

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # 在成功注销后将用户重定向到主页
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

处理认证 (Authentication) 状态

在 Logto SDK 中，我们可以使用 client.isAuthenticated() 来检查认证 (Authentication) 状态，如果用户已登录，值将为 true，否则，值将为 false。

这里我们还实现了一个简单的主页用于演示：

如果用户未登录，显示一个登录按钮；
如果用户已登录，显示一个登出按钮。

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "未认证 <a href='/sign-in'>登录</a>"
    return "已认证 <a href='/sign-out'>登出</a>"

检查点：测试你的应用程序

现在，你可以测试你的应用程序：

运行你的应用程序，你将看到登录按钮。
点击登录按钮，SDK 将初始化登录过程并将你重定向到 Logto 登录页面。
登录后，你将被重定向回你的应用程序，并看到登出按钮。
点击登出按钮以清除令牌存储并登出。

添加 SAML 连接器

要实现快速登录并提高用户转化率，请将 Flask 作为身份提供商 (IdP) 进行连接。Logto 社交连接器可以帮助你在几分钟内通过允许输入多个参数来建立此连接。

要添加社交连接器，只需按照以下步骤操作：

导航到 Console > Connectors > Social Connectors。
点击“添加社交连接器”并选择“SAML”。
按照 README 指南完成必填字段并自定义设置。

备注:

如果你正在按照现场连接器指南进行操作，可以跳过下一部分。

设置标准 SAML 应用

创建社交 IdP 的账户并注册 SAML 应用程序 (IdP)

让我们来看看 SAML 连接器的配置。

在开始之前，你可以去支持 SAML 协议的社交身份提供商创建自己的账户。Okta、OneLogin、Salesforce 和其他一些平台支持基于 SAML 协议的认证 (Authentication)。

如果你的 IdP 要求对 SAML 断言进行加密并接收签名的认证请求，你应该使用 RSA 算法生成你的私钥和相应的证书。保留私钥供你的 SP 使用，并将证书上传到 IdP。

你还需要将 ACS (Assertion Consumer Service) URL 配置为 ${your_logto_origin}/api/authn/saml/${connector_id} 以处理 IdP 的 SAML 断言。你可以在 Logto 管理控制台的 SAML 连接器详细信息页面找到你的 connectorId。

备注:

根据当前 Logto 的设计，我们仅支持用于发送认证请求的重定向绑定和用于接收 SAML 断言的 POST 绑定。虽然这听起来不太酷，但我们相信当前的设计可以处理大多数用例。如果你有任何问题，请随时联系我们！

配置 SAML 连接器 (SP)

在本节中，我们将详细介绍每个属性。

entityID `必需`

entityID（即 issuer）是实体标识符。它用于识别你的实体（SAML SP 实体），并在每个 SAML 请求/响应中匹配等效项。

signInEndpoint `必需`

你发送 SAML 认证请求的 IdP 端点。通常，你可以在 IdP 详细信息页面找到此值（即 IdP 的 SSO URL 或 Login URL）。

x509Certificate `必需`

从 IdP 私钥生成的 x509 证书，IdP 应该提供此值。

证书的内容带有 -----BEGIN CERTIFICATE----- 头和 -----END CERTIFICATE----- 尾。

idpMetadataXml `必需`

此字段用于放置来自 IdP 元数据 XML 文件的内容。

备注:

我们使用的 XML 解析器不支持自定义命名空间。如果 IdP 元数据带有命名空间，你应该手动删除它们。有关 XML 文件的命名空间，请参阅参考。

assertionConsumerServiceUrl `必需`

断言消费者服务 (ACS) URL 是 SP 接收 IdP 的 SAML 断言 POST 请求的端点。如我们在前面部分提到的，它通常在 IdP 设置中配置，但有些 IdP 从 SAML 认证请求中获取此值，因此我们也将此值添加为必需字段。它的值应类似于 ${your_logto_origin}/api/authn/saml/${connector_id}。

signAuthnRequest

控制 SAML 认证请求是否应签名的布尔值，默认值为 false。

encryptAssertion

encryptAssertion 是一个布尔值，指示 IdP 是否会加密 SAML 断言，默认值为 false。

备注:

signAuthnRequest 和 encryptAssertion 属性应与 IdP 设置的相应参数一致，否则会抛出错误，显示配置不匹配。所有 SAML 响应都需要签名。

requestSignatureAlgorithm

这应该与 IdP 的签名算法一致，以便 Logto 可以验证 SAML 断言的签名。其值应为 http://www.w3.org/2000/09/xmldsig#rsa-sha1、http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 或 http://www.w3.org/2001/04/xmldsig-more#rsa-sha512，默认值为 http://www.w3.org/2001/04/xmldsig-more#rsa-sha256。

messageSigningOrder

messageSigningOrder 指示 IdP 的签名和加密顺序，其值应为 sign-then-encrypt 或 encrypt-then-sign，默认值为 sign-then-encrypt。

privateKey 和 privateKeyPass

privateKey 是一个可选值，当 signAuthnRequest 为 true 时是必需的。

privateKeyPass 是你在创建 privateKey 时设置的密码，必要时需要。

如果 signAuthnRequest 为 true，则 IdP 需要从 privateKey 生成的相应证书来检查签名。

encPrivateKey 和 encPrivateKeyPass

encPrivateKey 是一个可选值，当 encryptAssertion 为 true 时是必需的。

encPrivateKeyPass 是你在创建 encPrivateKey 时设置的密码，必要时需要。

如果 encryptAssertion 为 true，则 IdP 需要从 encPrivateKey 生成的相应证书来加密 SAML 断言。

备注:

对于密钥和证书的生成，openssl 是一个很好的工具。以下是可能有用的示例命令行：

openssl genrsa -passout pass:${privateKeyPassword} -out ${encryptPrivateKeyFilename}.pem 4096
openssl req -new -x509 -key ${encryptPrivateKeyFilename}.pem -out ${encryptionCertificateFilename}.cer -days 3650

privateKey 和 encPrivateKey 文件被强制编码为 pkcs1 方案的 pem 字符串，这意味着私钥文件应以 -----BEGIN RSA PRIVATE KEY----- 开头并以 -----END RSA PRIVATE KEY----- 结尾。

nameIDFormat

nameIDFormat 是一个可选属性，用于声明响应的名称 ID 格式。其值可以是 urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、urn:oasis:names:tc:SAML:2.0:nameid-format:persistent 和 urn:oasis:names:tc:SAML:2.0:nameid-format:transient，默认值为 urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified。

timeout

timeout 是时间验证的时间容差，因为你的 SP 实体和 IdP 实体之间的时间可能不同，网络连接也可能带来一些延迟。单位为毫秒，默认值为 5000（即 5 秒）。

profileMap

Logto 还提供了一个 profileMap 字段，用户可以自定义从社交供应商的配置文件中映射，这些配置文件通常不是标准的。每个 profileMap 键是 Logto 的标准用户配置文件字段名称，相应的值应为社交配置文件字段名称。在当前阶段，Logto 只关注社交配置文件中的 'id'、'name'、'avatar'、'email' 和 'phone'，其中只有 'id' 是必需的，其他是可选字段。

配置类型

名称	类型	必需	默认值
signInEndpoint	string	true
x509certificate	string	true
idpMetadataXml	string	true
entityID	string	true
assertionConsumerServiceUrl	string	true
messageSigningOrder	`encrypt-then-sign` \| `sign-then-encrypt`	false	`sign-then-encrypt`
requestSignatureAlgorithm	`http://www.w3.org/2000/09/xmldsig#rsa-sha1` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`	false	`http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`
signAuthnRequest	boolean	false	false
encryptAssertion	boolean	false	false
privateKey	string	false
privateKeyPass	string	false
nameIDFormat	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`	false	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`
timeout	number	false	5000
profileMap	ProfileMap	false

ProfileMap 字段	类型	必需	默认值
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

参考

保存你的配置

仔细检查你是否在 Logto 连接器配置区域填写了必要的值。点击“保存并完成”（或“保存更改”），SAML 连接器现在应该可用了。

一旦你成功创建了一个社交连接器，你可以在登录体验中将其启用为“继续使用 SAML”按钮。

导航到 Console > 登录体验 > 注册和登录。
（可选）如果只需要社交登录，选择“无”作为注册标识符。
将配置好的 SAML 连接器添加到“社交登录”部分。

登录体验选项卡

测试和验证

返回到你的 Python 应用。你现在应该可以使用 SAML 登录了。享受吧！

拓展阅读

终端用户流程：Logto 提供开箱即用的认证 (Authentication) 流程，包括多因素认证 (MFA) 和企业单点登录 (SSO)，以及强大的 API，用于灵活实现账户设置、安全验证和多租户体验。

授权 (Authorization)：授权 (Authorization) 定义了用户在被认证 (Authentication) 后可以执行的操作或访问的资源。探索如何保护你的 API 以用于原生和单页应用程序，并实现基于角色的访问控制 (RBAC)。

组织 (Organizations)：在多租户 SaaS 和 B2B 应用中特别有效，组织功能支持租户创建、成员管理、组织级 RBAC 和即时供应。

客户 IAM 系列：我们关于客户（或消费者）身份和访问管理的系列博客文章，从 101 到高级主题及更深入的内容。

在 Logto 中创建一个应用程序​

集成 Flask SDK​

安装​

初始化 LogtoClient​

实现登录和登出​

处理认证 (Authentication) 状态​

检查点：测试你的应用程序​

添加 SAML 连接器​

设置 标准 SAML 应用​

创建社交 IdP 的账户并注册 SAML 应用程序 (IdP)​

配置 SAML 连接器 (SP)​

entityID 必需​

signInEndpoint 必需​

x509Certificate 必需​

idpMetadataXml 必需​

assertionConsumerServiceUrl 必需​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey 和 privateKeyPass​

encPrivateKey 和 encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

配置类型​

参考​

保存你的配置​

在登录体验中启用 SAML 连接器​

测试和验证​

拓展阅读​