Adding some xml summaries for WAMP-CRA

Author: Elad Zelingher

src/net45/WampSharp/Core/Cra/IWampCraChallenge.cs

@@ -1,9 +1,28 @@
 namespace WampSharp.Core.Cra
 {
+    /// <summary>
+    /// Represents details of a WAMP-CRA challenge.
+    /// </summary>
     public interface IWampCraChallenge
     {
+        /// <summary>
+        /// Gets the salt to use in order to compute the signature, sent to the user that upon CHALLENGE
+        /// message. (in challenge.extra)
+        /// </summary>
         string Salt { get; }
+
+        /// <summary>
+        /// Gets the number of iterations to use in order to compute the signature, 
+        /// sent to the user that upon CHALLENGE
+        /// message. (in challenge.extra)
+        /// </summary>
         int? Iterations { get; }
+ 
+        /// <summary>
+        /// Gets the keylength to use in order to compute the signature, 
+        /// sent to the user that upon CHALLENGE
+        /// message. (in challenge.extra)
+        /// </summary>
         int? KeyLength { get; }
     }
 }

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/IWampCraUserDb.cs

@@ -1,7 +1,15 @@
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// Represents a database of WampCra users.
+    /// </summary>
     public interface IWampCraUserDb
     {
+        /// <summary>
+        /// Gets the requetsed user's details given its authentication id.
+        /// </summary>
+        /// <param name="authenticationId">The requested user's authentication id.</param>
+        /// <returns>The user's WAMP-CRA authentication details.</returns>
         WampCraUser GetUserById(string authenticationId);
     }
 }

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraChallengeDetails.cs

