Skip to content

AppAuth 1.5.0 release #12160

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
AlexGhiondea merged 3 commits into from
May 20, 2020
Merged

AppAuth 1.5.0 release #12160

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
cfd0a69
Updating App Services MSI client to use new API version
nonik0 May 16, 2020
29eb5cc
Fixing backwards compatibility issue with missing ctor signature
nonik0 May 16, 2020
02d077c
KeyVaultClient updates, other various cleanup/refactoring, update NuG…
nonik0 May 15, 2020
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
7 changes: 3 additions & 4 deletions ...ppAuthentication/Azure.Services.AppAuthentication.IntegrationTests/Helpers/GraphHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public async Task<Application> CreateApplicationAsync(string secret)
Application newApp = new Application
{
DisplayName = $"Microsoft.Azure.Services.AppAuthentication.Test{guid}",
IdentifierUris = new List<string> { $"https://Microsoft.Azure.Services.AppAuthentication/{guid}"},
IdentifierUris = new List<string> { $"https://Microsoft.Azure.Services.AppAuthentication/{guid}" },
ReplyUrls = new List<string> { "https://Microsoft.Azure.Services.AppAuthentication/" },
OdataType = "Microsoft.DirectoryServices.Application",
AppRolesODataType = "Collection(Microsoft.DirectoryServices.AppRole)",
Expand All @@ -57,7 +57,7 @@ public async Task<Application> CreateApplicationAsync(string secret)
EndDate = DateTime.Now.AddDays(2)
};

newApp.PasswordCredentials = new List<PasswordCredential> {keyCredential};
newApp.PasswordCredentials = new List<PasswordCredential> { keyCredential };

return await CreateApplication(newApp).ConfigureAwait(false);

