Skip to content

Commit 9eb5a88

Browse files
aschmahmannaschmahmann
committed
feat: support decoding /p2p addresses that are encoded as CIDs
1 parent 38d498d commit 9eb5a88

File tree

4 files changed

+74
-4
lines changed

4 files changed

+74
-4
lines changed

‎go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ module github.com/multiformats/go-multiaddr
33
go 1.13
44

55
require (
6+
github.com/ipfs/go-cid v0.0.7
67
github.com/multiformats/go-multihash v0.0.14
78
github.com/multiformats/go-varint v0.0.6
89
)

‎go.sum

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1+
github.com/ipfs/go-cid v0.0.7 h1:ysQJVJA3fNDF1qigJbsSQOdjhVLsOEoPdh0+R97k3jY=
2+
github.com/ipfs/go-cid v0.0.7/go.mod h1:6Ux9z5e+HpkQdckYoX1PG/6xqKspzlEIR5SDmgqgC/I=
13
github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1 h1:lYpkrQH5ajf0OXOcUbGjvZxxijuBwbbmlSxLiuofa+g=
24
github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1/go.mod h1:pD8RvIylQ358TN4wwqatJ8rNavkEINozVn9DtGI3dfQ=
35
github.com/minio/sha256-simd v0.1.1-0.20190913151208-6de447530771 h1:MHkK1uRtFbVqvAgvWxafZe54+5uBxLluGylDiKgdhwo=
46
github.com/minio/sha256-simd v0.1.1-0.20190913151208-6de447530771/go.mod h1:B5e1o+1/KgNmWrSQK08Y6Z1Vb5pwIktudl0J58iy0KM=
7+
github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8=
58
github.com/mr-tron/base58 v1.1.3 h1:v+sk57XuaCKGXpWtVBX8YJzO7hMGx4Aajh4TQbdEFdc=
69
github.com/mr-tron/base58 v1.1.3/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
10+
github.com/multiformats/go-base32 v0.0.3 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI=
11+
github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA=
12+
github.com/multiformats/go-base36 v0.1.0 h1:JR6TyF7JjGd3m6FbLU2cOxhC0Li8z8dLNGQ89tUg4F4=
13+
github.com/multiformats/go-base36 v0.1.0/go.mod h1:kFGE83c6s80PklsHO9sRn2NCoffoRdUUOENyW/Vv6sM=
14+
github.com/multiformats/go-multibase v0.0.3 h1:l/B6bJDQjvQ5G52jw4QGSYeOTZoAwIO77RblWplfIqk=
15+
github.com/multiformats/go-multibase v0.0.3/go.mod h1:5+1R4eQrT3PkYZ24C3W2Ue2tPwIdYQD509ZjSb5y9Oc=
16+
github.com/multiformats/go-multihash v0.0.13/go.mod h1:VdAWLKTwram9oKAatUcLxBNUjdtcVwxObEQBtRfuyjc=
717
github.com/multiformats/go-multihash v0.0.14 h1:QoBceQYQQtNUuf6s7wHxnE2c8bhbMqhfGzNI032se/I=
818
github.com/multiformats/go-multihash v0.0.14/go.mod h1:VdAWLKTwram9oKAatUcLxBNUjdtcVwxObEQBtRfuyjc=
919
github.com/multiformats/go-varint v0.0.5 h1:XVZwSo04Cs3j/jS0uAEPpT3JY6DzMcVLLoWOSnCxOjg=

‎multiaddr_test.go

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import (
77
"strings"
88
"testing"
99
"time"
10+
11+
"github.com/ipfs/go-cid"
12+
mh "github.com/multiformats/go-multihash"
1013
)
1114