@@ -4,12 +4,21 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// An implementation of <see cref="ChallengeDetails"/> specific for WAMP-CRA authentication.
+    /// </summary>
     [DataContract]
     public class WampCraChallengeDetails : ChallengeDetails, IWampCraChallenge
     {
         private const int DefaultIterations = 1000;
         private const int DefaultKeyLength = 32;
 
+        /// <summary>
+        /// Instantiates a new instance of <see cref="WampCraChallengeDetails"/>.
+        /// </summary>
+        /// <param name="salt">The salt to use, sent to the user upon CHALLENGE.extra.</param>
+        /// <param name="iterations">The number of iterations to use, sent to the user upon CHALLENGE.extra.</param>
+        /// <param name="keyLen">The key length to use, sent to the user upon CHALLENGE.extra.</param>
         public WampCraChallengeDetails(string salt,
                                        int? iterations = DefaultIterations,
                                        int? keyLen = DefaultKeyLength)
@@ -23,6 +32,10 @@ internal WampCraChallengeDetails()
         {
         }
 
+        /// <summary>
+        /// Gets the authentication challenge - this is the challenge that will be sent upon CHALLENGE
+        /// message. (in challenge.extra)
+        /// </summary>
         [DataMember(Name = "challenge")]
         public string Challenge { get; internal set; }
 

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraSessionAuthenticator.cs

@@ -5,6 +5,9 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// An abstract class for an implementation of a WAMP-CRA <see cref="IWampSessionAuthenticator"/>.
+    /// </summary>
     public abstract class WampCraSessionAuthenticator : WampSessionAuthenticator
     {
         private readonly string mAuthenticationId;

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraStaticUserDb.cs

@@ -2,10 +2,18 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// Represents a static data based implementation of <see cref="IWampCraUserDb"/>.
+    /// </summary>
     public class WampCraStaticUserDb : IWampCraUserDb
     {
         private readonly IDictionary<string, WampCraUser> mUsers;
 
+        /// <summary>
+        /// Instantiates a new instance of <see cref="WampCraStaticUserDb"/> given
+        /// a map of authentication id to WAMP-CRA user details.
+        /// </summary>
+        /// <param name="users">The given map of authentication id to WAMP-CRA user details.</param>
         public WampCraStaticUserDb(IDictionary<string, WampCraUser> users)
         {
             mUsers = users;

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraUser.cs

@@ -2,12 +2,24 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// Represents details of a WAMP-CRA user.
+    /// </summary>
     public class WampCraUser : IWampCraChallenge
     {
+        /// <summary>
+        /// Gets the user's authentication id. If null, uses HELLO.details.authid.
+        /// </summary>
         public string AuthenticationId { get; set; }
 
+        /// <summary>
+        /// Gets the user's authentication role.
+        /// </summary>
         public string AuthenticationRole { get; set; }
 
+        /// <summary>
+        /// Gets the user's secret. If salted, contains the derived key (and NOT the actual secret).
+        /// </summary>
         public string Secret { get; set; }
 
         public string Salt { get; set; }

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraUserDbAuthenticationFactory.cs

@@ -4,12 +4,23 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// An implementation of <see cref="IWampSessionAuthenticatorFactory"/>
+    /// which is based on <see cref="IWampCraUserDb"/> and <see cref="IWampAuthenticationProvider"/>.
+    /// </summary>
     public class WampCraUserDbAuthenticationFactory : IWampSessionAuthenticatorFactory
     {
-        private const string WAMP_CRA = WampAuthenticationMethods.WampCra;
+        private const string WampCra = WampAuthenticationMethods.WampCra;
         private readonly IWampAuthenticationProvider mAuthenticationProvider;
         private readonly IWampCraUserDb mUserDb;
 
+        /// <summary>
+        /// Instantiates a new instance of <see cref="WampCraUserDbAuthenticationFactory"/>
+        /// given the <see cref="IWampAuthenticationProvider"/> and
+        /// the <see cref="IWampCraUserDb"/> to use.
+        /// </summary>
+        /// <param name="authenticationProvider">The <see cref="IWampAuthenticationProvider"/> to get role permissions.</param>
+        /// <param name="userDb">The <see cref="IWampCraUserDb"/> to use to get user WAMP-CRA details.</param>
         public WampCraUserDbAuthenticationFactory(IWampAuthenticationProvider authenticationProvider,
                                                   IWampCraUserDb userDb)
         {
@@ -24,7 +35,7 @@ public IWampSessionAuthenticator GetSessionAuthenticator
             HelloDetails helloDetails = details.HelloDetails;
 
             if ((helloDetails.AuthenticationMethods == null) || 
-                !helloDetails.AuthenticationMethods.Contains(WAMP_CRA))
+                !helloDetails.AuthenticationMethods.Contains(WampCra))
             {
                 throw new WampAuthenticationException("supports only 'wampcra' authentication");
             }

src/net45/WampSharp/WAMP2/V2/Authentication/WampCra/WampCraUserDbSessionAuthenticator.cs

@@ -3,11 +3,24 @@
 
 namespace WampSharp.V2.Authentication
 {
+    /// <summary>
+    /// An implementation of <see cref="IWampSessionAuthenticator"/> which uses
+    /// <see cref="WampCraUser"/> in order to compute WAMP-CRA key, and uses
+    /// <see cref="WampAuthenticationRole"/> in order to check permissions.
+    /// </summary>
     public class WampCraUserDbSessionAuthenticator : WampCraSessionAuthenticator
     {
         private readonly WampCraUser mUser;
         private readonly string mAuthenticationChallenge;
 
+        /// <summary>
+        /// Instantiates a new instance of <see cref="WampCraUserDbSessionAuthenticator"/>
+        /// given the WAMP-CRA user details, the <see cref="WampAuthenticationRole"/> and
+        /// the user's session id.
+        /// </summary>
+        /// <param name="user">The given user's WAMP-CRA details, used for authentication.</param>
+        /// <param name="role">The given user's role, used for authorization.</param>
+        /// <param name="sessionId">The given user's session id.</param>
         public WampCraUserDbSessionAuthenticator(WampCraUser user, WampAuthenticationRole role, long sessionId) :
             base(user.AuthenticationId)
         {