深入理解ueberauth/guardian中的实现模块-CSDN博客

深入理解ueberauth/guardian中的实现模块

guardian Elixir Authentication 项目地址: https://gitcode.com/gh_mirrors/gu/guardian

概述

在Elixir生态系统中，ueberauth/guardian是一个强大的认证解决方案，它提供了一种灵活且安全的方式来处理用户认证流程。本文将重点解析guardian中的实现模块(Implementation Modules)，这是与guardian交互的核心组件。

实现模块的作用

实现模块是应用程序与guardian交互的主要接口。它封装了开发者指定的配置和行为，并通过令牌后端(默认使用JWT)来实现所选令牌类型的细节处理。

与早期版本相比，当前架构的优势在于：

支持多种令牌类型
配置更加灵活
定制化更加简单直观

核心功能

令牌的编码与解码

实现模块提供了几个关键函数来处理认证令牌：

# 创建令牌
{:ok, token, full_claims} = MyApp.TokenImpl.encode_and_sign(user)

# 解码令牌
{:ok, claims} = MyApp.TokenImpl.decode_and_verify(token_string)

# 一步完成解码和资源获取
{:ok, user, claims} = MyApp.TokenImpl.resource_from_token(token_string)

在创建令牌时，可以添加自定义声明(claims)。最终的令牌声明将是以下内容的合并结果(按应用顺序)：

令牌模块提供的基础声明
传入的自定义声明
在Guardian.build_claims回调中进行的任何修改

基本设置

一个最基本的实现模块需要包含以下内容：

defmodule MyApp.TokenImpl do
  use Guardian, otp_app: :my_app

  def subject_for_token(resource, options) do
    {:ok, resource.id}
  end

  def resource_from_claims(claims) do
    # 根据claims["sub"]或其他存储的信息查找用户
  end
end

其中subject_for_token和resource_from_claims是两个必须实现的函数，它们互为逆操作：

subject_for_token：提供要编码到令牌中的标识符
resource_from_claims：使用上述标识符查找关联的资源

高级主题

主题标识设计

在设计subject_for_token返回的主题标识时，需要考虑以下几点：

如果有多类结构体需要认证，建议使用前缀标识类型
一旦令牌发布，需要支持所有主题方案直到令牌过期或被撤销
前缀设计便于模式匹配

示例实现：

def subject_for_token(%User{uid: uid} = user, _claims) do
  {:ok, "User:#{uid}"}
end

def resource_from_claims(%{"sub" => "User:" <> uid}) do
  # 查找用户逻辑
end