Skip to content

Commit d8e52f7

Browse files
committed
docs: enhance XML documentation for key OIDs and COSE enumerations
1 parent 9af41dd commit d8e52f7

File tree

4 files changed

+39
-7
lines changed

4 files changed

+39
-7
lines changed

Yubico.YubiKey/src/Yubico/YubiKey/Cryptography/KeyDefinitions.cs

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,38 @@ public static IReadOnlyCollection<KeyDefinition> GetEcKeyDefinitions() =>
165165
/// </summary>
166166
public struct KeyOids
167167
{
168-
public const string Rsa = "1.2.840.113549"; // all RSA keys share the same OID
169-
public const string P256 = "1.2.840.10045.3.1.7"; // nistP256 or secP256r1
170-
public const string P384 = "1.3.132.0.34"; // nistP384 or secP384r1
171-
public const string P521 = "1.3.132.0.35"; // nistP521 or secP521r1
172-
public const string X25519 = "1.3.101.110"; // Curve25519
173-
public const string Ed25519 = "1.3.101.112"; // Edwards25519
168+
/// <summary>
169+
/// Represents the object identifier (OID) for RSA keys.
170+
/// <remarks>
171+
/// All RSA keys share the same OID
172+
/// </remarks>
173+
/// </summary>
174+
public const string Rsa = "1.2.840.113549";
175+
176+
/// <summary>
177+
/// Represents the object identifier (OID) for nistP256 or secP256r1
178+
/// </summary>
179+
public const string P256 = "1.2.840.10045.3.1.7";
180+
181+
/// <summary>
182+
/// Represents the object identifier (OID) for nistP384 or secP384r1
183+
/// </summary>
184+
public const string P384 = "1.3.132.0.34";
185+
186+
/// <summary>
187+
/// Represents the object identifier (OID) for nistP521 or secP521r1
188+
/// </summary>
189+
public const string P521 = "1.3.132.0.35";
190+
191+
/// <summary>
192+
/// Represents the object identifier (OID) for X25519 (Curve25519)
193+
/// </summary>
194+
public const string X25519 = "1.3.101.110";
195+
196+
/// <summary>
197+
/// Represents the object identifier (OID) for Ed25519 (Edwards25519)
198+
/// </summary>
199+
public const string Ed25519 = "1.3.101.112";
174200
}
175201

176202
/// <summary>
@@ -264,7 +290,7 @@ public struct KeyOids
264290
};
265291

266292
/// <summary>
267-
/// Represents an RSA key with a length of1024 bits.
293+
/// Represents an RSA key with a length of 1024 bits.
268294
/// </summary>
269295
public static readonly KeyDefinition RSA1024 = new KeyDefinition
270296
{

Yubico.YubiKey/src/Yubico/YubiKey/Fido2/Cose/CoseAlgorithmIdentifier.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ namespace Yubico.YubiKey.Fido2.Cose
1818
/// Represents a COSE algorithm identifier.
1919
/// <remarks>
2020
/// This enumeration is based on the IANA COSE Algorithms registry.
21+
/// <para>
2122
/// https://www.iana.org/assignments/cose/cose.xhtml#algorithms
23+
/// </para>
2224
/// </remarks>
2325
/// </summary>
2426
public enum CoseAlgorithmIdentifier

Yubico.YubiKey/src/Yubico/YubiKey/Fido2/Cose/CoseEcCurve.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ namespace Yubico.YubiKey.Fido2.Cose
1818
/// An enumeration of the elliptic curves that are supported by COSE representations.
1919
/// <remarks>
2020
/// This enumeration is based on the IANA COSE Elliptic Curves registry.
21+
/// <para>
2122
/// https://www.iana.org/assignments/cose/cose.xhtml#elliptic-curves
23+
/// </para>
2224
/// </remarks>
2325
/// </summary>
2426
public enum CoseEcCurve

Yubico.YubiKey/src/Yubico/YubiKey/Fido2/Cose/CoseKeyType.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ namespace Yubico.YubiKey.Fido2.Cose
1818
/// An enumeration of the key families supported by COSE.
1919
/// <remarks>
2020
/// This enumeration is based on the IANA COSE Key Common Parameters registry.
21+
/// <para>
2122
/// https://www.iana.org/assignments/cose/cose.xhtml#key-type
23+
/// </para>
2224
/// </remarks>
2325
/// </summary>
2426
public enum CoseKeyType

0 commit comments

Comments
 (0)