Add JWT authentication.

Add: JWT authentication in Web API. Related configuration and services are added.
This commit is contained in:
2025-07-10 20:08:48 +08:00
parent 7cce413f79
commit 724b1d4dae
8 changed files with 132 additions and 4 deletions

View File

@ -4,6 +4,7 @@ public record OptixServeSettings
{ {
public ApiSettings? Api { get; set; } = new(); public ApiSettings? Api { get; set; } = new();
public DatabaseSettings? Database { get; set; } = new(); public DatabaseSettings? Database { get; set; } = new();
public JwtSettings? Jwt { get; set; } = new();
} }
public record ApiSettings public record ApiSettings
@ -12,6 +13,14 @@ public record ApiSettings
public int? Port { get; set; } = 10086; public int? Port { get; set; } = 10086;
} }
public record JwtSettings
{
public string Secret { get; set; } = string.Empty;
public string Issuer { get; set; } = "OptixServe";
public string Audience { get; set; } = "OptixServeUsers";
public int TokenExpirationMinutes { get; set; } = 60;
}
public enum DatabaseType public enum DatabaseType
{ {
Sqlite, Sqlite,

View File

@ -0,0 +1,12 @@
namespace OptixServe.Api.Dtos;
public record LoginRequestDto
{
public string? UserName { get; set; }
public string? Password { get; set; }
}
public record LoginResponseDto
{
public string? Token { get; set; }
}

View File

@ -1,12 +1,16 @@
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using OptixServe.Core.Services; using OptixServe.Core.Services;
using OptixServe.Api.Dtos; using OptixServe.Api.Dtos;
using OptixServe.Api.Services;
using Microsoft.AspNetCore.Authorization;
namespace OptixServe.Api.Endpoints; namespace OptixServe.Api.Endpoints;
[JsonSerializable(typeof(UserDto))] [JsonSerializable(typeof(UserDto))]
[JsonSerializable(typeof(IEnumerable<UserDto>))] [JsonSerializable(typeof(IEnumerable<UserDto>))]
[JsonSerializable(typeof(LoginRequestDto))]
[JsonSerializable(typeof(LoginResponseDto))] // For returning the token string
public partial class UserJsonContext : JsonSerializerContext { } public partial class UserJsonContext : JsonSerializerContext { }
public static class UserEndpoint public static class UserEndpoint
@ -15,8 +19,28 @@ public static class UserEndpoint
{ {
var group = parentGroup.MapGroup("/users"); var group = parentGroup.MapGroup("/users");
group.MapGet("/", GetAllUsers); group.MapPost("/login", LoginUser);
group.MapGet("/{id}", GetUserById); group.MapGet("/", GetAllUsers).RequireAuthorization();
group.MapGet("/{id}", GetUserById).RequireAuthorization();
}
public static IResult LoginUser(LoginRequestDto loginRequest, IUserService userService, ITokenService tokenService)
{
if (string.IsNullOrEmpty(loginRequest.UserName) || string.IsNullOrEmpty(loginRequest.Password))
{
return Results.BadRequest("Username and password are required.");
}
// Password hashing and salting will be implemented later.
var user = userService.GetUserByUsername(loginRequest.UserName);
if (user == null || user.Password != loginRequest.Password)
{
return Results.Unauthorized();
}
var token = tokenService.GenerateToken(user);
return Results.Ok(new LoginResponseDto { Token = token });
} }
public static IResult GetAllUsers(IUserService userService) public static IResult GetAllUsers(IUserService userService)
@ -34,4 +58,4 @@ public static class UserEndpoint
return Results.Ok(new UserDto { Id = user.Id, UserName = user.UserName }); return Results.Ok(new UserDto { Id = user.Id, UserName = user.UserName });
} }
} }

View File

@ -5,6 +5,7 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="9.0.6" />
<PackageReference Include="System.CommandLine" Version="2.0.0-beta5.25306.1" /> <PackageReference Include="System.CommandLine" Version="2.0.0-beta5.25306.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.6"> <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.6">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

View File

