-
Notifications
You must be signed in to change notification settings - Fork 373
Implement WinUI3 support for Desktop package #5411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 38 commits
Commits
Show all changes
94 commits
Select commit
Hold shift + click to select a range
0adea97
update
DharshanBJ 967bdbb
working
DharshanBJ d30aa7b
Code to create a seperate nuget for winui3
DharshanBJ 6632314
builds fine
DharshanBJ 0f190e7
clean-up
DharshanBJ 74804c1
clean-up
DharshanBJ a79a5ba
working
DharshanBJ 7c5396c
update
DharshanBJ 3fa1303
clean-up
DharshanBJ 01a14ef
clean-up
DharshanBJ 2956b33
clean-up
DharshanBJ 9b9dcd6
clean-up
DharshanBJ 3d5a15e
clean-up
DharshanBJ 67a3137
Merge branch 'main' into dharshanb/winui3Support
DharshanBJ cb3caeb
clean-up
DharshanBJ 1fa4a78
clean-up
DharshanBJ 4e7dd8b
clean-up
DharshanBJ fc24488
clean-up
DharshanBJ 9205904
clean-up
DharshanBJ cfe6c59
clean-up
DharshanBJ 82ba6ea
clean-up
DharshanBJ 25911f8
clean-up
DharshanBJ 790050b
update
DharshanBJ db14988
clean-up
DharshanBJ 8be4d3e
clean-up
DharshanBJ 6e7a475
clean-up
DharshanBJ a1f4f20
clean-up
DharshanBJ 8ab32e2
clean-up
DharshanBJ 510072b
update
DharshanBJ ccac18a
Merge branch 'main' into dharshanb/winui3Support
DharshanBJ b3d41f4
Revert changes to AuthCodeRequestComponent.cs and Microsoft.Identity.…
DharshanBJ f1bfbd6
Merge branch 'dharshanb/winui3Support' of https://github.com/AzureAD/…
DharshanBJ 2818fba
Revert changes to AuthCodeRequestComponent.cs and Microsoft.Identity.…
DharshanBJ 2db86dd
add test-app
DharshanBJ f70aea3
add test-app
DharshanBJ 453b9c5
Handle winui3 parent window
DharshanBJ 90ea83d
clean-up
DharshanBJ 0b64613
delete testapp readme
DharshanBJ 8a8bec3
Merge branch 'main' into dharshanb/winui3Support
DharshanBJ 12183e8
update
DharshanBJ 9d04d61
Merge branch 'dharshanb/winui3Support' of https://github.com/AzureAD/…
DharshanBJ 1573262
add winforms test app
DharshanBJ 29c1e13
add winforms app that goes through webview2 flow
DharshanBJ e00856e
update the IsWinUI3Window check
DharshanBJ 601f574
Merge branch 'main' into dharshanb/winui3Support
DharshanBJ c1cd2f8
update
DharshanBJ e982a1a
Merge branch 'dharshanb/winui3Support' of https://github.com/AzureAD/…
DharshanBJ 74b1d29
update
DharshanBJ 48d9e77
update
DharshanBJ 339bc82
update
DharshanBJ 8457760
working
DharshanBJ 5540066
Code to create a seperate nuget for winui3
DharshanBJ 07010d4
builds fine
DharshanBJ 39613e7
clean-up
DharshanBJ 00b6493
clean-up
DharshanBJ 6556838
working
DharshanBJ 6fbf4dd
update
DharshanBJ 440fdcc
clean-up
DharshanBJ 63ed0b3
clean-up
DharshanBJ 92d8193
clean-up
DharshanBJ d3213f4
clean-up
DharshanBJ 149ad82
clean-up
DharshanBJ 49d26cc
clean-up
DharshanBJ 83b48f5
clean-up
DharshanBJ 665a9fb
clean-up
DharshanBJ 6ed9b5c
clean-up
DharshanBJ 4df323a
clean-up
DharshanBJ 44281c9
clean-up
DharshanBJ d4127f1
clean-up
DharshanBJ 5f574b9
clean-up
DharshanBJ 613c06b
update
DharshanBJ f2806d0
clean-up
DharshanBJ 8796e91
clean-up
DharshanBJ 1f4c77e
clean-up
DharshanBJ 2a98fad
clean-up
DharshanBJ 1508c61
clean-up
DharshanBJ faf9574
update
DharshanBJ 0f36e41
Revert changes to AuthCodeRequestComponent.cs and Microsoft.Identity.…
DharshanBJ 51cad56
Revert changes to AuthCodeRequestComponent.cs and Microsoft.Identity.…
DharshanBJ 0a3ef3c
add test-app
DharshanBJ e384789
add test-app
DharshanBJ 8a19b2d
Handle winui3 parent window
DharshanBJ 974473d
clean-up
DharshanBJ eb51f12
delete testapp readme
DharshanBJ d76ec96
update
DharshanBJ a524b23
add winforms test app
DharshanBJ 5a96d29
add winforms app that goes through webview2 flow
DharshanBJ fcae881
update the IsWinUI3Window check
DharshanBJ 00d4537
update
DharshanBJ 7b11e68
update
DharshanBJ 7e54e7b
update
DharshanBJ 0b33cf4
Address comments
DharshanBJ 58e3cc6
merge update
DharshanBJ 31a2e7f
remove merge conflict
DharshanBJ File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
.../Microsoft.Identity.Client.Desktop.WinUI3/Microsoft.Identity.Client.Desktop.WinUI3.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net8.0-windows10.0.17763.0</TargetFramework> | ||
| <UseWinUI>true</UseWinUI> | ||
| <EnableMsixTooling>true</EnableMsixTooling> | ||
|
|
||
| <PathToMsalSources>$(MSBuildThisFileDirectory)../Microsoft.Identity.Client/</PathToMsalSources> | ||
| <PlatformTarget>AnyCPU</PlatformTarget> | ||
| <Configurations>Debug;Release;Debug + MobileApps</Configurations> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup Label="NuGet and AssemblyInfo metadata"> | ||
| <!--This should be passed from the VSTS build--> | ||
| <MicrosoftIdentityClientVersion Condition="'$(MicrosoftIdentityClientVersion)' == ''">$(MsalInternalVersion)</MicrosoftIdentityClientVersion> | ||
| <MicrosoftIdentityClientVersion>$(MicrosoftIdentityClientVersion)</MicrosoftIdentityClientVersion> | ||
| <!--This will generate AssemblyVersion, AssemblyFileVersion and AssemblyInformationVersion--> | ||
| <Version>$(MicrosoftIdentityClientVersion)</Version> | ||
| <!-- Copyright needs to be in the form of © not (c) to be compliant --> | ||
| <Title>MSAL.NET extension for WinUI3 desktop applications</Title> | ||
| <Description> | ||
| This package contains WinUI3-specific binaries for using MSAL.NET with modern Windows applications built on WinUI3 and Windows App SDK. | ||
| </Description> | ||
| <PackageTags>Microsoft Authentication Library Desktop MSAL WinUI3 Windows App SDK WebView2</PackageTags> | ||
| <Product>Microsoft Authentication Library Desktop WinUI3</Product> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup Label="For CI build" Condition="'$(TF_BUILD)' == 'true'"> | ||
DharshanBJ marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- Include shared source files from Desktop project, excluding WebView2WebUi files --> | ||
| <ItemGroup> | ||
| <Compile Include="..\Microsoft.Identity.Client.Desktop\**\*.cs" | ||
| Exclude="..\Microsoft.Identity.Client.Desktop\WebView2WebUi\**\*.cs;..\Microsoft.Identity.Client.Desktop\obj\**\*;..\Microsoft.Identity.Client.Desktop\bin\**\*" | ||
| LinkBase="" /> | ||
|
|
||
| <!-- Include InternalsVisibleTo --> | ||
| <Compile Include="..\Microsoft.Identity.Client\Properties\InternalsVisibleTo.cs" Link="Properties\InternalsVisibleTo.cs" /> | ||
| </ItemGroup> | ||
|
|
||
| <!-- WinUI3 and Windows App SDK dependencies --> | ||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.WindowsAppSDK" /> | ||
| <PackageReference Include="Microsoft.Windows.SDK.BuildTools" /> | ||
| </ItemGroup> | ||
|
|
||
| <!-- Project references --> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\Microsoft.Identity.Client.Broker\Microsoft.Identity.Client.Broker.csproj" /> | ||
DharshanBJ marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <ProjectReference Include="..\Microsoft.Identity.Client\Microsoft.Identity.Client.csproj" /> | ||
|
|
||
| <PackageReference Remove="Microsoft.CodeAnalysis.PublicApiAnalyzers" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
136 changes: 136 additions & 0 deletions
136
src/client/Microsoft.Identity.Client.Desktop.WinUI3/WebView2WebUi/WebView2WebUi.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Identity.Client.Http; | ||
| using Microsoft.Identity.Client.Internal; | ||
| using Microsoft.Identity.Client.Platforms.Features.DesktopOs; | ||
| using Microsoft.Identity.Client.UI; | ||
| using Microsoft.Identity.Client.Core; | ||
| using Microsoft.UI.Xaml; | ||
| using Microsoft.UI.Xaml.Controls; | ||
| using Microsoft.UI.Windowing; | ||
| using Windows.Graphics; | ||
| using Windows.Graphics.Display; | ||
| using Microsoft.UI; | ||
| using Microsoft.UI.Dispatching; | ||
|
|
||
| namespace Microsoft.Identity.Client.Desktop.WebView2WebUi | ||
DharshanBJ marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| internal class WebView2WebUi : IWebUI | ||
| { | ||
| private CoreUIParent _parent; | ||
| private RequestContext _requestContext; | ||
|
|
||
| public WebView2WebUi(CoreUIParent parent, RequestContext requestContext) | ||
| { | ||
| _parent = parent; | ||
| _requestContext = requestContext; | ||
| } | ||
|
|
||
| public async Task<AuthorizationResult> AcquireAuthorizationAsync( | ||
| Uri authorizationUri, | ||
| Uri redirectUri, | ||
| RequestContext requestContext, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| AuthorizationResult result = null; | ||
|
|
||
| var sendAuthorizeRequest = new Func<Task>(async () => | ||
| { | ||
| result = await InvokeEmbeddedWebviewAsync(authorizationUri, redirectUri, cancellationToken).ConfigureAwait(false); | ||
| }); | ||
|
|
||
| if (Thread.CurrentThread.GetApartmentState() == ApartmentState.MTA) | ||
| { | ||
| if (_parent.SynchronizationContext != null) | ||
| { | ||
| var tcs = new TaskCompletionSource<AuthorizationResult>(); | ||
|
|
||
| _parent.SynchronizationContext.Post((state) => | ||
| { | ||
| var taskCompletionSource = (TaskCompletionSource<AuthorizationResult>)state; | ||
|
|
||
| var asyncOperation = InvokeEmbeddedWebviewAsync(authorizationUri, redirectUri, cancellationToken); | ||
|
|
||
| // Handle the completion asynchronously | ||
| asyncOperation.ContinueWith(task => | ||
| { | ||
| if (task.IsFaulted) | ||
| { | ||
| var exception = task.Exception?.InnerException ?? task.Exception; | ||
| taskCompletionSource.TrySetException(exception); | ||
| } | ||
| else if (task.IsCanceled) | ||
| { | ||
| taskCompletionSource.TrySetCanceled(); | ||
| } | ||
| else | ||
| { | ||
| taskCompletionSource.TrySetResult(task.Result); | ||
| } | ||
| }, TaskContinuationOptions.ExecuteSynchronously); | ||
|
|
||
| }, tcs); | ||
|
|
||
| return await tcs.Task.ConfigureAwait(false); | ||
| } | ||
| else | ||
| { | ||
| using (var staTaskScheduler = new StaTaskScheduler(1)) | ||
| { | ||
| try | ||
| { | ||
| Task.Factory.StartNew( | ||
| sendAuthorizeRequest, | ||
| cancellationToken, | ||
| TaskCreationOptions.None, | ||
| staTaskScheduler).Wait(cancellationToken); | ||
| } | ||
| catch (AggregateException ae) | ||
| { | ||
| requestContext.Logger.ErrorPii(ae.InnerException); | ||
| Exception innerException = ae.InnerExceptions[0]; | ||
|
|
||
| if (innerException is AggregateException exception) | ||
| { | ||
| innerException = exception.InnerExceptions[0]; | ||
| } | ||
|
|
||
| throw innerException; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| else | ||
| { | ||
| await sendAuthorizeRequest().ConfigureAwait(false); | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| public Uri UpdateRedirectUri(Uri redirectUri) | ||
| { | ||
| RedirectUriHelper.Validate(redirectUri, usesSystemBrowser: false); | ||
| return redirectUri; | ||
| } | ||
|
|
||
| private async Task<AuthorizationResult> InvokeEmbeddedWebviewAsync(Uri startUri, Uri endUri, CancellationToken cancellationToken) | ||
| { | ||
| var window = new WinUI3WindowWithWebView2( | ||
| _parent.OwnerWindow, | ||
| _parent?.EmbeddedWebviewOptions, | ||
| _requestContext.Logger, | ||
| startUri, | ||
| endUri); | ||
|
|
||
| return await window.DisplayDialogAndInterceptUriAsync(cancellationToken).ConfigureAwait(false); | ||
| } | ||
| } | ||
| } | ||
61 changes: 61 additions & 0 deletions
61
src/client/Microsoft.Identity.Client.Desktop.WinUI3/WebView2WebUi/WebView2WebUiFactory.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using Microsoft.Identity.Client.ApiConfig.Parameters; | ||
| using Microsoft.Identity.Client.Core; | ||
| using Microsoft.Identity.Client.Internal; | ||
| using Microsoft.Identity.Client.Platforms.Shared.Desktop.OsBrowser; | ||
| using Microsoft.Identity.Client.PlatformsCommon.Shared; | ||
| using Microsoft.Identity.Client.UI; | ||
| using Microsoft.Web.WebView2.Core; | ||
|
|
||
| namespace Microsoft.Identity.Client.Desktop.WebView2WebUi | ||
| { | ||
| internal class WebView2WebUiFactory : IWebUIFactory | ||
| { | ||
| private readonly Func<bool> _isWebView2AvailableFunc; | ||
|
|
||
| public WebView2WebUiFactory(Func<bool> isWebView2AvailableForTest = null) | ||
| { | ||
| _isWebView2AvailableFunc = isWebView2AvailableForTest ?? IsWebView2Available; | ||
| } | ||
|
|
||
| public bool IsSystemWebViewAvailable => IsUserInteractive; | ||
|
|
||
| public bool IsUserInteractive => DesktopOsHelper.IsUserInteractive(); | ||
|
|
||
| public bool IsEmbeddedWebViewAvailable => | ||
| IsUserInteractive && | ||
| IsWebView2Available(); // Look for the globally available WebView2 runtime | ||
|
|
||
| public IWebUI CreateAuthenticationDialog(CoreUIParent coreUIParent, WebViewPreference useEmbeddedWebView, RequestContext requestContext) | ||
| { | ||
| if (useEmbeddedWebView == WebViewPreference.System) | ||
| { | ||
| requestContext.Logger.Info("Using system browser."); | ||
| return new DefaultOsBrowserWebUi( | ||
| requestContext.ServiceBundle.PlatformProxy, | ||
| requestContext.Logger, | ||
| coreUIParent.SystemWebViewOptions); | ||
| } | ||
|
|
||
| // In NET6+, webview2 is available by default | ||
| requestContext.Logger.Info("Using WebView2 embedded browser."); | ||
| return new WebView2WebUi(coreUIParent, requestContext); | ||
| } | ||
|
|
||
| private static bool IsWebView2Available() | ||
| { | ||
| try | ||
| { | ||
| string wv2Version = CoreWebView2Environment.GetAvailableBrowserVersionString(); | ||
| return !string.IsNullOrEmpty(wv2Version); | ||
| } | ||
| catch (Exception ex) when (ex is BadImageFormatException || ex is DllNotFoundException) | ||
| { | ||
| throw new MsalClientException(MsalError.WebView2LoaderNotFound, MsalErrorMessage.WebView2LoaderNotFound, ex); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.