Skip to content

Commit 7411f16

Browse files
driesengdrieseng
committed
Added slashdocs.
1 parent 21e86a5 commit 7411f16

File tree

6 files changed

+130
-6
lines changed

6 files changed

+130
-6
lines changed

‎src/Renci.SshNet/Security/Cryptography/AsymmetricCipher.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
/// </summary>
66
public abstract class AsymmetricCipher : Cipher
77
{
8+
/// <summary>
9+
/// Gets the minimum data size.
10+
/// </summary>
11+
/// <value>
12+
/// The minimum data size.
13+
/// </value>
814
public override byte MinimumSize
915
{
1016
get { return 0; }

‎src/Renci.SshNet/Security/Cryptography/HMACMD5.cs

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,54 @@
11
#if FEATURE_HMAC_MD5
22

3-
using Renci.SshNet.Common;
3+
using System.Security.Cryptography;
44

55
namespace Renci.SshNet.Security.Cryptography
66
{
77
/// <summary>
8-
/// Computes a Hash-based Message Authentication Code (HMAC) by using the MD5 hash function.
8+
/// Computes a Hash-based Message Authentication Code (HMAC) by using the <see cref="MD5"/> hash function.
99
/// </summary>
1010
public class HMACMD5 : System.Security.Cryptography.HMACMD5
1111
{
1212
private readonly int _hashSize;
1313

14+
/// <summary>
15+
/// Initializes a <see cref="HMACMD5"/> with the specified key.
16+
/// </summary>
17+
/// <param name="key">The key.</param>
1418
public HMACMD5(byte[] key)
1519
: base(key)
1620
{
1721
_hashSize = base.HashSize;
1822
}
1923

24+
/// <summary>
25+
/// Initializes a <see cref="HMACSHA1"/> with the specified key and size of the computed hash code.
26+
/// </summary>
27+
/// <param name="key">The key.</param>
28+
/// <param name="hashSize">The size, in bits, of the computed hash code.</param>
2029
public HMACMD5(byte[] key, int hashSize)
2130
: base(key)
2231
{
2332
_hashSize = hashSize;
2433
}
2534

35+
/// <summary>
36+
/// Gets the size, in bits, of the computed hash code.
37+
/// </summary>
38+
/// <value>
39+
/// The size, in bits, of the computed hash code.
40+
/// </value>
2641
public override int HashSize
2742
{
2843
get { return _hashSize; }
2944
}
3045

46+
/// <summary>
47+
/// Finalizes the hash computation after the last data is processed by the cryptographic stream object.
48+
/// </summary>
49+
/// <returns>
50+
/// The computed hash code.
51+
/// </returns>
3152
protected override byte[] HashFinal()
3253
{
3354
var hash = base.HashFinal();

‎src/Renci.SshNet/Security/Cryptography/HMACSHA1.cs

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,54 @@
11
#if FEATURE_HMAC_SHA1
22

3-
using Renci.SshNet.Common;
3+
using System.Security.Cryptography;
44

55
namespace Renci.SshNet.Security.Cryptography
66
{
7+
/// <summary>
8+
/// Computes a Hash-based Message Authentication Code (HMAC) by using the <see cref="SHA1"/> hash function.
9+
/// </summary>
710
public class HMACSHA1 : System.Security.Cryptography.HMACSHA1
811
{
912
private readonly int _hashSize;
1013

14+
/// <summary>
15+
/// Initializes a <see cref="HMACSHA1"/> with the specified key.
16+
/// </summary>
17+
/// <param name="key">The key.</param>
1118
public HMACSHA1(byte[] key)
1219
: base(key)
1320
{
1421
_hashSize = base.HashSize;
1522
}
1623

24+
/// <summary>
25+
/// Initializes a <see cref="HMACSHA1"/> with the specified key and size of the computed hash code.
26+
/// </summary>
27+
/// <param name="key">The key.</param>
28+
/// <param name="hashSize">The size, in bits, of the computed hash code.</param>
1729
public HMACSHA1(byte[] key, int hashSize)
1830
: base(key)
1931
{
2032
_hashSize = hashSize;
2133
}
2234

35+
/// <summary>
36+
/// Gets the size, in bits, of the computed hash code.
37+
/// </summary>
38+
/// <value>
39+
/// The size, in bits, of the computed hash code.
40+
/// </value>
2341
public override int HashSize
2442
{
2543
get { return _hashSize; }
2644
}
2745

46+
/// <summary>
47+
/// Finalizes the hash computation after the last data is processed by the cryptographic stream object.
48+
/// </summary>
49+
/// <returns>
50+
/// The computed hash code.
51+
/// </returns>
2852
protected override byte[] HashFinal()
2953
{
3054
var hash = base.HashFinal();

‎src/Renci.SshNet/Security/Cryptography/HMACSHA256.cs

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,55 @@
11
#if FEATURE_HMAC_SHA256
22

3-
using Renci.SshNet.Common;
3+
using System.Security.Cryptography;
44

55
namespace Renci.SshNet.Security.Cryptography
66
{
7+
/// <summary>
8+
/// Computes a Hash-based Message Authentication Code (HMAC) by using the <see cref="SHA256"/> hash function.
9+
/// </summary>
710
public class HMACSHA256 : System.Security.Cryptography.HMACSHA256
811
{
912
private readonly int _hashSize;
1013

14+
/// <summary>
15+
/// Initializes a <see cref="HMACSHA256"/> with the specified key.
16+
/// </summary>
17+
/// <param name="key">The key.</param>
1118
public HMACSHA256(byte[] key)
1219
: base(key)
1320
{
1421
_hashSize = base.HashSize;
1522
}
1623

24+
/// <summary>
25+
/// Initializes a <see cref="HMACSHA256"/> with the specified key and size of the computed hash code.
26+
/// </summary>
27+
/// <param name="key">The key.</param>
28+
/// <param name="hashSize">The size, in bits, of the computed hash code.</param>
1729
public HMACSHA256(byte[] key, int hashSize)
1830
: base(key)
1931
{
2032
_hashSize = hashSize;
2133
}
2234

35+
/// <summary>
36+
/// Gets the size, in bits, of the computed hash code.
37+
/// </summary>
38+
/// <value>
39+
/// The size, in bits, of the computed hash code.
40+
/// </value>
2341
public override int HashSize
2442
{
2543
get { return _hashSize; }
2644
}
2745

46+
/// <summary>
47+
/// Finalizes the hash computation after the last data is processed by the cryptographic stream object.
48+
/// </summary>
49+
/// <returns>
50+
/// The computed hash code.
51+
/// </returns>
52+
2853
protected override byte[] HashFinal()
2954
{
3055
var hash = base.HashFinal();

‎src/Renci.SshNet/Security/Cryptography/HMACSHA384.cs

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,54 @@
11
#if FEATURE_HMAC_SHA384
22

3-
using Renci.SshNet.Common;
3+
using System.Security.Cryptography;
44

55
namespace Renci.SshNet.Security.Cryptography
66
{
7+
/// <summary>
8+
/// Computes a Hash-based Message Authentication Code (HMAC) by using the <see cref="SHA384"/> hash function.
9+
/// </summary>
710
public class HMACSHA384 : System.Security.Cryptography.HMACSHA384
811
{
912
private readonly int _hashSize;
1013

14+
/// <summary>
15+
/// Initializes a <see cref="HMACSHA384"/> with the specified key.
16+
/// </summary>
17+
/// <param name="key">The key.</param>
1118
public HMACSHA384(byte[] key)
1219
: base(key)
1320
{
1421
_hashSize = base.HashSize;
1522
}
1623

24+
/// <summary>
25+
/// Initializes a <see cref="HMACSHA384"/> with the specified key and size of the computed hash code.
26+
/// </summary>
27+
/// <param name="key">The key.</param>
28+
/// <param name="hashSize">The size, in bits, of the computed hash code.</param>
1729
public HMACSHA384(byte[] key, int hashSize)
1830
: base(key)
1931
{
2032
_hashSize = hashSize;
2133
}
2234

35+
/// <summary>
36+
/// Gets the size, in bits, of the computed hash code.
37+
/// </summary>
38+
/// <value>
39+
/// The size, in bits, of the computed hash code.
40+
/// </value>
2341
public override int HashSize
2442
{
2543
get { return _hashSize; }
2644
}
2745

46+
/// <summary>
47+
/// Finalizes the hash computation after the last data is processed by the cryptographic stream object.
48+
/// </summary>
49+
/// <returns>
50+
/// The computed hash code.
51+
/// </returns>
2852
protected override byte[] HashFinal()
2953
{
3054
var hash = base.HashFinal();

‎src/Renci.SshNet/Security/Cryptography/HMACSHA512.cs

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,54 @@
11
#if FEATURE_HMAC_SHA512
22

3-
using Renci.SshNet.Common;
3+
using System.Security.Cryptography;
44

55
namespace Renci.SshNet.Security.Cryptography
66
{
7+
/// <summary>
8+
/// Computes a Hash-based Message Authentication Code (HMAC) by using the <see cref="SHA512"/> hash function.
9+
/// </summary>
710
public class HMACSHA512 : System.Security.Cryptography.HMACSHA512
811
{
912
private readonly int _hashSize;
1013

14+
/// <summary>
15+
/// Initializes a <see cref="HMACSHA512"/> with the specified key.
16+
/// </summary>
17+
/// <param name="key">The key.</param>
1118
public HMACSHA512(byte[] key)
1219
: base(key)
1320
{
1421
_hashSize = base.HashSize;
1522
}
1623

24+
/// <summary>
25+
/// Initializes a <see cref="HMACSHA512"/> with the specified key and size of the computed hash code.
26+
/// </summary>
27+
/// <param name="key">The key.</param>
28+
/// <param name="hashSize">The size, in bits, of the computed hash code.</param>
1729
public HMACSHA512(byte[] key, int hashSize)
1830
: base(key)
1931
{
2032
_hashSize = hashSize;
2133
}
2234

35+
/// <summary>
36+
/// Gets the size, in bits, of the computed hash code.
37+
/// </summary>
38+
/// <value>
39+
/// The size, in bits, of the computed hash code.
40+
/// </value>
2341
public override int HashSize
2442
{
2543
get { return _hashSize; }
2644
}
2745

46+
/// <summary>
47+
/// Finalizes the hash computation after the last data is processed by the cryptographic stream object.
48+
/// </summary>
49+
/// <returns>
50+
/// The computed hash code.
51+
/// </returns>
2852
protected override byte[] HashFinal()
2953
{
3054
var hash = base.HashFinal();

0 commit comments

Comments
 (0)