Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc
1.0.0
See the version list below for details.
dotnet add package Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc --version 1.0.0
NuGet\Install-Package Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc -Version 1.0.0
<PackageReference Include="Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc" Version="1.0.0" />
paket add Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc --version 1.0.0
#r "nuget: Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc, 1.0.0"
// Install Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc as a Cake Addin #addin nuget:?package=Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc&version=1.0.0 // Install Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc as a Cake Tool #tool nuget:?package=Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc&version=1.0.0
Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc
Simplify OIDC authentication for MAUI Blazor app
Use
Install the package in your MAUI Blazor project.
dotnet add package Aguacongas.AspNetCore.Components.Maui.Authentication.Oidc
Update your MauiProgram
to setup the DI
string authorityUrl =
DeviceInfo.Platform == DevicePlatform.Android ? "https://10.0.2.2:5001" : "https://localhost:5001";
builder.Services.AddMauiOidcAuthentication(options =>
{
var providerOptions = options.ProviderOptions;
providerOptions.Authority = authorityUrl;
providerOptions.ClientId = "mauiblazorsample";
providerOptions.RedirectUri = "mauiblazorsample://authentication/login-callback";
providerOptions.PostLogoutRedirectUri = "mauiblazorsample://authentication/logout-callback";
providerOptions.DefaultScopes.Add("offline_access");
providerOptions.DefaultScopes.Add("scope1");
}, ConfigureHttpMessgeBuilder);
AddMauiOidcAuthentication
adds AuthenticationStateProvider service
in DI so you can use AuthenticationState, CascadingAuthenticationState
and AuthorizationMessageHandler
Platform Specific Configurations
We need to declare the application uri scheme for each platforms. In following samples, the scheme is mauiblazorsample.
Android
Update AndroidManifest.xml by adding the queries section :
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
...
<queries>
<intent>
<action android:name="android.support.customtabs.action.CustomTabsService" />
</intent>
</queries>
</manifest>
Add a OidcAuthenticationCallbackActivity
class deriving from WebAuthenticatorCallbackActivity
declaring the application uri scheme:
using Android.App;
using Android.Content;
using Android.Content.PM;
namespace Maui.Blazor.Client.Platforms.Android;
[Activity(NoHistory = true, LaunchMode = LaunchMode.SingleTop, Exported = true)]
[IntentFilter(new[] { Intent.ActionView },
Categories = new[] {
Intent.CategoryDefault,
Intent.CategoryBrowsable
},
DataScheme = CALLBACK_SCHEME,
DataPaths = new[] {
"authentication/login-callback",
"authentication/login-callback"
})]
public class OidcAuthenticationCallbackActivity : WebAuthenticatorCallbackActivity
{
const string CALLBACK_SCHEME = "mauiblazorsample";
}
IOS and MacCatalyst
Update Info.plist file.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>mauiblazorsample</string>
<key>CFBundleURLSchemes</key>
<array>
<string>mauiblazorsample</string>
</array>
<key>CFBundleTypeRole</key>
<string>Editor</string>
</dict>
</array>
</dict>
</plist>
Update AppDelegate.cs to override OpenUrl
and ContinueUserActivity
methods
using Foundation;
using UIKit;
namespace Maui.Blazor.Client;
[Register("AppDelegate")]
public class AppDelegate : MauiUIApplicationDelegate
{
protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
public override bool OpenUrl(UIApplication app, NSUrl url, NSDictionary options)
{
if (Platform.OpenUrl(app, url, options))
{
return true;
}
return base.OpenUrl(app, url, options);
}
public override bool ContinueUserActivity(UIApplication application, NSUserActivity userActivity, UIApplicationRestorationHandler completionHandler)
{
if (Platform.ContinueUserActivity(application, userActivity, completionHandler))
{
return true;
}
return base.ContinueUserActivity(application, userActivity, completionHandler);
}
}
Windows
Add following protocol extension in Package.appxmanifest file.
<?xml version="1.0" encoding="utf-8"?>
<Package
xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
xmlns:mp="http://schemas.microsoft.com/appx/2014/phone/manifest"
xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
IgnorableNamespaces="uap rescap">
...
<Applications>
<Application Id="App" Executable="$targetnametoken$.exe" EntryPoint="$targetentrypoint$">
...
<Extensions>
<uap:Extension Category="windows.protocol">
<uap:Protocol Name="mauiblazorsample">
<uap:DisplayName>MAUI blazor sample</uap:DisplayName>
</uap:Protocol>
</uap:Extension>
</Extensions>
</Application>
</Applications>
...
</Package>
Local development
To configure the internal HttpMessageHandler
to trust self signed certificate or local url you can provide a configuration method like this one:
private static void ConfigureHttpMessgeBuilder(HttpMessageHandlerBuilder builder)
{
#if IOS
var handler = new NSUrlSessionHandler();
handler.TrustOverrideForUrl = (sender, url, trust) =>
{
if (url.StartsWith("https://localhost:5001"))
{
return true;
}
return false;
};
builder.PrimaryHandler = handler;
#else
var handler = builder.PrimaryHandler as HttpClientHandler;
handler.ServerCertificateCustomValidationCallback = (message, cert, chain, errors) =>
{
if (cert != null && cert.Issuer.Equals("CN=localhost"))
{
return true;
}
return errors == System.Net.Security.SslPolicyErrors.None;
};
#endif
}
Sample
The github repository contains a sample containing:
- a Blazor WASM project
- a MAUI Blazor project
- a Blazor UI project shared by Blazor WASM and MAUI Blazor
- an OIDC server project containing the WeatherForecast API
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-android33.0 is compatible. net7.0-ios was computed. net7.0-ios16.1 is compatible. net7.0-maccatalyst was computed. net7.0-maccatalyst16.1 is compatible. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net7.0-windows10.0.19041 is compatible. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- IdentityModel.OidcClient (>= 5.1.0)
- Microsoft.AspNetCore.Components.WebAssembly.Authentication (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
-
net7.0-android33.0
- IdentityModel.OidcClient (>= 5.1.0)
- Microsoft.AspNetCore.Components.WebAssembly.Authentication (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
-
net7.0-ios16.1
- IdentityModel.OidcClient (>= 5.1.0)
- Microsoft.AspNetCore.Components.WebAssembly.Authentication (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
-
net7.0-maccatalyst16.1
- IdentityModel.OidcClient (>= 5.1.0)
- Microsoft.AspNetCore.Components.WebAssembly.Authentication (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
-
net7.0-windows10.0.19041
- IdentityModel.OidcClient (>= 5.1.0)
- Microsoft.AspNetCore.Components.WebAssembly.Authentication (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.0.0-preview1-0093 | 212 | 12/10/2023 |
1.0.0 | 835 | 1/8/2023 |
0.1.0-preview1-0035 | 144 | 1/7/2023 |