Flutter JWT认证插件jaguar_jwt的使用

简介

jaguar_jwt 是一个用于 Dart 和 Jaguar.dart 的JWT工具库，可以用来生成和处理 JSON Web Tokens (JWT)。更多关于 JSON Web Tokens 的信息，请参见 RFC 7519。

目前，jaguar_jwt 只支持使用 HMAC SHA-256 算法来生成/处理 JSON Web Signature (JWS)。

使用方法

发行 JWT

下面是一个简单的例子，演示了如何创建一个 JWT：

import 'package:jaguar_jwt/jaguar_jwt.dart';

void main() {
  final key = 's3cr3t';
  final claimSet = JwtClaim(
      subject: 'kleak',
      issuer: 'teja',
      audience: ['audience1.example.com', 'audience2.example.com'],
      otherClaims: {
        'typ': 'authnresponse',
        'pld': {'k': 'v'}
      },
      maxAge: const Duration(minutes: 5));

  String token = issueJwtHS256(claimSet, key);
  print(token);
}

处理 JWT

处理 JWT 主要分为三步：

1. 验证签名并提取声明集。
2. 验证声明集。
3. 从声明集中提取声明。

以下是一个完整的示例，展示了如何验证和解析 JWT：

import 'package:jaguar_jwt/jaguar_jwt.dart';

void main() {
  final jwt = senderCreatesJwt();
  receiverProcessesJwt(jwt);
}

String senderCreatesJwt() {
  // 创建声明集
  final claimSet = JwtClaim(
    issuer: 'teja',
    subject: 'kleak',
    audience: ['client1.example.com', 'client2.example.com'],
    jwtId: _randomString(32),
    otherClaims: {
      'typ': 'authnresponse',
      'pld': {'k': 'v'}
    },
    maxAge: const Duration(minutes: 5),
  );

  // 根据声明集生成 JWT
  final token = issueJwtHS256(claimSet, sharedSecret);

  print('JWT: "$token"\n');

  return token;
}

void receiverProcessesJwt(String token) {
  try {
    // 验证 JWT 中的签名并提取其声明集
    final decClaimSet = verifyJwtHS256Signature(token, sharedSecret);
    print('JwtClaim: $decClaimSet\n');

    // 验证声明集
    decClaimSet.validate(issuer: 'teja', audience: 'client2.example.com');

    // 使用声明集中的值
    if (decClaimSet.jwtId != null) {
      print('JWT ID: "${decClaimSet.jwtId}"');
    }
    if (decClaimSet.subject != null) {
      print('Subject: "${decClaimSet.subject}"');
    }
    if (decClaimSet.issuedAt != null) {
      print('Issued At: ${decClaimSet.issuedAt}');
    }
    if (decClaimSet.containsKey('typ')) {
      final dynamic v = decClaimSet['typ'];
      if (v is String) {
        print('typ: "$v"');
      } else {
        print('Error: unexpected type for "typ" claim');
      }
    }
  } on JwtException catch (e) {
    print('Error: bad JWT: $e');
  }
}

const String sharedSecret = 's3cr3t';

String _randomString(int length) {
  const chars =
      '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
  final rnd = Random(DateTime.now().millisecondsSinceEpoch);
  final buf = StringBuffer();

  for (var x = 0; x < length; x++) {
    buf.write(chars[rnd.nextInt(chars.length)]);
  }
  return buf.toString();
}

配置

JwtClaimSet

JwtClaimSet 是持有 JWT 声明集信息的模型。以下是注册声明的列表：

1. issuer: 发行令牌的权威机构。这将在授权时用于验证预期的发行者是否已发行该令牌。填充 JWT 的 iss 字段。
2. subject: 令牌的主题。通常存储的是用户 ID。填充 JWT 的 sub 字段。
3. audience: 接受此令牌的受众列表。这将在授权时用于验证 JWT 是否有服务预期的受众。填充 JWT 的 aud 字段。
4. expiry: 令牌不再被接受的时间。填充 JWT 的 exp 字段。
5. notBefore: 令牌可接受处理的时间。填充 JWT 的 nbf 字段。
6. issuedAt: 令牌发出的时间。填充 JWT 的 iat 字段。
7. jwtId: 跨服务唯一标识符，识别令牌。填充 JWT 的 jti 字段。

此外，您也可以在 JWT 中包含其他声明。

通过以上内容，您可以轻松地在 Flutter 或 Dart 项目中集成 jaguar_jwt 插件以实现 JWT 的生成与验证功能。