堆栈内存溢出
  繁体   English   中英

Webapi 2.0如何在访问令牌过期时实现刷新JWT令牌

[英]Webapi 2.0 how to implement refresh JWT token when access token expired

 原文  2018-01-18 11:39:34  0   2    asp.net/ c#-4.0/ webforms/ asp.net-web-api2/ dotnet-httpclient

问题描述

我在Web API实施方面还很陌生，我创建了一个Web API服务，可与ASP.net web form应用程序以及一些使用HttpClient对象的独立应用程序（C＃Console / Windows应用程序）一起使用。

我已经在Web api中实现了具有到期时间限制的基本JWT访问令牌身份验证，此身份验证技术在令牌未过期之前可以正常工作，当令牌获取过期时，Web api不接受请求，因为令牌已过期！ 按照身份验证实现，这很好，但是我想在Web api中实现刷新令牌逻辑，以便令牌可以续订/刷新，并且客户端应该能够使用Web api资源。

我在Google上搜索了很多，但是找不到刷新令牌逻辑的正确实现。 如果有人有正确的方法来处理过期的访问令牌，请帮助我。

以下是我在asp.net应用程序中使用Web api所遵循的步骤。

  1. 在ASP.net Web表单登录页面中，我将Web API称为“ TokenController”，该控制器采用两个参数loginID和password，并返回我存储在会话对象中的JWT令牌。

  2. 现在，每当我的客户端应用程序也需要使用Web api资源时，必须在使用httpclient调用Web api时在请求标头中发送访问令牌。

  3. 但是，当令牌过期时，客户端无法使用Web api资源，他必须再次登录并更新令牌！ 这是我所不希望的，因为应用程序会话超时时间尚未过去，所以用户不应提示再次登录。

我如何刷新令牌而不强制用户再次登录。

如果我在下面给出的JWT访问令牌实现逻辑不合适或不正确，请告诉我正确的方法。

以下是代码。

的WebAPI

AuthHandler.cs 

  public class AuthHandler : DelegatingHandler
    {

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request,
                CancellationToken cancellationToken)
    {
        HttpResponseMessage errorResponse = null;           
        try
        {
            IEnumerable<string> authHeaderValues;
            request.Headers.TryGetValues("Authorization", out authHeaderValues);

            if (authHeaderValues == null)
                return base.SendAsync(request, cancellationToken);

            var requestToken = authHeaderValues.ElementAt(0);

            var token = "";

            if (requestToken.StartsWith("Bearer ", StringComparison.CurrentCultureIgnoreCase))
            {
                token = requestToken.Substring("Bearer ".Length);
            }

            var secret = "w$e$#*az";

            ClaimsPrincipal cp = ValidateToken(token, secret, true);


            Thread.CurrentPrincipal = cp;

            if (HttpContext.Current != null)
            {
                Thread.CurrentPrincipal = cp;
                HttpContext.Current.User = cp;
            }
        }
        catch (SignatureVerificationException ex)
        {
            errorResponse = request.CreateErrorResponse(HttpStatusCode.Unauthorized, ex.Message);
        }
        catch (Exception ex)
        {
            errorResponse = request.CreateErrorResponse(HttpStatusCode.InternalServerError, ex.Message);
        }


        return errorResponse != null
            ? Task.FromResult(errorResponse)
            : base.SendAsync(request, cancellationToken);
    }

    private static ClaimsPrincipal ValidateToken(string token, string secret, bool checkExpiration)
    {
        var jsonSerializer = new JavaScriptSerializer();
        string payloadJson = string.Empty;

        try
        {
            payloadJson = JsonWebToken.Decode(token, secret);
        }
        catch (Exception)
        {
            throw new SignatureVerificationException("Unauthorized access!");
        }

        var payloadData = jsonSerializer.Deserialize<Dictionary<string, object>>(payloadJson);


        object exp;
        if (payloadData != null && (checkExpiration && payloadData.TryGetValue("exp", out exp)))
        {
            var validTo = AuthFactory.FromUnixTime(long.Parse(exp.ToString()));
            if (DateTime.Compare(validTo, DateTime.UtcNow) <= 0)
            {
                throw new SignatureVerificationException("Token is expired!");
            }
        }

        var clmsIdentity = new ClaimsIdentity("Federation", ClaimTypes.Name, ClaimTypes.Role);

        var claims = new List<Claim>();

        if (payloadData != null)
            foreach (var pair in payloadData)
            {
                var claimType = pair.Key;

                var source = pair.Value as ArrayList;

                if (source != null)
                {
                    claims.AddRange(from object item in source
                                    select new Claim(claimType, item.ToString(), ClaimValueTypes.String));

                    continue;
                }

                switch (pair.Key.ToUpper())
                {
                    case "USERNAME":
                        claims.Add(new Claim(ClaimTypes.Name, pair.Value.ToString(), ClaimValueTypes.String));
                        break;
                    case "EMAILID":
                        claims.Add(new Claim(ClaimTypes.Email, pair.Value.ToString(), ClaimValueTypes.Email));
                        break;
                    case "USERID":
                        claims.Add(new Claim(ClaimTypes.UserData, pair.Value.ToString(), ClaimValueTypes.Integer));
                        break;
                    default:
                        claims.Add(new Claim(claimType, pair.Value.ToString(), ClaimValueTypes.String));
                        break;
                }
            }

        clmsIdentity.AddClaims(claims);

        ClaimsPrincipal cp = new ClaimsPrincipal(clmsIdentity);

        return cp;
    }


}

