如何使用 Flutter 构建 SAML 登录

给我们的新朋友:

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

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

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

先决条件

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

在 Logto 中创建一个应用程序

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

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

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

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

集成 Flutter SDK

提示:

SDK 包可在 pub.dev 和 Logto GitHub 仓库上获取。
示例项目使用 Flutter material 构建。你可以在 pub.dev 上找到它。
此 SDK 兼容 iOS、Android 和 Web 平台上的 Flutter 应用程序。与其他平台的兼容性尚未测试。

安装

pub.dev
GitHub

你可以使用 pub 包管理器直接安装 logto_dart_sdk package。在你的项目根目录下运行以下命令：

flutter pub add logto_dart_sdk

或者将以下内容添加到你的 pubspec.yaml 文件中：

dependencies:
  logto_dart_sdk: ^3.0.0

然后运行：

flutter pub get

如果你更喜欢 fork 你自己的 SDK 版本，你可以直接从 GitHub 克隆仓库。

git clone https://github.com/logto-io/dart

依赖和配置

SDK 版本兼容性

Logto SDK 版本	Dart SDK 版本	Dart 3.0 兼容性
< 2.0.0	>= 2.17.6 < 3.0.0	false
>= 2.0.0 < 3.0.0	>= 3.0.0	true
>= 3.0.0	>= 3.6.0	true

flutter_secure_storage 设置

在底层，这个 SDK 使用 flutter_secure_storage 来实现跨平台的持久安全令牌存储。

iOS 使用 Keychain
Android 使用 AES 加密。

配置 Android 版本

在项目的 android/app/build.gradle 文件中，将 android:minSdkVersion 设置为 >= 18。

build.gradle
  android {
      ...

      defaultConfig {
          ...
          minSdkVersion 18
          ...
      }
  }

禁用 Android 上的自动备份

默认情况下，Android 会在 Google Drive 上备份数据。这可能导致异常 java.security.InvalidKeyException:Failed 解包密钥。为避免这种情况，

要禁用自动备份，请转到应用程序的清单文件，并将 android:allowBackup 和 android:fullBackupContent 属性设置为 false。

AndroidManifest.xml
<manifest ... >
    ...
    <application
      android:allowBackup="false"
      android:fullBackupContent="false"
      ...
    >
        ...
    </application>
</manifest>

从 FlutterSecureStorage 中排除 sharedprefs。

如果你需要为应用程序保留 android:fullBackupContent 而不是禁用它，可以从备份中排除 sharedprefs 目录。请参阅 Android 文档了解更多详细信息。

在你的 AndroidManifest.xml 文件中，向 <application> 元素添加 android:fullBackupContent 属性，如以下示例所示。此属性指向一个包含备份规则的 XML 文件。
AndroidManifest.xml
```
<application ...
  android:fullBackupContent="@xml/backup_rules">
</application>
```
在 res/xml/ 目录中创建一个名为 @xml/backup_rules 的 XML 文件。在此文件中，使用 <include> 和 <exclude> 元素添加规则。以下示例备份所有共享首选项，除了 device.xml：
@xml/backup_rules
```
<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
  <exclude domain="sharedpref" path="FlutterSecureStorage"/>
</full-backup-content>
```

请查看 flutter_secure_storage 以获取更多详细信息。

flutter_web_auth_2 设置

在幕后，这个 SDK 使用 flutter_web_auth_2 来通过 Logto 认证用户。这个包提供了一种简单的方法，通过系统 webview 或浏览器来使用 Logto 认证用户。

这个插件在 iOS 12+ 和 macOS 10.15+ 上使用 ASWebAuthenticationSession，在 iOS 11 上使用 SFAuthenticationSession，在 Android 上使用 Chrome Custom Tabs，并在 Web 上打开一个新窗口。

iOS：无需额外设置

Android：在 Android 上注册回调 URL

为了从 Logto 的登录网页捕获回调 URL，你需要在 AndroidManifest.xml 文件中注册你的登录 redirectUri。

AndroidManifest.xml
  <manifest>
    <application>
        <activity
          android:name="com.linusu.flutter_web_auth_2.CallbackActivity"
          android:exported="true">
          <intent-filter android:label="flutter_web_auth_2">
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <data android:scheme="YOUR_CALLBACK_URL_SCHEME_HERE" />
          </intent-filter>
        </activity>
    </application>
  </manifest>

Web 浏览器：创建一个端点来处理回调 URL

如果你使用的是 Web 平台，你需要创建一个端点来处理回调 URL，并使用 postMessage API 将其发送回应用程序。

