AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-08 23:08:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: few edits to the structure

Browse Source
This commit is contained in:
David Dias
2018-10-12 11:52:39 +01:00
committed by GitHub
parent 59e079355c
commit 2f3e55d391
1 changed files with 26 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
discovery/mdns.md
View File

@@ -1,33 +1,28 @@
# Multicast DNS
Author: Richard Schneider (makaretu@gmail.com)
Author: Richard Schneider (makaretu@gmail.com)
## Overview
The goal is to allow peers to discover each other when on the same local network with zero configuration.
MDNS uses a multicast system of DNS records; this allows all peers on the local network to see all query responses.
The goal is to allow peers to discover each other when on the same local network with zero configuration. MDNS uses a multicast system of DNS records; this allows all peers on the local network to see all query responses.
Conceptually, it is very simple. When a peer starts (or detects a network change), it sends a query for all peers.
As responses come in, the peer adds the other peers information into is local database of peers.
Conceptually, it is very simple. When a peer starts (or detects a network change), it sends a query for all peers. As responses come in, the peer adds the other peers information into is local database of peers.
## Definitions
`service-name` is the DNS-SD service name for all peers. It is defined as `_p2p._udp.local`.
- `service-name` is the DNS-SD service name for all peers. It is defined as `_p2p._udp.local`.
- `host-name` is the fully qualified name of the peer. It is derived from the peer's name and `p2p.local`.
- `peer-name` is the case-insenstive unique identifier of the peer and less than 64 characters.
`host-name` is the fully qualified name of the peer. It is derived from the peer's name and `p2p.local`.
`peer-name` is the case-insenstive unique identifier of the peer and less than 64 characters.
It is normally the base-32 encoding of peer's ID.
If the encoding of the peer's ID exceeds 63 characters, then the [Split at 63rd character](https://github.com/ipfs/in-web-browsers/issues/89#issue-341357014)
workaround can be used.
If the encoding of the peer's ID exceeds 63 characters, then the [Split at 63rd character](https://github.com/ipfs/in-web-browsers/issues/89#issue-341357014) workaround can be used.
## Peer Discovery
### Request
To find all peers, a DNS message is sent with the question `_p2p._udp.local PTR`.
Peers will then start responding with their details.
To find all peers, a DNS message is sent with the question `_p2p._udp.local PTR`. Peers will then start responding with their details.
Note that a peer must respond to it's own query. This allows other peers to passively discover it.
@@ -36,21 +31,21 @@ Note that a peer must respond to it's own query. This allows other peers to pas
On receipt of a `find all peers` query, a peer sends a DNS response message (QR = 1) that contains
the **answer**
<service-name> PTR <peer-name>.<service-name>
```
<service-name> PTR <peer-name>.<service-name>
```
The **additional records** of the response contain the peer's discovery details
<peer-name>.<service-name> TXT "dnsaddr=..."
The TXT record contains the multiaddresses that the peer is listening on. Each multiaddress
is a TXT attribute with the form `dnsaddr=.../p2p/QmId`. Multiple `dnsaddr` attributes
and/or TXT records are allowed.
```
<peer-name>.<service-name> TXT "dnsaddr=..."
```
The TXT record contains the multiaddresses that the peer is listening on. Each multiaddress is a TXT attribute with the form `dnsaddr=.../p2p/QmId`. Multiple `dnsaddr` attributes and/or TXT records are allowed.
## DNS Service Discovery
DNS-SD support is not needed for peers to discover each other. However, it is
extremely usefull for network administrators to discover what is running on the
network.
DNS-SD support is not needed for peers to discover each other. However, it is extremely usefull for network administrators to discover what is running on the network.
### Meta Query
@@ -58,20 +53,23 @@ This allows discovery of all services. The question is `_services._dns-sd._udp.
A peer responds with the answer
```
_services._dns-sd._udp.local PTR <service-name>
```
### Find All Response
On receipt of a `find all peers` query, the following **additional records** should be included
```
<peer-name>.<service-name> SRV ... <host-name>
<host-name> A <ipv4 address>
<host-name> AAAA <ipv6 address>
```
### Gotchas
Many existing tools ignore the Additional Records and always send individual queries for the
peer's discovery details. To accomodate this, a peer should respond to the following queries:
Many existing tools ignore the Additional Records and always send individual queries for the peer's discovery details. To accomodate this, a peer should respond to the following queries:
- `<peer-name>.<service-name> SRV`
- `<peer-name>.<service-name> TXT`
@@ -80,8 +78,7 @@ peer's discovery details. To accomodate this, a peer should respond to the follo
## Issues
- MDNS requires link local addresses. Loopback and "nat busting" addresses should not sent and must
be ignored on receipt?
MDNS requires link local addresses. Loopback and "nat busting" addresses should not sent and must be ignored on receipt?
## References
@@ -96,7 +93,6 @@ Asumming that `peer-id` is `QmQusTXc1Z9C1mzxsqC9ZTFXCgSkpBRGgW4Jk2QYHxKE22`. Th
To make the examples more readable `id` and `name` are used.
### Meta Query
Find all services on the local network.