AuthFactory.cs 

public static class AuthFactory
{
internal static DateTime FromUnixTime(double unixTime)
{
    var epoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
    return epoch.AddSeconds(unixTime);
}


internal static string CreateToken(User user, string loginID, out double issuedAt, out double expiryAt)
{

    var unixEpoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
    expiryAt = Math.Round((DateTime.UtcNow.AddMinutes(TokenLifeDuration) - unixEpoch).TotalSeconds);
    issuedAt = Math.Round((DateTime.UtcNow - unixEpoch).TotalSeconds);

    var payload = new Dictionary<string, object>
        {
            {enmUserIdentity.UserName.ToString(), user.Name},
            {enmUserIdentity.EmailID.ToString(), user.Email},
            {enmUserIdentity.UserID.ToString(), user.UserID},
            {enmUserIdentity.LoginID.ToString(), loginID}
            ,{"iat", issuedAt}
            ,{"exp", expiryAt}
        };

    var secret = "w$e$#*az";

    var token = JsonWebToken.Encode(payload, secret, JwtHashAlgorithm.HS256);

    return token;
}

public static int TokenLifeDuration
{
    get
    {
        int tokenLifeDuration = 20; // in minuets
        return tokenLifeDuration;
    }
}

internal static string CreateMasterToken(int userID, string loginID)
{

    var payload = new Dictionary<string, object>
        {
            {enmUserIdentity.LoginID.ToString(), loginID},
            {enmUserIdentity.UserID.ToString(), userID},
            {"instanceid", DateTime.Now.ToFileTime()}
        };

    var secret = "w$e$#*az";

    var token = JsonWebToken.Encode(payload, secret, JwtHashAlgorithm.HS256);

    return token;
}

}

WebApiConfig.cs 

public static class WebApiConfig
{

    public static void Register(HttpConfiguration config)
    {
        var cors = new EnableCorsAttribute("*", "*", "*");
        config.EnableCors(cors);

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        config.Formatters.Remove(config.Formatters.XmlFormatter);

        config.MessageHandlers.Add(new AuthHandler());
    }
}

TokenController .cs 

