Autenticação baseada em token no ASP.NET Core

161

Estou trabalhando com o aplicativo ASP.NET Core. Estou tentando implementar a autenticação baseada em token, mas não consigo descobrir como usar o novo sistema de segurança no meu caso. Passei por exemplos, mas eles não me ajudaram muito, estão usando autenticação de cookie ou autenticação externa (GitHub, Microsoft, Twitter).

Qual é o meu cenário: o aplicativo angularjs deve solicitar o /tokenURL que passa o nome de usuário e a senha. O WebApi deve autorizar o usuário e o retorno, access_tokenque serão usados ​​pelo aplicativo angularjs nas seguintes solicitações.

Encontrei um excelente artigo sobre como implementar exatamente o que eu preciso na versão atual do ASP.NET - Autenticação baseada em token usando a API da Web 2 do ASP.NET, Owin e Identidade . Mas não é óbvio para mim como fazer a mesma coisa no ASP.NET Core.

Minha pergunta é: como configurar o aplicativo ASP.NET Core WebApi para funcionar com autenticação baseada em token?

Conceder
fonte
Eu tendo o mesmo problema e eu estava planejando em fazer tudo o que eu mesmo, FYI há uma outra questão stackoverflow.com/questions/29055477/... mas ainda não anserw, vamos ver o que acontece
Son_of_Sam
Também estou enfrentando o mesmo problema, mas ainda não consegui encontrar uma solução ... Preciso escrever uma autenticação personalizada usando outro serviço que autentique meu token.
Mayank Gupta

Respostas:

137

Atualização para .Net Core 3.1:

David Fowler (arquiteto da equipe do ASP .NET Core) reuniu um conjunto incrivelmente simples de aplicativos de tarefas, incluindo um aplicativo simples que demonstra o JWT . Em breve, incorporarei suas atualizações e seu estilo simplista.

Atualizado para .Net Core 2:

Versões anteriores desta resposta usavam RSA; realmente não é necessário se o mesmo código que está gerando os tokens também estiver verificando os tokens. No entanto, se você estiver distribuindo a responsabilidade, provavelmente ainda desejará fazer isso usando uma instância de Microsoft.IdentityModel.Tokens.RsaSecurityKey.

  1. Crie algumas constantes que usaremos mais tarde; aqui está o que eu fiz:

    const string TokenAudience = "Myself";
    const string TokenIssuer = "MyProject";
  2. Adicione isso ao seu Startup.cs ConfigureServices. Usaremos a injeção de dependência posteriormente para acessar essas configurações. Estou assumindo que você authenticationConfigurationé um ConfigurationSectionou um Configurationobjeto que pode ter uma configuração diferente para depuração e produção. Guarde sua chave com segurança! Pode ser qualquer string.

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

    Eu já vi outras respostas alterar outras configurações, como ClockSkew; os padrões são definidos de forma que funcionem em ambientes distribuídos cujos relógios não estejam exatamente sincronizados. Essas são as únicas configurações que você precisa alterar.

  3. Configure a autenticação. Você deve ter essa linha antes de qualquer middleware que exija suas Userinformações, como app.UseMvc().

    app.UseAuthentication();

    Observe que isso não fará com que seu token seja emitido com o SignInManagerou qualquer outra coisa. Você precisará fornecer seu próprio mecanismo para produzir seu JWT - veja abaixo.

  4. Você pode especificar um AuthorizationPolicy. Isso permitirá que você especifique controladores e ações que permitem apenas tokens do Bearer como autenticação usando [Authorize("Bearer")].

    services.AddAuthorization(auth =>
    {
        auth.AddPolicy("Bearer", new AuthorizationPolicyBuilder()
            .AddAuthenticationTypes(JwtBearerDefaults.AuthenticationType)
            .RequireAuthenticatedUser().Build());
    });
  5. Aí vem a parte complicada: construir o token.

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

    Em seguida, no seu controlador onde você deseja seu token, algo como o seguinte:

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

    Aqui, suponho que você já tenha um diretor. Se você estiver usando o Identity, poderá IUserClaimsPrincipalFactory<>transformá-lo Userem um ClaimsPrincipal.

  6. Para testá-lo : obter um token, colocá-lo em forma de jwt.io . As instruções que forneci acima também permitem que você use o segredo da sua configuração para validar a assinatura!

  7. Se você estava renderizando isso em uma exibição parcial na sua página HTML em combinação com a autenticação somente do portador no .Net 4.5, agora você pode usar a ViewComponentpara fazer o mesmo. É basicamente o mesmo que o código de Ação do Controlador acima.

Matt DeKrey
fonte
1
Você precisará realmente injetar IOptions<OAuthBearerAuthenticationOptions>para usar as Opções; o uso de um objeto Options diretamente não é suportado devido à configuração nomeada suportada pela estrutura do Modelo de Opções.
Matt DeKrey
2
Atualizado para o que estou usando, mas agora a resposta deve ser reescrita. Obrigado por me cutucar!
Matt DeKrey
5
O número 5 foi alterado para o seguinte no Microsoft.AspNet.Authentication.OAuthBearer - beta 5 - 6 e possivelmente betas anteriores, mas não os confirmaram. auth.AddPolicy ("Bearer", new AuthorizationPolicyBuilder () .AddAuthenticationSchemes (OAuthBearerAuthenticationDefaults.AuthenticationScheme) .RequireAuthenticatedUser (). Build ());
dynamiclynk
5
@MattDeKrey Usei esta resposta como ponto de partida para um exemplo de autenticação simples baseada em token e a atualizei para o beta 7 - consulte github.com/mrsheepuk/ASPNETSelfCreatedTokenAuthExample - também incorpora alguns dos ponteiros desses comentários.
Mark Hughes
2
Atualizado novamente para RC1 - versões antigas para Beta7 e beta8 disponível em filiais no GitHub.
Mark Hughes
83

