refactor: use b36 for all libp2p-keys in subdomains

Consensus reached in #7441 (comment) #7441 (comment) #7441 (comment) License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>
ipfs · Jul 10, 2020 · 79d571f · 79d571f
1 parent 673f99f
commit 79d571f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 12 deletions.
diff --git a/core/corehttp/hostname.go b/core/corehttp/hostname.go
@@ -378,13 +378,21 @@ func toSubdomainURL(hostname, path string, r *http.Request) (redirURL string, er
 	// If rootID is a CID, ensure it uses DNS-friendly text representation
 	if rootCID, err := cid.Decode(rootID); err == nil {
 		multicodec := rootCID.Type()
-
-		// PeerIDs represented as CIDv1 are expected to have libp2p-key
-		// multicodec (https://github.com/libp2p/specs/pull/209).
-		// We ease the transition by fixing multicodec on the fly:
-		// https://github.com/ipfs/go-ipfs/issues/5287#issuecomment-492163929
-		if isPeerIDNamespace(ns) && multicodec != cid.Libp2pKey {
-			multicodec = cid.Libp2pKey
+		var base mbase.Encoding = mbase.Base32
+
+		// Normalizations specific to /ipns/{libp2p-key}
+		if isPeerIDNamespace(ns) {
+			// Using Base36 for /ipns/ for consistency
+			// Context: https://github.com/ipfs/go-ipfs/pull/7441#discussion_r452372828
+			base = mbase.Base36
+
+			// PeerIDs represented as CIDv1 are expected to have libp2p-key
+			// multicodec (https://github.com/libp2p/specs/pull/209).
+			// We ease the transition by fixing multicodec on the fly:
+			// https://github.com/ipfs/go-ipfs/issues/5287#issuecomment-492163929
+			if multicodec != cid.Libp2pKey {
+				multicodec = cid.Libp2pKey
+			}
 		}
 
 		// Ensure CID text representation used in subdomain is compatible
@@ -395,7 +403,7 @@ func toSubdomainURL(hostname, path string, r *http.Request) (redirURL string, er
 		//    before making the request
 		//    (https://github.com/ipfs/in-web-browsers/issues/89)
 		rootCID = cid.NewCidV1(multicodec, rootCID.Hash())
-		rootID, err = rootCID.StringOfBase(mbase.Base32)
+		rootID, err = rootCID.StringOfBase(base)
 		if err != nil {
 			return "", err
 		}

diff --git a/core/corehttp/hostname_test.go b/core/corehttp/hostname_test.go
@@ -28,8 +28,8 @@ func TestToSubdomainURL(t *testing.T) {
 		// CIDv1 with long sha512
 		{"localhost", "/ipfs/bafkrgqe3ohjcjplc6n4f3fwunlj6upltggn7xqujbsvnvyw764srszz4u4rshq6ztos4chl4plgg4ffyyxnayrtdi5oc4xb2332g645433aeg", "", errors.New("CID incompatible with DNS label length limit of 63: kf1siqrebi3vir8sab33hu5vcy008djegvay6atmz91ojesyjs8lx350b7y7i1nvyw2haytfukfyu2f2x4tocdrfa0zgij6p4zpl4u5oj")},
 		// PeerID as CIDv1 needs to have libp2p-key multicodec
-		{"localhost", "/ipns/QmY3hE8xgFCjGcz6PHgnvJz5HZi1BaKRfPkn1ghZUcYMjD", "http://bafzbeieqhtl2l3mrszjnhv6hf2iloiitsx7mexiolcnywnbcrzkqxwslja.ipns.localhost/", nil},
-		{"localhost", "/ipns/bafybeickencdqw37dpz3ha36ewrh4undfjt2do52chtcky4rxkj447qhdm", "http://bafzbeickencdqw37dpz3ha36ewrh4undfjt2do52chtcky4rxkj447qhdm.ipns.localhost/", nil},
+		{"localhost", "/ipns/QmY3hE8xgFCjGcz6PHgnvJz5HZi1BaKRfPkn1ghZUcYMjD", "http://k2k4r8n0flx3ra0y5dr8fmyvwbzy3eiztmtq6th694k5a3rznayp3e4o.ipns.localhost/", nil},
+		{"localhost", "/ipns/bafybeickencdqw37dpz3ha36ewrh4undfjt2do52chtcky4rxkj447qhdm", "http://k2k4r8l9ja7hkzynavdqup76ou46tnvuaqegbd04a4o1mpbsey0meucb.ipns.localhost/", nil},
 		// PeerID: ed25519+identity multihash → CIDv1Base36
 		{"localhost", "/ipns/12D3KooWFB51PRY9BxcXSH6khFXw1BZeszeLDy7C8GciskqCTZn5", "http://k51qzi5uqu5di608geewp3nqkg0bpujoasmka7ftkyxgcm3fh1aroup0gsdrna.ipns.localhost/", nil},
 	} {

diff --git a/test/sharness/t0114-gateway-subdomains.sh b/test/sharness/t0114-gateway-subdomains.sh
@@ -110,8 +110,8 @@ test_expect_success "Add the test directory" '
 test_expect_success "Publish test text file to IPNS" '
   PEERID=$(ipfs id --format="<id>")
   IPNS_IDv0=$(echo "$PEERID" | ipfs cid format -v 0)
-  IPNS_IDv1=$(echo "$PEERID" | ipfs cid format -v 1 --codec libp2p-key -b base32)
-  IPNS_IDv1_DAGPB=$(echo "$IPNS_IDv0" | ipfs cid format -v 1 -b base32)
+  IPNS_IDv1=$(echo "$PEERID" | ipfs cid format -v 1 --codec libp2p-key -b base36)
+  IPNS_IDv1_DAGPB=$(echo "$IPNS_IDv0" | ipfs cid format -v 1 -b base36)
   test_check_peerid "${PEERID}" &&
   ipfs name publish --allow-offline -Q "/ipfs/$CIDv1" > name_publish_out &&
   ipfs name resolve "$PEERID"  > output &&