Add documentation for PortalSecurity.cs

DNN Platform/Library/Security/PortalSecurity.cs

@@ -137,6 +137,9 @@ private enum RoleType
             Owner = 3,
         }
 
+        /// <summary>
+        /// Forces the secure connection.
+        /// </summary>
         public static void ForceSecureConnection()
         {
             // get current url
@@ -163,6 +166,11 @@ public static void ForceSecureConnection()
             }
         }
 
+        /// <summary>
+        /// Gets the cookie domain for the portal group or from web.config.
+        /// </summary>
+        /// <param name="portalId">The portal identifier.</param>
+        /// <returns>Cookie domain for the portal group or from web.config.</returns>
         public static string GetCookieDomain(int portalId)
         {
             string cookieDomain = string.Empty;
@@ -193,13 +201,31 @@ public static string GetCookieDomain(int portalId)
             return cookieDomain;
         }
 
+        /// <summary>
+        /// Determined whether the current user is denied for the given role(s)
+
+        /// </summary>
+        /// <param name="roles">The semicolon separated list of roles.</param>
+        /// <returns>
+        ///   <c>true</c> if the current user is denied from the provided specified roles; otherwise, <c>false</c>.
+
+        /// </returns>
         public static bool IsDenied(string roles)
         {
             UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
             PortalSettings settings = PortalController.Instance.GetCurrentPortalSettings();
             return IsDenied(objUserInfo, settings, roles);
         }
 