Trabalhando com a fabulosa resposta de Matt Dekrey , criei um exemplo completo de autenticação baseada em token, trabalhando no ASP.NET Core (1.0.1). Você pode encontrar o código completo neste repositório no GitHub (ramificações alternativas para 1.0.0-rc1 , beta8 , beta7 ), mas, resumidamente, as etapas importantes são:

Gere uma chave para seu aplicativo

No meu exemplo, eu gero uma chave aleatória cada vez que o aplicativo é iniciado, você precisa gerar uma e armazená-la em algum lugar e fornecê-la ao seu aplicativo. Veja este arquivo para saber como estou gerando uma chave aleatória e como você pode importá-la de um arquivo .json . Conforme sugerido nos comentários de @kspearrin, a API de proteção de dados parece ser um candidato ideal para gerenciar as chaves "corretamente", mas ainda não resolvi se isso é possível. Envie uma solicitação de recebimento se você trabalhar com isso!

Startup.cs - ConfigureServices

Aqui, precisamos carregar uma chave privada para que nossos tokens sejam assinados, os quais também usaremos para verificar os tokens conforme eles são apresentados. Estamos armazenando a chave em uma variável em nível de classe keyque reutilizaremos no método Configure abaixo. TokenAuthOptions é uma classe simples que contém a identidade de assinatura, o público e o emissor que precisaremos no TokenController para criar nossas chaves.

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

Também estabelecemos uma política de autorização para permitir o uso [Authorize("Bearer")]nos pontos de extremidade e classes que desejamos proteger.

Startup.cs - Configurar

Aqui, precisamos configurar o JwtBearerAuthentication:

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

No controlador de token, você precisa ter um método para gerar chaves assinadas usando a chave que foi carregada no Startup.cs. Como registramos uma instância TokenAuthOptions na inicialização, precisamos injetar isso no construtor do TokenController:

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

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

Em seguida, você precisará gerar o token em seu manipulador para o terminal de logon. No meu exemplo, estou usando um nome de usuário e uma senha e validando aqueles usando uma instrução if, mas a principal coisa que você precisa fazer é criar ou carregar uma declaração baseada em identidade e gere o token para isso:

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

E deve ser isso. Basta adicionar [Authorize("Bearer")]a qualquer método ou classe que você deseja proteger e você receberá um erro se tentar acessá-lo sem a presença de um token. Se você deseja retornar um erro 401 em vez de 500, será necessário registrar um manipulador de exceção personalizado, como eu tenho no meu exemplo aqui .

Mark Hughes
fonte
1
Este é um exemplo realmente excelente e incluiu todas as peças que faltava para que o exemplo de @ MattDeKrey funcionasse, muito obrigado! Observe que qualquer pessoa que ainda esteja segmentando beta7 em vez de beta8 ainda pode encontrar esse exemplo no histórico
nickspoon 19/10/2015
1
Que bom que ajudou a @nickspoon - se você tiver algum problema, informe-me ou envie uma solicitação pull no github e eu atualizo!
Mark Hughes #
2
Obrigado por isso, no entanto, não entendo muito bem por que algo que funcionou imediatamente na API da Web do ASP.Net 4 agora requer um pouco de configuração no ASP.Net 5. Parece um retrocesso.
JMK
1
Eu acho que eles estão realmente pressionando a "autenticação social" para o ASP.NET 5, o que faz algum sentido, suponho, mas há aplicativos que não são apropriados, então não tenho certeza se concordo com a direção deles @JMK
Mark Hughes
1
@YuriyP Preciso atualizar esta resposta para o RC2 - ainda não atualizei nosso aplicativo interno que o utiliza para o RC2, por isso não tenho certeza do que está envolvido. Eu vou atualizar depois de já ter trabalhado a diferença ...
Mark Hughes
3

Você pode dar uma olhada nas amostras de conexão OpenId que ilustram como lidar com diferentes mecanismos de autenticação, incluindo Tokens JWT:

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

Se você olhar o projeto Cordova Backend, a configuração da API é a seguinte:

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

A lógica em /Providers/AuthorizationProvider.cs e o RessourceController desse projeto também merecem uma olhada;).

Como alternativa, você também pode usar o código a seguir para validar tokens (também há um trecho para fazê-lo funcionar com 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);
                }
            };
        });

Para emitir token, você pode usar os pacotes do servidor openId Connect da seguinte maneira:

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

EDIT: Eu implementei um aplicativo de página única com implementação de autenticação baseada em token usando a estrutura de front end Aurelia e o núcleo do ASP.NET. Há também uma conexão persistente do sinal R. No entanto, eu não fiz nenhuma implementação de banco de dados. O código pode ser visto aqui: https://github.com/alexandre-spieser/AureliaAspNetCoreAuth

Espero que isto ajude,

melhor,

Alex

Darxtar
fonte
1

Dê uma olhada no OpenIddict - é um novo projeto (no momento da redação) que facilita a configuração da criação de tokens JWT e a atualização de tokens no ASP.NET 5. A validação dos tokens é realizada por outro software.

Supondo que você usar Identitycom Entity Framework, a última linha é o que você adicionar ao seu ConfigureServicesmétodo:

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

Em Configure, você configura o OpenIddict para servir tokens 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;
});

Você também configura a validação de tokens em 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/";
});

Há uma ou duas outras coisas menores, como o DbContext precisa derivar do OpenIddictContext.

Você pode ver uma explicação completa nesta postagem do blog: http://capesean.co.za/blog/asp-net-5-jwt-tokens/

Uma demonstração de funcionamento está disponível em: https://github.com/capesean/openiddict-test

Sean
fonte