microsoft-identity-web/tests/Microsoft.Identity.Web.Test/BaseAuthorizationHeaderProviderTest.cs at b90fd0e7e9954076ba48ca53357e740fe0494420 · AzureAD/microsoft-identity-web · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Security.Claims;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Identity.Abstractions;
using Microsoft.Identity.Client;
using Microsoft.Identity.Web.Test.Common;
using Microsoft.Identity.Web.Extensibility;
using Xunit;

namespace Microsoft.Identity.Web.Test
{
    [Collection(nameof(TokenAcquirerFactorySingletonProtection))]
    public class BaseAuthorizationHeaderProviderTest
    {
        public BaseAuthorizationHeaderProviderTest()
        {
            TokenAcquirerFactory.ResetDefaultInstance(); // Test only
        }

        // Example of extension
        class CustomAuthorizationHeaderProvider : BaseAuthorizationHeaderProvider
        {
            public CustomAuthorizationHeaderProvider(IServiceProvider serviceProvider) : base(serviceProvider)
            {
            }
            public override Task<string> CreateAuthorizationHeaderForAppAsync(string scopes, AuthorizationHeaderProviderOptions? downstreamApiOptions = null, CancellationToken cancellationToken = default)
            {
                if (downstreamApiOptions?.ProtocolScheme == "Custom")
                    return Task.FromResult("CustomHeaderForApp");
                else
                    return base.CreateAuthorizationHeaderForAppAsync(scopes, downstreamApiOptions, cancellationToken);
            }

            public override Task<string> CreateAuthorizationHeaderForUserAsync(IEnumerable<string> scopes, AuthorizationHeaderProviderOptions? authorizationHeaderProviderOptions = null, ClaimsPrincipal? claimsPrincipal = null, CancellationToken cancellationToken = default)
            {
                if (authorizationHeaderProviderOptions?.ProtocolScheme == "Custom")
                    return Task.FromResult("CustomHeaderForUser");
                else
                    return base.CreateAuthorizationHeaderForUserAsync(scopes, authorizationHeaderProviderOptions, claimsPrincipal, cancellationToken);
            }

            public override Task<string> CreateAuthorizationHeaderAsync(IEnumerable<string> scopes, AuthorizationHeaderProviderOptions? authorizationHeaderProviderOptions = null, ClaimsPrincipal? claimsPrincipal = null, CancellationToken cancellationToken = default)
            {
                if (claimsPrincipal == null && authorizationHeaderProviderOptions?.ProtocolScheme == "Custom")
                    return Task.FromResult("CustomHeaderForApp");
                else if (claimsPrincipal != null && authorizationHeaderProviderOptions?.ProtocolScheme == "Custom")
                    return Task.FromResult("CustomHeaderForUser");
                else
                    return base.CreateAuthorizationHeaderAsync(scopes, authorizationHeaderProviderOptions, claimsPrincipal, cancellationToken);
            }
        }

        // Mock for ITokenAcquisition
        class CustomTokenAcquisition : ITokenAcquisition
        {
            public Task<string> GetAccessTokenForAppAsync(string scope, string? authenticationScheme, string? tenant = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)
            {
                throw new NotImplementedException();
            }

            public Task<string> GetAccessTokenForUserAsync(IEnumerable<string> scopes, string? authenticationScheme, string? tenantId = null, string? userFlow = null, ClaimsPrincipal? user = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)
            {
                throw new NotImplementedException();
            }

            public Task<AuthenticationResult> GetAuthenticationResultForAppAsync(string scopes, string? authenticationOptionsName = null, string? tenant = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null, CancellationToken cancellationToken = default)
            {
                throw new NotImplementedException();
            }

            public Task<AuthenticationResult> GetAuthenticationResultForAppAsync(string scope, string? authenticationScheme, string? tenant = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)
            {
                throw new NotImplementedException();
            }

            public Task<AuthenticationResult> GetAuthenticationResultForUserAsync(IEnumerable<string> scopes, string? authenticationOptionsName = null, string? tenant = null, string? userFlow = null, ClaimsPrincipal? claimsPrincipal = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null, CancellationToken cancellationToken = default)
            {
                throw new NotImplementedException();
            }

            public Task<AuthenticationResult> GetAuthenticationResultForUserAsync(IEnumerable<string> scopes, string? authenticationScheme, string? tenantId = null, string? userFlow = null, ClaimsPrincipal? user = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)
            {
                return Task.FromResult(new AuthenticationResult("eXY", false, null, DateTimeOffset.Now, DateTimeOffset.Now, null, null, null, null, Guid.Empty));
            }

            public string GetEffectiveAuthenticationScheme(string? authenticationScheme)
            {
                throw new NotImplementedException();
            }

            public void ReplyForbiddenWithWwwAuthenticateHeader(IEnumerable<string> scopes, MsalUiRequiredException msalServiceException, string? authenticationScheme, HttpResponse? httpResponse = null)
            {
                throw new NotImplementedException();
            }

            public Task ReplyForbiddenWithWwwAuthenticateHeaderAsync(IEnumerable<string> scopes, MsalUiRequiredException msalServiceException, HttpResponse? httpResponse = null)
            {
                throw new NotImplementedException();
            }
        }

        [Fact]
        public async Task TestBaseAuthorizationHeaderProviderAsync()
        {
            TokenAcquirerFactory tokenAcquirerFactory = TokenAcquirerFactory.GetDefaultInstance();
            // Test the extensibility
            tokenAcquirerFactory.Services.AddSingleton<IAuthorizationHeaderProvider, CustomAuthorizationHeaderProvider>();

            // Mock the token acquisition
            tokenAcquirerFactory.Services.AddSingleton<ITokenAcquisition, CustomTokenAcquisition>();
            var serviceProvider = tokenAcquirerFactory.Build();

            IAuthorizationHeaderProvider authorizationHeaderProvider = serviceProvider.GetRequiredService<IAuthorizationHeaderProvider>();

            // test acquiring a header on behalf of a user
            string result = await authorizationHeaderProvider.CreateAuthorizationHeaderForUserAsync(["scope"],
                new AuthorizationHeaderProviderOptions { ProtocolScheme = "Custom" }, new ClaimsPrincipal(), CancellationToken.None);
            Assert.Equal("CustomHeaderForUser", result);

            result = await authorizationHeaderProvider.CreateAuthorizationHeaderForUserAsync(["scope"],
                new AuthorizationHeaderProviderOptions { }, new ClaimsPrincipal(), CancellationToken.None);
            Assert.Equal("Bearer eXY", result);

            result = await authorizationHeaderProvider.CreateAuthorizationHeaderAsync(["scope"],
                new AuthorizationHeaderProviderOptions { ProtocolScheme = "Custom" }, new ClaimsPrincipal(), CancellationToken.None);
            Assert.Equal("CustomHeaderForUser", result);

            TokenAcquirerFactory.ResetDefaultInstance(); // Test only

            // test acquiring a header on behalf of an app
            result = await authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync("scope",
                new AuthorizationHeaderProviderOptions { ProtocolScheme = "Custom" }, CancellationToken.None);
            Assert.Equal("CustomHeaderForApp", result);

            result = await authorizationHeaderProvider.CreateAuthorizationHeaderAsync(["scope"],
                new AuthorizationHeaderProviderOptions { ProtocolScheme = "Custom" }, null, CancellationToken.None);
            Assert.Equal("CustomHeaderForApp", result);

            TokenAcquirerFactory.ResetDefaultInstance(); // Test only
        }
    }
}