Аутентификация на основе токенов в ядре ASP.NET

Ответ 1

Обновлено для.Net Core 2:

Предыдущие версии этого ответа использовали RSA; это действительно не нужно, если ваш код, который генерирует токены, также проверяет токены. Однако, если вы распределяете ответственность, вы, вероятно, все еще хотите сделать это, используя экземпляр Microsoft.IdentityModel.Tokens.RsaSecurityKey.

1. Создайте несколько констант, которые мы будем использовать позже; вот что я сделал:

   const string TokenAudience = "Myself";
   const string TokenIssuer = "MyProject";
   

2. Добавьте это в свой Startup.cs ConfigureServices. Мы будем использовать внедрение зависимостей позже для доступа к этим настройкам. Я предполагаю, что ваша authenticationConfiguration является объектом ConfigurationSection или Configuration, так что вы можете иметь другую конфигурацию для отладки и производства. Убедитесь, что вы храните свой ключ надежно! Это может быть любая строка.

   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;
       });
   

   Я видел, как другие ответы меняли другие настройки, такие как ClockSkew; Значения по умолчанию установлены так, что они должны работать для распределенных сред, часы которых не синхронизированы. Это единственные настройки, которые вам нужно изменить.

3. Настройте Аутентификацию. Эта строка должна быть перед любым промежуточным программным обеспечением, для которого требуется информация о User, например app.UseMvc().

   app.UseAuthentication();
   

   Обратите внимание, что это не приведет к SignInManager вашего токена с помощью SignInManager или чего-либо еще. Вам нужно будет предоставить собственный механизм вывода вашего JWT - см. Ниже.

4. Вы можете указать AuthorizationPolicy. Это позволит вам указать контроллеры и действия, которые разрешают только токены Bearer в качестве аутентификации с использованием [Authorize("Bearer")].

   services.AddAuthorization(auth =>
   {
       auth.AddPolicy("Bearer", new AuthorizationPolicyBuilder()
           .AddAuthenticationTypes(JwtBearerDefaults.AuthenticationType)
           .RequireAuthenticatedUser().Build());
   });
   

5. Здесь начинается сложная часть: создание токена.

   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);
       }
   }
   

   Затем в вашем контроллере, где вы хотите свой токен, что-то вроде следующего:

   [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);
   }
   

   Здесь, я полагаю, у вас уже есть директор. Если вы используете Identity, вы можете использовать IUserClaimsPrincipalFactory<> чтобы преобразовать вашего User в ClaimsPrincipal.

6. Чтобы проверить это: получите токен, поместите его в форму на jwt.io. Инструкции, которые я предоставил выше, также позволяют вам использовать секрет из вашей конфигурации для проверки подписи!

7. Если вы представляли это в виде частичного представления на своей HTML-странице в сочетании с аутентификацией только на предъявителя в.Net 4.5, теперь вы можете использовать ViewComponent чтобы сделать то же самое. Это в основном так же, как код действия контроллера выше.

Ответ 2

Работая с невероятным ответом Мэтта Декрея, я создал полностью рабочий пример аутентификации на основе токенов, работающей с ASP.NET Core (1.0.1). Вы можете найти полный код в этом репозитории на GitHub (альтернативные ветки для 1.0.0-rc1, beta8, beta7), но вкратце, важными шагами являются:

Создать ключ для вашего приложения

В моем примере я генерирую случайный ключ каждый раз, когда запускается приложение, вам нужно будет сгенерировать его, сохранить где-нибудь и предоставить его вашему приложению. Посмотрите этот файл, чтобы узнать, как я генерирую случайный ключ и как вы можете импортировать его из файла.json. Как предложено в комментариях @kspearrin, API защиты данных кажется идеальным кандидатом для "правильного" управления ключами, но я пока не решил, насколько это возможно. Пожалуйста, отправьте запрос, если вы решите это!

Startup.cs - ConfigureServices

Здесь нам нужно загрузить закрытый ключ для подписи наших токенов, который мы также будем использовать для проверки токенов по мере их представления. Мы хранение ключа в переменном классе уровня key, который мы будем повторно использовать в методе Configure ниже. TokenAuthOptions - это простой класс, который содержит подписывающую личность, аудиторию и издателя, которые нам понадобятся в TokenController для создания наших ключей.

// 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());
});

Мы также настроили политику авторизации, чтобы позволить нам использовать [Authorize("Bearer")] на конечных точках и классах, которые мы хотим защитить.

Startup.cs - настроить

Здесь нам нужно настроить аутентификацию JwtBearer:

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

В контроллере токенов необходимо иметь метод для генерации подписанных ключей с использованием ключа, который был загружен в Startup.cs. Мы зарегистрировали экземпляр TokenAuthOptions в автозагрузке, поэтому нам нужно внедрить его в конструктор TokenController:

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

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

Затем вам нужно сгенерировать токен в вашем обработчике для конечной точки входа в систему, в моем примере я беру имя пользователя и пароль и проверяю их с помощью оператора if, но главное, что вам нужно сделать, это создать или загрузить заявку на основе личности и сгенерировать токен для этого:

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);
}

И это должно быть так. Просто добавьте [Authorize("Bearer")] к любому методу или классу, который вы хотите защитить, и вы получите сообщение об ошибке, если попытаетесь получить к нему доступ без маркера. Если вы хотите вернуть ошибку 401 вместо ошибки 500, вам нужно зарегистрировать пользовательский обработчик исключений, как в моем примере здесь.

Ответ 3

Вы можете посмотреть образцы подключения OpenId, которые иллюстрируют, как обращаться с различными механизмами аутентификации, включая токены JWT:

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

Если вы посмотрите проект Cordova Backend, конфигурация для API будет такой:

           // 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"
            });
        });

Логика в /Providers/AuthorizationProvider.cs и RessourceController этого проекта также стоит взглянуть на;).

В качестве альтернативы вы также можете использовать следующий код для проверки токенов (есть также фрагмент, чтобы заставить его работать с signalR):

        // 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);
                }
            };
        });

Для выдачи токена вы можете использовать пакеты сервера openId Connect следующим образом:

        // 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 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...;
        });

EDIT: я реализовал одностраничное приложение с реализацией аутентификации на основе токенов, используя фреймворк Aurelia и ядро ​​ASP.NET. Существует также постоянное соединение R-сигнала. Однако я не выполнил никакой реализации БД. Код можно увидеть здесь: https://github.com/alexandre-spieser/AureliaAspNetCoreAuth

Надеюсь, что это поможет,

Бест,

Алекс

Ответ 4

Взгляните на OpenIddict - это новый проект (на момент написания), который упрощает настройку создания токенов JWT и токенов обновления в ASP.NET 5. Проверка маркеров обрабатывается другим программным обеспечением.

Предполагая, что вы используете Identity с Entity Framework, последняя строка - это то, что вы добавили бы к вашему методу ConfigureServices:

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

В Configure вы настроили OpenIddict для подачи токенов JWT:

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;
});

Вы также настраиваете проверку токенов в 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/";
});

Есть одна или две другие незначительные вещи, например, ваш DbContext должен выводиться из OpenIddictContext.

В этом блоге вы можете увидеть полное объяснение: http://capesean.co.za/blog/asp-net-5-jwt-tokens/

Функциональная демонстрация доступна по адресу: https://github.com/capesean/openiddict-test