1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
#[macro_export]
macro_rules! read_slice {
($data:expr, $n:expr, $prefix:expr) => {
if $data.len() < $n {
let msg = format!("{} insufficient bytes {}", $prefix, $n);
err_at!(DecodeError, msg: msg)
} else {
Ok((&$data[..$n], &$data[$n..]))
}
};
}
pub(crate) mod dccp;
pub(crate) mod dns;
pub(crate) mod dns4;
pub(crate) mod dns6;
pub(crate) mod dnsaddr;
pub(crate) mod garlic32;
pub(crate) mod garlic64;
pub(crate) mod http;
pub(crate) mod https;
pub(crate) mod ip4;
pub(crate) mod ip6;
pub(crate) mod ip6zone;
pub(crate) mod onion;
pub(crate) mod onion3;
pub(crate) mod p2p;
pub(crate) mod p2p_circuit;
pub(crate) mod p2p_webrtc_direct;
pub(crate) mod quic;
pub(crate) mod sctp;
pub(crate) mod tcp;
pub(crate) mod udp;
pub(crate) mod udt;
pub(crate) mod unix;
pub(crate) mod utp;
pub(crate) mod ws;
pub(crate) mod wss;
use crate::{
multiaddr::{
dccp::Dccp, dns::Dns, dns4::Dns4, dns6::Dns6, dnsaddr::Dnsaddr, garlic32::Garlic32,
garlic64::Garlic64, http::Http, https::Https, ip4::Ip4, ip6::Ip6, ip6zone::Ip6zone,
onion::Onion, onion3::Onion3, p2p::P2p, p2p_circuit::P2pCircuit,
p2p_webrtc_direct::P2pWebRtcDirect, quic::Quic, sctp::Sctp, tcp::Tcp, udp::Udp, udt::Udt,
unix::Unix, utp::Utp, ws::Ws, wss::Wss,
},
multicodec::{self, Multicodec},
Error, Result,
};
macro_rules! impl_multiaddr {
($(
#[$doc:meta]
($var:ident, $type:ident, $name:expr, $code:path),
)*) => (
/// Type implement a multiaddress.
///
/// As an enumerated type it can hold multiaddress,
///
/// * Address encoded in binary format.
/// * Address encoded in text format.
/// * Or parsed from binary/text format and held as Ip4, Tcp, Udp,
/// Quic etc..
#[derive(Clone, Eq, PartialEq, Debug)]
pub enum Multiaddr {
Text(String), // unparsed multi-addr in text format.
Binary(Vec<u8>), // unparsed multi-addr in binary format.
$(
#[$doc]
$var($type, Box<Self>),
)*
Ipfs(P2p, Box<Self>),
None,
}
impl Multiaddr {
/// Parse text formated multi-address. Refer to
/// [spec](https://multiformats.io/multiaddr/) for details.
pub fn from_text(text: &str) -> Result<Multiaddr> {
let parts: Vec<&str> = text.split('/').collect();
if parts.len() == 0 {
err_at!(BadAddr, msg: format!("empty multiaddr {}", text))
} else if parts[0].is_empty() {
err_at!(BadAddr, msg: format!("multiaddr must start with '/'"))
} else if parts[1..].len() == 0 {
err_at!(BadAddr, msg: format!("empty multiaddr {}", text))
} else {
match Self::parse_text_parts(&parts[1..])? {
(ma, []) => Ok(ma),
(_, _) => {
let msg = format!("invalid multiaddr {:?}", text);
err_at!(BadAddr, msg: msg)
}
}
}
}
pub(crate) fn parse_text_parts<'a, 'b>(parts: &'a [&'b str]) -> Result<(Multiaddr, &'a [&'b str])> {
let (maddr, tail) = match parts {
[] => (Multiaddr::None, parts),
$(
[$name, ..] => {
let (val, tail) = $type::from_text(&parts[1..])?;
let (ma, tail) = Self::parse_text_parts(tail)?;
(Multiaddr::$var(val, Box::new(ma)), tail)
}
)*
["ip", ..] => {
// first try parsing it for ip4
match Ip4::from_text(&parts[1..]) {
Ok((val, tail)) => {
let (ma, tail) = Self::parse_text_parts(tail)?;
(Multiaddr::Ip4(val, Box::new(ma)), tail)
}
Err(_) => {
// then try parsing it for ip6
let (val, tail) = Ip6::from_text(&parts[1..])?;
let (ma, tail) = Self::parse_text_parts(tail)?;
(Multiaddr::Ip6(val, Box::new(ma)), tail)
}
}
}
["ipfs", ..] => {
let (val, tail) = P2p::from_text(&parts[1..])?;
let (ma, tail) = Self::parse_text_parts(tail)?;
(Multiaddr::P2p(val, Box::new(ma)), tail)
}
parts => {
let msg = format!("invalid multiaddr {:?}", parts);
err_at!(BadAddr, msg: msg)?
}
};
Ok((maddr, tail))
}
/// Convert this multi-address into text format.
pub fn to_text(&self) -> Result<String> {
let text = match self {
Multiaddr::Text ( text ) => text.clone(),
Multiaddr::Binary(data) => {
let (maddr, _) = Self::decode(&data)?;
maddr.to_text()?
}
$(
Multiaddr::$var(val, tail) => {
val.to_text()? + &tail.to_text()?
}
)*
Multiaddr::Ipfs(val, tail) => {
val.to_text()? + &tail.to_text()?
}
Multiaddr::None => "".to_string(),
};
Ok(text)
}
/// Parse binary formated multi-address. Refer to
/// [spec](https://multiformats.io/multiaddr/) for details.
pub fn decode(data: &[u8]) -> Result<(Multiaddr, &[u8])> {
if data.len() == 0 {
return Ok((Multiaddr::None, data))
}
let (codec, data) = Multicodec::decode(data)?;
let (ma, data) = match codec.to_code() {
$(
$code => {
let (val, data) = $type::decode(data)?;
let (ma, data) = Self::decode(data)?;
(Multiaddr::$var(val, Box::new(ma)), data)
}
)*
code => {
let msg = format!("invalid code {}", code);
err_at!(DecodeError, msg: msg)?
}
};
Ok((ma, data))
}
/// Encode this multi-address into binary format.
pub fn encode(&self) -> Result<Vec<u8>> {
let data = match self {
Multiaddr::Text ( text ) => Self::from_text(text)?.encode()?,
Multiaddr::Binary ( data ) => data.clone(),
$(
Multiaddr::$var(val, tail) => {
let mut data = val.encode()?;
data.extend_from_slice(&tail.encode()?);
data
}
)*
Multiaddr::Ipfs(val, tail) => {
let mut data = val.encode()?;
data.extend_from_slice(&tail.encode()?);
data
}
Multiaddr::None => vec![],
};
Ok(data)
}
/// Return the multiaddress as multi-codec.
pub fn to_multicodec(&self) -> Option<Multicodec> {
match self {
Multiaddr::Text ( _ ) => None,
Multiaddr::Binary ( _ ) => None,
$(
Multiaddr::$var{ .. } => Some($code.into()),
)*
Multiaddr::Ipfs{ .. } => Some(multicodec::P2P.into()),
Multiaddr::None => None,
}
}
/// Return multiaddr as array of components.
pub fn split(self) -> Result<Vec<Self>> {
let mut ma = match self {
Multiaddr::Text ( text ) => Self::from_text(&text)?,
Multiaddr::Binary ( data ) => Self::decode(&data)?.0,
ma => ma
};
let mut components = vec![];
let nn = Box::new(Multiaddr::None);
loop {
ma = match ma {
$(
Multiaddr::$var(val, ma) => {
components.push(Multiaddr::$var(val, nn.clone()));
*ma
}
)*
Multiaddr::Ipfs(val, ma) => {
components.push(Multiaddr::Ipfs(val, nn.clone()));
*ma
}
Multiaddr::Text(_) => break,
Multiaddr::Binary(_) => break,
Multiaddr::None => break,
};
}
Ok(components)
}
/// Join the components into single multiaddr.
pub fn join(mut components: Vec<Multiaddr>) -> Result<Multiaddr> {
let mut ma = Box::new(Multiaddr::None);
components.reverse();
for comp in components.into_iter() {
ma = match comp {
$(
Multiaddr::$var(val, box Multiaddr::None) => {
Box::new(Multiaddr::$var(val, ma))
}
)*
Multiaddr::Ipfs(val, box Multiaddr::None) => {
Box::new(Multiaddr::Ipfs(val, ma))
}
_ => err_at!(Invalid, msg: format!("can't joint"))?
}
}
Ok(*ma)
}
}
);
}
impl Multiaddr {
/// IsThinWaist returns whether a Multiaddr starts with "Thin Waist"
/// Protocols. This means: /{IP4, IP6}[/{TCP, UDP}]
pub fn is_thin_wait(&self) -> bool {
use Multiaddr::*;
let ma = match self {
Ip4(_, box tail) => tail.clone(),
Ip6(_, box tail) => tail.clone(),
_ => return false,
};
match ma {
Tcp(_, _) => true,
Udp(_, _) => true,
Multiaddr::None => true,
_ => false,
}
}
pub fn parse(self) -> Result<Self> {
use Multiaddr::*;
let val = match self {
Text(text) => Multiaddr::from_text(&text)?,
Binary(data) => Multiaddr::decode(&data)?.0,
_ => self,
};
Ok(val)
}
}
impl_multiaddr![
/// Internet-protocol version 4
(Ip4, Ip4, "ip4", multicodec::IP4),
/// Internet-protocol version 6
(Ip6, Ip6, "ip6", multicodec::IP6),
/// Transport control protocol
(Tcp, Tcp, "tcp", multicodec::TCP),
/// Domain name service
(Dns, Dns, "dns", multicodec::DNS),
/// Domain name service, for IP4
(Dns4, Dns4, "dns4", multicodec::DNS4),
/// Domain name service, for IP6
(Dns6, Dns6, "dns6", multicodec::DNS6),
/// Domain name service, automatic
(Dnsaddr, Dnsaddr, "dnsaddr", multicodec::DNSADDR),
/// User datagram protocol
(Udp, Udp, "udp", multicodec::UDP),
/// Datagram congestion control protocol
(Dccp, Dccp, "dccp", multicodec::DCCP),
/// Ip-6-zone
(Ip6zone, Ip6zone, "ip6zone", multicodec::IP6ZONE),
/// Stream control transmission protocol
(Sctp, Sctp, "sctp", multicodec::SCTP),
/// Onion routing for Tor network.
(Onion, Onion, "onion", multicodec::ONION),
/// Onion routing for Tor network.
(Onion3, Onion3, "onion3", multicodec::ONION3),
/// Garlic routing for invisible internet protocol
(Garlic32, Garlic32, "garlic32", multicodec::GARLIC32),
/// Garlic routine for invisible internet protocol
(Garlic64, Garlic64, "garlic64", multicodec::GARLIC64),
/// Peer-2-peer addressing for ipfs and affiliated network
(P2p, P2p, "p2p", multicodec::P2P),
/// Unix socket addressing
(Unix, Unix, "unix", multicodec::UNIX),
/// Utp addressing
(Utp, Utp, "utp", multicodec::UTP),
/// Udt addressing
(Udt, Udt, "udt", multicodec::UDT),
/// Quic addressing
(Quic, Quic, "quic", multicodec::QUIC),
/// Addressing for HTTP protocol
(Http, Http, "http", multicodec::HTTP),
/// Https addressing
(Https, Https, "https", multicodec::HTTPS),
/// p2p-circuit addressing
(
P2pCircuit,
P2pCircuit,
"p2p-circuit",
multicodec::P2P_CIRCUIT
),
/// p2p-webrtc-direct addressing
(
P2pWebRtcDirect,
P2pWebRtcDirect,
"p2p-webrtc-direct",
multicodec::P2P_WEBRTC_DIRECT
),
/// ws addressing
(Ws, Ws, "ws", multicodec::WS),
/// wss addressing
(Wss, Wss, "wss", multicodec::WSS),
];