如何获取DotNetOpenAuth返回的错误信息.客户端OAuth2

本文关键字:错误 信息 客户端 OAuth2 返回 DotNetOpenAuth 何获取 获取 | 更新日期: 2023-09-27 18:15:40

我使用ExchangeUserCredentialForToken函数从授权服务器获取令牌。当我的用户存在于我的数据库中时,它工作得很好,但是当凭据不正确时,我想向客户端发回一条消息。我使用以下两行代码来设置错误消息:

context.SetError("Autorization Error", "The username or password is incorrect!");
context.Rejected();

但是在客户端,我只得到协议错误(错误400)。你能帮我如何在授权服务器上获得服务器端设置的错误消息吗?

来自授权服务器的完整应用配置:

using Constants;
using Microsoft.Owin;
using Microsoft.Owin.Security;
using Microsoft.Owin.Security.Cookies;
using Microsoft.Owin.Security.Infrastructure;
using Microsoft.Owin.Security.OAuth;
using Owin;
using System;
using System.Collections.Concurrent;
using System.Linq;
using System.Security.Claims;
using System.Security.Principal;
using System.Threading.Tasks;
using AuthorizationServer.Entities;
using AuthorizationServer.Entities.Infrastructure.Abstract;
using AuthorizationServer.Entities.Infrastructure.Concrete;
namespace AuthorizationServer
{
    public partial class Startup
    {
        private IEmployeeRepository Repository;  
        public void ConfigureAuth(IAppBuilder app)
        {
            //instanciate the repository
            Repository = new EmployeeRepository();
            // Enable Application Sign In Cookie
            app.UseCookieAuthentication(new CookieAuthenticationOptions
            {
                AuthenticationType = "Application",
                AuthenticationMode = AuthenticationMode.Passive,
                LoginPath = new PathString(Paths.LoginPath),
                LogoutPath = new PathString(Paths.LogoutPath),
            });
            // Enable External Sign In Cookie
            app.SetDefaultSignInAsAuthenticationType("External");
            app.UseCookieAuthentication(new CookieAuthenticationOptions
            {
                AuthenticationType = "External",
                AuthenticationMode = AuthenticationMode.Passive,
                CookieName = CookieAuthenticationDefaults.CookiePrefix + "External",
                ExpireTimeSpan = TimeSpan.FromMinutes(5),
            });
            // Enable google authentication
            app.UseGoogleAuthentication();
            // Setup Authorization Server
            app.UseOAuthAuthorizationServer(new OAuthAuthorizationServerOptions
            {
                AuthorizeEndpointPath = new PathString(Paths.AuthorizePath),
                TokenEndpointPath = new PathString(Paths.TokenPath),
                ApplicationCanDisplayErrors = true,
#if DEBUG
                AllowInsecureHttp = true,
#endif
                // Authorization server provider which controls the lifecycle of Authorization Server
                Provider = new OAuthAuthorizationServerProvider
                {
                    OnValidateClientRedirectUri = ValidateClientRedirectUri,
                    OnValidateClientAuthentication = ValidateClientAuthentication,
                    OnGrantResourceOwnerCredentials = GrantResourceOwnerCredentials,
                    OnGrantClientCredentials = GrantClientCredetails
                },
                // Authorization code provider which creates and receives authorization code
                AuthorizationCodeProvider = new AuthenticationTokenProvider
                {
                    OnCreate = CreateAuthenticationCode,
                    OnReceive = ReceiveAuthenticationCode,
                },
                // Refresh token provider which creates and receives referesh token
                RefreshTokenProvider = new AuthenticationTokenProvider
                {
                    OnCreate = CreateRefreshToken,
                    OnReceive = ReceiveRefreshToken,
                }
            });
            // indicate our intent to use bearer authentication
            app.UseOAuthBearerAuthentication(new OAuthBearerAuthenticationOptions
            {
                AuthenticationType = "Bearer",
                AuthenticationMode = Microsoft.Owin.Security.AuthenticationMode.Active
            });
        }
        private Task ValidateClientRedirectUri(OAuthValidateClientRedirectUriContext context)
        {
            if (context.ClientId == Clients.Client1.Id)
            {
                context.Validated(Clients.Client1.RedirectUrl);
            }
            else if (context.ClientId == Clients.Client2.Id)
            {
                context.Validated(Clients.Client2.RedirectUrl);
            }
            return Task.FromResult(0);
        }
        private Task ValidateClientAuthentication(OAuthValidateClientAuthenticationContext context)
        {
            string clientname;
            string clientpassword;

            if (context.TryGetBasicCredentials(out clientname, out clientpassword) ||
                context.TryGetFormCredentials(out clientname, out clientpassword))
            {
                employee Employee = Repository.GetEmployee(clientname, clientpassword);
                if (Employee != null)
                {
                    context.Validated();
                }
                else
                {
                    context.SetError("Autorization Error", "The username or password is incorrect!");
                    context.Rejected();
                }
            }
            return Task.FromResult(0);
        }
        private Task GrantResourceOwnerCredentials(OAuthGrantResourceOwnerCredentialsContext context)
        {
            var identity = new ClaimsIdentity(new GenericIdentity(context.UserName, OAuthDefaults.AuthenticationType), context.Scope.Select(x => new Claim("urn:oauth:scope", x)));
            context.Validated(identity);
            return Task.FromResult(0);
        }
        private Task GrantClientCredetails(OAuthGrantClientCredentialsContext context)
        {
            var identity = new ClaimsIdentity(new GenericIdentity(context.ClientId, OAuthDefaults.AuthenticationType), context.Scope.Select(x => new Claim("urn:oauth:scope", x)));
            context.Validated(identity);
            return Task.FromResult(0);
        }

