Update README in internal/ipaddr to match OpenTF

This commit is contained in:
RLRabinowitz 2023-08-23 10:44:43 +03:00
parent 36b43c7c28
commit 7cefa0df5b

View File

@ -5,7 +5,7 @@ as of Go 1.16, used under the Go project license which we've included here
in [`LICENSE`](LICENSE) and [`PATENTS`](PATENTS), which are also copied from
the Go project.
Terraform has its own fork of these functions because Go 1.17 included a
OpenTF has its own fork of these functions because Go 1.17 included a
breaking change to reject IPv4 address octets written with leading zeros.
The Go project rationale for that change was that Go historically interpreted
@ -19,14 +19,6 @@ implementations may cause naive validation or policy checks to produce
incorrect results, and thus it's a potential security concern. For more
information, see [Go issue #30999](https://golang.org/issue/30999).
After careful consideration, the Terraform team has concluded that Terraform's
use of these functions as part of the implementation of the `cidrhost`,
`cidrsubnet`, `cidrsubnets`, and `cidrnetmask` functions has a more limited
impact than the general availability of these functions in the Go standard
library, and so we can't justify a similar exception to our Terraform 1.0
compatibility promises as the Go team made to their Go 1.0 compatibility
promises.
If you're considering using this package for new functionality _other than_ the
built-in functions mentioned above, please do so only if consistency with the
behavior of those functions is important. Otherwise, new features are not