ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-13 17:23:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix email extraction from username (#2075)

Browse Source
This commit is contained in:
Cheena Malhotra
2023-05-30 14:46:18 -07:00
committed by GitHub
parent 97988661ec
commit b4f7bd01af
2 changed files with 99 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/Microsoft.SqlTools.Authentication/Authenticator.cs
View File

@@ -58,10 +58,27 @@ namespace Microsoft.SqlTools.Authentication
IEnumerator<IAccount>? accounts = (await publicClientApplication.GetAccountsAsync().ConfigureAwait(false)).GetEnumerator();
IAccount? account = default;
if (!string.IsNullOrEmpty(@params.UserName) && accounts.MoveNext())
if (!string.IsNullOrEmpty(@params.UserName))
{
// Handle username format to extract email: "John Doe - johndoe@constoso.com"
string username = @params.UserName.Contains(" - ") ? @params.UserName.Split(" - ")[1] : @params.UserName;
// Handle username format to extract email: "John Doe - johndoe@constoso.com" as received from ADS/VSCode-MSSQL
// Additional possible usernames to consider:
// John Doe (Role - Department) - johndoe@constoso.com
// John - Doe - johndoe@constoso.com
// John Doe - john-doe@constoso.com
// John Doe - john-doe@constoso.org-name.com
// A different way of implementing this is by sending user's email directly to STS in 'username' property but that would cause incompatibility
// with saved connection profiles and reading from settings.json, therefore this solution is used as of now.
string emailSeparator = " - ";
string username = @params.UserName;
if (username.Contains(emailSeparator))
{
int startIndex = username.LastIndexOf(emailSeparator) + emailSeparator.Length;
username = username.Substring(startIndex);
}
if (!Utils.isValidEmail(username))
{
SqlToolsLogger.Pii($"{nameof(Authenticator)}.{nameof(GetTokenAsync)} | Unexpected username format, email not retreived: {@params.UserName}. " +
@@ -69,6 +86,8 @@ namespace Microsoft.SqlTools.Authentication
throw new Exception($"Invalid email address format for user: [{username}] received for Azure Active Directory authentication.");
}
if (accounts.MoveNext())
{
do
{
IAccount? currentVal = accounts.Current;
@@ -105,6 +124,12 @@ namespace Microsoft.SqlTools.Authentication
}
}
else
{
SqlToolsLogger.Error($"{nameof(Authenticator)}.{nameof(GetTokenAsync)} | Account not found in MSAL cache for user.");
throw new Exception($"User account '{username}' not found in MSAL cache, please add linked account or refresh account credentials.");
}
}
else
{
SqlToolsLogger.Error($"{nameof(Authenticator)}.{nameof(GetTokenAsync)} | User account not received.");
throw new Exception($"User account not received.");

50
test/Microsoft.SqlTools.ServiceLayer.UnitTests/Authentication/AuthenticatorTests.cs Normal file
View File

@@ -0,0 +1,50 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.SqlTools.Authentication;
using NUnit.Framework;
namespace Microsoft.SqlTools.ServiceLayer.UnitTests.Authentication
{
[TestFixture]
public class AuthenticatorTests
{
[Test]
[TestCase("John Doe - johndoe@constoso.com", "johndoe@constoso.com")]
[TestCase("John Doe - john-doe@constoso.com", "john-doe@constoso.com")]
[TestCase("John Doe (Manager - Sales) - johndoe@constoso.com", "johndoe@constoso.com")]
[TestCase("John - Doe (Manager - Sales) - john-doe@constoso.com", "john-doe@constoso.com")]
[TestCase("John Doe - johndoe@constoso-sales.com", "johndoe@constoso-sales.com")]
[TestCase("johndoe@constoso.com", "johndoe@constoso.com")]
[TestCase("johndoe@constoso-sales.com", "johndoe@constoso-sales.com")]
public async Task GetTokenAsyncExtractsEmailSuccessfully(string username, string expectedEmail)
{
Authenticator authenticator = new Authenticator(new SqlTools.Authentication.Utility.AuthenticatorConfiguration(
Guid.NewGuid().ToString(), "AppName", ".", "dummyCacheFile"), () => ("key", "iv"));
try
{
await authenticator.GetTokenAsync(new AuthenticationParams(AuthenticationMethod.ActiveDirectoryInteractive,
"https://login.microsoftonline.com/",
"common",
"https://database.windows.net/",
new string[] {
"https://database.windows.net/.default"
},
username,
Guid.Empty),
CancellationToken.None);
Assert.Fail("Expected exception did not occur.");
}
catch (Exception e)
{
Assert.False(e.Message.StartsWith("Invalid email address format", StringComparison.OrdinalIgnoreCase), $"Email address format should be correct, message received: {e.Message}");
Assert.True(e.Message.Contains($"User account '{expectedEmail}' not found in MSAL cache, please add linked account or refresh account credentials."), $"Expected error did not occur, message received: {e.Message}");
}
}
}
}