Update AddMicrosoftIdentityWebApp without restarting application

Question

Update AddMicrosoftIdentityWebApp without restarting application

Amit Singh Rawat 731

I have used AddMicrosoftIdentityWebApp in my program.cs class for Microsoft Authentication.

builder.Services.AddAuthentication(opts =>
{
    opts.DefaultScheme = CookieAuthenticationDefaults.AuthenticationScheme;
    opts.DefaultChallengeScheme = OpenIdConnectDefaults.AuthenticationScheme;
})
.AddMicrosoftIdentityWebApp(opts =>
{
    var azureOptions = builder.Services.BuildServiceProvider().GetRequiredService<IOptionsMonitor<AzureAppOptions>>().CurrentValue;

    opts.Instance = azureOptions.Instance;
    opts.TenantId = azureOptions.TenantId;
    opts.ClientId = azureOptions.ClientId;
    opts.CallbackPath = azureOptions.CallbackPath;
}, openIdConnectScheme: OpenIdConnectDefaults.AuthenticationScheme);

If I have to update Azure App details then, I have to restart my application because AddMicrosoftIdentityWebApp only runs at start up.

Is it possible to modify AddMicrosoftIdentityWebApp so that it start using new app details without restarting the application.

Anonymous

2024-09-02T06:55:13.4033333+00:00
Hi @Amit,

There are two ways to implement this need that I know of at the moment.

Using IOptionsMonitor and Azure Key Vault . You can search it by using the keywords.

Using Azure App Configuration, here is the Tutorial: Use dynamic configuration in an ASP.NET Core app.

Best Regards

Jason

Amit Singh Rawat 731

Hi @Anonymous ,

As suggested, I tried to use IOptionsMonitor to fetch latest Azure App details. But it also only take update after application restart. I understand that that with IOptionsMonitor we can track chagnes but I don't find any document which suggest we can update settings of AddMicrosoftIdentityWebApp after initial setup.

Did I miss anything?

builder.Services.Configure<AzureAdOptions>(builder.Configuration.GetSection("AzureAd"));


var authBuilder = builder.Services.AddAuthentication(opts =>
{
    opts.DefaultScheme = CookieAuthenticationDefaults.AuthenticationScheme;
    opts.DefaultChallengeScheme = OpenIdConnectDefaults.AuthenticationScheme;
});

authBuilder.AddMicrosoftIdentityWebApp(opts =>
{
    var azureAdOptions = builder.Services.BuildServiceProvider().GetRequiredService<IOptionsMonitor<AzureAdOptions>>().CurrentValue;

    opts.Instance = azureAdOptions.Instance;
    opts.TenantId = azureAdOptions.TenantId;
    opts.ClientId = azureAdOptions.ClientId;
    opts.CallbackPath = azureAdOptions.CallbackPath ?? "/signin-oidc";
},
openIdConnectScheme: OpenIdConnectDefaults.AuthenticationScheme);

Anonymous

2024-09-02T08:09:50.3033333+00:00

Hi @Amit,

I've dealt with this case before, so I feel like IOptionsMonitor should be doable.

Related Link

Trying to get appSettings.json settings in an ILogger provider

You can check out everything in this link first, and if this meets your requirements, we can look into the issue further.

Best Regards

Jason
Amit Singh Rawat 731 Reputation points

2024-09-03T09:00:56.9766667+00:00

HI @Anonymous ,
I'm not sure if the same approach will work for me. They are using it within a controller, where the request reaches every time. In my code, there are multiple authentication schemes, and I'm specifically concerned about AddMicrosoftIdentityWebApp. Even if I were using a single authentication scheme, I can't figure out how to force my authentication middleware to reuse fresh settings without restarting the application.
Anonymous

2024-09-03T12:16:23.6866667+00:00

Hi @Amit,

Ok, then we can check the suggestion 2 Tutorial: Use dynamic configuration in an ASP.NET Core app.

Best Regards

Jason
youzeliang 900 Reputation points

2024-09-03T15:27:56.3566667+00:00

yeah, i argee with JasonPanJasonPan
Amit Singh Rawat 731 Reputation points

2024-09-04T05:35:08.5366667+00:00

Hi @jasonpan The link you provided first identifies changes using a 'Sentinel' key. Once a change is detected, the values are updated using ConfigureRefresh, which essentially updates the reference of the Settings class. However, there’s no clear explanation on how to use this approach to instruct my application to clear all the options provided for AddMicrosoftIdentityWebApp and apply the new settings. I attempted a similar approach with IOptionsMonitor, but for some reason, AddMicrosoftIdentityWebApp does not pick up the latest values. I've checked all related cache and cookie settings, but nothing seems to work.
Anonymous

2024-09-04T06:01:10.6633333+00:00

Hi @Amit,

I have added Azure App Configuration tag, hope their Team can guide us how to use it or tell us is it a correct way to implement this feature.

As far as I know, asp.net core does not directly support configuration reload( Bruce mentioned it below ).

