C# - ASP.NET Core 프로젝트에서 서버 Socket을 직접 생성하는 방법

excludedportrange로 인해,

"Administered port exclusions" 설명
; https://www.sysnet.pe.kr/2/0/12293

간혹 비주얼 스튜디오에서 생성한 웹 애플리케이션을 실행하는 경우에서조차도,

Visual Studio - 웹 애플리케이션 실행 시 "Unable to connect to web server 'IIS Express'." 오류 발생
; https://www.sysnet.pe.kr/2/0/12265

포트 충돌이 발생하곤 합니다. 이런 문제를 해결하려면, 우리도 사용해야 할 포트를 excludedportrange로 등록한 후 Socket.IOControl로 연결하면 된다고 설명했는데요,

C# - 소켓 포트를 미리 시스템에 등록/예약해 사용하는 방법(Port Exclusion Ranges)
; https://www.sysnet.pe.kr/2/0/13439

혹시, 그럼 저걸 이용해서 ASP.NET Core 웹 프로젝트를 실행할 때의 포트 충돌 문제를 해결할 수 있을까요? ^^

---

그러려면 가장 중요한 것이, ASP.NET Core 프레임워크에서 Socket을 사용자 정의할 수 있어야 합니다. 다행히, 이 기능이 .NET 6+부터 SocketTransportOptions을 통해 지원하기 시작했는데요, 코드는 간단하게 다음과 같이 나옵니다.

using System.Net.Sockets;
using Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets;

namespace WebApplication1
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var builder = WebApplication.CreateBuilder(args);

            builder.Services.Configure<SocketTransportOptions>(options =>
            {
                options.CreateBoundListenSocket = endpoint =>
                {
                    Socket socket = SocketTransportOptions.CreateDefaultBoundListenSocket(endpoint);
                    return socket;
                };
            });

            // Add services to the container.
            builder.Services.AddRazorPages();

            var app = builder.Build();

            // Configure the HTTP request pipeline.
            if (!app.Environment.IsDevelopment())
            {
                app.UseExceptionHandler("/Error");
            }
            app.UseStaticFiles();

            app.UseRouting();

            app.UseAuthorization();

            app.MapRazorPages();

            app.Run();
        }
    }
}

SocketTransportOptions가 구현한 CreateDefaultBoundListenSocket의 소스 코드는 이런 식인데요,

