Skip to content

Commit e0b0c1f

Browse files
committed
Add XML comments to AuthKeys
1 parent 2ba7604 commit e0b0c1f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Rijndael256/AuthKeys.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
namespace Rijndael256
1212
{
13+
/// <summary>
14+
/// Used for Authenticated AES.
15+
/// </summary>
1316
public class AuthKeys
1417
{
1518
// The generated hash is 512-bit (128 chars)
@@ -19,6 +22,12 @@ public class AuthKeys
1922
public string CipherKey { get; set; }
2023
public byte[] MacKey { get; set; }
2124

25+
/// <summary>
26+
/// Generates a SHA-512 hash from the provided password, and derives two
27+
/// 256-bit keys from the hash.
28+
/// </summary>
29+
/// <param name="password">The password to hash.</param>
30+
/// <returns>A pair of 256-bit keys.</returns>
2231
public static AuthKeys Generate(string password)
2332
{
2433
// Generate 512-bit hash from password

0 commit comments

Comments
 (0)