public class TokenController : ApiController
{
    [AllowAnonymous]
    [Route("signin")]
    [HttpPost]
    public HttpResponseMessage Login(Login model)
    {
        HttpResponseMessage response = null;
        DataTable dtblLogin = null;
        double issuedAt;
        double expiryAt;

        if (ModelState.IsValid)
        {
            dtblLogin = LoginManager.GetUserLoginDetails(model.LoginID, model.Password, true);

            if (dtblLogin == null || dtblLogin.Rows.Count == 0)
            {
                response = Request.CreateResponse(HttpStatusCode.NotFound);
            }
            else
            {
                User loggedInUser = new User();
                loggedInUser.UserID = Convert.ToInt32(dtblLogin.Rows[0]["UserID"]);
                loggedInUser.Email = Convert.ToString(dtblLogin.Rows[0]["UserEmailID"]);
                loggedInUser.Name = Convert.ToString(dtblLogin.Rows[0]["LastName"]) + " " + Convert.ToString(dtblLogin.Rows[0]["FirstName"]);

                string token = AuthFactory.CreateToken(loggedInUser, model.LoginID, out issuedAt, out expiryAt);
                loggedInUser.Token = token;

                response = Request.CreateResponse(loggedInUser);

            }
        }
        else
        {
            response = Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);
        }
        return response;
    }

    protected override void Dispose(bool disposing)
    {
        base.Dispose(disposing);
    }

}

PremiumCalculatorController.cs 

PremiumCalculatorController : ApiController
{
    [HttpPost]
    public IHttpActionResult CalculatAnnualPremium(PremiumFactorInfo premiumFactDetails)
    {
      PremiumInfo result;
      result = AnnualPremium.GetPremium(premiumFactDetails);
      return Ok(result);
    }
}

网络表格申请

Login.aspx.cs 

public class Login
{
    protected void imgbtnLogin_Click(object sender, System.EventArgs s)
    {

    UserInfo loggedinUser = LoginManager.ValidateUser(txtUserID.text.trim(), txtPassword.text);

    if (loggedinUser != null)
    {

        byte[] password = LoginManager.EncryptPassword(txtPassword.text);

        APIToken tokenInfo = ApiLoginManager.Login(txtUserID.text.trim(), password);

        loggedinUser.AccessToken = tokenInfo.Token;

        Session.Add("LoggedInUser", loggedinUser);

        Response.Redirect("Home.aspx");

    }
    else
    {
        msg.Show("Logn ID or Password is invalid.");
    }


    }
}

ApiLoginManager.cs 

public class ApiLoginManager
{
    public UserDetails Login(string userName, byte[] password)
    {
        APIToken result = null;
        UserLogin objLoginInfo;
        string webAPIBaseURL = "http://localhost/polwebapiService/"
        try
        {
            using (var client = new HttpClient())
            {
                result = new UserDetails();
                client.BaseAddress = new Uri(webAPIBaseURL);
                objLoginInfo = new UserLogin { LoginID = userName, Password = password };

                var response = client.PostAsJsonAsync("api/token/Login", objLoginInfo);

                if (response.Result.IsSuccessStatusCode)
                {
                    string jsonResponce = response.Result.Content.ReadAsStringAsync().Result;
                    result = JsonConvert.DeserializeObject<APIToken>(jsonResponce);
                }

                response = null;
            }

            return result;
        }
        catch (Exception ex)
        {
            throw ex;
        }

    }

}

AnnualPremiumCalculator.aspx.cs 

public class AnnualPremiumCalculator
{
    protected void imgbtnCalculatePremium_Click(object sender, System.EventArgs s)
    { 
       string token = ((UserInfo)Session["LoggedInUser"]).AccessToken;
       PremiumFactors premiumFacts = CollectUserInputPremiumFactors();
       PremiumInfo premiumDet = CalculatePremium(premiumFacts, token);
       txtAnnulPremium.text = premiumDet.Premium;
       //other details so on 
    }

    public PremiumInfo CalculatePremium(PremiumFactors premiumFacts, string accessToken)
    {
        PremiumInfo result = null;
        string webAPIBaseURL = "http://localhost/polwebapiService/";
        try
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(webAPIBaseURL);

                StringContent content = new StringContent(JsonConvert.SerializeObject(premiumFacts), Encoding.UTF8, "application/json");

                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);

