ASP.NET Core Web API認証


96

Webサービスで認証を設定する方法に苦労しています。このサービスはASP.NET Core Web APIを使用して構築されています。

すべてのクライアント(WPFアプリケーション)は、同じ資格情報を使用してWebサービス操作を呼び出す必要があります。

いくつかの調査の後、基本認証を思いつきました-HTTPリクエストのヘッダーでユーザー名とパスワードを送信します。しかし、何時間もの調査の結果、基本認証はASP.NET Coreに移行する方法ではないように思えます。

私が見つけたリソースのほとんどは、OAuthまたはその他のミドルウェアを使用した認証の実装です。しかし、私のシナリオでは、ASP.NET CoreのIdentity部分を使用するだけでなく、サイズが大きすぎるようです。

それで、私の目標を達成する正しい方法は何ですか-ASP.NET Core Webサービスでのユーザー名とパスワードによる単純な認証?

前もって感謝します!

回答:


73

基本認証を処理するミドルウェアを実装できます。

public async Task Invoke(HttpContext context)
{
    var authHeader = context.Request.Headers.Get("Authorization");
    if (authHeader != null && authHeader.StartsWith("basic", StringComparison.OrdinalIgnoreCase))
    {
        var token = authHeader.Substring("Basic ".Length).Trim();
        System.Console.WriteLine(token);
        var credentialstring = Encoding.UTF8.GetString(Convert.FromBase64String(token));
        var credentials = credentialstring.Split(':');
        if(credentials[0] == "admin" && credentials[1] == "admin")
        {
            var claims = new[] { new Claim("name", credentials[0]), new Claim(ClaimTypes.Role, "Admin") };
            var identity = new ClaimsIdentity(claims, "Basic");
            context.User = new ClaimsPrincipal(identity);
        }
    }
    else
    {
        context.Response.StatusCode = 401;
        context.Response.Headers.Set("WWW-Authenticate", "Basic realm=\"dotnetthoughts.net\"");
    }
    await _next(context);
}

このコードは、asp.netコアのベータ版で書かれています。それが役に立てば幸い。


1
ご回答有難うございます!これはまさに私が探していたものです-基本認証のためのシンプルなソリューションです。
Felix

1
credentialstring.Split( ':')を使用しているため、このコードにはバグがあります-コロンを含むパスワードは正しく処理されません。Felixによる回答のコードは、この問題の影響を受けません。
Phil Dennis、

110

今、私は正しい方向に向けられた後、これが私の完全な解決策です:

これは、すべての着信要求で実行され、要求に正しい資格情報があるかどうかをチェックするミドルウェアクラスです。資格情報が存在しない場合、または資格情報が間違っている場合、サービスはすぐに401 Unauthorizedエラーで応答します。

public class AuthenticationMiddleware
{
    private readonly RequestDelegate _next;

    public AuthenticationMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        string authHeader = context.Request.Headers["Authorization"];
        if (authHeader != null && authHeader.StartsWith("Basic"))
        {
            //Extract credentials
            string encodedUsernamePassword = authHeader.Substring("Basic ".Length).Trim();
            Encoding encoding = Encoding.GetEncoding("iso-8859-1");
            string usernamePassword = encoding.GetString(Convert.FromBase64String(encodedUsernamePassword));

            int seperatorIndex = usernamePassword.IndexOf(':');

            var username = usernamePassword.Substring(0, seperatorIndex);
            var password = usernamePassword.Substring(seperatorIndex + 1);

            if(username == "test" && password == "test" )
            {
                await _next.Invoke(context);
            }
            else
            {
                context.Response.StatusCode = 401; //Unauthorized
                return;
            }
        }
        else
        {
            // no authorization header
            context.Response.StatusCode = 401; //Unauthorized
            return;
        }
    }
}

ミドルウェア拡張機能は、サービスのスタートアップクラスのConfigureメソッドで呼び出す必要があります。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    loggerFactory.AddConsole(Configuration.GetSection("Logging"));
    loggerFactory.AddDebug();

    app.UseMiddleware<AuthenticationMiddleware>();

    app.UseMvc();
}

そしてそれだけです!:)

.Net Coreと認証のミドルウェアに関する非常に優れたリソースは、https//www.exceptionnotfound.net/writing-custom-middleware-in-asp-net-core-1-0/にあります。


4
完全なソリューションを投稿していただきありがとうございます。ただし、 'context.Response.Headers.Add( "WWW-Authenticate"、 "Basic realm = \" realm \ "");'という行を追加する必要がありました。ブラウザーに資格情報を要求させるには、「認証ヘッダーなし」セクションに移動します。
m0n0ph0n 2017年

この認証はどの程度安全ですか?誰かがリクエストヘッダーを傍受して、ユーザー名/パスワードを取得した場合はどうなりますか?
Bewar Salah

5
@BewarSalah https経由でこの種のソリューションを提供する必要があります
wal

