Skip to content

Commit 57d9436

Browse files
Improve documentation (#308)
1 parent a8d9d5f commit 57d9436

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Src/Fido2.Models/Fido2Configuration.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ namespace Fido2NetLib
66
{
77
public class Fido2Configuration
88
{
9+
private HashSet<string> _origins;
10+
private HashSet<string> _fullyQualifiedOrigins;
11+
12+
/// <summary>
13+
/// Create the configuration for Fido2.
14+
/// </summary>
15+
public Fido2Configuration()
16+
{
17+
}
18+
919
/// <summary>
1020
/// This member specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
1121
/// This is treated as a hint, and MAY be overridden by the client.
@@ -28,12 +38,12 @@ public class Fido2Configuration
2838
public string ServerDomain { get; set; }
2939

3040
/// <summary>
31-
/// A human friendly name of the RP
41+
/// A human-friendly name of the RP.
3242
/// </summary>
3343
public string ServerName { get; set; }
3444

3545
/// <summary>
36-
/// A serialized URL which resolves to an image associated with the entity.For example, this could be a user’s avatar or a Relying Party's logo. This URL MUST be an a priori authenticated URL. Authenticators MUST accept and store a 128-byte minimum length for an icon member’s value. Authenticators MAY ignore an icon member’s value if its length is greater than 128 bytes. The URL’s scheme MAY be "data" to avoid fetches of the URL, at the cost of needing more storage.
46+
/// A serialized URL which resolves to an image associated with the entity. For example, this could be a user’s avatar or a Relying Party's logo. This URL MUST be an a priori authenticated URL. Authenticators MUST accept and store a 128-byte minimum length for an icon member’s value. Authenticators MAY ignore an icon member’s value if its length is greater than 128 bytes. The URL’s scheme MAY be "data" to avoid fetches of the URL, at the cost of needing more storage.
3747
/// </summary>
3848
public string ServerIcon { get; set; }
3949

@@ -88,7 +98,7 @@ public HashSet<string> FullyQualifiedOrigins
8898
}
8999

90100
/// <summary>
91-
/// MDSCacheDirPath
101+
/// Metadata service cache directory path.
92102
/// </summary>
93103
public string MDSCacheDirPath { get; set; }
94104

@@ -103,15 +113,5 @@ public HashSet<string> FullyQualifiedOrigins
103113
AuthenticatorStatus.USER_KEY_PHYSICAL_COMPROMISE,
104114
AuthenticatorStatus.REVOKED
105115
};
106-
107-
/// <summary>
108-
/// Create the configuration for Fido2
109-
/// </summary>
110-
public Fido2Configuration()
111-
{
112-
}
113-
114-
private HashSet<string> _origins;
115-
private HashSet<string> _fullyQualifiedOrigins;
116116
}
117117
}

0 commit comments

Comments
 (0)