Flutter Azure AD OAuth认证插件flutter_aad_oauth的使用

Azure Active Directory OAuth

这个Flutter插件用于通过Azure Active Directory的OAuth2 v2.0端点进行用户认证。它支持授权码流（包括刷新令牌流）。

使用方法

要使用这个库，你需要在Azure应用注册门户创建一个Azure应用程序。使用本地应用作为平台类型（回调URL为https://login.live.com/oauth20_desktop.srf）。

初始化库的方式如下：

final Config config = Config(
        azureTenantId: "$TENANT_ID", // 租户ID
        clientId: "$CLIENT_ID",       // 客户端ID
        scope: "$scope",              // 作用域
        redirectUri: "$redirectUri",  // 重定向URI
        responseType: "$responseType" // 响应类型
);
final AadOAuth oauth = AadOAuth(config);

这允许你传入租户ID、客户端ID、作用域和重定向URL。

四个重要事项：

1. 移动端的响应类型通常是"code"，而Web端通常是"id_token + token"；
2. Flutter Web的重定向URI解释如下。
3. nonce是Web流程的一个可选参数。
4. 为了保存多个令牌，需要在FlutterAadOauth构造函数中传递tokenIdentifier。该参数用于定义存储中的不同名称，避免覆盖数据。

然后，一旦你有一个OAuth实例，你可以调用login()并随后调用getAccessToken()或getIdToken()或getRefreshToken()来检索访问令牌或ID令牌或刷新令牌：

await oauth.login(); // 登录
String accessToken = await oauth.getAccessToken(); // 获取访问令牌
String idToken = await oauth.getIdToken(); // 获取ID令牌
String refreshToken = await oauth.getRefreshToken(); // 获取刷新令牌
String tokenType = await oauth.getTokenType(); // 获取令牌类型
DateTime issueTimeStamp = await oauth.getIssueTimeStamp(); // 获取发行时间戳
DateTime expireTimeStamp = await oauth.getExpireTimeStamp(); // 获取过期时间戳
int expiresIn = await oauth.getExpiresIn(); // 获取令牌过期时间

你也可以直接调用getAccessToken()、getIdToken()、getRefreshToken()、getTokenType()、getIssueTimeStamp()、getExpireTimeStamp()和getExpiresIn()。它们会自动登录并检索相应的令牌信息。

令牌存储在iOS的Keychain或Android的Keystore中。要销毁令牌，可以调用logout()：

await oauth.logout(); // 注销

Flutter Web

要在Flutter Web上实现认证流程，有以下步骤：

1. 项目必须在根目录下有一个web文件夹（Flutter 2.0）；
2. 在此文件夹内需要创建authRedirect.html文件，作为请求令牌时的重定向页面。这个HTML文件需要包含一个带有POST方法的脚本，如下所示：

<script>
    window.opener.postMessage(window.location.href, '*');
</script>

1. 重定向URL必须预先在Azure中注册，因此应用程序必须始终在同一端口上运行。为此只需在flutter run中使用--web-port=3000标志，或在launch.json文件（VsCode）中添加args，如下所示：

"args": ["--web-port", "3000"],

1. 在这个包的仓库中，有一个示例文件夹，包含一个使用此库进行移动和Web身份验证的Flutter项目。

获取重定向URI的示例：

final currentUri = Uri.base;
redirectUri = Uri(
  host: currentUri.host,
  scheme: currentUri.scheme,
  port: currentUri.port,
  path: '/authRedirect.html',
);

Flutter Web支持基于这篇文章。

完整示例Demo

以下是完整的Flutter应用示例代码：

import 'package:flutter/foundation.dart' show kIsWeb;
import 'package:flutter/material.dart';
import 'package:flutter_aad_oauth/flutter_aad_oauth.dart';
import 'package:flutter_aad_oauth/model/config.dart';

void main() => runApp(const MyApp());

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

  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'AAD OAuth Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'AAD OAuth Home'),
    );
  }
}

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

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  static const String TENANT_ID = 'YOUR_TENANT_ID'; // 替换为你的租户ID
  static const String CLIENT_ID = 'YOUR_CLIENT_ID'; // 替换为你的客户端ID

  late Config config;
  late FlutterAadOauth oauth = FlutterAadOauth(config);

  [@override](/user/override)
  initState() {
    Object redirectUri;
    late String scope;
    late String responseType;

    if (kIsWeb) {
      scope = 'openid profile email offline_access user.read';
      responseType = 'id_token+token';
      final currentUri = Uri.base;
      redirectUri = Uri(
        host: currentUri.host,
        scheme: currentUri.scheme,
        port: currentUri.port,
        path: '/authRedirect.html',
      );
    } else {
      scope = 'openid profile offline_access';
      responseType = 'code';
      redirectUri = 'https://login.live.com/oauth20_desktop.srf';
    }

    config = Config(
        azureTenantId: TENANT_ID,
        clientId: CLIENT_ID,
        scope: scope,
        redirectUri: '$redirectUri',
        responseType: responseType);

    oauth = FlutterAadOauth(config);
    oauth.setContext(context);
    checkIsLogged();
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title!),
      ),
      body: ListView(
        children: <Widget>[
          ListTile(
            title: Text(
              'AzureAD OAuth',
              style: Theme.of(context).textTheme.headline5,
            ),
          ),
          ListTile(
            leading: const Icon(Icons.launch),
            title: const Text('Login'),
            onTap: () {
              login();
            },
          ),
          ListTile(
            leading: const Icon(Icons.delete),
            title: const Text('Logout'),
            onTap: () {
              logout();
            },
          ),
        ],
      ),
    );
  }

  void showError(dynamic ex) {
    showMessage(ex.toString());
  }

  void showMessage(String text) {
    var alert = AlertDialog(content: Text(text), actions: <Widget>[
      ElevatedButton(
          child: const Text('Ok'),
          onPressed: () {
            Navigator.pop(context);
          })
    ]);
    showDialog(context: context, builder: (BuildContext context) => alert);
  }

  void checkIsLogged() async {
    if (await oauth.tokenIsValid()) {
      String? accessToken = await oauth.getAccessToken();
      showMessage('Access token: $accessToken');
    }
  }

  void login() async {
    try {
      await oauth.login(); // 登录
      String? accessToken = await oauth.getAccessToken(); // 获取访问令牌
      showMessage('Logged in successfully, your access token: $accessToken');
    } catch (e) {
      showError(e);
    }
  }

  void logout() async {
    await oauth.logout(); // 注销
    showMessage('Logged out');
  }
}