Skip to content

Make AuthenticationResult derive from AcquireTokenResult #5453

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Make AuthenticationResult derive from AcquireTokenResult #5453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<PackageVersion Include="Microsoft.CSharp" Version="4.5.0" />
<PackageVersion Include="Microsoft.Identity.Client.NativeInterop" Version="$(MSALRuntimeNativeInteropVersion)" IncludeAssets="all" />
<PackageVersion Include="Microsoft.IdentityModel.Abstractions" Version="6.35.0" />
<PackageVersion Include="Microsoft.Identity.Abstractions" Version="9.3.0" />
<PackageVersion Include="Microsoft.Web.WebView2" Version="1.0.2903.40" />
<PackageVersion Include="Microsoft.WindowsAppSDK" Version="1.7.250606001" />
<PackageVersion Include="Microsoft.Windows.SDK.BuildTools" Version="10.0.26100.4188" />
Expand Down
79 changes: 32 additions & 47 deletions src/client/Microsoft.Identity.Client/AuthenticationResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace Microsoft.Identity.Client
/// Contains the results of one token acquisition operation in <see cref="PublicClientApplication"/>
/// or ConfidentialClientApplication. For details see https://aka.ms/msal-net-authenticationresult
/// </summary>
public partial class AuthenticationResult
public partial class AuthenticationResult : Microsoft.Identity.Abstractions.AcquireTokenResult
{
private readonly IAuthenticationOperation _authenticationScheme;

Expand All @@ -36,13 +36,14 @@ public partial class AuthenticationResult
/// <param name="isExtendedLifeTimeToken">See <see cref="IsExtendedLifeTimeToken"/></param>
/// <param name="scopes">Granted scope values as returned by the service</param>
/// <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param>
/// <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param>
/// <param name="uniqueId">Unique Id of the account. It can be null. When the IdToken is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param>
/// <param name="correlationId">The correlation id of the authentication request</param>
/// <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param>
/// <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param>
/// <param name="claimsPrincipal">Claims from the ID token</param>
/// <param name="spaAuthCode">Auth Code returned by the Microsoft identity platform when you use AcquireTokenByAuthorizationCode.WithSpaAuthorizationCode(). This auth code is meant to be redeemed by the frontend code. See https://aka.ms/msal-net/spa-auth-code</param>
/// <param name="additionalResponseParameters">Other properties from the token response.</param>
[EditorBrowsable(EditorBrowsableState.Never)] // for testing purposes only
public AuthenticationResult( // for backwards compat with 4.16-
string accessToken,
bool isExtendedLifeTimeToken,
Expand All @@ -59,6 +60,14 @@ public partial class AuthenticationResult
ClaimsPrincipal claimsPrincipal = null,
string spaAuthCode = null,
IReadOnlyDictionary<string, string> additionalResponseParameters = null)
: base(
accessToken,
expiresOn,
tenantId,
idToken,
scopes,
correlationId,
tokenType)
{
AccessToken = accessToken;
#pragma warning disable CS0618 // Type or member is obsolete
Expand Down Expand Up @@ -91,7 +100,7 @@ public partial class AuthenticationResult
/// <param name="isExtendedLifeTimeToken">See <see cref="IsExtendedLifeTimeToken"/></param>
/// <param name="scopes">Granted scope values as returned by the service</param>
/// <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param>
/// <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param>
/// <param name="uniqueId">Unique Id of the account. It can be null. When the IdToken is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param>
/// <param name="correlationId">The correlation id of the authentication request</param>
/// <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param>
/// <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param>
Expand Down Expand Up @@ -136,6 +145,14 @@ internal AuthenticationResult(
Account account,
string spaAuthCode,
IReadOnlyDictionary<string, string> additionalResponseParameters)
: base(
msalAccessTokenCacheItem?.Secret,
msalAccessTokenCacheItem?.ExpiresOn ?? default,
msalIdTokenCacheItem?.IdToken?.TenantId,
msalIdTokenCacheItem?.Secret,
msalAccessTokenCacheItem?.ScopeSet,
correlationID,
msalAccessTokenCacheItem?.TokenType)
{
_authenticationScheme = authenticationScheme ?? throw new ArgumentNullException(nameof(authenticationScheme));

Expand Down Expand Up @@ -168,8 +185,8 @@ internal AuthenticationResult(
ApiEvent = apiEvent;
AuthenticationResultMetadata = new AuthenticationResultMetadata(tokenSource);
AdditionalResponseParameters = msalAccessTokenCacheItem?.PersistedCacheParameters?.Count > 0 ?
(IReadOnlyDictionary<string, string>)msalAccessTokenCacheItem.PersistedCacheParameters :
additionalResponseParameters;
(IReadOnlyDictionary<string, string>)msalAccessTokenCacheItem.PersistedCacheParameters :
additionalResponseParameters;
if (msalAccessTokenCacheItem != null)
{
ExpiresOn = msalAccessTokenCacheItem.ExpiresOn;
Expand Down Expand Up @@ -201,13 +218,15 @@ internal AuthenticationResult(
}

//Default constructor for testing
internal AuthenticationResult() { }

/// <summary>
/// Access Token that can be used as a bearer token to access protected web APIs
/// </summary>
public string AccessToken { get; set; }

internal AuthenticationResult() : base(
accessToken: null,
expiresOn: default,
tenantId: null,
idToken: null,
scopes: null,
correlationId: default,
tokenType: null)
{ }
/// <summary>
/// In case when Azure AD has an outage, to be more resilient, it can return tokens with
/// an expiration time, and also with an extended expiration time.
Expand All @@ -224,7 +243,7 @@ internal AuthenticationResult() { }
public bool IsExtendedLifeTimeToken { get; }

/// <summary>
/// Gets the Unique Id of the account in this <see cref="TenantId" />
/// Gets the Unique Id of the account in this TenantId />
/// It is set as the oid (ObjectId) claim, or if that claim is <c>null</c>, as the sub (Subject) claim which is guaranteed not-null.
/// </summary>
/// <remarks>
Expand All @@ -236,13 +255,6 @@ internal AuthenticationResult() { }
/// </remarks>
public string UniqueId { get; set; }

/// <summary>
/// Gets the point in time in which the Access Token returned in the <see cref="AccessToken"/> property ceases to be valid.
/// This value is calculated based on current UTC time measured locally and the value expiresIn received from the
/// service.
/// </summary>
public DateTimeOffset ExpiresOn { get; set; }

/// <summary>
/// Gets the point in time in which the Access Token returned in the AccessToken property ceases to be valid in MSAL's extended LifeTime.
/// This value is calculated based on current UTC time measured locally and the value ext_expiresIn received from the service.
Expand All @@ -251,12 +263,6 @@ internal AuthenticationResult() { }
[Obsolete("This feature has been deprecated", false)]
public DateTimeOffset ExtendedExpiresOn { get; }

/// <summary>
/// Gets an identifier for the Azure AD tenant from which the token was acquired. This property will be null if tenant information is
/// not returned by the service.
/// </summary>
public string TenantId { get; set; }

/// <summary>
/// Gets the account information. Some elements in <see cref="IAccount"/> might be null if not returned by the
/// service. The account can be passed back in some API overloads to identify which account should be used such
Expand All @@ -265,27 +271,6 @@ internal AuthenticationResult() { }
/// </summary>
public IAccount Account { get; set; }

/// <summary>
/// Gets the Id Token if returned by the service or null if no Id Token is returned.
/// </summary>
public string IdToken { get; set; }

/// <summary>
/// Gets the granted scope values returned by the service.
/// </summary>
public IEnumerable<string> Scopes { get; set; }

/// <summary>
/// Gets the correlation id used for the request.
/// </summary>
public Guid CorrelationId { get; set; }

/// <summary>
/// Identifies the type of access token. By default tokens returned by Azure Active Directory are Bearer tokens.
/// <seealso cref="CreateAuthorizationHeader"/> for getting an HTTP authorization header from an AuthenticationResult.
/// </summary>
public string TokenType { get; set; }

/// <summary>
/// Gets the SPA Authorization Code, if it was requested using WithSpaAuthorizationCode method on the
/// AcquireTokenByAuthorizationCode builder. See https://aka.ms/msal-net/spa-auth-code for details.
Expand Down
1 change: 1 addition & 0 deletions src/client/Microsoft.Identity.Client/Microsoft.Identity.Client.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@

<ItemGroup>
<PackageReference Include="Microsoft.IdentityModel.Abstractions" />
<PackageReference Include="Microsoft.Identity.Abstractions" />
</ItemGroup>

<ItemGroup Label="For public api analyzer support">
Expand Down
Loading