Enable broker support on Linux platform #5086

xinyuxu1026 · 2025-01-16T00:05:05Z

Fixes #

Changes proposed in this request

Add broker support on Linux and WSL platforms
Update msalruntime to version 0.18.0

Testing

Performance impact

Documentation

All relevant documentation is updated.

gladjohn · 2025-01-16T05:00:37Z

NuGet.Config

@@ -3,5 +3,6 @@
  <packageSources>
    <clear />
    <add key="NuGet" value="https://api.nuget.org/v3/index.json" />
+    <add key="LocalPackages" value="/mnt/c/Users//Documents/MyLocalNugetPackages" />


please remove this

gladjohn · 2025-01-16T05:01:01Z

Directory.Packages.props

@@ -2,7 +2,7 @@
  <PropertyGroup>
    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
    <!-- Version of the Microsoft.Identity.Client.NativeInterop package. -->
-    <MSALRuntimeNativeInteropVersion>0.16.2</MSALRuntimeNativeInteropVersion>
+    <MSALRuntimeNativeInteropVersion>0.18.0</MSALRuntimeNativeInteropVersion>


is 0.18.0 published, I don't see it

We haven't published it yet due to the potential breaking change.

please publish a -preview version or a version lower than the one that is current and test this on priority @xinyuxu1026

@xinyuxu1026 , can you elaborate on what the potential breaking change might be?

@DharshanBJ , will that affect the already-shipped PyMsalRuntime 0.18.0?

