okta: add passwordless dsso support

src/D2L.Bmx/Browser.cs

@@ -0,0 +1,62 @@
+using PuppeteerSharp;
+
+namespace D2L.Bmx;
+
+public static class Browser {
+
+	// https://github.com/microsoft/playwright/blob/6763d5ab6bd20f1f0fc879537855a26c7644a496/packages/playwright-core/src/server/registry/index.ts#L630
+	private static readonly string[] WindowsEnvironmentVariables = [
+		"LOCALAPPDATA",
+		"PROGRAMFILES",
+		"PROGRAMFILES(X86)",
+	];
+
+	// https://github.com/microsoft/playwright/blob/6763d5ab6bd20f1f0fc879537855a26c7644a496/packages/playwright-core/src/server/registry/index.ts#L457-L459
+	private static readonly string[] WindowsPartialPaths = [
+		"\\Microsoft\\Edge\\Application\\msedge.exe",
+		"\\Google\\Chrome\\Application\\chrome.exe",
+	];
+	private static readonly string[] MacPaths = [
+		"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
+		"/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
+	];
+	private static readonly string[] LinuxPaths = [
+		"/opt/google/chrome/chrome",
+		"/opt/microsoft/msedge/msedge",
+	];
+
+	public static async Task<IBrowser?> LaunchBrowserAsync( bool noSandbox = false ) {
+		string? browserPath = GetPathToBrowser();
+		if( browserPath is null ) {
+			return null;
+		}
+
+		var launchOptions = new LaunchOptions {
+			ExecutablePath = browserPath,
+			Args = noSandbox ? ["--no-sandbox"] : []
+		};
+
+		return await Puppeteer.LaunchAsync( launchOptions );
+	}
+
+	private static string? GetPathToBrowser() {
+		if( OperatingSystem.IsWindows() ) {
+			foreach( string windowsPartialPath in WindowsPartialPaths ) {
+				foreach( string environmentVariable in WindowsEnvironmentVariables ) {
+					string? prefix = Environment.GetEnvironmentVariable( environmentVariable );
+					if( prefix is not null ) {
+						string path = prefix + windowsPartialPath;
+						if( File.Exists( path ) ) {
+							return path;
+						}
+					}
+				}
+			}
+		} else if( OperatingSystem.IsMacOS() ) {
+			return MacPaths.First( File.Exists );
+		} else if( OperatingSystem.IsLinux() ) {
+			return LinuxPaths.First( File.Exists );
+		}
+		return null;
+	}
+}

src/D2L.Bmx/D2L.Bmx.csproj

@@ -14,6 +14,7 @@
     <PackageReference Include="AWSSDK.SecurityToken" Version="3.7.300.35" />
     <PackageReference Include="HtmlAgilityPack" Version="1.11.57" />
     <PackageReference Include="ini-parser-netstandard" Version="2.5.2" />
+    <PackageReference Include="PuppeteerSharp" Version="20.0.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
   </ItemGroup>
 

src/D2L.Bmx/LoginHandler.cs

@@ -5,14 +5,21 @@ OktaAuthenticator oktaAuth
 ) {
 	public async Task HandleAsync(
 		string? org,
-		string? user
+		string? user,
+		bool bypassBrowserSecurity
 	) {
 		if( !File.Exists( BmxPaths.CONFIG_FILE_NAME ) ) {
 			throw new BmxException(
 				"BMX global config file not found. Okta sessions will not be saved. Please run `bmx configure` first."
 			);
 		}
-		await oktaAuth.AuthenticateAsync( org, user, nonInteractive: false, ignoreCache: true );
+		await oktaAuth.AuthenticateAsync(
+			org,
+			user,
+			nonInteractive: false,
+			ignoreCache: true,
+			bypassBrowserSecurity: bypassBrowserSecurity
+		);
 		Console.WriteLine( "Successfully logged in and Okta session has been cached." );
 	}
 }

src/D2L.Bmx/Okta/Models/OktaSession.cs

