From 8c176d26ebdad5d0a225f83a467c7efcd2285295 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Magiera?= <magik6k@gmail.com>
Date: Mon, 8 Jan 2018 14:22:53 +0100
Subject: [PATCH 1/3] commands/block: use CIDv1 with custom mhtype
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
---
core/commands/block.go | 41 +++++++++++++++++++++++++-----------
test/sharness/t0050-block.sh | 12 +++++++++++
2 files changed, 41 insertions(+), 12 deletions(-)
diff --git a/core/commands/block.go b/core/commands/block.go
index 2d9356ada13..04312f13e6e 100644
--- a/core/commands/block.go
+++ b/core/commands/block.go
@@ -3,6 +3,7 @@ package commands
import (
"bytes"
"context"
+ "errors"
"fmt"
"io"
"io/ioutil"
@@ -121,6 +122,9 @@ var blockPutCmd = &cmds.Command{
ShortDescription: `
'ipfs block put' is a plumbing command for storing raw IPFS blocks.
It reads from stdin, and <key> is a base58 encoded multihash.
+
+By default CIDv0 is going to be generated. Setting 'mhtype' to anything other
+than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
`,
},
@@ -128,7 +132,7 @@ It reads from stdin, and <key> is a base58 encoded multihash.
cmdkit.FileArg("data", true, false, "The data to be stored as an IPFS block.").EnableStdin(),
},
Options: []cmdkit.Option{
- cmdkit.StringOption("format", "f", "cid format for blocks to be created with.").WithDefault("v0"),
+ cmdkit.StringOption("format", "f", "cid format for blocks to be created with.").WithDefault(""),
cmdkit.StringOption("mhtype", "multihash hash function").WithDefault("sha2-256"),
cmdkit.IntOption("mhlen", "multihash hash length").WithDefault(-1),
},
@@ -157,27 +161,40 @@ It reads from stdin, and <key> is a base58 encoded multihash.
return
}
+ mhtype, _ := req.Options["mhtype"].(string)
+ mhtval, ok := mh.Names[mhtype]
+ if !ok {
+ err := fmt.Errorf("unrecognized multihash function: %s", mhtype)
+ res.SetError(err, cmdkit.ErrNormal)
+ return
+ }
+
var pref cid.Prefix
pref.Version = 1
- format, _ := req.Options["format"].(string)
- formatval, ok := cid.Codecs[format]
- if !ok {
- res.SetError(fmt.Errorf("unrecognized format: %s", format), cmdkit.ErrNormal)
- return
+ format := req.Options["format"].(string)
+ if format == "" {
+ if mhtval == mh.SHA2_256 {
+ format = "v0"
+ } else {
+ format = "protobuf"
+ }
}
+
if format == "v0" {
pref.Version = 0
}
- pref.Codec = formatval
-
- mhtype, _ := req.Options["mhtype"].(string)
- mhtval, ok := mh.Names[mhtype]
+ formatval, ok := cid.Codecs[format]
if !ok {
- err := fmt.Errorf("unrecognized multihash function: %s", mhtype)
- res.SetError(err, cmdkit.ErrNormal)
+ res.SetError(fmt.Errorf("unrecognized format: %s", format), cmdkit.ErrNormal)
+ return
+ }
+ if mhtval != mh.SHA2_256 && pref.Version == 0 {
+ res.SetError(errors.New("cannot generate CIDv0 with non-sha256 hash function"), cmdkit.ErrNormal)
return
}
+
+ pref.Codec = formatval
pref.MhType = mhtval
mhlen, ok := req.Options["mhlen"].(int)
diff --git a/test/sharness/t0050-block.sh b/test/sharness/t0050-block.sh
index 285d8ad94b5..0cdd2498ba4 100755
--- a/test/sharness/t0050-block.sh
+++ b/test/sharness/t0050-block.sh
@@ -209,4 +209,16 @@ test_expect_success "no panic in output" '
test_expect_code 1 grep "panic" stat_out
'
+test_expect_success "can set multihash type and length on block put without format" '
+ HASH=$(echo "foooo" | ipfs block put --mhtype=sha3 --mhlen=16)
+'
+
+test_expect_success "output looks good" '
+ test "z2APJNN6rqZTWPpv7gYFHzh7ZEDX" = "$HASH"
+'
+
+test_expect_success "put with sha3 and cidv0 fails" '
+ echo "foooo" | test_must_fail ipfs block put --mhtype=sha3 --mhlen=16 --format=v0
+'
+
test_done
From 6f68eac5bc8d48f77e6bc2b57751adf38b511dc7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Magiera?= <magik6k@gmail.com>
Date: Thu, 1 Mar 2018 16:18:53 +0100
Subject: [PATCH 2/3] commands/block: Increase mhlen in sharness
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
---
test/sharness/t0050-block.sh | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/test/sharness/t0050-block.sh b/test/sharness/t0050-block.sh
index 0cdd2498ba4..054b5491089 100755
--- a/test/sharness/t0050-block.sh
+++ b/test/sharness/t0050-block.sh
@@ -185,11 +185,11 @@ test_expect_success "block get output looks right" '
'
test_expect_success "can set multihash type and length on block put" '
- HASH=$(echo "foooo" | ipfs block put --format=raw --mhtype=sha3 --mhlen=16)
+ HASH=$(echo "foooo" | ipfs block put --format=raw --mhtype=sha3 --mhlen=20)
'
test_expect_success "output looks good" '
- test "z25ScPysKoxJBcPxczn9NvuHiZU5" = "$HASH"
+ test "z83bYcqyBkbx5fuNAcvbdv4pr5RYQiEpK" = "$HASH"
'
test_expect_success "can read block with different hash" '
@@ -210,15 +210,15 @@ test_expect_success "no panic in output" '
'
test_expect_success "can set multihash type and length on block put without format" '
- HASH=$(echo "foooo" | ipfs block put --mhtype=sha3 --mhlen=16)
+ HASH=$(echo "foooo" | ipfs block put --mhtype=sha3 --mhlen=20)
'
test_expect_success "output looks good" '
- test "z2APJNN6rqZTWPpv7gYFHzh7ZEDX" = "$HASH"
+ test "z8bwYCvQPhyDY7VUTsUdGdE8Evm1ktSPV" = "$HASH"
'
test_expect_success "put with sha3 and cidv0 fails" '
- echo "foooo" | test_must_fail ipfs block put --mhtype=sha3 --mhlen=16 --format=v0
+ echo "foooo" | test_must_fail ipfs block put --mhtype=sha3 --mhlen=20 --format=v0
'
test_done
From efb74199bf2d9d92fcfec28a10edceefed9adec2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Magiera?= <magik6k@gmail.com>
Date: Sat, 10 Mar 2018 23:44:34 +0100
Subject: [PATCH 3/3] commands/block: don't use default for -f
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
---
core/commands/block.go | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/commands/block.go b/core/commands/block.go
index 04312f13e6e..fe9f939454e 100644
--- a/core/commands/block.go
+++ b/core/commands/block.go
@@ -132,7 +132,7 @@ than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
cmdkit.FileArg("data", true, false, "The data to be stored as an IPFS block.").EnableStdin(),
},
Options: []cmdkit.Option{
- cmdkit.StringOption("format", "f", "cid format for blocks to be created with.").WithDefault(""),
+ cmdkit.StringOption("format", "f", "cid format for blocks to be created with."),
cmdkit.StringOption("mhtype", "multihash hash function").WithDefault("sha2-256"),
cmdkit.IntOption("mhlen", "multihash hash length").WithDefault(-1),
},
@@ -172,8 +172,8 @@ than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
var pref cid.Prefix
pref.Version = 1
- format := req.Options["format"].(string)
- if format == "" {
+ format, formatSet := req.Options["format"].(string)
+ if !formatSet {
if mhtval == mh.SHA2_256 {
format = "v0"
} else {
@@ -186,7 +186,7 @@ than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
}
formatval, ok := cid.Codecs[format]
if !ok {
- res.SetError(fmt.Errorf("unrecognized format: %s", format), cmdkit.ErrNormal)
+ res.SetError(fmt.Errorf("unrecognized format: '%s'", format), cmdkit.ErrNormal)
return
}
if mhtval != mh.SHA2_256 && pref.Version == 0 {