1215
func newMultiaddr(t *testing.T, a string) Multiaddr {
@@ -126,28 +129,42 @@ func TestConstructSucceeds(t *testing.T) {
126129
"/udp/65535",
127130
"/tcp/65535",
128131
"/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC",
132+
"/ipfs/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7",
129133
"/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC",
134+
"/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7",
135+
"/p2p/bafzbeigvf25ytwc3akrijfecaotc74udrhcxzh2cx3we5qqnw5vgrei4bm",
136+
"/p2p/12D3KooWCryG7Mon9orvQxcS1rYZjotPgpwoJNHHKcLLfE4Hf5mV",
137+
"/p2p/k51qzi5uqu5dhb6l8spkdx7yxafegfkee5by8h7lmjh2ehc2sgg34z7c15vzqs",
138+
"/p2p/bafzaajaiaejcalj543iwv2d7pkjt7ykvefrkfu7qjfi6sduakhso4lay6abn2d5u",
130139
"/udp/1234/sctp/1234",
131140
"/udp/1234/udt",
132141
"/udp/1234/utp",
133142
"/tcp/1234/http",
134143
"/tcp/1234/https",
135144
"/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234",
145+
"/ipfs/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234",
136146
"/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234",
147+
"/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234",
137148
"/ip4/127.0.0.1/udp/1234",
138149
"/ip4/127.0.0.1/udp/0",
139150
"/ip4/127.0.0.1/tcp/1234",
140151
"/ip4/127.0.0.1/tcp/1234/",
141152
"/ip4/127.0.0.1/udp/1234/quic",
142153
"/ip4/127.0.0.1/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC",
143154
"/ip4/127.0.0.1/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234",
155+
"/ip4/127.0.0.1/ipfs/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7",
156+
"/ip4/127.0.0.1/ipfs/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234",
144157
"/ip4/127.0.0.1/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC",
145158
"/ip4/127.0.0.1/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234",
159+
"/ip4/127.0.0.1/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7",
160+
"/ip4/127.0.0.1/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234",
146161
"/unix/a/b/c/d/e",
147162
"/unix/stdio",
148163
"/ip4/1.2.3.4/tcp/80/unix/a/b/c/d/e/f",
149164
"/ip4/127.0.0.1/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234/unix/stdio",
165+
"/ip4/127.0.0.1/ipfs/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234/unix/stdio",
150166
"/ip4/127.0.0.1/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC/tcp/1234/unix/stdio",
167+
"/ip4/127.0.0.1/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl7/tcp/1234/unix/stdio",
151168
"/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct",
152169
"/ip4/127.0.0.1/tcp/127/ws",
153170
"/ip4/127.0.0.1/tcp/127/ws",
@@ -544,7 +561,7 @@ func TestIPFSvP2P(t *testing.T) {
544561
}
545562
}
546563

547-
func TestInvalidP2PAddr(t *testing.T) {
564+
func TestInvalidP2PAddrBytes(t *testing.T) {
548565
badAddr := "a503221221c05877cbae039d70a5e600ea02c6f9f2942439285c9e344e26f8d280c850fad6"
549566
bts, err := hex.DecodeString(badAddr)
550567
if err != nil {
@@ -558,6 +575,31 @@ func TestInvalidP2PAddr(t *testing.T) {
558575
}
559576
}
560577

578+
func TestInvalidP2PAddrString(t *testing.T) {
579+
hashedData, err := mh.Sum([]byte("test"), mh.SHA2_256, -1)
580+
if err != nil {
581+
t.Fatal(err)
582+
}
583+
584+
// using MD5 since it's not a valid data codec
585+
unknownCodecCID := cid.NewCidV1(mh.MD5, hashedData).String()
586+
587+
badStringAddrs := []string{
588+
"/p2p/k2k4r8oqamigqdo6o7hsbfwd45y70oyynp98usk7zmyfrzpqxh1pohl-", // invalid multibase encoding
589+
"/p2p/?unknownmultibase", // invalid multibase encoding
590+
"/p2p/k2jmtxwoe2phm1hbqp0e7nufqf6umvuu2e9qd7ana7h411a0haqj6i2z", // non-libp2p-key codec
591+
"/p2p/" + unknownCodecCID, // impossible codec
592+
}
593+
for _, a := range badStringAddrs {
594+
ma, err := NewMultiaddr(a)
595+
if err == nil {
596+
t.Error("should have failed")
597+
// Check for panic
598+
_ = ma.String()
599+
}
600+
}
601+
}
602+
561603
func TestZone(t *testing.T) {
562604
ip6String := "/ip6zone/eth0/ip6/::1"
563605
ip6Bytes := []byte{

‎transcoders.go

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"strconv"
1111
"strings"
1212

13+
"github.com/ipfs/go-cid"
1314
mh "github.com/multiformats/go-multihash"
1415
)
1516

@@ -292,13 +293,29 @@ func garlic32Validate(b []byte) error {
292293

293294
var TranscoderP2P = NewTranscoderFromFunctions(p2pStB, p2pBtS, p2pVal)
294295

296+
// The encoded peer ID can either be a CID of a key or a raw multihash (identity
297+
// or sha256-256).
295298
func p2pStB(s string) ([]byte, error) {
296-
// the address is a varint prefixed multihash string representation
297-
m, err := mh.FromB58String(s)
299+
// check if the address is a base58 encoded sha256 or identity multihash
300+
if strings.HasPrefix(s, "Qm") || strings.HasPrefix(s, "1") {
301+
m, err := mh.FromB58String(s)
302+
if err != nil {
303+
return nil, fmt.Errorf("failed to parse p2p addr: %s %s", s, err)
304+
}
305+
return m, nil
306+
}
307+
308+
// check if the address is a CID
309+
c, err := cid.Decode(s)
298310
if err != nil {
299311
return nil, fmt.Errorf("failed to parse p2p addr: %s %s", s, err)
300312
}
301-
return m, nil
313+
314+
if ty := c.Type(); ty == cid.Libp2pKey {
315+
return c.Hash(), nil
316+
} else {
317+
return nil, fmt.Errorf("failed to parse p2p addr: %s has the invalid codec %d", s, ty)
318+
}
302319
}
303320

304321
func p2pVal(b []byte) error {

0 commit comments

Comments
 (0)