diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-17 20:20:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-17 20:20:17 -0700 |
| commit | 109a559590abfe3017dd317c3068e2457188541c (patch) | |
| tree | 103c9eba61c3d82956b677c78cc83ae040968c8f /docs | |
| parent | 70d478f5d185e147ca8d3dcba4cbd8bb6da3719a (diff) | |
| download | nng-109a559590abfe3017dd317c3068e2457188541c.tar.gz nng-109a559590abfe3017dd317c3068e2457188541c.tar.bz2 nng-109a559590abfe3017dd317c3068e2457188541c.zip | |
fixes #452 Want tcp6:// and tcp4:// to constrain IP family
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_tcp.7.adoc | 14 | ||||
| -rw-r--r-- | docs/man/nng_tls.7.adoc | 16 |
2 files changed, 29 insertions, 1 deletions
diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc index aa90364e..7b9b6823 100644 --- a/docs/man/nng_tcp.7.adoc +++ b/docs/man/nng_tcp.7.adoc @@ -45,6 +45,20 @@ TCP port number.(((port number, TCP))) For example, to contact port 80 on the localhost either of the following URIs could be used: `tcp://127.0.0.1:80` or `tcp://localhost:80`. +A URI may be restricted to IPv6 using the scheme `tcp6://`, and may +be restricted to IPv4 using the scheme `tcp4://`. + +NOTE: Specifying `tcp6://` may not prevent IPv4 hosts from being used with +IPv4-in-IPv6 addresses, particularly when using a wildcard hostname with +listeners. +The details of varies across operating systems. + +NOTE: Both `tcp6://` and `tcp4://` are _nng_ extensions, and will not +be understood by other implementations such as _libnanomsg_. + +TIP: We recommend using either numeric IP addresses, or names that are +specific to either IPv4 or IPv6 to prevent confusion and surprises. + When specifying IPv6 addresses, the address must be enclosed in square brackets (`[]`) to avoid confusion with the final colon separating the port. diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index 249159b7..e2465377 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -26,7 +26,7 @@ int nng_tls_register(void); (((TLS)))(((Transport Layer Security)))(((transport, _tls_))) The ((_tls_ transport)) provides communication support between -_nng_ sockets across a TCP/IP network using +_nng_ sockets across a TCP/IP network using https://tools.ietf.org/html/rfc5246[TLS v1.2] on top of https://tools.ietf.org/html/rfc793[TCP]. Both IPv4 and IPv6 are supported when the underlying platform also supports it. @@ -67,6 +67,20 @@ For example, to contact port 4433 on the localhost either of the following URIs could be used: `tls+tcp://127.0.0.1:4433` or `tls+tcp://localhost:4433`. +A URI may be restricted to IPv6 using the scheme `tls+tcp6://`, and may +be restricted to IPv4 using the scheme `tls+tcp4://`. + +NOTE: Specifying `tls+tcp6://` may not prevent IPv4 hosts from being used with +IPv4-in-IPv6 addresses, particularly when using a wildcard hostname with +listeners. +The details of varies across operating systems. + +NOTE: Both `tls+tcp6://` and `tls+tcp4://` are _nng_ extensions, and will not +be understood by other implementations such as _mangos_. + +TIP: We recommend using either numeric IP addresses, or names that are +specific to either IPv4 or IPv6 to prevent confusion and surprises. + When specifying IPv6 addresses, the address must be enclosed in square brackets (`[]`) to avoid confusion with the final colon separating the port. |