@@ -2,6 +2,7 @@ namespace D2L.Bmx.Okta.Models;
 
 internal record OktaSession(
 	string Id,
+	string Login,
 	string UserId,
 	DateTimeOffset CreatedAt,
 	DateTimeOffset ExpiresAt

src/D2L.Bmx/Okta/OktaClient.cs

@@ -6,8 +6,8 @@
 namespace D2L.Bmx.Okta;
 
 internal interface IOktaClientFactory {
-	IOktaAnonymousClient CreateAnonymousClient( string org );
-	IOktaAuthenticatedClient CreateAuthenticatedClient( string org, string sessionId );
+	IOktaAnonymousClient CreateAnonymousClient( Uri orgUrl );
+	IOktaAuthenticatedClient CreateAuthenticatedClient( Uri orgUrl, string sessionId );
 }
 
 internal interface IOktaAnonymousClient {
@@ -23,20 +23,21 @@ string challengeResponse
 
 internal interface IOktaAuthenticatedClient {
 	Task<OktaApp[]> GetAwsAccountAppsAsync();
+	Task<OktaSession> GetCurrentOktaSessionAsync();
 	Task<string> GetPageAsync( string url );
 }
 
 internal class OktaClientFactory : IOktaClientFactory {
-	IOktaAnonymousClient IOktaClientFactory.CreateAnonymousClient( string org ) {
+	IOktaAnonymousClient IOktaClientFactory.CreateAnonymousClient( Uri orgUrl ) {
 		var httpClient = new HttpClient {
 			Timeout = TimeSpan.FromSeconds( 30 ),
-			BaseAddress = GetBaseAddress( org ),
+			BaseAddress = GetApiBaseAddress( orgUrl ),
 		};
 		return new OktaAnonymousClient( httpClient );
 	}
 
-	IOktaAuthenticatedClient IOktaClientFactory.CreateAuthenticatedClient( string org, string sessionId ) {
-		var baseAddress = GetBaseAddress( org );
+	IOktaAuthenticatedClient IOktaClientFactory.CreateAuthenticatedClient( Uri orgUrl, string sessionId ) {
+		var baseAddress = GetApiBaseAddress( orgUrl );
 
 		var cookieContainer = new CookieContainer();
 		cookieContainer.Add( new Cookie( "sid", sessionId, "/", baseAddress.Host ) );
@@ -51,10 +52,8 @@ IOktaAuthenticatedClient IOktaClientFactory.CreateAuthenticatedClient( string or
 		return new OktaAuthenticatedClient( httpClient );
 	}
 
-	private static Uri GetBaseAddress( string org ) {
-		return org.Contains( '.' )
-			? new Uri( $"https://{org}/api/v1/" )
-			: new Uri( $"https://{org}.okta.com/api/v1/" );
+	private static Uri GetApiBaseAddress( Uri orgBaseAddresss ) {
+		return new Uri( orgBaseAddresss, "api/v1/" );
 	}
 }
 
@@ -187,6 +186,19 @@ async Task<OktaApp[]> IOktaAuthenticatedClient.GetAwsAccountAppsAsync() {
 				?? throw new BmxException( "Error retrieving AWS accounts from Okta." );
 	}
 
+	async Task<OktaSession> IOktaAuthenticatedClient.GetCurrentOktaSessionAsync() {
+		OktaSession? session;
+		try {
+			session = await httpClient.GetFromJsonAsync(
+				"sessions/me",
+				JsonCamelCaseContext.Default.OktaSession );
+		} catch( Exception ex ) {
+			throw new BmxException( "Request to retrieve session from Okta failed.", ex );
+		}
+
+		return session ?? throw new BmxException( "Error retrieving session from Okta." );
+	}
+
 	async Task<string> IOktaAuthenticatedClient.GetPageAsync( string url ) {
 		return await httpClient.GetStringAsync( url );
 	}

src/D2L.Bmx/OktaAuthenticator.cs

@@ -2,6 +2,7 @@
 using System.Diagnostics.CodeAnalysis;
 using D2L.Bmx.Okta;
 using D2L.Bmx.Okta.Models;
+using PuppeteerSharp;
 
 namespace D2L.Bmx;
 
@@ -22,7 +23,8 @@ public async Task<OktaAuthenticatedContext> AuthenticateAsync(
 		string? org,
 		string? user,
 		bool nonInteractive,
-		bool ignoreCache
+		bool ignoreCache,
+		bool bypassBrowserSecurity
 	) {
 		var orgSource = ParameterSource.CliArg;
 		if( string.IsNullOrEmpty( org ) && !string.IsNullOrEmpty( config.Org ) ) {
@@ -52,11 +54,21 @@ bool ignoreCache
 			consoleWriter.WriteParameter( ParameterDescriptions.User, user, userSource );
 		}
 
-		var oktaAnonymous = oktaClientFactory.CreateAnonymousClient( org );
+		var orgUrl = GetOrgBaseAddress( org );
+		var oktaAnonymous = oktaClientFactory.CreateAnonymousClient( orgUrl );
 
-		if( !ignoreCache && TryAuthenticateFromCache( org, user, oktaClientFactory, out var oktaAuthenticated ) ) {
+		if( !ignoreCache && TryAuthenticateFromCache( orgUrl, user, oktaClientFactory, out var oktaAuthenticated ) ) {
 			return new OktaAuthenticatedContext( Org: org, User: user, Client: oktaAuthenticated );
 		}
+		if( await GetDssoAuthenticatedClientAsync(
+			orgUrl,
+			user,
+			oktaClientFactory,
+			nonInteractive,
+			bypassBrowserSecurity ) is { } oktaDssoAuthenticated
+		) {
+			return new OktaAuthenticatedContext( Org: org, User: user, Client: oktaDssoAuthenticated );
+		}
 		if( nonInteractive ) {
 			throw new BmxException( "Okta authentication failed. Please run `bmx login` first." );
 		}
@@ -95,15 +107,8 @@ mfaFactor is OktaMfaQuestionFactor // Security question factor is a static value
 		if( authnResponse is AuthenticateResponse.Success successInfo ) {
 			var sessionResp = await oktaAnonymous.CreateSessionAsync( successInfo.SessionToken );
 
-			oktaAuthenticated = oktaClientFactory.CreateAuthenticatedClient( org, sessionResp.Id );
-			if( File.Exists( BmxPaths.CONFIG_FILE_NAME ) ) {
-				CacheOktaSession( user, org, sessionResp.Id, sessionResp.ExpiresAt );
-			} else {
-				consoleWriter.WriteWarning( """
-					No config file found. Your Okta session will not be cached.
-					Consider running `bmx configure` if you own this machine.
-					""" );
-			}
+			oktaAuthenticated = oktaClientFactory.CreateAuthenticatedClient( orgUrl, sessionResp.Id );
+			TryCacheOktaSession( user, orgUrl.Host, sessionResp.Id, sessionResp.ExpiresAt );
 			return new OktaAuthenticatedContext( Org: org, User: user, Client: oktaAuthenticated );
 		}
 
@@ -114,26 +119,142 @@ No config file found. Your Okta session will not be cached.
 		throw new UnreachableException( $"Unexpected response type: {authnResponse.GetType()}" );
 	}
 
+	private static Uri GetOrgBaseAddress( string org ) {
+		return org.Contains( '.' )
+			? new Uri( $"https://{org}/" )
+			: new Uri( $"https://{org}.okta.com/" );
+	}
+
 	private bool TryAuthenticateFromCache(
-		string org,
+		Uri orgBaseAddress,
 		string user,
 		IOktaClientFactory oktaClientFactory,
 		[NotNullWhen( true )] out IOktaAuthenticatedClient? oktaAuthenticated
 	) {
-		string? sessionId = GetCachedOktaSessionId( user, org );
+		string? sessionId = GetCachedOktaSessionId( user, orgBaseAddress.Host );
 		if( string.IsNullOrEmpty( sessionId ) ) {
 			oktaAuthenticated = null;
 			return false;
 		}
 
-		oktaAuthenticated = oktaClientFactory.CreateAuthenticatedClient( org, sessionId );
+		oktaAuthenticated = oktaClientFactory.CreateAuthenticatedClient( orgBaseAddress, sessionId );
 		return true;
 	}
 
+	private async Task<IOktaAuthenticatedClient?> GetDssoAuthenticatedClientAsync(
+		Uri orgUrl,
+		string user,
+		IOktaClientFactory oktaClientFactory,
+		bool nonInteractive,
+		bool experimentalBypassBrowserSecurity
+	) {
+		await using IBrowser? browser = await Browser.LaunchBrowserAsync( experimentalBypassBrowserSecurity );
+		if( browser is null ) {
+			return null;
+		}
+
+		if( !nonInteractive ) {
+			Console.Error.WriteLine( "Attempting to automatically login using Okta Desktop Single Sign-On." );
+		}
+		using var cancellationTokenSource = new CancellationTokenSource( TimeSpan.FromSeconds( 15 ) );
+		var sessionIdTcs = new TaskCompletionSource<string?>( TaskCreationOptions.RunContinuationsAsynchronously );
+		string? sessionId;
+
+		try {
+			using var page = await browser.NewPageAsync().WaitAsync( cancellationTokenSource.Token );
+			int attempt = 1;
+
+			page.Load += ( _, _ ) => _ = GetSessionCookieAsync();
+			await page.GoToAsync( orgUrl.AbsoluteUri ).WaitAsync( cancellationTokenSource.Token );
+			sessionId = await sessionIdTcs.Task;
+
+			async Task GetSessionCookieAsync() {
+				var url = new Uri( page.Url );
+				if( url.Host == orgUrl.Host ) {
+					string title = await page.GetTitleAsync().WaitAsync( cancellationTokenSource.Token );
+					// DSSO can sometimes takes more than one attempt.
+					// If the path is '/' with 'sign in' in the title, it means DSSO is not available and we should stop retrying.
+					if( title.Contains( "sign in", StringComparison.OrdinalIgnoreCase ) ) {
+						if( attempt < 3 && url.AbsolutePath != "/" ) {
+							attempt++;
+							await page.GoToAsync( orgUrl.AbsoluteUri ).WaitAsync( cancellationTokenSource.Token );
+						} else {
+							consoleWriter.WriteWarning(
+								"WARNING: Could not authenticate with Okta using Desktop Single Sign-On." );
+							sessionIdTcs.SetResult( null );
+						}
+						return;
+					}
+				}
+				var cookies = await page.GetCookiesAsync( orgUrl.AbsoluteUri ).WaitAsync( cancellationTokenSource.Token );
+				if( Array.Find( cookies, c => c.Name == "sid" )?.Value is string sid ) {
+					sessionIdTcs.SetResult( sid );
+				}
+			}
+		} catch( TaskCanceledException ) {
+			consoleWriter.WriteWarning( $"""
+				WARNING: Timed out when trying to create Okta session through Desktop Single Sign-On.
+				Check if the org '{orgUrl}' is correct. If running BMX with elevated privileges,
+				rerun the command with the '--experimental-bypass-browser-security' flag
+				"""
+			);
+			return null;
+		} catch( TargetClosedException ) {
+			consoleWriter.WriteWarning( """
+				WARNING: Failed to create Okta session through Desktop Single Sign-On as BMX is likely being run
+				with elevated privileges. Rerun the command with the '--experimental-bypass-browser-security' flag.
+				"""
+			);
+			return null;
+		} catch( Exception ) {
+			consoleWriter.WriteWarning(
+				"WARNING: Unknown error while trying to authenticate with Okta using Desktop Single Sign-On." );
+			return null;
+		}
+
+		if( sessionId is null ) {
+			return null;
+		}
+
+		var oktaAuthenticatedClient = oktaClientFactory.CreateAuthenticatedClient( orgUrl, sessionId );
+		var oktaSession = await oktaAuthenticatedClient.GetCurrentOktaSessionAsync();
+		if( !OktaUserMatchesProvided( oktaSession.Login, user ) ) {
+			consoleWriter.WriteWarning(
+				"WARNING: Could not create Okta session using Desktop Single Sign-On as provided Okta user "
+				+ $"'{StripLoginDomain( user )}' does not match user '{StripLoginDomain( oktaSession.Login )}'." );
+			return null;
+		}
+
+		TryCacheOktaSession( user, orgUrl.Host, sessionId, oktaSession.ExpiresAt );
+		return oktaAuthenticatedClient;
+	}
+
+	private static string StripLoginDomain( string email ) {
+		return email.Contains( '@' ) ? email.Split( '@' )[0] : email;
+	}
+
+	private static bool OktaUserMatchesProvided( string oktaLogin, string providedUser ) {
+		string adName = StripLoginDomain( oktaLogin );
+		string normalizedUser = StripLoginDomain( providedUser );
+		return adName.Equals( normalizedUser, StringComparison.OrdinalIgnoreCase );
+	}
+
+	private bool TryCacheOktaSession( string userId, string org, string sessionId, DateTimeOffset expiresAt ) {
+		if( File.Exists( BmxPaths.CONFIG_FILE_NAME ) ) {
+			CacheOktaSession( userId, org, sessionId, expiresAt );
+			return true;
+		}
+		consoleWriter.WriteWarning( """
+					No config file found. Your Okta session will not be cached.
+					Consider running `bmx configure` if you own this machine.
+					""" );
+		return false;
+	}
+
 	private void CacheOktaSession( string userId, string org, string sessionId, DateTimeOffset expiresAt ) {
 		var session = new OktaSessionCache( userId, org, sessionId, expiresAt );
 		var sessionsToCache = ReadOktaSessionCacheFile();
-		sessionsToCache = sessionsToCache.Where( session => session.UserId != userId && session.Org != org )
+		sessionsToCache = sessionsToCache.Where( session => session.UserId != userId || session.Org != org )
 			.ToList();
 		sessionsToCache.Add( session );
 

src/D2L.Bmx/ParameterDescriptions.cs

@@ -18,4 +18,7 @@ internal static class ParameterDescriptions {
 		Write BMX command to AWS profile, so that AWS tools & SDKs using the profile will source credentials from BMX.
 		See https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sourcing-external.html.
 		""";
+
+	public const string ExperimentalBypassBrowserSecurity
+		= "Disable chromium sandbox when running with elevated permissions for Okta Desktop Single Sign-On";
 }