Expand All @@ -75,7 +75,7 @@ public async Task<Application> CreateApplicationAsync(X509Certificate2 cert)
Application newApp = new Application
{
DisplayName = $"Microsoft.Azure.Services.AppAuthentication.Test{guid}",
IdentifierUris = new List<string> { $"https://localhost/demo/{guid}"},
IdentifierUris = new List<string> { $"https://localhost/demo/{guid}" },
ReplyUrls = new List<string> { "https://localhost/demo" },
OdataType = "Microsoft.DirectoryServices.Application",
AppRolesODataType = "Collection(Microsoft.DirectoryServices.AppRole)",
Expand Down Expand Up @@ -157,7 +157,6 @@ await SendHttpRequest(HttpMethod.Delete,

await SendHttpRequest(HttpMethod.Delete,
$"{Constants.GraphResourceId}{_directory}/applications/{app.ObjectId}?api-version=1.6").ConfigureAwait(false);

}

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions sdk/mgmtcommon/AppAuthentication/Azure.Services.AppAuthentication.TestCommon/Constants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ public class Constants
public static readonly string AppType = "App";

// MSI related constants
public static readonly string MsiAppServiceEndpointEnv = "MSI_ENDPOINT";
public static readonly string MsiAppServiceSecretEnv = "MSI_SECRET";
public static readonly string MsiAppServiceEndpointEnv = "IDENTITY_ENDPOINT";
public static readonly string MsiAppServiceHeaderEnv = "IDENTITY_HEADER";
public static readonly string MsiEndpoint = "http://localhost:3748/oauth2/token";

// Unit test certificate
Expand Down
7 changes: 3 additions & 4 deletions sdk/mgmtcommon/AppAuthentication/Azure.Services.AppAuthentication.TestCommon/Validator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,8 @@ private static DateTimeOffset GetTokenExpiration(string accessTokenString)
/// <param name="appId"></param>
/// <param name="thumbprint"></param>
/// <param name="expiresOn"></param>
public static void ValidateToken(string token, Principal principalUsed, string type,
string tenantId, string appId = default(string), string thumbprint = default(string),
DateTimeOffset expiresOn = default(DateTimeOffset))
public static void ValidateToken(string token, Principal principalUsed, string type, string tenantId,
string appId = default, string thumbprint = default, DateTimeOffset expiresOn = default)
{
Assert.Equal("eyJ0eXAiOiJKV1Qi", token.Substring(0, "eyJ0eXAiOiJKV1Qi".Length));
Assert.Contains(".", token);
Expand Down Expand Up @@ -113,7 +112,7 @@ public static void ValidateToken(string token, Principal principalUsed, string t
upnPart = $" UserPrincipalName:{principalUsed.UserPrincipalName}";
}

if (expiresOn != default(DateTimeOffset))
if (expiresOn != default)
{
DateTimeOffset tokenExpiration = GetTokenExpiration(token);

Expand Down
65 changes: 51 additions & 14 deletions ...hentication/Azure.Services.AppAuthentication.Unit.Tests/AzureServiceTokenProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.Services.AppAuthentication.TestCommon;
Expand All @@ -25,7 +27,7 @@ public void Dispose()
// Delete environment variables
Environment.SetEnvironmentVariable(Constants.TestCertUrlEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, null);
}

/// <summary>
Expand All @@ -45,7 +47,7 @@ public async Task GetAppAuthResultCacheTest()

// ManualResetEvent will enable testing of SemaphoreSlim used in AzureServiceTokenProvider.
ManualResetEvent manualResetEvent = new ManualResetEvent(false);

// Use AzureServiceTokenProviders to get tokens in parallel.
for (int i = 0; i < 5; i++)
{
Expand Down Expand Up @@ -95,9 +97,9 @@ public async Task GetAppAuthResultCacheTest()
// AppAuthResultCache should not return this, since it is about to expire.
var tokenResponse = TokenResponse.Parse(TokenHelper.GetUserTokenResponse(5 * 60 - 2));
var authResult = AppAuthenticationResult.Create(tokenResponse);
AppAuthResultCache.AddOrUpdate("ConnectionString:;Authority:;Resource:https://vault.azure.net/",
AppAuthResultCache.AddOrUpdate("ConnectionString:;Authority:;Resource:https://vault.azure.net/",
new Tuple<AppAuthenticationResult, Principal>(authResult, null));

// Get the token again.
for (int i = 0; i < 5; i++)
{
Expand Down Expand Up @@ -144,8 +146,8 @@ public async Task GetTokenExceptionTest()
[Fact]
public void InvalidAzureAdInstanceTest()
{
var exception = Assert.Throws<ArgumentException>(() => new AzureServiceTokenProvider(azureAdInstance:"http://aadinstance/"));
var exception = Assert.Throws<ArgumentException>(() => new AzureServiceTokenProvider(azureAdInstance: "http://aadinstance/"));

Assert.Contains(Constants.MustUseHttpsError, exception.ToString());
}

Expand Down Expand Up @@ -194,7 +196,7 @@ public void UnspecifiedConnectionStringTest()
{
// Set environment variable AzureServicesAuthConnectionString
Environment.SetEnvironmentVariable(Constants.ConnectionStringEnvironmentVariableName, Constants.AzureCliConnectionString);

var provider = new AzureServiceTokenProvider();

Assert.NotNull(provider);
Expand All @@ -217,7 +219,7 @@ public async Task DiscoveryTestFirstSuccess()

// set env vars so MsiAccessTokenProvider assumes App Service environment and not VM environment
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

// AzureServiceTokenProvider is being asked to use two providers, and return token from the first that succeeds.
var providers = new List<NonInteractiveAzureServiceTokenProviderBase> { azureCliAccessTokenProvider, msiAccessTokenProvider };
Expand Down Expand Up @@ -248,10 +250,10 @@ public async Task DiscoveryTestFirstFail()

// set env vars so MsiAccessTokenProvider assumes App Service environment and not VM environment
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

// AzureServiceTokenProvider is being asked to use two providers, and return token from the first that succeeds.
var providers = new List<NonInteractiveAzureServiceTokenProviderBase>{azureCliAccessTokenProvider, msiAccessTokenProvider};
var providers = new List<NonInteractiveAzureServiceTokenProviderBase> { azureCliAccessTokenProvider, msiAccessTokenProvider };
AzureServiceTokenProvider azureServiceTokenProvider = new AzureServiceTokenProvider(providers);

var token = await azureServiceTokenProvider.GetAccessTokenAsync(Constants.GraphResourceId, Constants.TenantId);
Expand Down Expand Up @@ -280,10 +282,10 @@ public void DiscoveryTestBothFail()
MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAppServicesFailure);
HttpClient httpClient = new HttpClient(mockMsi);
MsiAccessTokenProvider msiAccessTokenProvider = new MsiAccessTokenProvider(httpClient);

// set env vars so MsiAccessTokenProvider assumes App Service environment and not VM environment
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

// use test hook to expedite test
MsiRetryHelper.WaitBeforeRetry = false;
Expand All @@ -302,8 +304,8 @@ public void DiscoveryTestBothFail()
Assert.Equal(5, mockMsi.HitCount);

// Clean up environment variables
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv,null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, null);
}

/// <summary>
Expand Down Expand Up @@ -351,5 +353,40 @@ public async Task SideLoadHttpFactory()

Assert.EndsWith(MockHttpClientFactory.ExceptionMessage, exception.Message);
}

/// <summary>
/// Verify backwards compatibility with constructor and method signatures
/// </summary>
[Fact]
public void VerifyPublicSignatures()
{
var KnownPublicCtors = new List<string>()
{
"Void .ctor(System.String, System.String)",
"Void .ctor(System.String, System.String, Microsoft.IdentityModel.Clients.ActiveDirectory.IHttpClientFactory)"
};

var KnownPublicMethods = new List<string>()
{
"Microsoft.IdentityModel.Clients.ActiveDirectory.IHttpClientFactory get_HttpClientFactory()",
"Void set_HttpClientFactory(Microsoft.IdentityModel.Clients.ActiveDirectory.IHttpClientFactory)",
"TokenCallback get_KeyVaultTokenCallback()",
"Microsoft.Azure.Services.AppAuthentication.Principal get_PrincipalUsed()",
"System.Threading.Tasks.Task`1[System.String] GetAccessTokenAsync(System.String, System.String, System.Threading.CancellationToken)",
"System.Threading.Tasks.Task`1[System.String] GetAccessTokenAsync(System.String, System.String)",
"System.Threading.Tasks.Task`1[Microsoft.Azure.Services.AppAuthentication.AppAuthenticationResult] GetAuthenticationResultAsync(System.String, System.String, System.Threading.CancellationToken)",
"System.Threading.Tasks.Task`1[Microsoft.Azure.Services.AppAuthentication.AppAuthenticationResult] GetAuthenticationResultAsync(System.String, System.String)",
"Boolean Equals(System.Object)",
"Int32 GetHashCode()",
"System.Type GetType()",
"System.String ToString()"
};

var publicCtorSignatures = typeof(AzureServiceTokenProvider).GetConstructors().Select(o => o.ToString()).ToList();
var publicMethodSignatures = typeof(AzureServiceTokenProvider).GetMethods().Select(o => o.ToString()).ToList();

Assert.True(Enumerable.SequenceEqual(KnownPublicCtors.OrderBy(i => i), publicCtorSignatures.OrderBy(i => i)));
Assert.True(Enumerable.SequenceEqual(KnownPublicMethods.OrderBy(i => i), publicMethodSignatures.OrderBy(i => i)));
}
}
}
11 changes: 0 additions & 11 deletions ...mmon/AppAuthentication/Azure.Services.AppAuthentication.Unit.Tests/KeyVaultClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,6 @@ public async Task SecretIdentifierInvalidSchemeTest()
Assert.Contains(KeyVaultClient.SecretIdentifierInvalidSchemeError, exception.Message);
}