+        /// <summary>
+        /// Determines whether the specified user is denied for the given roles.
+        /// </summary>
+        /// <param name="objUserInfo">The user information.</param>
+        /// <param name="settings">The settings.</param>
+        /// <param name="roles">The semicolon separated list of roles.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified user is denied; otherwise, <c>false</c>.
+        /// </returns>
         public static bool IsDenied(UserInfo objUserInfo, PortalSettings settings, string roles)
         {
             // super user always has full access
@@ -238,6 +264,13 @@ public static bool IsDenied(UserInfo objUserInfo, PortalSettings settings, strin
             return isDenied;
         }
 
+        /// <summary>
+        /// Determines whether the current user belonds to the specified role.
+        /// </summary>
+        /// <param name="role">The role name.</param>
+        /// <returns>
+        ///   <c>true</c> if user belongs to the specified role; otherwise, <c>false</c>.
+        /// </returns>
         public static bool IsInRole(string role)
         {
             if (!string.IsNullOrEmpty(role) && role == Globals.glbRoleUnauthUserName && !HttpContext.Current.Request.IsAuthenticated)
@@ -248,13 +281,31 @@ public static bool IsInRole(string role)
             return IsInRoles(UserController.Instance.GetCurrentUserInfo(), PortalController.Instance.GetCurrentPortalSettings(), role);
         }
 
+        /// <summary>
+        /// Determines whether the current user belongs to the specified roles.
+        /// </summary>
+        /// <param name="roles">The semicolon separated list of roles.</param>
+        /// <returns>
+        ///   <c>true</c> if user belongs to the specified roles; otherwise, <c>false</c>.
+        /// </returns>
         public static bool IsInRoles(string roles)
         {
             UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
             PortalSettings settings = PortalController.Instance.GetCurrentPortalSettings();
             return IsInRoles(objUserInfo, settings, roles);
         }
 
+        /// <summary>
+        /// Determines whether the provided user belongs to the specified roles.
+
+        /// </summary>
+        /// <param name="objUserInfo">The user information.</param>
+        /// <param name="settings">The settings.</param>
+        /// <param name="roles">The semicolon separated list of roles.</param>
+        /// <returns>
+        ///   <c>true</c> if the provided user belongs to the specific roles; otherwise, <c>false</c>.
+
+        /// </returns>
         public static bool IsInRoles(UserInfo objUserInfo, PortalSettings settings, string roles)
         {
             // super user always has full access
@@ -280,20 +331,45 @@ public static bool IsInRoles(UserInfo objUserInfo, PortalSettings settings, stri
             return isInRoles;
         }
 
+        /// <summary>
+        /// Determines whether the specified user is a friend of the current user.
+
+        /// </summary>
+        /// <param name="userId">The user identifier.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified user is a friend of the current user; otherwise, <c>false</c>.
+
+        /// </returns>
         public static bool IsFriend(int userId)
         {
             UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
             PortalSettings settings = PortalController.Instance.GetCurrentPortalSettings();
             return IsInRoles(objUserInfo, settings, RoleFriendPrefix + userId);
         }
 
+        /// <summary>
+        /// Determines whether the specified user is a follower of the current user.
+
+        /// </summary>
+        /// <param name="userId">The user identifier.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified user is a follower of the current user; otherwise, <c>false</c>.
+
+        /// </returns>
         public static bool IsFollower(int userId)
         {
             UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
             PortalSettings settings = PortalController.Instance.GetCurrentPortalSettings();
             return IsInRoles(objUserInfo, settings, RoleFollowerPrefix + userId);
         }
 
+        /// <summary>
+        /// Determines whether the specified user is an owner.
+        /// </summary>
+        /// <param name="userId">The user identifier.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified user is an owner; otherwise, <c>false</c>.
+        /// </returns>
         public static bool IsOwner(int userId)
         {
             UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
@@ -315,21 +391,51 @@ public string CreateKey(int numBytes)
             }
         }
 
+        /// <summary>
+        /// Decrypts the provided string data using a supplied key.
+
+        /// </summary>
+        /// <param name="strKey">The encryption key.</param>
+
+        /// <param name="strData">The encrypted data.</param>
+
+        /// <returns>The decrypted string.</returns>
         public string Decrypt(string strKey, string strData)
         {
             return CryptographyProvider.Instance().DecryptParameter(strData, strKey);
         }
 
+        /// <summary>
+        /// Decrypts a string using a provided passphrase.
+
+        /// </summary>
+        /// <param name="message">The encrypted message.</param>
+
+        /// <param name="passphrase">The passphrase.</param>
+        /// <returns>The decrypted string.</returns>
         public string DecryptString(string message, string passphrase)
         {
             return CryptographyProvider.Instance().DecryptString(message, passphrase);
         }
 
+        /// <summary>
+        /// Encrypts the specified key.
+        /// </summary>
+        /// <param name="key">The key.</param>
+        /// <param name="data">The data.</param>
+        /// <returns>The encrypted string.</returns>
         public string Encrypt(string key, string data)
         {
             return CryptographyProvider.Instance().EncryptParameter(data, key);
         }
 
+        /// <summary>
+        /// Encrypts a string using a provided passphrase
+
+        /// </summary>
+        /// <param name="message">The message.</param>
+        /// <param name="passphrase">The passphrase.</param>
+        /// <returns>The encrypted string.</returns>
         public string EncryptString(string message, string passphrase)
         {
             return CryptographyProvider.Instance().EncryptString(message, passphrase);
@@ -500,6 +606,12 @@ public string Remove(string inputString, ConfigType configType, string configSou
             return inputString;
         }
 
+        /// <summary>
+        /// Signs the provided user in and sets a persistent login cookie if needed
+
+        /// </summary>
+        /// <param name="user">The user info.</param>
+        /// <param name="createPersistentCookie">if set to <c>true</c> [create persistent cookie].</param>
         public void SignIn(UserInfo user, bool createPersistentCookie)
         {
             if (PortalController.IsMemberOfPortalGroup(user.PortalID) || createPersistentCookie)
@@ -574,6 +686,10 @@ public void SignIn(UserInfo user, bool createPersistentCookie)
             HttpContext.Current.Items["DNN_UserSignIn"] = true;
         }
 
+        /// <summary>
+        /// Signs the current user out.
+
+        /// </summary>
         public void SignOut()
         {
             InvalidateAspNetSession(HttpContext.Current);