IPNS format keys in b36cid

ipfs · Aug 4, 2020 · e384b59 · e384b59
1 parent 086ea33
commit e384b59
Show file tree

Hide file tree

Showing 9 changed files with 315 additions and 237 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -175,7 +175,7 @@ jobs:
           command: |
             npm init -y
             npm install ipfs@^0.48.1
-            npm install ipfs-interop@^2.0.0
+            npm install ipfs-interop@^2.0.1
             npm install mocha-circleci-reporter@0.0.3
           working_directory: ~/ipfs/go-ipfs/interop
       - run:

diff --git a/core/commands/keystore.go b/core/commands/keystore.go
@@ -104,7 +104,7 @@ var keyGenCmd = &cmds.Command{
 		if sizefound {
 			opts = append(opts, options.Key.Size(size))
 		}
-		if err = verifyFormatLabel(req.Options[keyFormatOptionName].(string)); err != nil {
+		if err = verifyIDFormatLabel(req.Options[keyFormatOptionName].(string)); err != nil {
 			return err
 		}
 
@@ -128,31 +128,6 @@ var keyGenCmd = &cmds.Command{
 	Type: KeyOutput{},
 }
 
-func verifyFormatLabel(formatLabel string) error {
-	switch formatLabel {
-	case "b58mh":
-		return nil
-	case "b36cid":
-		return nil
-	}
-	return fmt.Errorf("invalid output format option")
-}
-
-func formatID(id peer.ID, formatLabel string) string {
-	switch formatLabel {
-	case "b58mh":
-		return id.Pretty()
-	case "b36cid":
-		if s, err := peer.ToCid(id).StringOfBase(mbase.Base36); err != nil {
-			panic(err)
-		} else {
-			return s
-		}
-	default:
-		panic("unreachable")
-	}
-}
-
 var keyExportCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Export a keypair",
@@ -320,7 +295,7 @@ var keyListCmd = &cmds.Command{
 		cmds.StringOption(keyFormatOptionName, "f", "output format: b58mh or b36cid").WithDefault("b58mh"),
 	},
 	Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
-		if err := verifyFormatLabel(req.Options[keyFormatOptionName].(string)); err != nil {
+		if err := verifyIDFormatLabel(req.Options[keyFormatOptionName].(string)); err != nil {
 			return err
 		}
 
@@ -437,6 +412,31 @@ var keyRmCmd = &cmds.Command{
 	Type: KeyOutputList{},
 }
 
+func verifyIDFormatLabel(formatLabel string) error {
+	switch formatLabel {
+	case "b58mh":
+		return nil
+	case "b36cid":
+		return nil
+	}
+	return fmt.Errorf("invalid output format option")
+}
+
+func formatID(id peer.ID, formatLabel string) string {
+	switch formatLabel {
+	case "b58mh":
+		return id.Pretty()
+	case "b36cid":
+		if s, err := peer.ToCid(id).StringOfBase(mbase.Base36); err != nil {
+			panic(err)
+		} else {
+			return s
+		}
+	default:
+		panic("unreachable")
+	}
+}
+
 func keyOutputListEncoders() cmds.EncoderFunc {
 	return cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, list *KeyOutputList) error {
 		withID, _ := req.Options["l"].(bool)

diff --git a/core/coreapi/key.go b/core/coreapi/key.go
@@ -29,7 +29,7 @@ func (k *key) Name() string {
 
 // Path returns the path of the key.
 func (k *key) Path() path.Path {
-	return path.New(ipfspath.Join([]string{"/ipns", k.peerID.Pretty()}))
+	return path.New(ipfspath.Join([]string{"/ipns", coreiface.FormatKeyID(k.peerID)}))
 }
 
 // ID returns key PeerID

diff --git a/core/coreapi/name.go b/core/coreapi/name.go
@@ -76,7 +76,7 @@ func (api *NameAPI) Publish(ctx context.Context, p path.Path, opts ...caopts.Nam
 	}
 
 	return &ipnsEntry{
-		name:  pid.Pretty(),
+		name:  coreiface.FormatKeyID(pid),
 		value: p,
 	}, nil
 }

diff --git a/go.mod b/go.mod
@@ -54,7 +54,7 @@ require (
 	github.com/ipfs/go-path v0.0.7
 	github.com/ipfs/go-unixfs v0.2.4
 	github.com/ipfs/go-verifcid v0.0.1
-	github.com/ipfs/interface-go-ipfs-core v0.3.0
+	github.com/ipfs/interface-go-ipfs-core v0.4.0
 	github.com/ipld/go-car v0.1.0
 	github.com/jbenet/go-is-domain v1.0.5
 	github.com/jbenet/go-random v0.0.0-20190219211222-123a90aedc0c

diff --git a/go.sum b/go.sum
@@ -447,6 +447,8 @@ github.com/ipfs/go-verifcid v0.0.1 h1:m2HI7zIuR5TFyQ1b79Da5N9dnnCP1vcu2QqawmWlK2
 github.com/ipfs/go-verifcid v0.0.1/go.mod h1:5Hrva5KBeIog4A+UpqlaIU+DEstipcJYQQZc0g37pY0=
 github.com/ipfs/interface-go-ipfs-core v0.3.0 h1:oZdLLfh256gPGcYPURjivj/lv296GIcr8mUqZUnXOEI=
 github.com/ipfs/interface-go-ipfs-core v0.3.0/go.mod h1:Tihp8zxGpUeE3Tokr94L6zWZZdkRQvG5TL6i9MuNE+s=
+github.com/ipfs/interface-go-ipfs-core v0.4.0 h1:+mUiamyHIwedqP8ZgbCIwpy40oX7QcXUbo4CZOeJVJg=
+github.com/ipfs/interface-go-ipfs-core v0.4.0/go.mod h1:UJBcU6iNennuI05amq3FQ7g0JHUkibHFAfhfUIy927o=
 github.com/ipld/go-car v0.1.0 h1:AaIEA5ITRnFA68uMyuIPYGM2XXllxsu8sNjFJP797us=
 github.com/ipld/go-car v0.1.0/go.mod h1:RCWzaUh2i4mOEkB3W45Vc+9jnS/M6Qay5ooytiBHl3g=
 github.com/ipld/go-ipld-prime v0.0.2-0.20191108012745-28a82f04c785 h1:fASnkvtR+SmB2y453RxmDD3Uvd4LonVUgFGk9JoDaZs=

diff --git a/test/sharness/lib/test-lib.sh b/test/sharness/lib/test-lib.sh
@@ -443,9 +443,13 @@ file_size() {
     $_STAT "$1"
 }
 
+# len 46: 2048-bit RSA keys, b58mh-encoded
+# len 52: ED25519 keys, b58mh-encoded
+# len 56: 2048-bit RSA keys, b36cid-encoded
+# len 62: ED25519 keys, b36cid-encoded
 test_check_peerid() {
   peeridlen=$(echo "$1" | tr -dC "[:alnum:]" | wc -c | tr -d " ") &&
-  test "$peeridlen" = "46" -o "$peeridlen" = "52" -o "$peeridlen" = "62" || {
+  test "$peeridlen" = "46" -o "$peeridlen" = "52" -o "$peeridlen" = "56" -o "$peeridlen" = "62" || {
     echo "Bad peerid '$1' with len '$peeridlen'"
     return 1
   }