IdentityServer4 rejestruje UserService i pobiera użytkowników z bazy danych w asp.net core

84

Przeszukałem cały czas, jak zarejestrować UserServicez IdentityServer4 w rdzeniu asp.net, ale nie mogę znaleźć właściwego sposobu, aby to zrobić.

To jest kod do rejestracji InMemoryUsers znaleziony tutaj , jednak chciałbym uzyskać dostęp do użytkowników z mojej bazy danych MSSQL, a nie statycznych użytkowników zdefiniowanych w przykładzie.

var builder = services.AddIdentityServer(options =>
{
    options.SigningCertificate = cert;
});

builder.AddInMemoryClients(Clients.Get());
builder.AddInMemoryScopes(Scopes.Get());
builder.AddInMemoryUsers(Users.Get());

Więc przyjrzałem się temu, który jest przeznaczony dla IdentityServer3 .

var factory = new IdentityServerServiceFactory()
                .UseInMemoryClients(Clients.Get())
                .UseInMemoryScopes(Scopes.Get());

var userService = new UserService();
factory.UserService = new Registration<IUserService>(resolver => userService);

Z czytania w trybie online wydaje się, że muszę użyć systemu DI do zarejestrowania usługi UserService, ale nie jestem pewien, jak wiąże się to z serwerem tożsamości, np.

services.AddScoped<IUserService, UserService>();

Więc moje pytanie brzmi:

Jak mogę powiązać mój UserServicez konstruktorem (użytkownicy IdentityServer4)? I jak mam się zabrać do wywoływania mojej bazy danych w celu uzyskania dostępu i uwierzytelnienia moich istniejących użytkowników bazy danych w UserService(używam repozytoriów do łączenia się z bazą danych )?

Biorąc pod uwagę to musi działać z rdzeniem asp.net .

Dzięki!

Nick De Beer
źródło

Odpowiedzi:

116

Aktualizacja - IdentityServer 4 zmienił i zastąpił IUserService z IResourceOwnerPasswordValidator i IProfileService

Użyłem mojego UserRepository, aby pobrać wszystkie dane użytkownika z bazy danych. Jest to wstrzykiwane (DI) do konstruktorów i definiowane w Startup.cs. Stworzyłem również następujące klasy dla serwera tożsamości (który również jest wstrzykiwany):

Najpierw zdefiniuj ResourceOwnerPasswordValidator.cs:

public class ResourceOwnerPasswordValidator : IResourceOwnerPasswordValidator
{
    //repository to get user from db
    private readonly IUserRepository _userRepository;

    public ResourceOwnerPasswordValidator(IUserRepository userRepository)
    {
        _userRepository = userRepository; //DI
    }

    //this is used to validate your user account with provided grant at /connect/token
    public async Task ValidateAsync(ResourceOwnerPasswordValidationContext context)
    {
        try
        {
            //get your user model from db (by username - in my case its email)
            var user = await _userRepository.FindAsync(context.UserName);
            if (user != null)
            {
                //check if password match - remember to hash password if stored as hash in db
                if (user.Password == context.Password) {
                    //set the result
                    context.Result = new GrantValidationResult(
                        subject: user.UserId.ToString(),
                        authenticationMethod: "custom", 
                        claims: GetUserClaims(user));

                    return;
                } 

                context.Result = new GrantValidationResult(TokenRequestErrors.InvalidGrant, "Incorrect password");
                return;
            }
            context.Result = new GrantValidationResult(TokenRequestErrors.InvalidGrant, "User does not exist.");
            return;
        }
        catch (Exception ex)
        {
            context.Result = new GrantValidationResult(TokenRequestErrors.InvalidGrant, "Invalid username or password");
        }
    }

    //build claims array from user data
    public static Claim[] GetUserClaims(User user)
    {
        return new Claim[]
        {
            new Claim("user_id", user.UserId.ToString() ?? ""),
            new Claim(JwtClaimTypes.Name, (!string.IsNullOrEmpty(user.Firstname) && !string.IsNullOrEmpty(user.Lastname)) ? (user.Firstname + " " + user.Lastname) : ""),
            new Claim(JwtClaimTypes.GivenName, user.Firstname  ?? ""),
            new Claim(JwtClaimTypes.FamilyName, user.Lastname  ?? ""),
            new Claim(JwtClaimTypes.Email, user.Email  ?? ""),
            new Claim("some_claim_you_want_to_see", user.Some_Data_From_User ?? ""),

            //roles
            new Claim(JwtClaimTypes.Role, user.Role)
        };
}

Oraz ProfileService.cs:

public class ProfileService : IProfileService
{
    //services
    private readonly IUserRepository _userRepository;