        private readonly ConcurrentDictionary<string, string> _authenticationCodes =
            new ConcurrentDictionary<string, string>(StringComparer.Ordinal);
        private void CreateAuthenticationCode(AuthenticationTokenCreateContext context)
        {
            context.SetToken(Guid.NewGuid().ToString("n") + Guid.NewGuid().ToString("n"));
            _authenticationCodes[context.Token] = context.SerializeTicket();
        }
        private void ReceiveAuthenticationCode(AuthenticationTokenReceiveContext context)
        {
            string value;
            if (_authenticationCodes.TryRemove(context.Token, out value))
            {
                context.DeserializeTicket(value);
            }
        }
        private void CreateRefreshToken(AuthenticationTokenCreateContext context)
        {
            context.SetToken(context.SerializeTicket());
        }
        private void ReceiveRefreshToken(AuthenticationTokenReceiveContext context)
        {
            context.DeserializeTicket(context.Token);
        }
    }
}

如何获取DotNetOpenAuth返回的错误信息.客户端OAuth2

经过几个小时的网络搜索和阅读blobs,以及自己的文档,我找到了一种方法,可以为失败的登录尝试返回401。

我意识到添加下面的标题有点hack,但是我找不到任何方法来读取IOwinContext.Response.Body流来查找错误消息。

首先,在OAuthAuthorizationServerProvider.GrantResourceOwnerCredentials中,我使用SetError()并在响应中加入Headers

context.SetError("Autorization Error", "The username or password is incorrect!");
context.Response.Headers.Add("AuthorizationResponse", new[] { "Failed" });

现在,您有了一种方法来区分认证请求失败导致的400错误和其他原因导致的400错误。

下一步是创建一个继承OwinMiddleware的类。这个类检查传出响应,如果StatusCode == 400和上面的Header存在,它将StatucCode更改为401。

public class InvalidAuthenticationMiddleware : OwinMiddleware
{
    public InvalidAuthenticationMiddleware(OwinMiddleware next) 
        : base(next)
    {
    }
    public override async Task Invoke(IOwinContext context)
    {
        await Next.Invoke(context);
        if (context.Response.StatusCode == 400 && context.Response.Headers.ContainsKey("AuthorizationResponse"))
        {
            context.Response.Headers.Remove("AuthorizationResponse");
            context.Response.StatusCode = 401;
        }
    }
}

最后要做的事情是在Startup.Configuration方法中注册您刚刚创建的类。在方法中执行其他操作之前,我先注册了它。

app.Use<InvalidAuthenticationMiddleware>();

这是一个完整的解决方案,使用了Jeff的概念和我原来的帖子。

1) 在上下文中设置错误消息

如果在设置了错误消息之后调用context.Rejected(),则错误消息将被删除(参见下面的示例):

    context.SetError("Account locked", 
             "You have exceeded the total allowed failed logins.  Please try back in an hour.");
    context.Rejected();

您需要从任务中删除context.Rejected()。请注意,Rejected和SetError方法的定义是:

拒绝:

将此上下文标记为未被应用程序验证。当调用。

时,IsValidated和HasError变为false。

SetError:

将此上下文标记为未被应用程序验证,并分配各种错误信息属性。调用。

后,HasError变为true, IsValidated变为false。

同样,通过在设置错误后调用Rejected方法,上下文将被标记为没有错误,并且错误消息将被删除。

2) 设置响应的状态码:使用Jeff的例子,稍微有点旋转

