| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System.Diagnostics; |
| | | 5 | | using System.Numerics; |
| | | 6 | | |
| | | 7 | | namespace System.Net |
| | | 8 | | { |
| | | 9 | | internal static partial class IPv6AddressHelper |
| | | 10 | | { |
| | | 11 | | private const int Hex = 16; |
| | | 12 | | private const int NumberOfLabels = 8; |
| | | 13 | | |
| | | 14 | | // RFC 5952 Section 4.2.3 |
| | | 15 | | // Longest consecutive sequence of zero segments, minimum 2. |
| | | 16 | | // On equal, first sequence wins. <-1, -1> for no compression. |
| | | 17 | | internal static (int longestSequenceStart, int longestSequenceLength) FindCompressionRange(ReadOnlySpan<ushort> |
| | 470 | 18 | | { |
| | 1410 | 19 | | int longestSequenceLength = 0, longestSequenceStart = -1, currentSequenceLength = 0; |
| | | 20 | | |
| | 8256 | 21 | | for (int i = 0; i < numbers.Length; i++) |
| | 3658 | 22 | | { |
| | 3658 | 23 | | if (numbers[i] == 0) |
| | 2375 | 24 | | { |
| | 2375 | 25 | | currentSequenceLength++; |
| | 2375 | 26 | | if (currentSequenceLength > longestSequenceLength) |
| | 2228 | 27 | | { |
| | 2228 | 28 | | longestSequenceLength = currentSequenceLength; |
| | 2228 | 29 | | longestSequenceStart = i - currentSequenceLength + 1; |
| | 2228 | 30 | | } |
| | 2375 | 31 | | } |
| | | 32 | | else |
| | 1283 | 33 | | { |
| | 1283 | 34 | | currentSequenceLength = 0; |
| | 1283 | 35 | | } |
| | 3658 | 36 | | } |
| | | 37 | | |
| | 470 | 38 | | return longestSequenceLength > 1 ? |
| | 470 | 39 | | (longestSequenceStart, longestSequenceStart + longestSequenceLength) : |
| | 470 | 40 | | (-1, 0); |
| | 470 | 41 | | } |
| | | 42 | | |
| | | 43 | | // Returns true if the IPv6 address should be formatted with an embedded IPv4 address: |
| | | 44 | | // ::192.168.1.1 |
| | | 45 | | internal static bool ShouldHaveIpv4Embedded(ReadOnlySpan<ushort> numbers) |
| | 470 | 46 | | { |
| | | 47 | | // 0:0 : 0:0 : x:x : x.x.x.x |
| | 470 | 48 | | if (numbers[0] == 0 && numbers[1] == 0 && numbers[2] == 0 && numbers[3] == 0 && numbers[6] != 0) |
| | 73 | 49 | | { |
| | | 50 | | // RFC 5952 Section 5 - 0:0 : 0:0 : 0:[0 | FFFF] : x.x.x.x |
| | 73 | 51 | | if (numbers[4] == 0 && (numbers[5] == 0 || numbers[5] == 0xFFFF)) |
| | 51 | 52 | | { |
| | 51 | 53 | | return true; |
| | | 54 | | } |
| | | 55 | | // SIIT - 0:0 : 0:0 : FFFF:0 : x.x.x.x |
| | 22 | 56 | | else if (numbers[4] == 0xFFFF && numbers[5] == 0) |
| | 0 | 57 | | { |
| | 0 | 58 | | return true; |
| | | 59 | | } |
| | 22 | 60 | | } |
| | | 61 | | |
| | | 62 | | // ISATAP |
| | 419 | 63 | | return numbers[4] == 0 && numbers[5] == 0x5EFE; |
| | 470 | 64 | | } |
| | | 65 | | |
| | | 66 | | // |
| | | 67 | | // IsValidStrict |
| | | 68 | | // |
| | | 69 | | // Determine whether a name is a valid IPv6 address. Rules are: |
| | | 70 | | // |
| | | 71 | | // * 8 groups of 16-bit hex numbers, separated by ':' |
| | | 72 | | // * a *single* run of zeros can be compressed using the symbol '::' |
| | | 73 | | // * an optional string of a ScopeID delimited by '%' |
| | | 74 | | // * the last 32 bits in an address can be represented as an IPv4 address |
| | | 75 | | // |
| | | 76 | | // Difference between IsValid() and IsValidStrict() is that IsValid() expects part of the string to |
| | | 77 | | // be ipv6 address where as IsValidStrict() expects strict ipv6 address. |
| | | 78 | | // |
| | | 79 | | // Inputs: |
| | | 80 | | // <argument> name |
| | | 81 | | // IPv6 address in string format |
| | | 82 | | // |
| | | 83 | | // Outputs: |
| | | 84 | | // Nothing |
| | | 85 | | // |
| | | 86 | | // Assumes: |
| | | 87 | | // the correct name is terminated by ']' character |
| | | 88 | | // |
| | | 89 | | // Returns: |
| | | 90 | | // true if <name> is IPv6 address, else false |
| | | 91 | | // |
| | | 92 | | // Throws: |
| | | 93 | | // Nothing |
| | | 94 | | // |
| | | 95 | | |
| | | 96 | | // Remarks: MUST NOT be used unless all input indexes are verified and trusted. |
| | | 97 | | // start must be next to '[' position, or error is reported |
| | | 98 | | internal static bool IsValidStrict<TChar>(ReadOnlySpan<TChar> name) |
| | | 99 | | where TChar : unmanaged, IBinaryInteger<TChar> |
| | 3456 | 100 | | { |
| | 3456 | 101 | | Debug.Assert(typeof(TChar) == typeof(char) || typeof(TChar) == typeof(byte)); |
| | | 102 | | |
| | | 103 | | // Number of components in this IPv6 address |
| | 3456 | 104 | | int sequenceCount = 0; |
| | | 105 | | // Length of the component currently being constructed |
| | 3456 | 106 | | int sequenceLength = 0; |
| | 3456 | 107 | | bool haveCompressor = false; |
| | 3456 | 108 | | bool haveIPv4Address = false; |
| | 3456 | 109 | | bool expectingNumber = true; |
| | | 110 | | // Start position of the previous component |
| | 3456 | 111 | | int lastSequence = 1; |
| | 3456 | 112 | | int start = 0; |
| | 3456 | 113 | | int end = name.Length; |
| | | 114 | | |
| | 3456 | 115 | | bool needsClosingBracket = false; |
| | | 116 | | |
| | | 117 | | // An IPv6 address may begin with a start character ('['). If it does, it must end with an end |
| | | 118 | | // character (']'). |
| | 3456 | 119 | | if (start < end && name[start] == TChar.CreateTruncating('[')) |
| | 506 | 120 | | { |
| | 506 | 121 | | start++; |
| | 506 | 122 | | needsClosingBracket = true; |
| | | 123 | | |
| | | 124 | | // IsValidStrict() is only called if there is a ':' in the name string, i.e. |
| | | 125 | | // it is a possible IPv6 address. So, if the string starts with a '[' and |
| | | 126 | | // the pointer is advanced here there are still more characters to parse. |
| | 506 | 127 | | Debug.Assert(start < end); |
| | 506 | 128 | | } |
| | | 129 | | |
| | | 130 | | // Starting with a colon character is only valid if another colon follows. |
| | 3456 | 131 | | if (name[start] == TChar.CreateTruncating(':') && (start + 1 >= end || name[start + 1] != TChar.CreateTrunca |
| | 20 | 132 | | { |
| | 20 | 133 | | return false; |
| | | 134 | | } |
| | | 135 | | |
| | | 136 | | int i; |
| | 58116 | 137 | | for (i = start; i < end; ++i) |
| | 26550 | 138 | | { |
| | 26550 | 139 | | int currentCh = IPv4AddressHelper.ToUShort(name[i]); |
| | | 140 | | |
| | 26550 | 141 | | if (HexConverter.IsHexChar(currentCh)) |
| | 15183 | 142 | | { |
| | 15183 | 143 | | ++sequenceLength; |
| | 15183 | 144 | | expectingNumber = false; |
| | 15183 | 145 | | } |
| | | 146 | | else |
| | 11367 | 147 | | { |
| | 11367 | 148 | | if (sequenceLength > 4) |
| | 10 | 149 | | { |
| | 10 | 150 | | return false; |
| | | 151 | | } |
| | 11357 | 152 | | if (sequenceLength != 0) |
| | 7099 | 153 | | { |
| | 7099 | 154 | | ++sequenceCount; |
| | 7099 | 155 | | lastSequence = i - sequenceLength; |
| | 7099 | 156 | | sequenceLength = 0; |
| | 7099 | 157 | | } |
| | | 158 | | |
| | 11357 | 159 | | switch (currentCh) |
| | | 160 | | { |
| | | 161 | | case '%': |
| | | 162 | | // An IPv6 address is separated from its scope by a '%' character. The scope |
| | | 163 | | // is terminated by the natural end of the address, the address end character (']') |
| | | 164 | | // or the start of the prefix ('/'). |
| | 11974 | 165 | | while (i + 1 < end) |
| | 11602 | 166 | | { |
| | 11602 | 167 | | i++; |
| | 11602 | 168 | | if (name[i] == TChar.CreateTruncating(']')) |
| | 144 | 169 | | { |
| | 144 | 170 | | goto case ']'; |
| | | 171 | | } |
| | 11458 | 172 | | else if (name[i] == TChar.CreateTruncating('/')) |
| | 94 | 173 | | { |
| | 94 | 174 | | goto case '/'; |
| | | 175 | | } |
| | 11364 | 176 | | } |
| | 372 | 177 | | break; |
| | | 178 | | |
| | | 179 | | case ']': |
| | 518 | 180 | | if (!needsClosingBracket) |
| | 20 | 181 | | { |
| | 20 | 182 | | return false; |
| | | 183 | | } |
| | 498 | 184 | | needsClosingBracket = false; |
| | | 185 | | |
| | | 186 | | // If there's more after the closing bracket, it must be a port. |
| | | 187 | | // We don't use the port, but we still validate it. |
| | 498 | 188 | | if (i + 1 < end && name[i + 1] != TChar.CreateTruncating(':')) |
| | 20 | 189 | | { |
| | 20 | 190 | | return false; |
| | | 191 | | } |
| | | 192 | | |
| | | 193 | | // If there is a port, it must either be a hexadecimal or decimal number. |
| | | 194 | | // If the next two characters are '0x' then it's a hexadecimal number. Skip the prefix. |
| | 478 | 195 | | if (i + 3 < end && name[i + 2] == TChar.CreateTruncating('0') && name[i + 3] == TChar.Create |
| | 162 | 196 | | { |
| | 162 | 197 | | i += 4; |
| | 5534 | 198 | | for (; i < end; i++) |
| | 2724 | 199 | | { |
| | 2724 | 200 | | int ch = IPv4AddressHelper.ToUShort(name[i]); |
| | | 201 | | |
| | 2724 | 202 | | if (!HexConverter.IsHexChar(ch)) |
| | 38 | 203 | | { |
| | 38 | 204 | | return false; |
| | | 205 | | } |
| | 2686 | 206 | | } |
| | 124 | 207 | | } |
| | | 208 | | else |
| | 316 | 209 | | { |
| | 316 | 210 | | i += 2; |
| | 4424 | 211 | | for (; i < end; i++) |
| | 2170 | 212 | | { |
| | 2170 | 213 | | if (!char.IsAsciiDigit((char)IPv4AddressHelper.ToUShort(name[i]))) |
| | 116 | 214 | | { |
| | 116 | 215 | | return false; |
| | | 216 | | } |
| | 2054 | 217 | | } |
| | 200 | 218 | | } |
| | 324 | 219 | | continue; |
| | | 220 | | |
| | | 221 | | case ':': |
| | | 222 | | // If the next character after a colon is another colon, the address contains a compressor ( |
| | 9534 | 223 | | if ((i > 0) && (name[i - 1] == TChar.CreateTruncating(':'))) |
| | 2158 | 224 | | { |
| | 2158 | 225 | | if (haveCompressor) |
| | 2 | 226 | | { |
| | | 227 | | // can only have one per IPv6 address |
| | 2 | 228 | | return false; |
| | | 229 | | } |
| | 2156 | 230 | | haveCompressor = true; |
| | 2156 | 231 | | expectingNumber = false; |
| | 2156 | 232 | | } |
| | | 233 | | else |
| | 7376 | 234 | | { |
| | 7376 | 235 | | expectingNumber = true; |
| | 7376 | 236 | | } |
| | 9532 | 237 | | break; |
| | | 238 | | |
| | | 239 | | case '/': |
| | | 240 | | // A prefix in an IPv6 address is invalid. |
| | 100 | 241 | | return false; |
| | | 242 | | |
| | | 243 | | case '.': |
| | 741 | 244 | | if (haveIPv4Address) |
| | 0 | 245 | | { |
| | 0 | 246 | | return false; |
| | | 247 | | } |
| | | 248 | | |
| | 741 | 249 | | if (!IPv4AddressHelper.IsValid(name.Slice(lastSequence, end - lastSequence), out int seqEnd, |
| | 530 | 250 | | { |
| | 530 | 251 | | return false; |
| | | 252 | | } |
| | 211 | 253 | | i = lastSequence + seqEnd; |
| | | 254 | | |
| | | 255 | | // An IPv4 address takes 2 slots in an IPv6 address. One was just counted meeting the '.' |
| | 211 | 256 | | ++sequenceCount; |
| | 211 | 257 | | lastSequence = i - sequenceLength; |
| | 211 | 258 | | haveIPv4Address = true; |
| | 211 | 259 | | --i; // it will be incremented back on the next loop |
| | 211 | 260 | | break; |
| | | 261 | | |
| | | 262 | | default: |
| | 92 | 263 | | return false; |
| | | 264 | | } |
| | 10115 | 265 | | sequenceLength = 0; |
| | 10115 | 266 | | } |
| | 25298 | 267 | | } |
| | | 268 | | |
| | 2508 | 269 | | if (sequenceLength != 0) |
| | 1313 | 270 | | { |
| | 1313 | 271 | | if (sequenceLength > 4) |
| | 12 | 272 | | { |
| | 12 | 273 | | return false; |
| | | 274 | | } |
| | | 275 | | |
| | 1301 | 276 | | ++sequenceCount; |
| | 1301 | 277 | | } |
| | | 278 | | |
| | | 279 | | // These sequence counts are -1 because it is implied in end-of-sequence. |
| | | 280 | | |
| | | 281 | | const int ExpectedSequenceCount = 8; |
| | 2496 | 282 | | return |
| | 2496 | 283 | | !expectingNumber && |
| | 2496 | 284 | | (haveCompressor ? (sequenceCount < ExpectedSequenceCount) : (sequenceCount == ExpectedSequenceCount)) && |
| | 2496 | 285 | | !needsClosingBracket; |
| | 3456 | 286 | | } |
| | | 287 | | |
| | | 288 | | // |
| | | 289 | | // Parse |
| | | 290 | | // |
| | | 291 | | // Convert this IPv6 address into a sequence of 8 16-bit numbers |
| | | 292 | | // |
| | | 293 | | // Inputs: |
| | | 294 | | // <member> Name |
| | | 295 | | // The validated IPv6 address |
| | | 296 | | // |
| | | 297 | | // Outputs: |
| | | 298 | | // <member> numbers |
| | | 299 | | // Array filled in with the numbers in the IPv6 groups |
| | | 300 | | // |
| | | 301 | | // <member> scopeId |
| | | 302 | | // Set to the text after the scope separator (%) if found |
| | | 303 | | // |
| | | 304 | | // Assumes: |
| | | 305 | | // <Name> has been validated and contains only hex digits in groups of |
| | | 306 | | // 16-bit numbers, the characters ':', '/' and '%', and a possible IPv4 |
| | | 307 | | // address |
| | | 308 | | // |
| | | 309 | | // Throws: |
| | | 310 | | // Nothing |
| | | 311 | | // |
| | | 312 | | |
| | | 313 | | internal static void Parse<TChar>(ReadOnlySpan<TChar> address, scoped Span<ushort> numbers, out ReadOnlySpan<TCh |
| | | 314 | | where TChar : unmanaged, IBinaryInteger<TChar> |
| | 940 | 315 | | { |
| | 940 | 316 | | Debug.Assert(typeof(TChar) == typeof(char) || typeof(TChar) == typeof(byte)); |
| | | 317 | | |
| | 940 | 318 | | int number = 0; |
| | | 319 | | int currentCh; |
| | 940 | 320 | | int index = 0; |
| | 940 | 321 | | int compressorIndex = -1; |
| | 940 | 322 | | bool numberIsValid = true; |
| | | 323 | | |
| | 940 | 324 | | scopeId = ReadOnlySpan<TChar>.Empty; |
| | | 325 | | |
| | | 326 | | // Skip the start '[' character, if present. Stop parsing at the end IPv6 address terminator (']'). |
| | 10674 | 327 | | for (int i = (address[0] == TChar.CreateTruncating('[') ? 1 : 0); i < address.Length && address[i] != TChar. |
| | 8794 | 328 | | { |
| | 8794 | 329 | | currentCh = IPv4AddressHelper.ToUShort(address[i]); |
| | | 330 | | |
| | 8794 | 331 | | switch (currentCh) |
| | | 332 | | { |
| | | 333 | | case '%': |
| | 232 | 334 | | if (numberIsValid) |
| | 184 | 335 | | { |
| | 184 | 336 | | numbers[index++] = (ushort)number; |
| | 184 | 337 | | numberIsValid = false; |
| | 184 | 338 | | } |
| | | 339 | | |
| | | 340 | | // The scope follows a '%' and terminates at the natural end of the address, the address termina |
| | 232 | 341 | | int scopeStart = i; |
| | | 342 | | |
| | 11644 | 343 | | for (++i; i < address.Length && address[i] != TChar.CreateTruncating(']') && address[i] != TChar |
| | 5590 | 344 | | { |
| | 5590 | 345 | | } |
| | 232 | 346 | | scopeId = address.Slice(scopeStart, i - scopeStart); |
| | | 347 | | |
| | | 348 | | // Ignore the prefix (if any.) |
| | 232 | 349 | | for (; i < address.Length && address[i] != TChar.CreateTruncating(']'); ++i) |
| | 0 | 350 | | { |
| | 0 | 351 | | } |
| | 232 | 352 | | break; |
| | | 353 | | |
| | | 354 | | case ':': |
| | 2930 | 355 | | numbers[index++] = (ushort)number; |
| | 2930 | 356 | | number = 0; |
| | | 357 | | // Two sequential colons form a compressor ('::'). |
| | 2930 | 358 | | ++i; |
| | 2930 | 359 | | if (address[i] == TChar.CreateTruncating(':')) |
| | 858 | 360 | | { |
| | 858 | 361 | | compressorIndex = index; |
| | 858 | 362 | | ++i; |
| | 858 | 363 | | } |
| | 2072 | 364 | | else if ((compressorIndex < 0) && (index < 6)) |
| | 1232 | 365 | | { |
| | | 366 | | // No point checking for IPv4 address if we don't |
| | | 367 | | // have a compressor or we haven't seen 6 16-bit |
| | | 368 | | // numbers yet. |
| | 1232 | 369 | | break; |
| | | 370 | | } |
| | | 371 | | |
| | | 372 | | // Check to see if the upcoming number is really an IPv4 |
| | | 373 | | // address. If it is, convert it to 2 ushort numbers |
| | 5704 | 374 | | for (int j = i; j < address.Length && |
| | 4006 | 375 | | (address[j] != TChar.CreateTruncating(']')) && |
| | 4006 | 376 | | (address[j] != TChar.CreateTruncating(':')) && |
| | 4006 | 377 | | (address[j] != TChar.CreateTruncating('%')) && |
| | 4006 | 378 | | (address[j] != TChar.CreateTruncating('/')) && |
| | 6314 | 379 | | (j < i + 4); ++j) |
| | 2386 | 380 | | { |
| | | 381 | | |
| | 2386 | 382 | | if (address[j] == TChar.CreateTruncating('.')) |
| | 78 | 383 | | { |
| | | 384 | | // We have an IPv4 address. Find the end of it: |
| | | 385 | | // we know that since we have a valid IPv6 |
| | | 386 | | // address, the only things that will terminate |
| | | 387 | | // the IPv4 address are the prefix delimiter '/' |
| | | 388 | | // or the end-of-string (which we conveniently |
| | | 389 | | // delimited with ']'). |
| | 688 | 390 | | while (j < address.Length && (address[j] != TChar.CreateTruncating(']')) && (address[j] |
| | 610 | 391 | | { |
| | 610 | 392 | | ++j; |
| | 610 | 393 | | } |
| | 78 | 394 | | int ipv4Address = IPv4AddressHelper.ParseHostNumber(address, i, j); |
| | | 395 | | |
| | 78 | 396 | | numbers[index++] = (ushort)(ipv4Address >> 16); |
| | 78 | 397 | | numbers[index++] = (ushort)(ipv4Address & 0xFFFF); |
| | 78 | 398 | | i = j; |
| | | 399 | | |
| | | 400 | | // Set this to avoid adding another number to |
| | | 401 | | // the array if there's a prefix |
| | 78 | 402 | | number = 0; |
| | 78 | 403 | | numberIsValid = false; |
| | 78 | 404 | | break; |
| | | 405 | | } |
| | 2308 | 406 | | } |
| | 1698 | 407 | | break; |
| | | 408 | | |
| | | 409 | | case '/': |
| | 0 | 410 | | if (numberIsValid) |
| | 0 | 411 | | { |
| | 0 | 412 | | numbers[index++] = (ushort)number; |
| | 0 | 413 | | numberIsValid = false; |
| | 0 | 414 | | } |
| | | 415 | | |
| | 0 | 416 | | for (++i; i < address.Length && address[i] != TChar.CreateTruncating(']'); i++) |
| | 0 | 417 | | { |
| | 0 | 418 | | } |
| | | 419 | | |
| | 0 | 420 | | break; |
| | | 421 | | |
| | | 422 | | default: |
| | 5632 | 423 | | int characterValue = HexConverter.FromChar(currentCh); |
| | | 424 | | |
| | 5632 | 425 | | number = number * IPv6AddressHelper.Hex + characterValue; |
| | 5632 | 426 | | i++; |
| | 5632 | 427 | | break; |
| | | 428 | | } |
| | 8794 | 429 | | } |
| | | 430 | | |
| | | 431 | | // Add number to the array if it's not the prefix length or part of |
| | | 432 | | // an IPv4 address that's already been handled |
| | 940 | 433 | | if (numberIsValid) |
| | 678 | 434 | | { |
| | 678 | 435 | | numbers[index++] = (ushort)number; |
| | 678 | 436 | | } |
| | | 437 | | |
| | | 438 | | // If we had a compressor sequence ("::") then we need to expand the |
| | | 439 | | // numbers array. |
| | 940 | 440 | | if (compressorIndex > 0) |
| | 858 | 441 | | { |
| | 858 | 442 | | int toIndex = NumberOfLabels - 1; |
| | 858 | 443 | | int fromIndex = index - 1; |
| | | 444 | | |
| | | 445 | | // If fromIndex and toIndex are the same, it means that "zero bits" are already in the correct place. |
| | | 446 | | // This happens for leading and trailing compression. |
| | 858 | 447 | | if (fromIndex != toIndex) |
| | 822 | 448 | | { |
| | 4504 | 449 | | for (int i = index - compressorIndex; i > 0; --i) |
| | 1430 | 450 | | { |
| | 1430 | 451 | | numbers[toIndex--] = numbers[fromIndex]; |
| | 1430 | 452 | | numbers[fromIndex--] = 0; |
| | 1430 | 453 | | } |
| | 822 | 454 | | } |
| | 858 | 455 | | } |
| | 940 | 456 | | } |
| | | 457 | | } |
| | | 458 | | } |