    public ProfileService(IUserRepository userRepository)
    {
        _userRepository = userRepository;
    }

    //Get user profile date in terms of claims when calling /connect/userinfo
    public async Task GetProfileDataAsync(ProfileDataRequestContext context)
    {
        try
        {
            //depending on the scope accessing the user data.
            if (!string.IsNullOrEmpty(context.Subject.Identity.Name))
            {
                //get user from db (in my case this is by email)
                var user = await _userRepository.FindAsync(context.Subject.Identity.Name);

                if (user != null)
                {
                    var claims = GetUserClaims(user);

                    //set issued claims to return
                    context.IssuedClaims = claims.Where(x => context.RequestedClaimTypes.Contains(x.Type)).ToList();
                }
            }
            else
            {
                //get subject from context (this was set ResourceOwnerPasswordValidator.ValidateAsync),
                //where and subject was set to my user id.
                var userId = context.Subject.Claims.FirstOrDefault(x => x.Type == "sub");

                if (!string.IsNullOrEmpty(userId?.Value) && long.Parse(userId.Value) > 0)
                {
                    //get user from db (find user by user id)
                    var user = await _userRepository.FindAsync(long.Parse(userId.Value));

                    // issue the claims for the user
                    if (user != null)
                    {
                        var claims = ResourceOwnerPasswordValidator.GetUserClaims(user);

                        context.IssuedClaims = claims.Where(x => context.RequestedClaimTypes.Contains(x.Type)).ToList();
                    }
                }
            }
        }
        catch (Exception ex)
        {
            //log your error
        }
    }

    //check if user account is active.
    public async Task IsActiveAsync(IsActiveContext context)
    {
        try
        {
            //get subject from context (set in ResourceOwnerPasswordValidator.ValidateAsync),
            var userId = context.Subject.Claims.FirstOrDefault(x => x.Type == "user_id");

            if (!string.IsNullOrEmpty(userId?.Value) && long.Parse(userId.Value) > 0)
            {
                var user = await _userRepository.FindAsync(long.Parse(userId.Value));

                if (user != null)
                {
                    if (user.IsActive)
                    {
                        context.IsActive = user.IsActive;
                    }
                }
            }
        }
        catch (Exception ex)
        {
            //handle error logging
        }
    }
}

Następnie Startup.cswykonałem następujące czynności:

public void ConfigureServices(IServiceCollection services)
{
    //...

    //identity server 4 cert
    var cert = new X509Certificate2(Path.Combine(_environment.ContentRootPath, "idsrv4test.pfx"), "your_cert_password");

    //DI DBContext inject connection string
    services.AddScoped(_ => new YourDbContext(Configuration.GetConnectionString("DefaultConnection")));

    //my user repository
    services.AddScoped<IUserRepository, UserRepository>();

    //add identity server 4
    services.AddIdentityServer()
        .AddSigningCredential(cert)
        .AddInMemoryIdentityResources(Config.GetIdentityResources()) //check below
        .AddInMemoryApiResources(Config.GetApiResources())
        .AddInMemoryClients(Config.GetClients())
        .AddProfileService<ProfileService>();

    //Inject the classes we just created
    services.AddTransient<IResourceOwnerPasswordValidator, ResourceOwnerPasswordValidator>();
    services.AddTransient<IProfileService, ProfileService>();

    //...
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    //...

    app.UseIdentityServer();

    JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Clear();

    IdentityServerAuthenticationOptions identityServerValidationOptions = new IdentityServerAuthenticationOptions
    {
        //move host url into appsettings.json
        Authority = "http://localhost:50000/",
        ApiSecret = "secret",
        ApiName = "my.api.resource",
        AutomaticAuthenticate = true,
        SupportedTokens = SupportedTokens.Both,

        // required if you want to return a 403 and not a 401 for forbidden responses
        AutomaticChallenge = true,

        //change this to true for SLL
        RequireHttpsMetadata = false
    };

    app.UseIdentityServerAuthentication(identityServerValidationOptions);

    //...
}

Będziesz także potrzebować, Config.csktóry definiuje klientów, interfejsy API i zasoby. Przykład można znaleźć tutaj: https://github.com/IdentityServer/IdentityServer4.Demo/blob/master/src/IdentityServer4Demo/Config.cs

Powinieneś teraz móc wywołać IdentityServer / connect / token

wprowadź opis obrazu tutaj

Więcej informacji można znaleźć w dokumentacji: https://media.readthedocs.org/pdf/identityserver4/release/identityserver4.pdf


Stara odpowiedź (to już nie działa dla nowszych IdentityServer4)

Jest to całkiem proste, gdy zrozumiesz bieg rzeczy.

Skonfiguruj usługę IdentityService w następujący sposób (w Startup.cs - ConfigureServices()):

var builder = services.AddIdentityServer(options =>
{
    options.SigningCertificate = cert;
});

builder.AddInMemoryClients(Clients.Get());
builder.AddInMemoryScopes(Scopes.Get());

//** this piece of code DI's the UserService into IdentityServer **
builder.Services.AddTransient<IUserService, UserService>();

//for clarity of the next piece of code
services.AddTransient<IUserRepository, UserRepository>();

Następnie skonfiguruj usługę UserService

public class UserService : IUserService
{
    //DI the repository from Startup.cs - see previous code block
    private IUserRepository _userRepository;

