StunClient5389UDP.cs 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. using Microsoft;
  2. using STUN.Enums;
  3. using STUN.Messages;
  4. using STUN.Proxy;
  5. using STUN.StunResult;
  6. using STUN.Utils;
  7. using System;
  8. using System.Buffers;
  9. using System.Diagnostics;
  10. using System.Net;
  11. using System.Net.Sockets;
  12. using System.Threading;
  13. using System.Threading.Tasks;
  14. namespace STUN.Client
  15. {
  16. /// <summary>
  17. /// https://tools.ietf.org/html/rfc5389#section-7.2.1
  18. /// https://tools.ietf.org/html/rfc5780#section-4.2
  19. /// </summary>
  20. public class StunClient5389UDP : IStunClient
  21. {
  22. public virtual IPEndPoint LocalEndPoint => (IPEndPoint)_proxy.Client.LocalEndPoint!;
  23. public TimeSpan ReceiveTimeout { get; set; } = TimeSpan.FromSeconds(3);
  24. private readonly IPEndPoint _remoteEndPoint;
  25. private readonly IUdpProxy _proxy;
  26. public StunResult5389 Status { get; } = new();
  27. public StunClient5389UDP(IPAddress server, ushort port, IPEndPoint local, IUdpProxy? proxy = null)
  28. {
  29. Requires.NotNull(server, nameof(server));
  30. Requires.Argument(port > 0, nameof(port), @"Port value must be > 0!");
  31. _proxy = proxy ?? new NoneUdpProxy(local);
  32. _remoteEndPoint = new IPEndPoint(server, port);
  33. Status.LocalEndPoint = local;
  34. }
  35. public virtual async ValueTask ConnectProxyAsync(CancellationToken cancellationToken = default)
  36. {
  37. using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
  38. cts.CancelAfter(ReceiveTimeout);
  39. await _proxy.ConnectAsync(cts.Token);
  40. }
  41. public virtual async ValueTask CloseProxyAsync(CancellationToken cancellationToken = default)
  42. {
  43. await _proxy.CloseAsync(cancellationToken);
  44. }
  45. public async ValueTask QueryAsync(CancellationToken cancellationToken = default)
  46. {
  47. Status.Reset();
  48. await FilteringBehaviorTestBaseAsync(cancellationToken);
  49. if (Status.BindingTestResult != BindingTestResult.Success
  50. || Status.FilteringBehavior == FilteringBehavior.UnsupportedServer
  51. )
  52. {
  53. return;
  54. }
  55. if (Equals(Status.PublicEndPoint, Status.LocalEndPoint))
  56. {
  57. Status.MappingBehavior = MappingBehavior.Direct;
  58. return;
  59. }
  60. // MappingBehaviorTest test II
  61. var (success2, result2) = await MappingBehaviorTestBase2Async(cancellationToken);
  62. if (!success2)
  63. {
  64. return;
  65. }
  66. // MappingBehaviorTest test III
  67. await MappingBehaviorTestBase3Async(result2, cancellationToken);
  68. }
  69. public async Task BindingTestAsync()
  70. {
  71. try
  72. {
  73. Status.Reset();
  74. using var cts = new CancellationTokenSource(ReceiveTimeout);
  75. await _proxy.ConnectAsync(cts.Token);
  76. await BindingTestInternalAsync(cts.Token);
  77. }
  78. finally
  79. {
  80. await _proxy.ConnectAsync();
  81. }
  82. }
  83. private async Task BindingTestInternalAsync(CancellationToken token)
  84. {
  85. Status.Clone(await BindingTestBaseAsync(_remoteEndPoint, token));
  86. }
  87. private async Task<StunResult5389> BindingTestBaseAsync(IPEndPoint remote, CancellationToken token)
  88. {
  89. var result = new StunResult5389();
  90. var test = new StunMessage5389 { StunMessageType = StunMessageType.BindingRequest };
  91. var (response1, _, local1) = await TestAsync(test, remote, remote, token);
  92. var mappedAddress1 = response1?.GetXorMappedAddressAttribute();
  93. var otherAddress = response1?.GetOtherAddressAttribute();
  94. var local = local1 is null ? null : new IPEndPoint(local1, LocalEndPoint.Port);
  95. if (response1 is null)
  96. {
  97. result.BindingTestResult = BindingTestResult.Fail;
  98. }
  99. else if (mappedAddress1 is null)
  100. {
  101. result.BindingTestResult = BindingTestResult.UnsupportedServer;
  102. }
  103. else
  104. {
  105. result.BindingTestResult = BindingTestResult.Success;
  106. }
  107. result.LocalEndPoint = local;
  108. result.PublicEndPoint = mappedAddress1;
  109. result.OtherEndPoint = otherAddress;
  110. return result;
  111. }
  112. public async Task MappingBehaviorTestAsync()
  113. {
  114. try
  115. {
  116. Status.Reset();
  117. using var cts = new CancellationTokenSource(ReceiveTimeout);
  118. await _proxy.ConnectAsync(cts.Token);
  119. // test I
  120. await BindingTestInternalAsync(cts.Token);
  121. if (Status.BindingTestResult != BindingTestResult.Success)
  122. {
  123. return;
  124. }
  125. if (Status.OtherEndPoint is null
  126. || Equals(Status.OtherEndPoint.Address, _remoteEndPoint.Address)
  127. || Status.OtherEndPoint.Port == _remoteEndPoint.Port)
  128. {
  129. Status.MappingBehavior = MappingBehavior.UnsupportedServer;
  130. return;
  131. }
  132. if (Equals(Status.PublicEndPoint, Status.LocalEndPoint))
  133. {
  134. Status.MappingBehavior = MappingBehavior.Direct;
  135. return;
  136. }
  137. // test II
  138. var (success2, result2) = await MappingBehaviorTestBase2Async(cts.Token);
  139. if (!success2)
  140. {
  141. return;
  142. }
  143. // test III
  144. await MappingBehaviorTestBase3Async(result2, cts.Token);
  145. }
  146. finally
  147. {
  148. await _proxy.CloseAsync();
  149. }
  150. }
  151. private async Task<(bool, StunResult5389)> MappingBehaviorTestBase2Async(CancellationToken token)
  152. {
  153. var result2 = await BindingTestBaseAsync(new IPEndPoint(Status.OtherEndPoint!.Address, _remoteEndPoint.Port), token);
  154. if (result2.BindingTestResult != BindingTestResult.Success)
  155. {
  156. Status.MappingBehavior = MappingBehavior.Fail;
  157. return (false, result2);
  158. }
  159. if (Equals(result2.PublicEndPoint, Status.PublicEndPoint))
  160. {
  161. Status.MappingBehavior = MappingBehavior.EndpointIndependent;
  162. return (false, result2);
  163. }
  164. return (true, result2);
  165. }
  166. private async Task MappingBehaviorTestBase3Async(StunResult5389 result2, CancellationToken token)
  167. {
  168. var result3 = await BindingTestBaseAsync(Status.OtherEndPoint!, token);
  169. if (result3.BindingTestResult != BindingTestResult.Success)
  170. {
  171. Status.MappingBehavior = MappingBehavior.Fail;
  172. return;
  173. }
  174. Status.MappingBehavior = Equals(result3.PublicEndPoint, result2.PublicEndPoint) ? MappingBehavior.AddressDependent : MappingBehavior.AddressAndPortDependent;
  175. }
  176. private async Task FilteringBehaviorTestBaseAsync(CancellationToken token)
  177. {
  178. // test I
  179. await BindingTestInternalAsync(token);
  180. if (Status.BindingTestResult != BindingTestResult.Success)
  181. {
  182. return;
  183. }
  184. if (Status.OtherEndPoint is null
  185. || Equals(Status.OtherEndPoint.Address, _remoteEndPoint.Address)
  186. || Status.OtherEndPoint.Port == _remoteEndPoint.Port)
  187. {
  188. Status.FilteringBehavior = FilteringBehavior.UnsupportedServer;
  189. return;
  190. }
  191. // test II
  192. var test2 = new StunMessage5389
  193. {
  194. StunMessageType = StunMessageType.BindingRequest,
  195. Attributes = new[] { AttributeExtensions.BuildChangeRequest(true, true) }
  196. };
  197. var (response2, _, _) = await TestAsync(test2, _remoteEndPoint, Status.OtherEndPoint, token);
  198. if (response2 is not null)
  199. {
  200. Status.FilteringBehavior = FilteringBehavior.EndpointIndependent;
  201. return;
  202. }
  203. // test III
  204. var test3 = new StunMessage5389
  205. {
  206. StunMessageType = StunMessageType.BindingRequest,
  207. Attributes = new[] { AttributeExtensions.BuildChangeRequest(false, true) }
  208. };
  209. var (response3, remote3, _) = await TestAsync(test3, _remoteEndPoint, _remoteEndPoint, token);
  210. if (response3 is null || remote3 is null)
  211. {
  212. Status.FilteringBehavior = FilteringBehavior.AddressAndPortDependent;
  213. return;
  214. }
  215. if (Equals(remote3.Address, _remoteEndPoint.Address) && remote3.Port != _remoteEndPoint.Port)
  216. {
  217. Status.FilteringBehavior = FilteringBehavior.AddressAndPortDependent;
  218. }
  219. else
  220. {
  221. Status.FilteringBehavior = FilteringBehavior.UnsupportedServer;
  222. }
  223. }
  224. public async Task FilteringBehaviorTestAsync()
  225. {
  226. try
  227. {
  228. Status.Reset();
  229. using var cts = new CancellationTokenSource(ReceiveTimeout);
  230. await _proxy.ConnectAsync(cts.Token);
  231. await FilteringBehaviorTestBaseAsync(cts.Token);
  232. }
  233. finally
  234. {
  235. await _proxy.CloseAsync();
  236. }
  237. }
  238. private async Task<(StunMessage5389?, IPEndPoint?, IPAddress?)> TestAsync(StunMessage5389 sendMessage, IPEndPoint remote, IPEndPoint receive, CancellationToken cancellationToken)
  239. {
  240. try
  241. {
  242. using var memoryOwner = MemoryPool<byte>.Shared.Rent(0x10000);
  243. var buffer = memoryOwner.Memory;
  244. var length = sendMessage.WriteTo(buffer.Span);
  245. await _proxy.SendToAsync(buffer[..length], SocketFlags.None, remote, cancellationToken);
  246. using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
  247. cts.CancelAfter(ReceiveTimeout);
  248. var r = await _proxy.ReceiveMessageFromAsync(buffer, SocketFlags.None, receive, cts.Token);
  249. var message = new StunMessage5389();
  250. if (message.TryParse(buffer.Span[..r.ReceivedBytes]) && message.IsSameTransaction(sendMessage))
  251. {
  252. return (message, (IPEndPoint)r.RemoteEndPoint, r.PacketInformation.Address);
  253. }
  254. }
  255. catch (Exception ex)
  256. {
  257. Debug.WriteLine(ex);
  258. }
  259. return (null, null, null);
  260. }
  261. public void Dispose()
  262. {
  263. _proxy.Dispose();
  264. }
  265. }
  266. }