Bangara Raju Kottedi
cd01c11be7
Refactored AdminController and AuthService to use primary constructor syntax, removing explicit field declarations. Updated logging to use structured logging across controllers and services. Added XML documentation for methods in AdminController, AuthController, AuthService, and MailService. Modified Program.cs to improve connection string handling and Swagger setup. Removed deprecated service files.
67 lines
2.7 KiB
C#
67 lines
2.7 KiB
C#
using PortBlog.API.Entities;
|
|
|
|
namespace PortBlog.API.Services.Contracts
|
|
{
|
|
/// <summary>
|
|
/// Provides authentication-related services such as OTP generation, token management, and refresh token handling.
|
|
/// </summary>
|
|
public interface IAuthService
|
|
{
|
|
/// <summary>
|
|
/// Generates a one-time password (OTP) for the specified email.
|
|
/// </summary>
|
|
/// <param name="email">The email address to generate the OTP for.</param>
|
|
/// <param name="ct">A cancellation token.</param>
|
|
/// <returns>The generated OTP as a string.</returns>
|
|
Task<string> GenerateOtp(string email, CancellationToken ct = default);
|
|
|
|
/// <summary>
|
|
/// Validates the provided OTP against the secret key.
|
|
/// </summary>
|
|
/// <param name="secretKey">The secret key used for validation.</param>
|
|
/// <param name="otp">The OTP to validate.</param>
|
|
/// <returns>True if the OTP is valid; otherwise, false.</returns>
|
|
bool ValidateOtp(string secretKey, string otp);
|
|
|
|
/// <summary>
|
|
/// Generates an access token for the specified username.
|
|
/// </summary>
|
|
/// <param name="username">The username for which to generate the access token.</param>
|
|
/// <returns>The generated access token as a string.</returns>
|
|
string GenerateAccessToken(string username);
|
|
|
|
/// <summary>
|
|
/// Generates a new refresh token.
|
|
/// </summary>
|
|
/// <returns>The generated refresh token as a string.</returns>
|
|
string GenerateRefreshToken();
|
|
|
|
/// <summary>
|
|
/// Saves the refresh token for the specified user and HTTP context.
|
|
/// </summary>
|
|
/// <param name="userId">The user ID.</param>
|
|
/// <param name="refreshToken">The refresh token to save.</param>
|
|
/// <param name="httpContext">The HTTP context.</param>
|
|
Task SaveRefreshToken(string userId, string refreshToken, HttpContext httpContext);
|
|
|
|
/// <summary>
|
|
/// Saves the specified refresh token.
|
|
/// </summary>
|
|
/// <param name="refreshToken">The refresh token entity to save.</param>
|
|
Task SaveRefreshToken(RefreshToken refreshToken);
|
|
|
|
/// <summary>
|
|
/// Retrieves the refresh token entity for the specified token string.
|
|
/// </summary>
|
|
/// <param name="refreshToken">The refresh token string.</param>
|
|
/// <returns>The corresponding <see cref="RefreshToken"/> entity.</returns>
|
|
Task<RefreshToken> GetRefreshToken(string refreshToken);
|
|
|
|
/// <summary>
|
|
/// Removes the specified refresh token.
|
|
/// </summary>
|
|
/// <param name="refreshToken">The refresh token to remove.</param>
|
|
Task RemoveRefreshToken(string refreshToken);
|
|
}
|
|
}
|