    public UserService(IUserRepository userRepository)
    {
        _userRepository = userRepository;
    }

    public Task AuthenticateLocalAsync(LocalAuthenticationContext context)
    {
        var user = _userRepository.Find(context.UserName);

        //check if passwords match against user column 
        //My password was hashed, 
        //so I had to hash it with the saved salt first and then compare.
        if (user.Password == context.Password)
        {
            context.AuthenticateResult = new AuthenticateResult(
                user.UserId.ToString(),
                user.Email,

                //I set up some claims 
                new Claim[]
                {
                    //Firstname and Surname are DB columns mapped to User object (from table [User])
                    new Claim(Constants.ClaimTypes.Name, user.Firstname + " " + user.Surname),
                    new Claim(Constants.ClaimTypes.Email, user.Email),
                    new Claim(Constants.ClaimTypes.Role, user.Role.ToString()),
                    //custom claim
                    new Claim("company", user.Company)
                }
            );
        }

        return Task.FromResult(0);
    }

    public Task GetProfileDataAsync(ProfileDataRequestContext context)
    {
        //find method in my repository to check my user email
        var user = _userRepository.Find(context.Subject.Identity.Name);

        if (user != null)
        {
            var claims = new Claim[]
                {
                    new Claim(Constants.ClaimTypes.Name, user.Firstname + " " + user.Surname),
                    new Claim(Constants.ClaimTypes.Email, user.Email),
                    new Claim(Constants.ClaimTypes.Role, user.Role.ToString(), ClaimValueTypes.Integer),
                    new Claim("company", user.Company)
            };

            context.IssuedClaims = claims.Where(x => context.RequestedClaimTypes.Contains(x.Type));
        }

        return Task.FromResult(0);
    }

