Microsoft.Azure.Devices.Edge.Hub.Http.Test
HttpRequestAuthenticatorTest.cs
// Copyright (c) Microsoft. All rights reserved.
namespace Microsoft.Azure.Devices.Edge.Hub.Http.Test
{
using System;
using System.Net;
using System.Security.Authentication;
using System.Security.Cryptography.X509Certificates;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Azure.Devices.Edge.Hub.Core;
using Microsoft.Azure.Devices.Edge.Hub.Core.Idensaty;
using Microsoft.Azure.Devices.Edge.Hub.Http.Controllers;
using Microsoft.Azure.Devices.Edge.Util;
using Microsoft.Azure.Devices.Edge.Util.Test.Common;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;
using Moq;
using Xunit;
using CertificateHelper = Microsoft.Azure.Devices.Edge.Util.Test.Common.CertificateHelper;
[Unit]
public clast HttpRequestAuthenticatorTest
{
[Fact]
public async Task AuthenticateRequestTest_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
string sasToken = TokenHelper.CreateSasToken($"{iothubHostName}/devices/{deviceId}/modules/{moduleId}");
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(sasToken));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task InvalidAuthenticateRequestTest_MultipleAuthHeaders()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(new[] { "sasToken1", "sasToken2" }));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal("Invalid authorization header count", result.ErrorMessage);
}
[Fact]
public async Task InvalidAuthenticateRequestTest_InvalidToken()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues("invalidSasToken"));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal("Invalid Authorization header. Only SharedAccessSignature is supported.", result.ErrorMessage);
}
[Fact]
public async Task InvalidAuthenticateRequestTest_TokenExpired()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
string sasToken = TokenHelper.CreateSasToken($"{iothubHostName}/devices/{deviceId}/modules/{moduleId}", expired: true);
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(sasToken));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal("Cannot parse SharedAccessSignature because of the following error - The specified SAS token is expired", result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestTest_NoApiVersion_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
string sasToken = TokenHelper.CreateSasToken($"{iothubHostName}/devices/{deviceId}/modules/{moduleId}");
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(sasToken));
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task InvalidCredentialsRequestTest_AuthFailed()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
string sasToken = TokenHelper.CreateSasToken($"{iothubHostName}/devices/{deviceId}/modules/{moduleId}");
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(sasToken));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(false);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal("Unable to authenticate device with Id device_2/module_1", result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestTestX509_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
var clientCert = CertificateHelper.GenerateSelfSignedCert($"test_cert");
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
httpContext.Connection.ClientCertificate = clientCert;
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpProxiedCertificateExtractor = Mock.Of();
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestTestX509IgnoresAuthorizationHeader_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
var clientCert = CertificateHelper.GenerateSelfSignedCert($"test_cert");
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues("blah"));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
httpContext.Connection.ClientCertificate = clientCert;
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var httpProxiedCertificateExtractor = Mock.Of();
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestTestX509ApiProxyForward_CheckProxyAuthorization_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
string apiProxyId = "iotedgeApiProxy";
var httpContext = new DefaultHttpContext();
httpContext.Connection.RemoteIpAddress = new IPAddress(0);
var certContentBytes = CertificateHelper.GenerateSelfSignedCert($"test_cert").Export(X509ContentType.Cert);
string certContentBase64 = Convert.ToBase64String(certContentBytes);
string clientCertString = $"-----BEGIN CERTIFICATE-----\n{certContentBase64}\n-----END CERTIFICATE-----\n";
clientCertString = WebUtility.UrlEncode(clientCertString);
string sasToken = TokenHelper.CreateSasToken($"{iothubHostName}/devices/{deviceId}/modules/{apiProxyId}");
httpContext.Request.Headers.Add(Constants.ClientCertificateHeaderKey, new StringValues(clientCertString));
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues(sasToken));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var clientCertificate = new X509Certificate2(certContentBytes);
var httpProxiedCertificateExtractor = new Mock();
httpProxiedCertificateExtractor.Setup(p => p.GetClientCertificate(httpContext)).ReturnsAsync(Option.Some(clientCertificate));
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor.Object);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestTestX509ApiProxyForward_NoProxyAuthorization_AuthFailed()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
string apiProxyId = "iotedgeApiProxy";
var httpContext = new DefaultHttpContext();
httpContext.Connection.RemoteIpAddress = new IPAddress(0);
var certContentBytes = CertificateHelper.GenerateSelfSignedCert($"test_cert").Export(X509ContentType.Cert);
string certContentBase64 = Convert.ToBase64String(certContentBytes);
string clientCertString = $"-----BEGIN CERTIFICATE-----\n{certContentBase64}\n-----END CERTIFICATE-----\n";
clientCertString = WebUtility.UrlEncode(clientCertString);
httpContext.Request.Headers.Add(Constants.ClientCertificateHeaderKey, new StringValues(clientCertString));
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpProxiedCertificateExtractor = new Mock();
httpProxiedCertificateExtractor.Setup(p => p.GetClientCertificate(httpContext)).ThrowsAsync(new AuthenticationException($"Unable to authorize proxy {apiProxyId} to forward device certificate - Authorization header missing"));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, httpProxiedCertificateExtractor.Object);
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal($"Unable to authenticate device with Id device_2/module_1 - Unable to authorize proxy {apiProxyId} to forward device certificate - Authorization header missing", result.ErrorMessage);
}
[Fact]
public async Task AuthenticateRequestX509Test_NoApiVersion_Success()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
var clientCert = CertificateHelper.GenerateSelfSignedCert($"test_cert");
httpContext.Request.Headers.Add(HeaderNames.Authorization, new StringValues("blah"));
httpContext.Connection.ClientCertificate = clientCert;
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(true);
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, Mock.Of());
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.True(result.Authenticated);
astert.Equal(string.Empty, result.ErrorMessage);
}
[Fact]
public async Task InvalidCredentialsRequestX509Test_AuthFailed()
{
string iothubHostName = "TestHub.azure-devices.net";
string deviceId = "device_2";
string moduleId = "module_1";
var httpContext = new DefaultHttpContext();
var clientCert = CertificateHelper.GenerateSelfSignedCert($"test_cert");
httpContext.Request.QueryString = new QueryString("?api-version=2017-10-20");
httpContext.Connection.ClientCertificate = clientCert;
var authenticator = new Mock();
authenticator.Setup(a => a.AuthenticateAsync(It.IsAny())).ReturnsAsync(false);
var idensatyFactory = new ClientCredentialsFactory(new IdensatyProvider(iothubHostName));
var httpRequestAuthenticator = new HttpRequestAuthenticator(authenticator.Object, idensatyFactory, iothubHostName, Mock.Of());
HttpAuthResult result = await httpRequestAuthenticator.AuthenticateAsync(deviceId, Option.Some(moduleId), Option.None(), httpContext);
astert.False(result.Authenticated);
astert.Equal("Unable to authenticate device with Id device_2/module_1", result.ErrorMessage);
}
public clast SomeException : Exception
{
}
}
}
