Improve exception when HTTP.sys can't register a prefix (#20718)

* Improve exception when HTTP.sys can't register a prefix

Propose an actionable solution and include a link to the documentation.

* Add SkipOnHelix attribute
This commit is contained in:
Cédric Luthi 2020-04-27 22:16:26 +02:00 committed by GitHub
parent c7a2c0648a
commit b73b2027cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 3 deletions

View File

@ -79,12 +79,13 @@ namespace Microsoft.AspNetCore.Server.HttpSys
{
if (statusCode == UnsafeNclNativeMethods.ErrorCodes.ERROR_ALREADY_EXISTS)
{
throw new HttpSysException((int)statusCode, string.Format(Resources.Exception_PrefixAlreadyRegistered, uriPrefix));
throw new HttpSysException((int)statusCode, Resources.FormatException_PrefixAlreadyRegistered(uriPrefix));
}
else
if (statusCode == UnsafeNclNativeMethods.ErrorCodes.ERROR_ACCESS_DENIED)
{
throw new HttpSysException((int)statusCode);
throw new HttpSysException((int)statusCode, Resources.FormatException_AccessDenied(uriPrefix, Environment.UserDomainName + @"\" + Environment.UserName));
}
throw new HttpSysException((int)statusCode);
}
}

View File

@ -117,6 +117,11 @@
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="Exception_AccessDenied" xml:space="preserve">
<value>The prefix '{0}' is not registered. Please run the following command as Administrator to register this prefix:
netsh http add urlacl url={0} user={1}
See "Preregister URL prefixes on the server" on https://go.microsoft.com/fwlink/?linkid=2127065 for more information.</value>
</data>
<data name="Exception_ArrayTooSmall" xml:space="preserve">
<value>The destination array is too small.</value>
</data>

View File

@ -9,7 +9,9 @@ using System.Net.Sockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.HttpSys.Internal;
using Microsoft.AspNetCore.Testing;
using Microsoft.Extensions.Logging;
using Xunit;
namespace Microsoft.AspNetCore.Server.HttpSys.Listener
@ -123,6 +125,20 @@ namespace Microsoft.AspNetCore.Server.HttpSys.Listener
}
}
[ConditionalFact]
[SkipOnHelix("https://github.com/dotnet/aspnetcore/pull/20718#issuecomment-618758634")]
public void Server_RegisterUnavailablePrefix_ThrowsActionableHttpSysException()
{
var options = new HttpSysOptions();
options.UrlPrefixes.Add(UrlPrefix.Create("http", "example.org", "8080", ""));
var listener = new HttpSysListener(options, new LoggerFactory());
var exception = Assert.Throws<HttpSysException>(() => listener.Start());
Assert.Equal((int)UnsafeNclNativeMethods.ErrorCodes.ERROR_ACCESS_DENIED, exception.ErrorCode);
Assert.Contains($@"netsh http add urlacl url=http://example.org:8080/ user={Environment.UserDomainName}\{Environment.UserName}", exception.Message);
}
[ConditionalFact]
public async Task Server_HotAddPrefix_Success()
{