Skip to content

Commit 26e5f75

Browse files
authored
Update MetadataStatement to include friendly names (#544)
* Update MetadataStatement to include friendly names * Fix file encoding * Update MetadataStatement.cs * Fix alternativeDescriptions --------- Co-authored-by: joegoldman2 <[email protected]>
1 parent cb71a15 commit 26e5f75

File tree

5 files changed

+13
-32
lines changed

5 files changed

+13
-32
lines changed

Src/Fido2.Models/Metadata/AlternativeDescriptions.cs

Lines changed: 0 additions & 27 deletions
This file was deleted.

Src/Fido2.Models/Metadata/AuthenticatorStatus.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace Fido2NetLib;
66
/// Describes the status of an authenticator model as identified by its AAID and potentially some additional information (such as a specific attestation key).
77
/// </summary>
88
/// <remarks>
9-
/// <see href="https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-service-v2.0-rd-20180702.html#authenticatorstatus-enum"/>
9+
/// <see href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#authenticatorstatus-enum"/>
1010
/// </remarks>
1111
[JsonConverter(typeof(JsonStringEnumConverter<AuthenticatorStatus>))]
1212
public enum AuthenticatorStatus

Src/Fido2.Models/Metadata/BiometricStatusReport.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Fido2NetLib;
77
/// Contains the current BiometricStatusReport of one of the authenticator's biometric component.
88
/// </summary>
99
/// <remarks>
10-
/// <see href="https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-service-v2.0-rd-20180702.html#biometricstatusreport-dictionary"/>
10+
/// <see href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#biometricstatusreport-dictionary"/>
1111
/// </remarks>
1212
public class BiometricStatusReport
1313
{

Src/Fido2.Models/Metadata/MetadataStatement.cs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Fido2NetLib;
77
/// Represents the metadata statement.
88
/// </summary>
99
/// <remarks>
10-
/// <see href="https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-statement-v2.0-rd-20180702.html#metadata-keys"/>
10+
/// <see href="https://fidoalliance.org/specs/mds/fido-metadata-statement-v3.0-ps-20210518.html"/>
1111
/// </remarks>
1212
public class MetadataStatement
1313
{
@@ -48,11 +48,19 @@ public class MetadataStatement
4848
[JsonPropertyName("description"), Required]
4949
public string Description { get; set; }
5050

51+
/// <summary>
52+
/// Gets or sets a human-readable, short description of the authenticator, in alternative languages.
53+
/// </summary>
54+
/// <value>A dictionary where keys are IETF language codes (e.g. "de-AT" for Austrian-German) and values are human-readable descriptions.</value>
55+
[JsonPropertyName("friendlyNames")]
56+
public IDictionary<string, string> FriendlyNames { get; set; }
57+
5158
/// <summary>
5259
/// Gets or set a list of human-readable short descriptions of the authenticator in different languages.
5360
/// </summary>
61+
/// <value>A dictionary where keys are IETF language codes (e.g. "de-AT" for Austrian-German) and values are human-readable descriptions.</value>
5462
[JsonPropertyName("alternativeDescriptions")]
55-
public AlternativeDescriptions IETFLanguageCodesMembers { get; set; }
63+
public IDictionary<string, string> AlternativeDescriptions { get; set; }
5664

5765
/// <summary>
5866
/// Gets or set earliest (i.e. lowest) trustworthy authenticatorVersion meeting the requirements specified in this metadata statement.

Src/Fido2.Models/Metadata/StatusReport.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Fido2NetLib;
77
/// Contains an AuthenticatorStatus and additional data associated with it, if any.
88
/// </summary>
99
/// <remarks>
10-
/// <see href="https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-metadata-service-v2.0-rd-20180702.html#statusreport-dictionary"/>
10+
/// <see href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#statusreport-dictionary"/>
1111
/// </remarks>
1212
public sealed class StatusReport
1313
{

0 commit comments

Comments
 (0)