Bug fixes, comments

Author: mvadu

AdysTech.CredentialManager/CredentialManager.cs

@@ -16,7 +16,11 @@ namespace AdysTech.CredentialManager
     public static class CredentialManager
     {
 
-
+        /// <summary>
+        /// Opens OS Version specific Window prompting for credentials
+        /// </summary>
+        /// <param name="Target">A descriptive text for where teh credentials being asked are used for</param>
+        /// <returns>NetworkCredential object containing the user name, </returns>
         public static NetworkCredential PromptForCredentials(string Target)
         {
             var username = String.Empty;
@@ -28,6 +32,13 @@ public static NetworkCredential PromptForCredentials(string Target)
             return new NetworkCredential (username, passwd, domain);
         }
 
+        /// <summary>
+        /// Opens OS Version specific Window prompting for credentials
+        /// </summary>
+        /// <param name="Target">A descriptive text for where teh credentials being asked are used for</param>
+        /// <param name="Message">A brief message to display in the dialog box</param>
+        /// <param name="Caption">Title for the dialog box</param>
+        /// <returns>NetworkCredential object containing the user name, </returns>
         public static NetworkCredential PromptForCredentials(string Target, string Message, string Caption)
         {
             var username = String.Empty;
@@ -96,7 +107,12 @@ private static bool PromptForCredentials(string target, NativeStructs.Credential
 
 
 
-
+        /// <summary>
+        /// Saves teh given Network Credential into Windows Credential store
+        /// </summary>
+        /// <param name="Target">Name of the application/Url where the credential is used for</param>
+        /// <param name="credential">Credential to store</param>
+        /// <returns>True:Success, False:Failure</returns>
         public static bool SaveCredentials(string Target, NetworkCredential credential)
         {
             // Go ahead with what we have are stuff it into the CredMan structures.
@@ -118,6 +134,12 @@ public static bool SaveCredentials(string Target, NetworkCredential credential)
             }
         }
 
+
+        /// <summary>
+        /// Extract the stored credential from WIndows Credential store
+        /// </summary>
+        /// <param name="Target">Name of the application/Url where the credential is used for</param>
+        /// <returns>null if target not found, else stored credentials</returns>
         public static NetworkCredential GetCredentials(string Target)
         {
             IntPtr nCredPtr;
@@ -141,7 +163,16 @@ public static NetworkCredential GetCredentials(string Target)
                     var user = cred.UserName;
                     StringBuilder userBuilder = new StringBuilder ();
                     StringBuilder domainBuilder = new StringBuilder ();
-                    NativeStructs.CredUIParseUserName (user, userBuilder, int.MaxValue, domainBuilder, int.MaxValue);
+                    var ret1 = NativeStructs.CredUIParseUserName (user, userBuilder, int.MaxValue, domainBuilder, int.MaxValue);
+                    lastError = Marshal.GetLastWin32Error ();
+
+                    //assuming invalid account name to be not meeting condition for CredUIParseUserName 
+                    //"The name must be in UPN or down-level format, or a certificate"
+                    if ( ret1 == NativeStructs.CredentialUIReturnCodes.ERROR_INVALID_ACCOUNT_NAME )
+                        userBuilder.Append (user);
+                    else if ( (uint) ret1 > 0 )
+                        throw new Win32Exception (lastError, "CredUIParseUserName throw an error");
+
                     username = userBuilder.ToString ();
                     domain = domainBuilder.ToString ();
                     return new NetworkCredential (username, passwd, domain);
@@ -150,6 +181,12 @@ public static NetworkCredential GetCredentials(string Target)
             return null;
         }
 
+
+        /// <summary>
+        /// Remove stored credentials from windows credential store
+        /// </summary>
+        /// <param name="Target">Name of the application/Url where the credential is used for</param>
+        /// <returns>True: Success, False: Failure</returns>
         public static bool RemoveCredentials(string Target)
         {
             // Make the API call using the P/Invoke signature
@@ -160,6 +197,11 @@ public static bool RemoveCredentials(string Target)
             return ret;
         }
 
+        /// <summary>
+        /// Generates a string that can be used for "Auth" headers in web requests, "username:password" encoded in Base64
+        /// </summary>
+        /// <param name="cred"></param>
+        /// <returns></returns>
         public static string GetBasicAuthString(this NetworkCredential cred)
         {
             byte[] credentialBuffer = new UTF8Encoding ().GetBytes (cred.UserName + ":" + cred.Password);

AdysTech.CredentialManager/NativeStructs.cs

@@ -31,7 +31,7 @@ internal enum CredentialUIFlags
             KEEP_USERNAME = 0x100000,
         }
 
-        internal enum CredentialUIReturnCodes
+        internal enum CredentialUIReturnCodes : uint
         {
             NO_ERROR = 0,
             ERROR_CANCELLED = 1223,
@@ -65,7 +65,7 @@ internal static extern CredentialUIReturnCodes CredUIPromptForCredentials(ref Cr
           [MarshalAs (UnmanagedType.Bool)] ref bool pfSave,
           CredentialUIFlags flags);
 
-        [DllImport ("credui.dll", EntryPoint = "CredUIParseUserNameW", CharSet = CharSet.Unicode)]
+        [DllImport ("credui.dll", EntryPoint = "CredUIParseUserNameW", CharSet = CharSet.Unicode, SetLastError = true)]
         internal static extern CredentialUIReturnCodes CredUIParseUserName(
                 string userName,
                 StringBuilder user,
@@ -102,7 +102,7 @@ internal struct NativeCredential
             public IntPtr Attributes;
             public IntPtr TargetAlias;
             public IntPtr UserName;
-           
+
         }
 
         [DllImport ("Advapi32.dll", EntryPoint = "CredDeleteW", CharSet = CharSet.Unicode, SetLastError = true)]

CredentialManager.Test/CredentialManagerTest.cs

@@ -31,7 +31,7 @@ public void TestGetCredentials()
 
             try
             {
-                Assert.IsNotNull (CredentialManager.GetCredentials ("TestSystem"), "GetCredential failed");
+                Assert.IsNotNull (CredentialManager.GetCredentials ("localhost:8086"), "GetCredential failed");
             }
             catch ( Exception e )
             {