Best Regards

Jason

1 answer

Your answer

Anonymous

2024-09-02T06:55:13.4033333+00:00

Hi @Amit,

There are two ways to implement this need that I know of at the moment.

Using IOptionsMonitor and Azure Key Vault . You can search it by using the keywords.

Using Azure App Configuration, here is the Tutorial: Use dynamic configuration in an ASP.NET Core app.

Best Regards

Jason
Amit Singh Rawat 731 Reputation points

2024-09-02T07:55:02.69+00:00

Hi @Anonymous ,

As suggested, I tried to use IOptionsMonitor to fetch latest Azure App details. But it also only take update after application restart. I understand that that with IOptionsMonitor we can track chagnes but I don't find any document which suggest we can update settings of AddMicrosoftIdentityWebApp after initial setup.

Did I miss anything?

builder.Services.Configure<AzureAdOptions>(builder.Configuration.GetSection("AzureAd")); var authBuilder = builder.Services.AddAuthentication(opts => { opts.DefaultScheme = CookieAuthenticationDefaults.AuthenticationScheme; opts.DefaultChallengeScheme = OpenIdConnectDefaults.AuthenticationScheme; }); authBuilder.AddMicrosoftIdentityWebApp(opts => { var azureAdOptions = builder.Services.BuildServiceProvider().GetRequiredService<IOptionsMonitor<AzureAdOptions>>().CurrentValue; opts.Instance = azureAdOptions.Instance; opts.TenantId = azureAdOptions.TenantId; opts.ClientId = azureAdOptions.ClientId; opts.CallbackPath = azureAdOptions.CallbackPath ?? "/signin-oidc"; }, openIdConnectScheme: OpenIdConnectDefaults.AuthenticationScheme);
Anonymous

2024-09-02T08:09:50.3033333+00:00

Hi @Amit,

I've dealt with this case before, so I feel like IOptionsMonitor should be doable.

Related Link

Trying to get appSettings.json settings in an ILogger provider

You can check out everything in this link first, and if this meets your requirements, we can look into the issue further.

Best Regards

Jason
Amit Singh Rawat 731 Reputation points

2024-09-03T09:00:56.9766667+00:00

HI @Anonymous ,
I'm not sure if the same approach will work for me. They are using it within a controller, where the request reaches every time. In my code, there are multiple authentication schemes, and I'm specifically concerned about AddMicrosoftIdentityWebApp. Even if I were using a single authentication scheme, I can't figure out how to force my authentication middleware to reuse fresh settings without restarting the application.
Anonymous

2024-09-03T12:16:23.6866667+00:00

Hi @Amit,

Ok, then we can check the suggestion 2 Tutorial: Use dynamic configuration in an ASP.NET Core app.

Best Regards

Jason
youzeliang 900 Reputation points

2024-09-03T15:27:56.3566667+00:00

yeah, i argee with JasonPanJasonPan
Amit Singh Rawat 731 Reputation points

2024-09-04T05:35:08.5366667+00:00

Hi @jasonpan The link you provided first identifies changes using a 'Sentinel' key. Once a change is detected, the values are updated using ConfigureRefresh, which essentially updates the reference of the Settings class. However, there’s no clear explanation on how to use this approach to instruct my application to clear all the options provided for AddMicrosoftIdentityWebApp and apply the new settings. I attempted a similar approach with IOptionsMonitor, but for some reason, AddMicrosoftIdentityWebApp does not pick up the latest values. I've checked all related cache and cookie settings, but nothing seems to work.
Anonymous

2024-09-04T06:01:10.6633333+00:00

Hi @Amit,

I have added Azure App Configuration tag, hope their Team can guide us how to use it or tell us is it a correct way to implement this feature.

As far as I know, asp.net core does not directly support configuration reload( Bruce mentioned it below ).

Best Regards

Jason

Answer 1

Bruce (SqlWork.com) 83,421 Volunteer Moderator

if you review the source:

https://github.com/AzureAD/microsoft-identity-web/blob/c8ba0ce096f103baab417bac7fb2e9a40582a7af/src/Microsoft.Identity.Web/WebAppExtensions/MicrosoftIdentityWebAppAuthenticationBuilderExtensions.cs#L43

you will see it does not directly support configuration reload. you may be able to add a sentinel key, and manually update the injected authentication options on key change.

Amit Singh Rawat 731 Reputation points

2024-09-04T05:16:34.1366667+00:00

Hi @Bruce (SqlWork.com) ,

I am unable to find a way to manually update the injected authentication options when a key changes. For key changes, I can save the data in the appsettings.json file and track it via IOptionsMonitor. However, when I detect this change, I'm not sure how to modify the authentication settings accordingly. Similar this I already tried but it always pick older app and not the fresh one even thouth while debugging I check IOptionsMonitor pick the correct value on change.

Share via

Update AddMicrosoftIdentityWebApp without restarting application

1 answer

Your answer