TokenValidator 1.0.0

Token校验与解析 概述 TokenValidator用于ASP .NET Core Web API项目开发，包含以下功能：

• 从Http请求头中读取、解析、校验安全令牌
• 检测安全令牌的用户权限，以支持用户鉴权 使用说明

1. 引用TokenValidator
2. 初始化相关配置 在使用该dll相关功能之前，请先通过ConfigInit类初始化相关配置 ConfigInit configInit = new ConfigInit(discoveryUrl,authParamName,isBlackListEnable,isAuthValidatorEnable)

/// <summary> /// 初始化配置参数 /// </summary> /// <param name="discoveryUrl">OIDC认证地址</param> /// <param name="authParamName">Http请求头中token字段名，默认为Authorization</param> /// <param name="isBlackListEnable">是否启用token黑名单，默认不启用</param> /// <param name="isAuthValidatorEnable">是否开启token实时校验，默认不启用</param> public ConfigInit(string discoveryUrl, string authParamName = "Authorization", bool isBlackListEnable = false, bool isAuthValidatorEnable = false) { AuthParamName = authParamName; IsBlackListEnable = isBlackListEnable; IsAuthValidatorEnable = isAuthValidatorEnable; DiscoveryUrl = discoveryUrl ?? throw new ArgumentNullException(nameof(discoveryUrl), "ConfigInit Error"); JwksUrl = Regex.Replace(discoveryUrl, "/$", "") + CommonCst.KEYS_SUFFIX_V1; } 3. 使用相关API接口 提供以下接口：

• 从Http请求头中解析校验token //实现方法

/// <summary> /// 从 HTTP 请求头中读取、验证、解析安全令牌 /// </summary> /// <param name="httpRequest">请求</param> /// <param name="httpResponse">响应</param> /// <returns>token验证结果</returns> public bool PreHandle(HttpRequestMessage httpRequest, HttpResponseMessage httpResponse)

//调用示例 HttpFilterService filterService = new HttpFilterService(); bool result = filterService.PreHandle(request, response); 校验通过后，可在该请求的处理流程中随时调用Token解析与校验的API，该dll保证并发请求中的线程安全问题

• token解析与校验 //获取token中payload部分 /// <summary> /// 解析token /// </summary> /// <param name="jwtString">待解析的token</param> /// <returns>json格式的jwt中的payload</returns> public static string ParseJwtPayload(string jwtString)

//获取token中Header部分 public static string ParseJwtHeader(string jwtString)

//获取token实例 /// <summary> // 获取token内容 /// </summary> /// <returns>OpenIdConnectToken实体类</returns> public AuthTokenEntity GetTokenEntity()

//使用示例 JwtUtils.ParseJwtPayload(token); JwtUtils.ParseJwtHeader(token);

AuthTokenService authTokenService = new AuthTokenService(); authTokenService.GetTokenEntity(); 其中token实例包含的属性如下： public class AuthTokenEntity { [JsonProperty("userId")] public string UserId { get; set; }

    [JsonProperty("clientId")]
    public string ClientId { get; set; }

    [JsonProperty("userPhone")]
    public string UserPhone { get; set; }

    [JsonProperty("userEmail")]
    public string UserEmail { get; set; }

    [JsonProperty("userName")]
    public string UserName { get; set; }

    [JsonProperty("userDirectory")]
    public string UserDirectory { get; set; }

    [JsonProperty("tenantId")]
    public string TenantId { get; set; }

    [JsonProperty("tenantName")]
    public string TenantName { get; set; }

    [JsonProperty("appId")]
    public string AppId { get; set; }

    [JsonProperty("nickName")]
    public string NickName { get; set; }

    [JsonProperty("userHead")]
    public string UserHead { get; set; }

    [JsonProperty("userLoginId")]
    public string UserLoginId { get; set; }

    [JsonProperty("roles")]
    public List<string> Roles { get; set; }

    [JsonProperty("permissions")]
    public List<string> Permissions { get; set; }

    [JsonProperty("nonce")]
    public string Nonce { get; set; }

    [JsonProperty("extendedField")]
    public string ExtendedField { get; set; }

    [JsonProperty("jwtString")]
    public string JwtString { get; set; }

    [JsonProperty("accountType")]
    public string AccountType { get; set; }

    [JsonProperty("aud")]
    public string Aud { get; set; }

    [JsonProperty("tp")]
    public string Tp { get; set; }

}