2
一部のコントローラーは匿名を許可する必要があります。このミドルウェアソリューションは、各リクエストの認証ヘッダーをチェックするため、その場合は失敗します。
Karthik、

28

たとえば、これを特定のコントローラのみに使用するには、次のようにします。

app.UseWhen(x => (x.Request.Path.StartsWithSegments("/api", StringComparison.OrdinalIgnoreCase)), 
            builder =>
            {
                builder.UseMiddleware<AuthenticationMiddleware>();
            });

21

私はJWT(Json Web Tokens)を使用できると思います。

最初に、パッケージSystem.IdentityModel.Tokens.Jwtをインストールする必要があります。

$ dotnet add package System.IdentityModel.Tokens.Jwt

次のようなトークンの生成と認証のためのコントローラーを追加する必要があります。

public class TokenController : Controller
{
    [Route("/token")]

    [HttpPost]
    public IActionResult Create(string username, string password)
    {
        if (IsValidUserAndPasswordCombination(username, password))
            return new ObjectResult(GenerateToken(username));
        return BadRequest();
    }

    private bool IsValidUserAndPasswordCombination(string username, string password)
    {
        return !string.IsNullOrEmpty(username) && username == password;
    }

    private string GenerateToken(string username)
    {
        var claims = new Claim[]
        {
            new Claim(ClaimTypes.Name, username),
            new Claim(JwtRegisteredClaimNames.Nbf, new DateTimeOffset(DateTime.Now).ToUnixTimeSeconds().ToString()),
            new Claim(JwtRegisteredClaimNames.Exp, new DateTimeOffset(DateTime.Now.AddDays(1)).ToUnixTimeSeconds().ToString()),
        };

        var token = new JwtSecurityToken(
            new JwtHeader(new SigningCredentials(
                new SymmetricSecurityKey(Encoding.UTF8.GetBytes("Secret Key You Devise")),
                                         SecurityAlgorithms.HmacSha256)),
            new JwtPayload(claims));

        return new JwtSecurityTokenHandler().WriteToken(token);
    }
}

その後、Startup.csクラスを以下のように更新します。

namespace WebAPISecurity
{   
public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();

        services.AddAuthentication(options => {
            options.DefaultAuthenticateScheme = "JwtBearer";
            options.DefaultChallengeScheme = "JwtBearer";
        })
        .AddJwtBearer("JwtBearer", jwtBearerOptions =>
        {
            jwtBearerOptions.TokenValidationParameters = new TokenValidationParameters
            {
                ValidateIssuerSigningKey = true,
                IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("Secret Key You Devise")),
                ValidateIssuer = false,
                //ValidIssuer = "The name of the issuer",
                ValidateAudience = false,
                //ValidAudience = "The name of the audience",
                ValidateLifetime = true, //validate the expiration and not before values in the token
                ClockSkew = TimeSpan.FromMinutes(5) //5 minute tolerance for the expiration date
            };
        });

    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseAuthentication();

        app.UseMvc();
    }
}

それ[Authorize]だけです。あとは、必要なコントローラまたはアクションに属性を設定するだけです。

ここに完全な簡単なチュートリアルのリンクがあります。

http://www.blinkingcaret.com/2017/09/06/secure-web-api-in-asp-net-core/


9

BasicAuthenticationHandler基本認証用に実装したので、標準の属性Authorizeおよびで使用できますAllowAnonymous

public class BasicAuthenticationHandler : AuthenticationHandler<BasicAuthenticationOptions>
{
    protected override Task<AuthenticateResult> HandleAuthenticateAsync()
    {
        var authHeader = (string)this.Request.Headers["Authorization"];

        if (!string.IsNullOrEmpty(authHeader) && authHeader.StartsWith("basic", StringComparison.OrdinalIgnoreCase))
        {
            //Extract credentials
            string encodedUsernamePassword = authHeader.Substring("Basic ".Length).Trim();
            Encoding encoding = Encoding.GetEncoding("iso-8859-1");
            string usernamePassword = encoding.GetString(Convert.FromBase64String(encodedUsernamePassword));

            int seperatorIndex = usernamePassword.IndexOf(':', StringComparison.OrdinalIgnoreCase);

            var username = usernamePassword.Substring(0, seperatorIndex);
            var password = usernamePassword.Substring(seperatorIndex + 1);

            //you also can use this.Context.Authentication here
            if (username == "test" && password == "test")
            {
                var user = new GenericPrincipal(new GenericIdentity("User"), null);
                var ticket = new AuthenticationTicket(user, new AuthenticationProperties(), Options.AuthenticationScheme);
                return Task.FromResult(AuthenticateResult.Success(ticket));
            }
            else
            {
                return Task.FromResult(AuthenticateResult.Fail("No valid user."));
            }
        }

        this.Response.Headers["WWW-Authenticate"]= "Basic realm=\"yourawesomesite.net\"";
        return Task.FromResult(AuthenticateResult.Fail("No credentials."));
    }
}

public class BasicAuthenticationMiddleware : AuthenticationMiddleware<BasicAuthenticationOptions>
{
    public BasicAuthenticationMiddleware(
       RequestDelegate next,
       IOptions<BasicAuthenticationOptions> options,
       ILoggerFactory loggerFactory,
       UrlEncoder encoder)
       : base(next, options, loggerFactory, encoder)
    {
    }

    protected override AuthenticationHandler<BasicAuthenticationOptions> CreateHandler()
    {
        return new BasicAuthenticationHandler();
    }
}

public class BasicAuthenticationOptions : AuthenticationOptions
{
    public BasicAuthenticationOptions()
    {
        AuthenticationScheme = "Basic";
        AutomaticAuthenticate = true;
    }
}

Startup.csでの登録- app.UseMiddleware<BasicAuthenticationMiddleware>();。このコードを使用して、standart属性Autorizeで任意のコントローラーを制限できます。

[Authorize(ActiveAuthenticationSchemes = "Basic")]
[Route("api/[controller]")]
public class ValuesController : Controller

AllowAnonymousアプリケーションレベルで承認フィルターを適用する場合は、属性を使用します。


1
私はあなたのコードを使用しましたが、Authorize(ActiveAuthenticationSchemes = "Basic")]がすべての呼び出しで設定されているかどうかに関係なく、ミドルウェアがアクティブになり、すべてのコントローラーが不要な場合にも検証されます。
CSharper 2017

私はこの答えが好きです
KTOV 2018年

1
ここでの作業例:jasonwatmore.com/post/2018/09/08/...
bside

私はこれが答えであると思います。これにより、ソリューションの上位で標準の承認/許可属性を使用できるようになります。その次に、プロジェクトのフェーズの後半で別の認証スキームが必要な場合に簡単に使用できるはずです
Frederik Gheysels

0

このパブリックGithubリポジトリ https://github.com/boskjoett/BasicAuthWebApi には、基本認証で保護されたエンドポイントを持つASP.NET Core 2.2 Web APIの簡単な例があります。


コントローラー(SecureValuesController)で認証済みIDを使用する場合は、Request.Userオブジェクトが空であるため、チケットを作成するだけでは不十分です。このClaimsPrincipalをAuthenticationHandlerの現在のコンテキストに割り当てる必要がありますか?これが、以前のWebApiで行った方法です
。– pseabury

0

以前の投稿で正しく述べられているように、1つの方法は、カスタムの基本認証ミドルウェアを実装することです。私はこのブログで説明付きの最も効果的なコードを見つけました: カスタムミドルウェアを使用した基本認証

私は同じブログを参照しましたが、2つの適応を行わなければなりませんでした:

  1. スタートアップファイルにミドルウェアを追加するとき->構成機能、a​​pp.UseMvc()を追加する前に必ずカスタムミドルウェアを追加してください。
  2. appsettings.jsonファイルからユーザー名とパスワードを読み取るときに、静的な読み取り専用プロパティをスタートアップファイルに追加します。次にappsettings.jsonから読み取ります。最後に、プロジェクトのどこからでも値を読み取ります。例:

    public class Startup
    {
      public Startup(IConfiguration configuration)
      {
        Configuration = configuration;
      }
    
      public IConfiguration Configuration { get; }
      public static string UserNameFromAppSettings { get; private set; }
      public static string PasswordFromAppSettings { get; private set; }
    
      //set username and password from appsettings.json
      UserNameFromAppSettings = Configuration.GetSection("BasicAuth").GetSection("UserName").Value;
      PasswordFromAppSettings = Configuration.GetSection("BasicAuth").GetSection("Password").Value;
    }
    

0

あなたは使うことができます ActionFilterAttribute

public class BasicAuthAttribute : ActionFilterAttribute
{
    public string BasicRealm { get; set; }
    protected NetworkCredential Nc { get; set; }

    public BasicAuthAttribute(string user,string pass)
    {
        this.Nc = new NetworkCredential(user,pass);
    }

    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        var req = filterContext.HttpContext.Request;
        var auth = req.Headers["Authorization"].ToString();
        if (!String.IsNullOrEmpty(auth))
        {
            var cred = System.Text.Encoding.UTF8.GetString(Convert.FromBase64String(auth.Substring(6)))
                .Split(':');
            var user = new {Name = cred[0], Pass = cred[1]};
            if (user.Name == Nc.UserName && user.Pass == Nc.Password) return;
        }

        filterContext.HttpContext.Response.Headers.Add("WWW-Authenticate",
            String.Format("Basic realm=\"{0}\"", BasicRealm ?? "Ryadel"));
        filterContext.Result = new UnauthorizedResult();
    }
}

そしてコントローラに属性を追加します

[BasicAuth("USR", "MyPassword")]


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.