This breaking change is about the dll redistribution of nuget package on dotnet (ref: #5019), it should not affect the python package.

How is it a breaking change @xinyuxu1026 ? The public API doesn't change. Is it behavioral? Do applications need to do extra work on their own to package the native binaries?

We really should try to avoid breaking changes. All these packages have been released in-sync (same version) with MSAL. It's simple and effective.

gladjohn · 2025-01-16T05:02:11Z

src/client/Microsoft.Identity.Client.Broker/Microsoft.Identity.Client.Broker.csproj

@@ -4,7 +4,7 @@
    <TargetFrameworkNetStandard>netstandard2.0</TargetFrameworkNetStandard>
    <TargetFrameworkNetDesktop Condition="$([MSBuild]::IsOsPlatform('Windows'))">net462</TargetFrameworkNetDesktop>
    <PlatformTarget>AnyCPU</PlatformTarget>
-    <TargetFramework Condition="'$(TargetFrameworkNetDesktop)' == ''">$(TargetFrameworkNetStandard)</TargetFramework>
+    <TargetFramework Condition="'$(TargetFrameworkNetDesktop) == ''">$(TargetFrameworkNetStandard)</TargetFramework>


gladjohn · 2025-01-16T05:02:43Z

src/client/Microsoft.Identity.Client.Broker/RuntimeBroker.cs

@@ -126,6 +126,7 @@ public async Task<MsalTokenResponse> AcquireTokenInteractiveAsync(
            AuthenticationRequestParameters authenticationRequestParameters,
            AcquireTokenInteractiveParameters acquireTokenInteractiveParameters)
        {
+            Console.WriteLine("Runtime Broker AcquireTokenInteractiveAsync");


gladjohn · 2025-01-16T05:05:54Z

tests/devapps/WAM/NetWSLWam/test.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">


can you also add this project to the MSAL Runtime dll checks that happens in the build pipepline

gladjohn · 2025-01-16T05:08:47Z

src/client/Microsoft.Identity.Client.Broker/RuntimeBroker.cs

@@ -586,7 +587,7 @@ public void HandleInstallUrl(string appLink)

        public bool IsBrokerInstalledAndInvokable(AuthorityType authorityType)
        {
-            if (!DesktopOsHelper.IsWin10OrServerEquivalent())
+            if (!DesktopOsHelper.IsWin10OrServerEquivalent() && !DesktopOsHelper.IsLinux())


are you able to add some unit tests?

Well, we don't really have unit tests for these helpers and I'm not sure how useful they'd be.

Copilot reviewed 5 out of 10 changed files in this pull request and generated no comments.

Files not reviewed (5)

Directory.Packages.props: Language not supported
NuGet.Config: Language not supported
src/client/Microsoft.Identity.Client.Broker/Microsoft.Identity.Client.Broker.csproj: Language not supported
tests/devapps/WAM/NetWSLWam/Properties/launchSettings.json: Language not supported
tests/devapps/WAM/NetWSLWam/test.csproj: Language not supported

Comments suppressed due to low confidence (2)

src/client/Microsoft.Identity.Client/PlatformsCommon/Shared/DesktopOsHelper.cs:59

[nitpick] The method name 'IsRunningOnWsl' could be more descriptive. Consider renaming it to 'IsRunningOnWindowsSubsystemForLinux'.

public static bool IsRunningOnWsl()

src/client/Microsoft.Identity.Client.Broker/RuntimeBroker.cs:129

Replace the debug log statement with a proper logging mechanism: _logger.Info("Runtime Broker AcquireTokenInteractiveAsync");

Console.WriteLine("Runtime Broker AcquireTokenInteractiveAsync");

gladjohn · 2025-01-16T05:12:29Z

src/client/Microsoft.Identity.Client.Broker/BrokerExtension.cs

@@ -79,6 +79,20 @@ private static void AddRuntimeSupport(PublicClientApplicationBuilder builder)
                         logger.Info("[Runtime] WAM supported OS.");
                         return new RuntimeBroker(uiParent, appConfig, logger);
                     };
+            } else if (DesktopOsHelper.IsRunningOnWsl()) {


can you create a helper method so the dupe can be avoided?

bgavrilMS · 2025-01-18T16:08:35Z

src/client/Microsoft.Identity.Client/PlatformsCommon/Shared/DesktopOsHelper.cs

+        public static bool IsRunningOnWsl()
+        {
+            if (IsLinux()) {
+                var versionInfo = File.ReadAllText("/proc/version");


This can be fairly expensive operation. Use the lazy trick to cache the result ? See line 20.

bgavrilMS · 2025-01-18T16:11:12Z

src/client/Microsoft.Identity.Client/ApiConfig/BrokerOptions.cs

+            /// <summary>
+            /// Use broker on WSL
+            /// </summary>
+            WSL = 0b_0000_0011,  // 3


The reason we made the OS an explicit API is to allow app developers to opt-in to different brokers, because different brokers have different:

redirect_uri

parent window details

Is the E2E setup on Linux different than the broker setup on WSL? If not, I would not complicate the dev experience with this option and I'd just add "Linux".

If it is, pls explain with a comment in the code, ideally pointing to an aka.ms doc

I agree with what @bgavrilMS said. To that end, I am curious to know what the scope of this PR is. Does it bring broker support for BOTH wsl and non-wsl, @xinyuxu1026 ?

For what it's worth, there is currently a similar PR for MSAL Python, but it targets wsl only; and I am told that the "wsl broker" is WAM so it has the redirect_uri requirement identical to WAM, and the "non-wsl broker" does not use that redirect_uri.

bgavrilMS · 2025-01-27T09:49:16Z

src/client/Microsoft.Identity.Client/ApiConfig/BrokerOptions.cs

@@ -81,6 +85,8 @@ internal bool IsBrokerEnabledOnCurrentOs()
            if (EnabledOn.HasFlag(OperatingSystems.Windows) && DesktopOsHelper.IsWindows())
            {
                return true;
+            } else if (DesktopOsHelper.IsLinux()) {


I think you need to check if EnabledOn.HasFlag(OperatingSystems.Linux) ?

xinyuxu1026 added 10 commits October 22, 2024 16:01

initial commit

2c18064

add linux test app

6a1f431

bypass check for linux platform

0eb4000

Add isRunningInWsl check

c7ff66a

Update RuntimeSupport OS check

883e44d

update

9b6cc0c

Add linux

67b0bbd

Merge branch 'main' into xinyu/wsl-support

5b3a00d

update

12ae021

update to net8.0

0807920

xinyuxu1026 requested a review from a team as a code owner January 16, 2025 00:05

xinyuxu1026 and others added 2 commits January 15, 2025 16:05

fix typo

9b27756

Merge branch 'main' into xinyu/wsl-support

4a0ac90

gladjohn reviewed Jan 16, 2025

View reviewed changes

gladjohn requested a review from Copilot January 16, 2025 05:09

Copilot AI reviewed Jan 16, 2025

View reviewed changes

gladjohn reviewed Jan 16, 2025

View reviewed changes

bgavrilMS reviewed Jan 18, 2025

View reviewed changes

xinyuxu1026 and others added 5 commits January 22, 2025 16:58

use lazy bool

eadc942

Merge branch 'main' into xinyu/wsl-support

212917c

address comments

9fde6ec

Merge branch 'main' into xinyu/wsl-support

20d2e59

temp change

d5afada

bgavrilMS reviewed Jan 27, 2025

View reviewed changes

xinyuxu1026 and others added 2 commits January 27, 2025 11:47

Add new broker option to PublicAPI.Unshipped

ad07cde

Merge branch 'main' into xinyu/wsl-support

d6e47cd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable broker support on Linux platform #5086

Enable broker support on Linux platform #5086

xinyuxu1026 commented Jan 16, 2025

gladjohn Jan 16, 2025

gladjohn Jan 16, 2025

xinyuxu1026 Jan 16, 2025

gladjohn Jan 16, 2025 •

edited

Loading

rayluo Jan 16, 2025

xinyuxu1026 Jan 16, 2025

bgavrilMS Jan 18, 2025 •

edited

Loading

gladjohn Jan 16, 2025

gladjohn Jan 16, 2025

gladjohn Jan 16, 2025

gladjohn Jan 16, 2025

bgavrilMS Jan 27, 2025

gladjohn Jan 16, 2025

bgavrilMS Jan 18, 2025

bgavrilMS Jan 18, 2025

bgavrilMS Jan 18, 2025

rayluo Jan 25, 2025

bgavrilMS Jan 27, 2025

Enable broker support on Linux platform #5086

Are you sure you want to change the base?

Enable broker support on Linux platform #5086

Conversation

xinyuxu1026 commented Jan 16, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gladjohn Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bgavrilMS Jan 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gladjohn Jan 16, 2025 •

edited

Loading

bgavrilMS Jan 18, 2025 •

edited

Loading