    public Task IsActiveAsync(IsActiveContext context)
    {
        var user = _userRepository.Find(context.Subject.Identity.Name);

        return Task.FromResult(user != null);
    }
}

Zasadniczo poprzez wstrzyknięcie UserServicedo builder(typu IdentityServerBuilder) Servicesumożliwia wywołanie usługi UserService przy auth.

Mam nadzieję, że to pomoże innym, ponieważ zajęło mi to kilka godzin.

Nick De Beer
źródło
10
Hmmm, z tego, co widzę, IUserServicena IdSvr4 (dla ASP.NET Core 1.0) już nie istnieje. Został zastąpiony przez dwa interfejsy / usługi IProfileServicei IResourceOwnerPasswordValidator.
Frank Fajardo,
3
Tak - idąc naprzód - zostaną podzielone. Oddzielne obawy.
najmniejprivilege
3
@Sinaesthetic - Przepraszamy za to, od czasu opublikowania tej odpowiedzi identityserver4 został zaktualizowany i nie używa już IUserService. Zaktualizowałem odpowiedź, więc mam nadzieję, że to pomoże.
Nick De Beer
3
@Uros - Powinieneś być w stanie wywołać tylko context.IssuedClaims = context.Subject.Claims.ToList();w GetProfileData, zależy tylko od tego, czy chcesz ukryć niektóre roszczenia przed opinią publiczną lub musisz wykonać jakąś logikę pośredniczącą podczas przeglądania danych profilu.
Nick De Beer
3
Czy to wymaga aktualizacji dla .net core 2? Zaimplementowałem zarówno IProfileServiece, jak i IResourceOwnerPasswordValidator, ale żaden z nich nie jest wywoływany przez serwer tożsamości.
stt106
66

W IdentityServer4. IUserServicenie jest już dostępny, teraz musisz użyć IResourceOwnerPasswordValidatorgo do uwierzytelnienia i IProfileServicedo uzyskania roszczeń.

W moim scenariuszu używam typu przyznania właściciela zasobów, a wszystko, czego potrzebuję, to uzyskanie oświadczeń użytkowników, aby przeprowadzali autoryzację opartą na rolach dla moich internetowych interfejsów API zgodnie z nazwą użytkownika i hasłem. I założyłem, że temat jest inny dla każdego użytkownika.

Poniżej zamieściłem swoje kody i może działać poprawnie; czy ktoś mógłby mi powiedzieć, że są jakieś problemy z moimi kodami?

Zarejestruj te dwie usługi w pliku startup.cs.

public void ConfigureServices(IServiceCollection services)
{
    var builder = services.AddIdentityServer();
    builder.AddInMemoryClients(Clients.Get());
    builder.AddInMemoryScopes(Scopes.Get());
    builder.Services.AddTransient<IResourceOwnerPasswordValidator, ResourceOwnerPasswordValidator>();
    builder.Services.AddTransient<IProfileService, ProfileService>();
}

Zaimplementuj IResourceOwnerPasswordValidatorinterfejs.

public class ResourceOwnerPasswordValidator: IResourceOwnerPasswordValidator
{
    public Task<customgrantvalidationresult> ValidateAsync(string userName, string password, ValidatedTokenRequest request)
    {
        // Check The UserName And Password In Database, Return The Subject If Correct, Return Null Otherwise
        // subject = ......
        if (subject == null)
        {
            var result = new CustomGrantValidationResult("Username Or Password Incorrect");
            return Task.FromResult(result);
        }
        else {
            var result = new CustomGrantValidationResult(subject, "password");
            return Task.FromResult(result);
        }
    }
}

Zaimplementuj ProfileServiceinterfejs.

public class ProfileService : IProfileService
{
    public Task GetProfileDataAsync(ProfileDataRequestContext context)
    {
        string subject = context.Subject.Claims.ToList().Find(s => s.Type == "sub").Value;
        try
        {
            // Get Claims From Database, And Use Subject To Find The Related Claims, As A Subject Is An Unique Identity Of User
            //List<string> claimStringList = ......
            if (claimStringList == null)
            {
                return Task.FromResult(0);
            }
            else {
                List<Claim> claimList = new List<Claim>();
                for (int i = 0; i < claimStringList.Count; i++)
                {
                    claimList.Add(new Claim("role", claimStringList[i]));
                }
                context.IssuedClaims = claimList.Where(x => context.RequestedClaimTypes.Contains(x.Type));
                return Task.FromResult(0);
            }
        }
        catch
        {
            return Task.FromResult(0);
        }
    }

    public Task IsActiveAsync(IsActiveContext context)
    {
        return Task.FromResult(0);
    }
}
EternityWYH
źródło
Postępowałem zgodnie z tą odpowiedzią, ale otrzymuję następujący błąd: „Dodatkowe informacje: Nie określono mechanizmu przechowywania dotacji. Użyj metody rozszerzenia„ AddInMemoryStores ”, aby zarejestrować wersję rozwojową”. Używam "services.AddIdentityServer" do tworzenia kreatora, wersja IdentitiServer4 to 1.0.0-rc1-update2.
FRA
Warto zauważyć, że jeśli chcesz przejąć kontrolę nad roszczeniem „podrzędnym”, musisz dokonać pewnych dostosowań wcześniej w potoku.
Ben Collins,
Ten sam błąd utrzymuje się, nawet jeśli zapewniam implementację dla obu usług!
Hussein Salman
@EternityWYH czy możesz rzucić okiem na to [ stackoverflow.com/questions/40797993/…
Hussein Salman
Dzięki za odpowiedź, dla mnie wystarczyło zaimplementować IResourceOwnerPasswordValidator i IProfileService w"IdentityServer4": "1.3.1"
Ilya Chumakov
10

W IdentityServer4 1.0.0-rc5 nie są dostępne ani IUserService, ani CustomGrantValidationResult.

Teraz zamiast zwracać CustomGrantValidationResult, będziesz musiał ustawić kontekst.

 public class ResourceOwnerPasswordValidator: IResourceOwnerPasswordValidator
 {
    private MyUserManager _myUserManager { get; set; }
    public ResourceOwnerPasswordValidator()
    {
        _myUserManager = new MyUserManager();
    }

    public async Task ValidateAsync(ResourceOwnerPasswordValidationContext context)
    {
        var user = await _myUserManager.FindByNameAsync(context.UserName);
        if (user != null && await _myUserManager.CheckPasswordAsync(user,context.Password))
        {
             context.Result = new GrantValidationResult(
                 subject: "2", 
                 authenticationMethod: "custom", 
                 claims: someClaimsList);


        }
        else
        {
             context.Result = new GrantValidationResult(
                    TokenRequestErrors.InvalidGrant,
                    "invalid custom credential");
         }


        return;

   }

Walidacja hasła właściciela zasobu

krucyfiks
źródło