public static Socket CreateDefaultBoundListenSocket(EndPoint endpoint)
{
    Socket listenSocket;
    switch (endpoint)
    {
        case FileHandleEndPoint fileHandle:
            listenSocket = new Socket(
                new SafeSocketHandle((IntPtr)fileHandle.FileHandle, ownsHandle: true)
            );
            break;
        case UnixDomainSocketEndPoint unix:
            listenSocket = new Socket(unix.AddressFamily, SocketType.Stream, ProtocolType.Unspecified);
            break;
        case IPEndPoint ip:
            listenSocket = new Socket(ip.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

            if (ip.Address.Equals(IPAddress.IPv6Any))
            {
                listenSocket.DualMode = true;
            }

            break;
        default:
            listenSocket = new Socket(endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
            break;
    }

    if (!(endpoint is FileHandleEndPoint))
    {
        listenSocket.Bind(endpoint);
    }

    return listenSocket;
}

따라서 우리는 저 코드를 이용해 다음과 같은 식으로 만들면 됩니다.

builder.Services.Configure<SocketTransportOptions>(options =>
{
    options.CreateBoundListenSocket = endpoint =>
    {
        return CreateSocketFromExcludedPortRange(endpoint);
    };
});

private static Socket CreateSocketFromExcludedPortRange(EndPoint endpoint)
{
    switch (endpoint)
    {
        case FileHandleEndPoint:
        case UnixDomainSocketEndPoint:
            return SocketTransportOptions.CreateDefaultBoundListenSocket(endpoint);
    }
            
    Socket socket = // ...[생략: Port Exclusion Ranges를 고려한 소켓 생성]...
    return socket;
}

간단하죠? ^^

---

그런데, 정작 구현하다 보면 이게 그렇게 간단하게 끝나지 않습니다. 왜냐하면 Port Exclusion을 이용한 IOControl 코드는 관리자 권한에서만 동작하기 때문에, 반드시 비주얼 스튜디오 프로세스부터 관리자 권한으로 띄워 두어야 합니다.

그리고 이러한 동작은 대개의 경우 개발자 머신에서만 유효할 것입니다. 실제 현업에 배포할 때는 대개의 경우 80/443 포트를 점유하거나, Reverse Proxy나 Container 환경에서 미리 정의한 바로 그 포트로만 서비스를 할 것이기 때문에 딱히 Port Exclusion을 사용할 필요가 없습니다.

따라서 이런 것을 고려했을 때, 대충 다음과 같은 식으로 코드를 작성해 볼 수 있습니다.

using Microsoft.AspNetCore.Connections;
using Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets;
using System.Net;
using System.Net.Sockets;
using System.Runtime.InteropServices;
using System.Security.Principal;

namespace WebApplication1
{
    public class Program
    {
#if DEBUG
        [DllImport("Iphlpapi.dll")]
        internal static extern uint CreatePersistentTcpPortReservation(ushort startPort, ushort numberOfPorts, out long token);

        [DllImport("Iphlpapi.dll")]
        internal static extern uint LookupPersistentTcpPortReservation(ushort startPort, ushort numberOfPorts, out long token);

        const int ERROR_NOT_FOUND = 1168;
        const int ERROR_INVALID_PARAMETER = 87;
        const int SIO_ASSOCIATE_PORT_RESERVATION = -1744830362;
        const int WSAEACCES = 10013;
#endif

        public static void Main(string[] args)
        {
            var builder = WebApplication.CreateBuilder(args);

#if DEBUG
            builder.Services.Configure<SocketTransportOptions>(options =>
            {
                options.CreateBoundListenSocket = endpoint =>
                {
                    return CreateSocketFromExcludedPortRange(endpoint);
                };
            });
#endif

            // Add services to the container.
            builder.Services.AddRazorPages();

            var app = builder.Build();

            // Configure the HTTP request pipeline.
            if (!app.Environment.IsDevelopment())
            {
                app.UseExceptionHandler("/Error");
            }
            app.UseStaticFiles();

            app.UseRouting();

            app.UseAuthorization();

            app.MapRazorPages();

            app.Run();
        }

#if DEBUG
        // ClickOnce - 관리자 권한 상승하는 방법
        // https://www.sysnet.pe.kr/2/0/950

        public static bool IsAdministrator()
        {
            WindowsIdentity identity = WindowsIdentity.GetCurrent();

            if (null != identity)
            {
                WindowsPrincipal principal = new WindowsPrincipal(identity);
                return principal.IsInRole(WindowsBuiltInRole.Administrator);
            }

            return false;
        }

        private static Socket CreateSocketFromExcludedPortRange(EndPoint endpoint)
        {
            if (IsAdministrator() == false)
            {
                return SocketTransportOptions.CreateDefaultBoundListenSocket(endpoint);
            }

            switch (endpoint)
            {
                case FileHandleEndPoint:
                case UnixDomainSocketEndPoint:
                    return SocketTransportOptions.CreateDefaultBoundListenSocket(endpoint);
            }

            Socket listenSocket;

            switch (endpoint)
            {
                case IPEndPoint ip:
                    listenSocket = new Socket(ip.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

                    if (ip.Address.Equals(IPAddress.IPv6Any))
                    {
                        listenSocket.DualMode = true;
                    }
                    break;

                default:
                    listenSocket = new Socket(endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
                    break;
            }

            endpoint = DetermineEndpoint(listenSocket, endpoint);

            listenSocket.Bind(endpoint);
            return listenSocket;
        }

        private static EndPoint DetermineEndpoint(Socket socket, EndPoint endpoint)
        {
            IPEndPoint? ip = endpoint as IPEndPoint;
            if (ip == null)
            {
                return endpoint;
            }

            ushort startPort = (ushort)ip.Port;
            long token = 0;

            for (ushort i = startPort; i <= ushort.MaxValue; i++)
            {
                ushort port = (ushort)IPAddress.HostToNetworkOrder((short)i);

                uint status = LookupPersistentTcpPortReservation(port, 1, out token);

                if (status == ERROR_NOT_FOUND)
                {
                    status = CreatePersistentTcpPortReservation((ushort)port, 1, out token);
                }

                if (status == 0)
                {
                    byte[] resToken = BitConverter.GetBytes(token);

                    try
                    {
                        int result = socket.IOControl(SIO_ASSOCIATE_PORT_RESERVATION, resToken, null);
                        if (result == 0)
                        {
                            return new IPEndPoint(ip.Address, i);
                        }
                    }
                    catch (SocketException)
                    {
                    }
                }
            }

            return endpoint;
        }
#endif

    }
}

그런데, 여러분들이 해결해야 할 문제가 정말 저 코드를 사용해가면서까지 필요한 것인가? 라는 질문을 해야 합니다. 그러니까, 단순히 로컬에서 디버깅 실행 중 포트 충돌이 나는 귀찮음을 피하기 위해 저런 더 귀찮은 코드를 넣어야 하는 것이 바람직하냐는 것입니다.

사실 저 정도의 처리는 Port Exclusion 없이도 그냥 Bind를 무작정 시켜 예외가 나는 것을 catch하는 식으로,

builder.Services.Configure<SocketTransportOptions>(options =>
{
    options.CreateBoundListenSocket = endpoint =>
    {
        return CreateServerSocket(endpoint);
    };
});

private static Socket CreateServerSocket(EndPoint endpoint)
{
    switch (endpoint)
    {
        case FileHandleEndPoint:
        case UnixDomainSocketEndPoint:
            return SocketTransportOptions.CreateDefaultBoundListenSocket(endpoint);
    }

    Socket listenSocket = new Socket(endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

    IPEndPoint? ip = endpoint as IPEndPoint;
    if (ip == null)
    {
        listenSocket.Bind(endpoint);
        return listenSocket;
    }

    if (ip.Address.Equals(IPAddress.IPv6Any))
    {
        listenSocket.DualMode = true;
    }

    Exception? lastException = null;
    int portNumber = ip.Port;

    for (int i = portNumber; i < ushort.MaxValue; i++)
    {
        IPEndPoint ep = new IPEndPoint(ip.Address, i);

        try
        {
            listenSocket.Bind(ep);
            Console.WriteLine($"Binding: {ep}");
            return listenSocket;
        }
        catch (SocketException ex)
        {
            lastException = ex;
        }
    }

    throw lastException;
}

처리하는 것이 더 단순해서 좋습니다. ^^ 하지만, 여전히 의문이군요. 1) 비주얼 스튜디오를 관리자 권한으로 실행시키고 2) 저 코드를 넣어서 처리하느니, 저라면 그냥 설정에서 포트 번호를 다른 것으로 바꾸고 말겠습니다.

---

참고로, .NET 6+부터 저렇게 서버 소켓을 사용자 정의할 수 있게 되었는데요, 마찬가지로 웹 서버에 접속한 클라이언트와의 통신을 담당하는 소켓도 IConnectionSocketFeature로 구하는 것이 가능해졌습니다.

따라서, 요청 중에 다음과 같이 구할 수 있습니다.

using Microsoft.AspNetCore.Connections.Features;
using Microsoft.AspNetCore.Mvc.RazorPages;
using System.Net.Sockets;

namespace WebApplication1.Pages
{
    public class IndexModel : PageModel
    {
        private readonly ILogger<IndexModel> _logger;

        public IndexModel(ILogger<IndexModel> logger)
        {
            _logger = logger;
        }

        public void OnGet()
        {
            var socketFeature = this.HttpContext.Features.Get<IConnectionSocketFeature>();
            Socket clntSock = socketFeature.Socket;
            Console.WriteLine($"{clntSock.RemoteEndPoint} - {clntSock.LocalEndPoint}");
        }
    }
}

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();

var app = builder.Build();

app.Use(next =>
{
    return async context =>
    {
        var socketFeature = context.Features.Get<IConnectionSocketFeature>();
        Socket clntSock = socketFeature.Socket;
        Console.WriteLine($"{clntSock.RemoteEndPoint} - {clntSock.LocalEndPoint}");
        await next(context);
    };
});

(첨부 파일은 이 글의 예제 코드를 포함합니다.)

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 11/12/2023]
[최종 수정일: 11/12/2023]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com