[Fact]
public async Task SecretIdentifierInvalidHostTest()
{
KeyVaultClient keyVaultClient = new KeyVaultClient();

string secretIdentifier = Constants.TestKeyVaultCertificateSecretIdentifier.Replace("vault.azure.net", "vault.baddudes.net");

var exception = await Assert.ThrowsAnyAsync<Exception>(() => Task.Run(() => keyVaultClient.GetCertificateAsync(secretIdentifier)));
Assert.Contains(KeyVaultClient.SecretIdentifierInvalidHostError, exception.Message);
}

[Fact]
public async Task SecretIdentifierInvalidTypeTest()
{
Expand Down
22 changes: 11 additions & 11 deletions ...Authentication/Azure.Services.AppAuthentication.Unit.Tests/MsiAccessTokenProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public void Dispose()
{
// Delete the environment variables
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, null);
}

[Theory]
Expand Down Expand Up @@ -105,7 +105,7 @@ public async Task GetTokenUsingManagedIdentityAppServices(bool specifyUserAssign
{
// Setup the environment variables that App Service MSI would setup.
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

string expectedAppId;
string managedIdentityArgument;
Expand Down Expand Up @@ -137,15 +137,15 @@ public async Task GetTokenUsingManagedIdentityAppServices(bool specifyUserAssign
}

/// <summary>
/// Test response when MSI_SECRET in AppServices MSI is invalid.
/// Test response when IDENTITY_HEADER in AppServices MSI is invalid.
/// </summary>
/// <returns></returns>
[Fact]
public async Task UnauthorizedTest()
{
// Setup the environment variables
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

// MockMsi is being asked to act like response from App Service MSI failed (unauthorized).
MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAppServicesUnauthorized);
Expand All @@ -167,7 +167,7 @@ public async Task IncorrectFormatTest()
{
// Setup the environment variables
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAppServicesIncorrectRequest);
HttpClient httpClient = new HttpClient(mockMsi);
Expand All @@ -188,7 +188,7 @@ public async Task HttpResponseExceptionTest()
{
// Setup the environment variables
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAppServicesFailure);
HttpClient httpClient = new HttpClient(mockMsi);
Expand All @@ -206,7 +206,7 @@ public async Task HttpResponseExceptionTest()
public async Task AzureVmImdsTimeoutTest()
{
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, null);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, null);

MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAzureVmTimeout);
HttpClient httpClient = new HttpClient(mockMsi);
Expand All @@ -226,7 +226,7 @@ internal async Task TransientErrorRetryTest(MockMsi.MsiTestType testType)
{
// To simplify tests, mock as MSI App Services to skip Azure VM IDMS probe request by
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

MockMsi mockMsi = new MockMsi(testType);
HttpClient httpClient = new HttpClient(mockMsi);
Expand Down Expand Up @@ -259,9 +259,9 @@ private async Task MsiRetryTimeoutTest()
{
// To simplify tests, mock as MSI App Services to skip Azure VM IDMS probe request
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

int timeoutInSeconds = (new Random()).Next(1,4);
int timeoutInSeconds = (new Random()).Next(1, 4);

MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiUnresponsive);
HttpClient httpClient = new HttpClient(mockMsi);
Expand Down Expand Up @@ -293,7 +293,7 @@ private async Task AppServicesDifferentCultureTest()

// Setup the environment variables that App Service MSI would setup.
Environment.SetEnvironmentVariable(Constants.MsiAppServiceEndpointEnv, Constants.MsiEndpoint);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceSecretEnv, Constants.ClientSecret);
Environment.SetEnvironmentVariable(Constants.MsiAppServiceHeaderEnv, Constants.ClientSecret);

// MockMsi is being asked to act like response from App Service MSI suceeded.
MockMsi mockMsi = new MockMsi(MockMsi.MsiTestType.MsiAppServicesSuccess);
Expand Down
Loading