callback.html
<!doctype html>
<title>认证完成</title>
<p>认证已完成。如果没有自动发生，请关闭窗口。</p>
<script>
  function postAuthenticationMessage() {
    const message = {
      'flutter-web-auth-2': window.location.href,
    };

    if (window.opener) {
      window.opener.postMessage(message, window.location.origin);
      window.close();
    } else if (window.parent && window.parent !== window) {
      window.parent.postMessage(message, window.location.origin);
    } else {
      localStorage.setItem('flutter-web-auth-2', window.location.href);
      window.close();
    }
  }

  postAuthenticationMessage();
</script>

请查看 flutter_web_auth_2 包中的设置指南以获取更多详细信息。

集成

初始化 LogtoClient

导入 logto_dart_sdk 包并在应用程序的根部初始化 LogtoClient 实例。

lib/main.dart
import 'package:logto_dart_sdk/logto_dart_sdk.dart';
import 'package:http/http.dart' as http;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Logto Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late LogtoClient logtoClient;

  void render() {
    // 状态变化
  }

  // LogtoConfig
  final logtoConfig = const LogtoConfig(
    endpoint: "<your-logto-endpoint>",
    appId: "<your-app-id>"
  );

  void _init() {
    logtoClient = LogtoClient(
      config: logtoConfig,
      httpClient: http.Client(), // 可选的 http 客户端
    );
    render();
  }

  @override
  void initState() {
    super.initState();
    _init();
  }

  // ...
}

在我们深入细节之前，这里是终端用户体验的快速概述。登录过程可以简化如下：

你的应用调用登录方法。
用户被重定向到 Logto 登录页面。对于原生应用，将打开系统浏览器。
用户登录并被重定向回你的应用（配置为重定向 URI）。

此认证 (Authentication) 过程遵循 OpenID Connect (OIDC) 协议，Logto 强制执行严格的安全措施以保护用户登录。
如果你有多个应用程序，可以使用相同的身份提供商 (IdP)（日志 (Logto)）。一旦用户登录到一个应用程序，当用户访问另一个应用程序时，Logto 将自动完成登录过程。

要了解有关基于重定向的登录的原理和好处的更多信息，请参阅 Logto 登录体验解释。

在开始之前，你需要在管理控制台为你的应用程序添加一个重定向 URI。

让我们切换到 Logto Console 的应用详情页面。添加一个重定向 URI io.logto://callback 并点击“保存更改”。

对于 iOS，重定向 URI 方案并不重要，因为 ASWebAuthenticationSession 类会监听重定向 URI，无论它是否注册。
对于 Android，重定向 URI 方案必须在 AndroidManifest.xml 文件中注册。

配置好重定向 URI 后，我们在页面上添加一个登录按钮，该按钮将调用 logtoClient.signIn API 来启动 Logto 登录流程：

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  final redirectUri = 'io.logto://callback';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signInButton = TextButton(
      onPressed: () async {
        await logtoClient.signIn(redirectUri);
        render();
      },
      child: const Text('Sign In'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
          ],
        ),
      ),
    );
  }
}

实现登出

让我们切换到 Logto Console 的应用详情页面。添加一个注销后重定向 URI io.logto://callback，然后点击“保存更改”。

注销后重定向 URI 是一个 OAuth 2.0 概念，意味着在注销后应该重定向的位置。

现在让我们在主页上添加一个登出按钮，以便用户可以从你的应用程序中登出。

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...

  final postSignOutRedirectUri = 'io.logto//home';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signOutButton = TextButton(
      onPressed: () async {
        await logtoClient.signOut(postSignOutRedirectUri);
        render();
      },
      child: const Text('Sign Out'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
            signOutButton,
          ],
        ),
      ),
    );
  }
}

处理认证 (Authentication) 状态

Logto SDK 提供了一个异步方法来检查认证 (Authentication) 状态。该方法是 logtoClient.isAuthenticated。该方法返回一个布尔值，如果用户已认证 (Authentication)，则返回 true，否则返回 false。

在示例中，我们根据认证 (Authentication) 状态有条件地渲染登录和登出按钮。现在让我们更新 Widget 中的 render 方法以处理状态变化：

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  bool? isAuthenticated = false;

  void render() {
    setState(() async {
      isAuthenticated = await logtoClient.isAuthenticated;
    });
  }

  @override
  Widget build(BuildContext context) {
    // ...

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            isAuthenticated == true ? signOutButton : signInButton,
          ],
        ),
      ),
    );
  }
}

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

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

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

添加 SAML 连接器

要实现快速登录并提高用户转化率，请将 Flutter 作为身份提供商 (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 连接器添加到“社交登录”部分。

登录体验选项卡

测试和验证

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

拓展阅读

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

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

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

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

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

集成 Flutter SDK​

安装​

依赖和配置​

SDK 版本兼容性​

flutter_secure_storage 设置​

配置 Android 版本​

禁用 Android 上的自动备份​

flutter_web_auth_2 设置​

集成​

初始化 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 连接器​

测试和验证​

拓展阅读​