Skip to content

Include the thrown exception in CertificateChangeEventArg #3428

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.

Sign up for GitHub

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 3 commits into from
Jul 23, 2025
Merged

Include the thrown exception in CertificateChangeEventArg #3428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
138443b
Include the thrown exception in CertificateChangeEventArg
tlupes Jul 21, 2025
096d930
merge
tlupes Jul 21, 2025
60b06ad
fix
tlupes Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/ICertificatesObserver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Security.Cryptography.X509Certificates;
using Microsoft.Identity.Abstractions;

Expand Down Expand Up @@ -46,6 +47,11 @@ public class CertificateChangeEventArg
/// Credential description
/// </summary>
public CredentialDescription? CredentialDescription { get; set; }

/// <summary>
/// Gets the exception thrown during the certificate selection or deselection.
/// </summary>
public Exception? ThrownException { get; set; }
}

/// <summary>
Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net462/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net472/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net6.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net7.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net8.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/net9.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
2 changes: 2 additions & 0 deletions src/Microsoft.Identity.Web.TokenAcquisition/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider
Microsoft.Identity.Web.IAuthenticationSchemeInformationProvider.GetEffectiveAuthenticationScheme(string? authenticationScheme) -> string!
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.get -> System.Exception?
Microsoft.Identity.Web.Experimental.CertificateChangeEventArg.ThrownException.set -> void
18 changes: 12 additions & 6 deletions src/Microsoft.Identity.Web.TokenAcquisition/TokenAcquisition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ public async Task<AcquireTokenResult> AddAccountToCacheFromAuthorizationCodeAsyn
}
catch (MsalServiceException exMsal) when (IsInvalidClientCertificateOrSignedAssertionError(exMsal))
{
NotifyCertificateSelection(mergedOptions, application!, CerticateObserverAction.Deselected);
NotifyCertificateSelection(mergedOptions, application!, CerticateObserverAction.Deselected, exMsal);
DefaultCertificateLoader.ResetCertificates(mergedOptions.ClientCredentials);
_applicationsByAuthorityClientId[GetApplicationKey(mergedOptions)] = null;

Expand Down Expand Up @@ -302,7 +302,7 @@ public async Task<AuthenticationResult> GetAuthenticationResultForUserAsync(
}
catch (MsalServiceException exMsal) when (IsInvalidClientCertificateOrSignedAssertionError(exMsal))
{
NotifyCertificateSelection(mergedOptions, application, CerticateObserverAction.Deselected);
NotifyCertificateSelection(mergedOptions, application, CerticateObserverAction.Deselected, exMsal);
DefaultCertificateLoader.ResetCertificates(mergedOptions.ClientCredentials);
_applicationsByAuthorityClientId[GetApplicationKey(mergedOptions)] = null;

Expand Down Expand Up @@ -620,7 +620,7 @@ public async Task<AuthenticationResult> GetAuthenticationResultForAppAsync(
}
catch (MsalServiceException exMsal) when (IsInvalidClientCertificateOrSignedAssertionError(exMsal))
{
NotifyCertificateSelection(mergedOptions, application, CerticateObserverAction.Deselected);
NotifyCertificateSelection(mergedOptions, application, CerticateObserverAction.Deselected, exMsal);
DefaultCertificateLoader.ResetCertificates(mergedOptions.ClientCredentials);
_applicationsByAuthorityClientId[GetApplicationKey(mergedOptions)] = null;

Expand Down Expand Up @@ -935,7 +935,7 @@ await builder.WithClientCredentialsAsync(

// If the client application has set certificate observer,
// fire the event to notify the client app that a certificate was selected.
NotifyCertificateSelection(mergedOptions, app, CerticateObserverAction.Selected);
NotifyCertificateSelection(mergedOptions, app, CerticateObserverAction.Selected, null);

// Initialize token cache providers
if (!(_tokenCacheProvider is MsalMemoryTokenCacheProvider))
Expand All @@ -962,7 +962,12 @@ await builder.WithClientCredentialsAsync(
/// <param name="mergedOptions"></param>
/// <param name="app"></param>
/// <param name="action"></param>
private void NotifyCertificateSelection(MergedOptions mergedOptions, IConfidentialClientApplication app, CerticateObserverAction action)
/// <param name="exception">The thrown exception, if any.</param>
private void NotifyCertificateSelection(
MergedOptions mergedOptions,
IConfidentialClientApplication app,
CerticateObserverAction action,
Exception? exception)
{
X509Certificate2 selectedCertificate = app.AppConfig.ClientCredentialCertificate;
if (_certificatesObserver != null
Expand All @@ -973,7 +978,8 @@ private void NotifyCertificateSelection(MergedOptions mergedOptions, IConfidenti
{
Action = action,
Certificate = app.AppConfig.ClientCredentialCertificate,
CredentialDescription = mergedOptions.ClientCredentials?.FirstOrDefault(c => c.Certificate == selectedCertificate)
CredentialDescription = mergedOptions.ClientCredentials?.FirstOrDefault(c => c.Certificate == selectedCertificate),
ThrownException = exception,
});
}
}
Expand Down
Loading