README
¶
go-net
Introduction
This library contains basic validators and helpers for handling IP addresses, IP networks, IP ranges (from - to IP adress), domain names, FQDN (fully qualified domain names), and URL (unified resource locators).
All methods that work with IP addresses are IPv4 and IPv6 compliant.
Please see the unit tests (xx_test.go) for examples on how to use this library.
Hints
We have received feedback from software developers who were confused about how this library handles specific cases. Examples include but are not limited to:
- URLs:
- We consider URLs that do not have a scheme as valid.
This is a clear violation of RFC #3986
that says The scheme and path components are required, (...).
We are doing this because of several of our own use cases where we had to process large lists of URLs that did
not contain a scheme in each end every case. We neither wanted to add a scheme like
http://by default nor simply reject entries. If you, however, need a URL that fully complies to RFC #3986 (e.g. because you want to use it with other libraries), please callNormaliseURLSchema().
- We consider URLs that do not have a scheme as valid.
This is a clear violation of RFC #3986
that says The scheme and path components are required, (...).
We are doing this because of several of our own use cases where we had to process large lists of URLs that did
not contain a scheme in each end every case. We neither wanted to add a scheme like
- Domains
- To get an idea, what a valid domain name looks like, we use the list of TLDs (top-level-domains) from PublicSuffixes.org.
- FQDNs
- www.site.tld is not a URL but a FQDN (fully qualified domain name), because it neither has a path component
nor a schema (
http://,https://, etc.). - www.site.tld/about is a valid URL.
- www.site.tld is not a URL but a FQDN (fully qualified domain name), because it neither has a path component
nor a schema (
- IP addresses and networks
- 10.0.0.1/32 although presented as a network address is in fact a single IPv4 address (10.0.0.1).
- 10.0.0.1/24 is not an IPv4 address, but a URL! This is because we do not need a schema (see URLs above), but when the netmask is /24 the last byte must be 0.
- 10.0.0.0/24 is a valid network address.
If you find any other behaviour that seems odd, please double check with the code of the unit tests. If something still does not make sense, let us know by starting a discussion or by opening an issue here.
Feedback
We would love to hear from you! Please contact us at [email protected] for feedback and general requests. Kindly raise an issue in Codeberg if you find a problem in the code.
Want to know what we do when we're not developing open-source software? Find out at www.threatint.eu ;-)
License
Release under the MIT License. (see LICENSE)
Documentation
¶
Overview ¶
Package net contains helper function for handling urls
Index ¶
- Variables
- func DomainFromFqdn(fqdn string) string
- func HostFromURL(u string) (string, error)
- func IntToIP(i string) net.IP
- func IsDomain(domain string) bool
- func IsFQDN(fqdn string) bool
- func IsIPAddr(ip string) bool
- func IsIPRange(r string) bool
- func IsIPv4(ip net.IP) bool
- func IsIPv6(ip net.IP) bool
- func IsNetwork(network string) bool
- func IsURL(u string) bool
- func NormaliseIPAddr(ip string) string
- func NormaliseURL(u string) (string, error)
- func NormaliseURLSchema(u string) (string, error)
- func ReverseIPAddr(ip string) (string, error)
- func ToPunycode(s string) (string, error)
- func ToUnicode(s string) (string, error)
- func URLToPunycode(u string) (string, error)
- func URLToUnicode(u string) (string, error)
Constants ¶
This section is empty.
Variables ¶
var PublicSuffix = []string{}/* 6919 elements not displayed */
Functions ¶
func DomainFromFqdn ¶
DomainFromFqdn returns domain name or empty string
func HostFromURL ¶
HostFromURL extraxts hostname from given URL
func IntToIP ¶
IntToIP (int) return net.IP from the integer representation of an ip address (use e.g. for IP2Location databases )
func IsDomain ¶
IsDomain (domainname string) returns true if domainname is a valid domain, otherwise false
func IsFQDN ¶
IsFQDN (fqdn) returns true if fqdn is a FQDN (Fully Qualified Domain Name) hostname + domainname + tld, otherwise false
func IsIPAddr ¶
IsIPAddr return true if string ip contains a valid representation of an IPv4 or IPv6 address
func IsIPRange ¶
IsIPRange (range) return true if string r contains a valid representation of an ip network (e.g. 192.168.10.1-192.168.10.199)
func IsIPv4 ¶
IsIPv4 (ipaddr) return true if string ip contains a valid representation of an IPv4 address
func IsIPv6 ¶
IsIPv6 (ipaddr) return true if string ip contains a valid representation of an IPv6 address
func IsNetwork ¶
IsNetwork (network) return true if string network contains a valid representation of an ip network
func NormaliseIPAddr ¶
NormaliseIPAddr return ip adresse without /32 (IPv4 or /128 (IPv6)
func NormaliseURL ¶
NormaliseURL returns a normalised url (e.g. without default ports like :80 for HTTP or :443 for HTTPS, duplicate slashes, etc.)
func NormaliseURLSchema ¶
NormaliseURLSchema returns normalised URL string that includes a schema.
func ReverseIPAddr ¶
ReverseIPAddr (ipaddr) reverses string ip (use e.g. for DNS blacklists)
func URLToPunycode ¶
URLToPunycode returns URL string in punycode
func URLToUnicode ¶
URLToUnicode returns normalised URL string.
Types ¶
This section is empty.
Source Files