@ -1,6 +1,10 @@
using System.CommandLine; using System.CommandLine;
using System.Text;
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;
using OptixServe.Api.Configuration; using OptixServe.Api.Configuration;
using OptixServe.Api.Endpoints; using OptixServe.Api.Endpoints;
using OptixServe.Api.Services;
using OptixServe.Core.Data; using OptixServe.Core.Data;
using OptixServe.Core.Services; using OptixServe.Core.Services;
using OptixServe.Api.Utilites; using OptixServe.Api.Utilites;
@ -50,6 +54,9 @@ class Program
var app = builder.Build(); var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();
using (var scope = app.Services.CreateScope()) using (var scope = app.Services.CreateScope())
{ {
var initializer = scope.ServiceProvider.GetRequiredService<DbInitializer>(); var initializer = scope.ServiceProvider.GetRequiredService<DbInitializer>();
@ -127,6 +134,25 @@ static class StartupHelper
// Application services // Application services
builder.Services.AddScoped<IUserService, UserService>(); builder.Services.AddScoped<IUserService, UserService>();
builder.Services.AddScoped<ITokenService, TokenService>();
// Add Authentication and Authorization
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddJwtBearer(options =>
{
var jwtSettings = onConfigSettings?.Jwt ?? throw new ArgumentNullException(nameof(builder), "JWT settings are not configured.");
options.TokenValidationParameters = new TokenValidationParameters
{
ValidateIssuer = true,
ValidateAudience = true,
ValidateLifetime = true,
ValidateIssuerSigningKey = true,
ValidIssuer = jwtSettings.Issuer,
ValidAudience = jwtSettings.Audience,
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtSettings.Secret))
};
});
builder.Services.AddAuthorization();
} }
/// <summary> /// <summary>

View File

@ -0,0 +1,44 @@
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;
using System.Text;
using Microsoft.Extensions.Options;
using Microsoft.IdentityModel.Tokens;
using OptixServe.Api.Configuration;
using OptixServe.Core.Models;
namespace OptixServe.Api.Services;
public interface ITokenService
{
public string GenerateToken(User user);
}
public class TokenService(IOptions<OptixServeSettings> optixServeSettings) : ITokenService
{
private readonly JwtSettings _jwtSettings = optixServeSettings.Value.Jwt ?? throw new ArgumentNullException(nameof(optixServeSettings), "JWT settings are not configured.");
public string GenerateToken(User user)
{
var tokenHandler = new JwtSecurityTokenHandler();
var key = Encoding.ASCII.GetBytes(_jwtSettings.Secret);
var claims = new List<Claim>
{
new (ClaimTypes.NameIdentifier, user.Id.ToString()),
new (ClaimTypes.Name, user.UserName)
// Add roles if applicable: new Claim(ClaimTypes.Role, user.Role)
};
var tokenDescriptor = new SecurityTokenDescriptor
{
Subject = new ClaimsIdentity(claims),
Expires = DateTime.UtcNow.AddMinutes(_jwtSettings.TokenExpirationMinutes),
Issuer = _jwtSettings.Issuer,
Audience = _jwtSettings.Audience,
SigningCredentials = new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature)
};
var token = tokenHandler.CreateToken(tokenDescriptor);
return tokenHandler.WriteToken(token);
}
}

View File

@ -14,6 +14,12 @@
"Database": { "Database": {
"Type": "Sqlite", "Type": "Sqlite",
"Host": "optixserve.db" "Host": "optixserve.db"
},
"Jwt": {
"Secret": "YOUR_SECRET_KEY_HERE_DO_NOT_SHARE_THIS_AND_MAKE_IT_LONG_ENOUGH",
"Issuer": "OptixServe",
"Audience": "OptixServeUsers",
"TokenExpirationMinutes": 60
} }
} }
} }

View File

@ -7,6 +7,7 @@ public interface IUserService
{ {
IEnumerable<User> GetUsers(); IEnumerable<User> GetUsers();
User? GetUserById(string id); User? GetUserById(string id);
User? GetUserByUsername(string username);
} }
public class UserService(AppDbContext dbContext) : IUserService public class UserService(AppDbContext dbContext) : IUserService
@ -18,6 +19,11 @@ public class UserService(AppDbContext dbContext) : IUserService
return _dbContext.Users.FirstOrDefault(u => u.Id == id); return _dbContext.Users.FirstOrDefault(u => u.Id == id);
} }
public User? GetUserByUsername(string username)
{
return _dbContext.Users.FirstOrDefault(u => u.UserName == username);
}
public IEnumerable<User> GetUsers() public IEnumerable<User> GetUsers()
{ {
return _dbContext.Users.AsEnumerable(); return _dbContext.Users.AsEnumerable();