                var response = client.PostAsync("api/calculators/PremiumCalculator", content);

                if (response.Result.IsSuccessStatusCode)
                {
                    string jsonResponce = response.Result.Content.ReadAsStringAsync().Result;
                    result = JsonConvert.DeserializeObject<PremiumInfo>(jsonResponce);
                }

                response = null;

            }

            return result;
        }
        finally
        {

        }

    }

}

上面是一个示例代码来说明该问题，它可能有一些错字。

2 个解决方案

解决方案1
 3  2018-01-28 17:45:17

这可以通过单独的持久性刷新令牌来完成。 网址为http://www.c-sharpcorner.com/article/handle-refresh-token-using-asp-net-core-2-0-and-json-web-token/的不错的教程

解决方案2
 3 已采纳  2018-01-28 21:50:03

我有一些评论：

  1. 访问令牌应由客户端保存，而不是在服务器上的会话中保存。 刷新令牌的计数相同。 这样做的原因是通常没有会话。 智能客户端无需会话即可处理令牌，MVC网站可以使用Cookie，而API不知道会话。 这不是禁止的，但是再次，您将需要担心会话到期，并且在重新启动服务器时所有用户都必须再次登录。

  2. 如果要实现OAuth，请阅读规范 。 在这里，您将找到实现刷新令牌所需的一切。

  3. 在TokenController中，您处理登录。 在那里，您还应该检查其他条件 。

    • grant_type =密码
    • 内容类型必须为“ application / x-www-form-urlencoded”
    • 仅当通过安全线路（https）发送时，才应处理该请求。

  4. 当获得了access_token时，并且仅当请求了refresh_token时，您才应在access_token中包括refresh_token 。

  5. 客户端应用程序 （grant_type = client_credentials）不需要刷新令牌，因为那些使用clientid / secret获得访问令牌的应用程序。 扩展TokenController以允许client_credentials流。 请注意：刷新令牌仅供用户使用，只有在可以将其保密的情况下才应使用。 刷新令牌非常强大，因此请谨慎处理。

  6. 为了刷新访问令牌，您需要将刷新令牌发送到端点。 在您的情况下，您可以扩展TokenController以允许refresh_token请求。 您需要检查：

    • grant_type =刷新令牌
    • 内容类型必须为“ application / x-www-form-urlencoded”

  7. 刷新令牌有几种方案，您也可以将它们组合在一起：

    • 将刷新令牌保存在数据库中。 每次使用刷新令牌时，都可以将其从数据库中删除，然后保存新的刷新令牌，该刷新令牌也将在新的access_token中返回。
    • 将刷新令牌设置为更长的生命周期，并且在刷新访问令牌时不要刷新它。 在这种情况下，返回的access_token不包含新的刷新令牌。 这样，您将需要在refresh_token到期后再次登录。

  8. 请注意，永不过期且无法撤消的刷新令牌为用户提供了无限的访问权限，因此请谨慎实施。

  9. 在我的回答中，您可以看到如何使用身份2处理刷新令牌。您可以考虑切换到身份2。

我想我已经提到了一切。 如果我错过了某些内容或不清楚的内容，请告诉我。

暂无
暂无

声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

相关问题 ASP.net Core 2.0 JWT令牌刷新 OWIN ASP.NET-如果访问令牌过期，则无法使用刷新令牌生成访问令牌 刷新令牌刷新jwt后如何刷新数据 如何在 Web Api 2 中实现 Oauth 刷新令牌 Sharepoint Provider托管的应用程序：无效的JWT令牌。 令牌已过期 WebAPI 不尊重 Jwt 令牌的授权属性 访问令牌过期时如何使Owin自动使用刷新令牌 当我将google +按钮添加到我的网站时，如何知道`access_token`已过期？ 无法获取访问令牌和刷新令牌 如何在ASP.NET中刷新（或检测到过期的）活动目录oauth2令牌？
相关标签
 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM