web-dev-qa-db-ger.com

Token-basierte Authentifizierung in ASP.NET Core

Ich arbeite mit ASP.NET Core-Anwendung. Ich versuche, die Token-basierte Authentifizierung zu implementieren, kann jedoch nicht herausfinden, wie new Security System für meinen Fall verwendet wird. Ich habe Beispiele durchgearbeitet, aber sie haben mir nicht viel geholfen. Sie verwenden entweder die Cookie-Authentifizierung oder die externe Authentifizierung (GitHub, Microsoft, Twitter).

Was mein Szenario ist: anglejs Anwendung sollte /token URL anfordern, die Benutzername und Passwort übergibt. WebApi sollte den Benutzer autorisieren und access_token Zurückgeben, das von der anglejs-App bei folgenden Anfragen verwendet wird.

Ich habe einen großartigen Artikel über die Implementierung genau dessen gefunden, was ich in der aktuellen Version von ASP.NET benötige - Token-basierte Authentifizierung mit ASP.NET Web API 2, Owin und Identity . Mir ist jedoch nicht klar, wie ich dasselbe in ASP.NET Core tun soll.

Meine Frage lautet: Wie konfiguriere ich die ASP.NET Core-WebApi-Anwendung für die tokenbasierte Authentifizierung?

153
Grant

Aktualisiert für .Net Core 2:

Frühere Versionen dieser Antwort verwendeten RSA. Es ist wirklich nicht notwendig, wenn derselbe Code, der die Token generiert, auch die Token überprüft. Wenn Sie jedoch die Verantwortung verteilen, möchten Sie dies wahrscheinlich immer noch mit einer Instanz von Microsoft.IdentityModel.Tokens.RsaSecurityKey Tun.

  1. Erstellen Sie einige Konstanten, die wir später verwenden werden. Folgendes habe ich getan:

    const string TokenAudience = "Myself";
    const string TokenIssuer = "MyProject";
    
  2. Fügen Sie dies dem ConfigureServices Ihrer Startup.cs hinzu. Wir werden später die Abhängigkeitsinjektion verwenden, um auf diese Einstellungen zuzugreifen. Ich gehe davon aus, dass Ihr authenticationConfiguration ein ConfigurationSection oder Configuration -Objekt ist, sodass Sie für Debug und Produktion eine andere Konfiguration haben können. Stellen Sie sicher, dass Sie Ihren Schlüssel sicher aufbewahren! Es kann eine beliebige Zeichenfolge sein.

    var keySecret = authenticationConfiguration["JwtSigningKey"];
    var symmetricKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(keySecret));
    
    services.AddTransient(_ => new JwtSignInHandler(symmetricKey));
    
    services.AddAuthentication(options =>
    {
        // This causes the default authentication scheme to be JWT.
        // Without this, the Authorization header is not checked and
        // you'll get no results. However, this also means that if
        // you're already using cookies in your app, they won't be 
        // checked by default.
        options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
    })
        .AddJwtBearer(options =>
        {
            options.TokenValidationParameters.ValidateIssuerSigningKey = true;
            options.TokenValidationParameters.IssuerSigningKey = symmetricKey;
            options.TokenValidationParameters.ValidAudience = JwtSignInHandler.TokenAudience;
            options.TokenValidationParameters.ValidIssuer = JwtSignInHandler.TokenIssuer;
        });
    

    Ich habe andere Antworten gesehen, die andere Einstellungen geändert haben, z. B. ClockSkew; Die Standardeinstellungen sind so festgelegt, dass sie für verteilte Umgebungen funktionieren sollten, deren Uhren nicht genau synchron sind. Dies sind die einzigen Einstellungen, die Sie ändern müssen.

  3. Richten Sie die Authentifizierung ein. Diese Zeile sollte vor jeder Middleware stehen, für die Ihre User -Informationen erforderlich sind, z. B. app.UseMvc().

    app.UseAuthentication();
    

    Beachten Sie, dass dies nicht dazu führt, dass Ihr Token mit dem SignInManager oder etwas anderem ausgegeben wird. Sie müssen Ihren eigenen Mechanismus für die Ausgabe Ihres JWT bereitstellen - siehe unten.

  4. Möglicherweise möchten Sie ein AuthorizationPolicy angeben. Auf diese Weise können Sie Controller und Aktionen angeben, die nur Inhaber-Token als Authentifizierung mithilfe von [Authorize("Bearer")] zulassen.

    services.AddAuthorization(auth =>
    {
        auth.AddPolicy("Bearer", new AuthorizationPolicyBuilder()
            .AddAuthenticationTypes(JwtBearerDefaults.AuthenticationType)
            .RequireAuthenticatedUser().Build());
    });
    
  5. Hier kommt der knifflige Teil: das Bauen des Tokens.

    class JwtSignInHandler
    {
        public const string TokenAudience = "Myself";
        public const string TokenIssuer = "MyProject";
        private readonly SymmetricSecurityKey key;
    
        public JwtSignInHandler(SymmetricSecurityKey symmetricKey)
        {
            this.key = symmetricKey;
        }
    
        public string BuildJwt(ClaimsPrincipal principal)
        {
            var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);
    
            var token = new JwtSecurityToken(
                issuer: TokenIssuer,
                audience: TokenAudience,
                claims: principal.Claims,
                expires: DateTime.Now.AddMinutes(20),
                signingCredentials: creds
            );
    
            return new JwtSecurityTokenHandler().WriteToken(token);
        }
    }
    

    Dann, in Ihrem Controller, wo Sie Ihr Token möchten, etwas wie das folgende:

    [HttpPost]
    public string AnonymousSignIn([FromServices] JwtSignInHandler tokenFactory)
    {
        var principal = new System.Security.Claims.ClaimsPrincipal(new[]
        {
            new System.Security.Claims.ClaimsIdentity(new[]
            {
                new System.Security.Claims.Claim(System.Security.Claims.ClaimTypes.Name, "Demo User")
            })
        });
        return tokenFactory.BuildJwt(principal);
    }
    

    Ich gehe davon aus, dass Sie bereits einen Schulleiter haben. Wenn Sie Identity verwenden, können Sie IUserClaimsPrincipalFactory<> verwenden, um Ihr User in ein ClaimsPrincipal umzuwandeln.

  6. Um es zu testen : Holen Sie sich ein Token, legen Sie es in das Formular bei jwt.io . Mit den Anweisungen, die ich oben angegeben habe, können Sie auch das Geheimnis Ihrer Konfiguration verwenden, um die Signatur zu validieren!

  7. Wenn Sie dies in einer Teilansicht auf Ihrer HTML-Seite in Kombination mit der Nur-Inhaber-Authentifizierung in .Net 4.5 rendern, können Sie jetzt ein ViewComponent verwenden, um dasselbe zu tun. Es ist größtenteils dasselbe wie der obige Controller-Aktionscode.

127
Matt DeKrey

Ausgehend von Matt Dekreys fabelhafte Antwort habe ich ein voll funktionsfähiges Beispiel für die tokenbasierte Authentifizierung erstellt, das mit ASP.NET Core (1.0.1) funktioniert. Sie finden den vollständigen Code in diesem Repository auf GitHub (alternative Verzweigungen für 1.0.0-rc1 , beta8 , beta7 ), aber in Kürze sind die wichtigen Schritte:

Generieren Sie einen Schlüssel für Ihre Anwendung

In meinem Beispiel muss jedes Mal, wenn die App gestartet wird, ein zufälliger Schlüssel generiert werden, der irgendwo gespeichert und Ihrer Anwendung zur Verfügung gestellt werden muss. In dieser Datei erfahren Sie, wie ich einen zufälligen Schlüssel generiere und wie Sie ihn aus einer .json-Datei importieren können. . Wie in den Kommentaren von @kspearrin vorgeschlagen, scheint Data Protection API ein idealer Kandidat für die "richtige" Verwaltung der Schlüssel zu sein, aber ich habe noch nicht herausgefunden, ob dies möglich ist. Bitte senden Sie eine Pull-Anfrage, wenn Sie es herausfinden!

Startup.cs - ConfigureServices

Hier müssen wir einen privaten Schlüssel laden, mit dem unsere Token signiert werden sollen. Mit diesem Schlüssel überprüfen wir auch, ob die Token angezeigt werden. Wir speichern den Schlüssel in einer Variablen auf Klassenebene key, die wir in der unten stehenden Configure-Methode wiederverwenden. TokenAuthOptions ist eine einfache Klasse, die die Signaturidentität, die Zielgruppe und den Aussteller enthält, die wir im TokenController zum Erstellen unserer Schlüssel benötigen.

// Replace this with some sort of loading from config / file.
RSAParameters keyParams = RSAKeyUtils.GetRandomKey();

// Create the key, and a set of token options to record signing credentials 
// using that key, along with the other parameters we will need in the 
// token controlller.
key = new RsaSecurityKey(keyParams);
tokenOptions = new TokenAuthOptions()
{
    Audience = TokenAudience,
    Issuer = TokenIssuer,
    SigningCredentials = new SigningCredentials(key, SecurityAlgorithms.Sha256Digest)
};

// Save the token options into an instance so they're accessible to the 
// controller.
services.AddSingleton<TokenAuthOptions>(tokenOptions);

// Enable the use of an [Authorize("Bearer")] attribute on methods and
// classes to protect.
services.AddAuthorization(auth =>
{
    auth.AddPolicy("Bearer", new AuthorizationPolicyBuilder()
        .AddAuthenticationSchemes(JwtBearerDefaults.AuthenticationScheme‌​)
        .RequireAuthenticatedUser().Build());
});

Wir haben auch eine Autorisierungsrichtlinie eingerichtet, mit der wir [Authorize("Bearer")] für die Endpunkte und Klassen verwenden können, die wir schützen möchten.

Startup.cs - Konfigurieren

Hier müssen wir die JwtBearerAuthentication konfigurieren:

app.UseJwtBearerAuthentication(new JwtBearerOptions {
    TokenValidationParameters = new TokenValidationParameters {
        IssuerSigningKey = key,
        ValidAudience = tokenOptions.Audience,
        ValidIssuer = tokenOptions.Issuer,

        // When receiving a token, check that it is still valid.
        ValidateLifetime = true,

        // This defines the maximum allowable clock skew - i.e.
        // provides a tolerance on the token expiry time 
        // when validating the lifetime. As we're creating the tokens 
        // locally and validating them on the same machines which 
        // should have synchronised time, this can be set to zero. 
        // Where external tokens are used, some leeway here could be 
        // useful.
        ClockSkew = TimeSpan.FromMinutes(0)
    }
});

TokenController

Im Token-Controller benötigen Sie eine Methode zum Generieren signierter Schlüssel mit dem in Startup.cs geladenen Schlüssel. Wir haben eine TokenAuthOptions-Instanz in Startup registriert, daher müssen wir diese im Konstruktor für TokenController einfügen:

[Route("api/[controller]")]
public class TokenController : Controller
{
    private readonly TokenAuthOptions tokenOptions;

    public TokenController(TokenAuthOptions tokenOptions)
    {
        this.tokenOptions = tokenOptions;
    }
...

Dann müssen Sie das Token in Ihrem Handler für den Anmeldeendpunkt generieren. In meinem Beispiel verwende ich einen Benutzernamen und ein Kennwort und validiere diese mit einer if-Anweisung. Der Schlüssel, den Sie tun müssen, ist jedoch, Ansprüche zu erstellen oder zu laden -basierte Identität und generieren Sie das Token dafür:

public class AuthRequest
{
    public string username { get; set; }
    public string password { get; set; }
}

/// <summary>
/// Request a new token for a given username/password pair.
/// </summary>
/// <param name="req"></param>
/// <returns></returns>
[HttpPost]
public dynamic Post([FromBody] AuthRequest req)
{
    // Obviously, at this point you need to validate the username and password against whatever system you wish.
    if ((req.username == "TEST" && req.password == "TEST") || (req.username == "TEST2" && req.password == "TEST"))
    {
        DateTime? expires = DateTime.UtcNow.AddMinutes(2);
        var token = GetToken(req.username, expires);
        return new { authenticated = true, entityId = 1, token = token, tokenExpires = expires };
    }
    return new { authenticated = false };
}

private string GetToken(string user, DateTime? expires)
{
    var handler = new JwtSecurityTokenHandler();

    // Here, you should create or look up an identity for the user which is being authenticated.
    // For now, just creating a simple generic identity.
    ClaimsIdentity identity = new ClaimsIdentity(new GenericIdentity(user, "TokenAuth"), new[] { new Claim("EntityID", "1", ClaimValueTypes.Integer) });

    var securityToken = handler.CreateToken(new Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor() {
        Issuer = tokenOptions.Issuer,
        Audience = tokenOptions.Audience,
        SigningCredentials = tokenOptions.SigningCredentials,
        Subject = identity,
        Expires = expires
    });
    return handler.WriteToken(securityToken);
}

Und das sollte es sein. Fügen Sie einfach [Authorize("Bearer")] zu einer Methode oder Klasse hinzu, die Sie schützen möchten, und Sie sollten eine Fehlermeldung erhalten, wenn Sie versuchen, auf sie zuzugreifen, ohne dass ein Token vorhanden ist. Wenn Sie einen 401-Fehler anstelle eines 500-Fehlers zurückgeben möchten, müssen Sie einen benutzerdefinierten Ausnahmehandler registrieren wie in meinem Beispiel hier .

80
Mark Hughes

Sie können sich die OpenId-Connect-Beispiele ansehen, die veranschaulichen, wie mit verschiedenen Authentifizierungsmechanismen, einschließlich JWT-Tokens, umgegangen wird:

https://github.com/aspnet-contrib/AspNet.Security.OpenIdConnect.Samples

Wenn Sie sich das Cordova Backend-Projekt ansehen, sieht die Konfiguration für die API folgendermaßen aus:

           // Create a new branch where the registered middleware will be executed only for non API calls.
        app.UseWhen(context => !context.Request.Path.StartsWithSegments(new PathString("/api")), branch => {
            // Insert a new cookies middleware in the pipeline to store
            // the user identity returned by the external identity provider.
            branch.UseCookieAuthentication(new CookieAuthenticationOptions {
                AutomaticAuthenticate = true,
                AutomaticChallenge = true,
                AuthenticationScheme = "ServerCookie",
                CookieName = CookieAuthenticationDefaults.CookiePrefix + "ServerCookie",
                ExpireTimeSpan = TimeSpan.FromMinutes(5),
                LoginPath = new PathString("/signin"),
                LogoutPath = new PathString("/signout")
            });

            branch.UseGoogleAuthentication(new GoogleOptions {
                ClientId = "560027070069-37ldt4kfuohhu3m495hk2j4pjp92d382.apps.googleusercontent.com",
                ClientSecret = "n2Q-GEw9RQjzcRbU3qhfTj8f"
            });

            branch.UseTwitterAuthentication(new TwitterOptions {
                ConsumerKey = "6XaCTaLbMqfj6ww3zvZ5g",
                ConsumerSecret = "Il2eFzGIrYhz6BWjYhVXBPQSfZuS4xoHpSSyD9PI"
            });
        });

Die Logik in /Providers/AuthorizationProvider.cs und der RessourceController dieses Projekts sind ebenfalls einen Blick wert;).

Alternativ können Sie auch den folgenden Code verwenden, um Token zu validieren (es gibt auch ein Snippet, damit es mit signalR funktioniert):

        // Add a new middleware validating access tokens.
        app.UseOAuthValidation(options =>
        {
            // Automatic authentication must be enabled
            // for SignalR to receive the access token.
            options.AutomaticAuthenticate = true;

            options.Events = new OAuthValidationEvents
            {
                // Note: for SignalR connections, the default Authorization header does not work,
                // because the WebSockets JS API doesn't allow setting custom parameters.
                // To work around this limitation, the access token is retrieved from the query string.
                OnRetrieveToken = context =>
                {
                    // Note: when the token is missing from the query string,
                    // context.Token is null and the JWT bearer middleware will
                    // automatically try to retrieve it from the Authorization header.
                    context.Token = context.Request.Query["access_token"];

                    return Task.FromResult(0);
                }
            };
        });

Zum Ausstellen des Tokens können Sie die openId Connect-Serverpakete wie folgt verwenden:

        // Add a new middleware issuing access tokens.
        app.UseOpenIdConnectServer(options =>
        {
            options.Provider = new AuthenticationProvider();
            // Enable the authorization, logout, token and userinfo endpoints.
            //options.AuthorizationEndpointPath = "/connect/authorize";
            //options.LogoutEndpointPath = "/connect/logout";
            options.TokenEndpointPath = "/connect/token";
            //options.UserinfoEndpointPath = "/connect/userinfo";

            // Note: if you don't explicitly register a signing key, one is automatically generated and
            // persisted on the disk. If the key cannot be persisted, an exception is thrown.
            // 
            // On production, using a X.509 certificate stored in the machine store is recommended.
            // You can generate a self-signed certificate using Pluralsight's self-cert utility:
            // https://s3.amazonaws.com/pluralsight-free/keith-brown/samples/SelfCert.Zip
            // 
            // options.SigningCredentials.AddCertificate("7D2A741FE34CC2C7369237A5F2078988E17A6A75");
            // 
            // Alternatively, you can also store the certificate as an embedded .pfx resource
            // directly in this Assembly or in a file published alongside this project:
            // 
            // options.SigningCredentials.AddCertificate(
            //     Assembly: typeof(Startup).GetTypeInfo().Assembly,
            //     resource: "Nancy.Server.Certificate.pfx",
            //     password: "Owin.Security.OpenIdConnect.Server");

            // Note: see AuthorizationController.cs for more
            // information concerning ApplicationCanDisplayErrors.
            options.ApplicationCanDisplayErrors = true // in dev only ...;
            options.AllowInsecureHttp = true // in dev only...;
        });

BEARBEITEN: Ich habe eine Einzelseitenanwendung mit Token-basierter Authentifizierungsimplementierung unter Verwendung des Aurelia-Front-End-Frameworks und des ASP.NET-Kerns implementiert. Es besteht auch eine Signal-R-Verbindung. Ich habe jedoch keine DB-Implementierung durchgeführt. Code kann hier eingesehen werden: https://github.com/alexandre-spieser/AureliaAspNetCoreAuth

Hoffe das hilft,

Beste,

Alex

3
Darxtar

Werfen Sie einen Blick auf OpenIddict - es ist ein neues Projekt (zum Zeitpunkt des Schreibens), mit dem die Erstellung von JWT-Token und die Aktualisierung von Token in ASP.NET 5 auf einfache Weise konfiguriert werden können. Die Validierung der Token wird von einer anderen Software durchgeführt.

Angenommen, Sie verwenden Identity mit Entity Framework, die letzte Zeile ist das, was Sie Ihrer ConfigureServices -Methode hinzufügen möchten:

services.AddIdentity<ApplicationUser, ApplicationRole>()
    .AddEntityFrameworkStores<ApplicationDbContext>()
    .AddDefaultTokenProviders()
    .AddOpenIddictCore<Application>(config => config.UseEntityFramework());

In Configure richten Sie OpenIddict ein, um JWT-Token bereitzustellen:

app.UseOpenIddictCore(builder =>
{
    // tell openiddict you're wanting to use jwt tokens
    builder.Options.UseJwtTokens();
    // NOTE: for dev consumption only! for live, this is not encouraged!
    builder.Options.AllowInsecureHttp = true;
    builder.Options.ApplicationCanDisplayErrors = true;
});

Sie konfigurieren auch die Validierung von Tokens in Configure:

// use jwt bearer authentication
app.UseJwtBearerAuthentication(options =>
{
    options.AutomaticAuthenticate = true;
    options.AutomaticChallenge = true;
    options.RequireHttpsMetadata = false;
    options.Audience = "http://localhost:58292/";
    options.Authority = "http://localhost:58292/";
});

Es gibt ein oder zwei andere kleinere Dinge, wie zum Beispiel, dass Ihr DbContext von OpenIddictContext abgeleitet werden muss.

Eine ausführliche Erklärung finden Sie in diesem Blog-Beitrag: http://capesean.co.za/blog/asp-net-5-jwt-tokens/

Eine funktionierende Demo finden Sie unter: https://github.com/capesean/openiddict-test

1
Sean