我将创建一个全局属性来为状态码设置标记,而不是使用魔法字符串。在静态全局类中,创建一个标记状态码的属性(我使用X-Challenge,当然您可以选择使用任何属性)。这将用于标记响应中添加的header属性。
public static class ServerGlobalVariables
{
//Your other properties...
public const string OwinChallengeFlag = "X-Challenge";
}

然后在OAuthAuthorizationServerProvider的各种任务中,您将在响应中添加标记作为新报头值的键。使用HttpStatusCode枚举和你的全局标志,你可以访问所有不同的状态码,你可以避免一个神奇的字符串。

//Set the error message
context.SetError("Account locked", 
        "You have exceeded the total allowed failed logins.  Please try back in an hour.");
//Add your flag to the header of the response
context.Response.Headers.Add(ServerGlobalVariables.OwinChallengeFlag, 
         new[] { ((int)HttpStatusCode.Unauthorized).ToString() }); 

在客户OwinMiddleware中,您可以使用全局变量在header中搜索标志:

//This class handles all the OwinMiddleware responses, so the name should 
//not just focus on invalid authentication
public class CustomAuthenticationMiddleware : OwinMiddleware
{
    public CustomAuthenticationMiddleware(OwinMiddleware next)
        : base(next)
    {
    }
    public override async Task Invoke(IOwinContext context)
    {
        await Next.Invoke(context);
        if (context.Response.StatusCode == 400 
            && context.Response.Headers.ContainsKey(
                      ServerGlobalVariables.OwinChallengeFlag))
        {
            var headerValues = context.Response.Headers.GetValues
                  (ServerGlobalVariables.OwinChallengeFlag);
            context.Response.StatusCode = 
                   Convert.ToInt16(headerValues.FirstOrDefault());
            context.Response.Headers.Remove(
                   ServerGlobalVariables.OwinChallengeFlag);
        }         
    }
}

最后,正如Jeff指出的那样,您必须在Startup.ConfigurationStartup.ConfigureAuth方法中注册此自定义OwinMiddleware:

app.Use<CustomAuthenticationMiddleware>();
使用上述解决方案,您现在可以设置状态码和自定义错误消息,如下所示:
  • 无效的用户名或密码
  • 此帐户已超过最大尝试次数
  • 邮件账号未被确认

3) 从协议异常

中提取错误消息

在客户端应用程序中,需要捕获和处理ProtocolException。像这样的代码会给你答案:

//Need to create a class to deserialize the Json
//Create this somewhere in your application
public class OAuthErrorMsg
    {
        public string error { get; set; }
        public string error_description { get; set; }
        public string error_uri { get; set; }
    }
 //Need to make sure to include Newtonsoft.Json
 using Newtonsoft.Json;
 //Code for your object....
 private void login()
    {
        try
        {
            var state = _webServerClient.ExchangeUserCredentialForToken(
                this.emailTextBox.Text, 
                this.passwordBox.Password.Trim(), 
                scopes: new string[] { "PublicProfile" });
            _accessToken = state.AccessToken;
            _refreshToken = state.RefreshToken;
        }
        catch (ProtocolException ex)
        {
            var webException = ex.InnerException as WebException;
            OAuthErrorMsg error = 
                JsonConvert.DeserializeObject<OAuthErrorMsg>(
                ExtractResponseString(webException));
            var errorMessage = error.error_description;
            //Now it's up to you how you process the errorMessage
        }
    }
    public static string ExtractResponseString(WebException webException)
    {
        if (webException == null || webException.Response == null)
            return null;
        var responseStream = 
            webException.Response.GetResponseStream() as MemoryStream;
        if (responseStream == null)
            return null;
        var responseBytes = responseStream.ToArray();
        var responseString = Encoding.UTF8.GetString(responseBytes);
        return responseString;
    }

我已经测试过了,它在VS2013 Pro 4.5中工作得很好!!

(请注意,我没有包括所有必要的名称空间或额外的代码,因为这将取决于应用程序:WPF、MVC或Winform。另外,我没有讨论错误处理,因此您需要确保在整个解决方案中实现适当的错误处理。

Jeff的解决方案不适合我,但当我使用OnSendingHeaders时,它工作得很好:

public class InvalidAuthenticationMiddleware : OwinMiddleware
{
    public InvalidAuthenticationMiddleware(OwinMiddleware next) : base(next) { }
    public override async Task Invoke(IOwinContext context)
    {
        context.Response.OnSendingHeaders(state =>
        {
            var response = (OwinResponse)state;
            if (!response.Headers.ContainsKey("AuthorizationResponse") && response.StatusCode != 400) return;
            response.Headers.Remove("AuthorizationResponse");
            response.StatusCode = 401;
        }, context.Response);
        await Next.Invoke(context);
    }
}