add xmldoc comments

This commit is contained in:
Aaron Po
2026-06-18 23:25:50 -04:00
parent 6a66619c70
commit 254b2afb9f
52 changed files with 1681 additions and 7 deletions

View File

@@ -1,7 +1,22 @@
namespace Infrastructure.PasswordHashing;
/// <summary>
/// Service for hashing and verifying user passwords.
/// </summary>
public interface IPasswordInfrastructure
{
/// <summary>
/// Hashes a plaintext password, generating a new random salt.
/// </summary>
/// <param name="password">The plaintext password to hash.</param>
/// <returns>A string encoding both the salt and the resulting hash, suitable for storage.</returns>
public string Hash(string password);
/// <summary>
/// Verifies a plaintext password against a previously stored hash.
/// </summary>
/// <param name="password">The plaintext password to verify.</param>
/// <param name="stored">The stored salt/hash string previously produced by <see cref="Hash"/>.</param>
/// <returns><c>true</c> if the password matches the stored hash; otherwise <c>false</c>.</returns>
public bool Verify(string password, string stored);
}