feat: add 'ipfs multibase' commands #8180
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "io/ioutil" | ||
| "strings" | ||
|
|
||
| cmds "github.com/ipfs/go-ipfs-cmds" | ||
| "github.com/ipfs/go-ipfs/core/commands/cmdenv" | ||
| mbase "github.com/multiformats/go-multibase" | ||
| ) | ||
|
|
||
| var MbaseCmd = &cmds.Command{ | ||
| Helptext: cmds.HelpText{ | ||
| Tagline: "Encode and decode files or stdin with multibase format", | ||
| }, | ||
| Subcommands: map[string]*cmds.Command{ | ||
| "encode": mbaseEncodeCmd, | ||
| "decode": mbaseDecodeCmd, | ||
| "list": basesCmd, | ||
| }, | ||
| Extra: CreateCmdExtras(SetDoesNotUseRepo(true)), | ||
| } | ||
|
|
||
| const ( | ||
| mbaseOptionName = "b" | ||
| ) | ||
|
|
||
| var mbaseEncodeCmd = &cmds.Command{ | ||
| Helptext: cmds.HelpText{ | ||
| Tagline: "Encode data into multibase string", | ||
| LongDescription: ` | ||
| This command expects a file name or data provided via stdin. | ||
|
|
||
| By default it will use URL-safe base64url encoding, | ||
| but one can customize used base with -b: | ||
|
|
||
| > echo hello | ipfs multibase encode -b base16 > output_file | ||
| > cat output_file | ||
| f68656c6c6f0a | ||
|
|
||
| > echo hello > input_file | ||
| > ipfs multibase encode -b base16 input_file | ||
| f68656c6c6f0a | ||
| `, | ||
| }, | ||
| Arguments: []cmds.Argument{ | ||
| cmds.FileArg("file", true, false, "data to encode").EnableStdin(), | ||
| }, | ||
| Options: []cmds.Option{ | ||
| cmds.StringOption(mbaseOptionName, "multibase encoding").WithDefault("base64url"), | ||
| }, | ||
| Run: func(req *cmds.Request, resp cmds.ResponseEmitter, env cmds.Environment) error { | ||
| if err := req.ParseBodyArgs(); err != nil { | ||
| return err | ||
| } | ||
| encoderName, _ := req.Options[mbaseOptionName].(string) | ||
| encoder, err := mbase.EncoderByName(encoderName) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| files := req.Files.Entries() | ||
| file, err := cmdenv.GetFileArg(files) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to access file: %w", err) | ||
| } | ||
| buf, err := ioutil.ReadAll(file) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read file contents: %w", err) | ||
| } | ||
| encoded := encoder.Encode(buf) | ||
| reader := strings.NewReader(encoded) | ||
| return resp.Emit(reader) | ||
| }, | ||
| } | ||
|
|
||
| var mbaseDecodeCmd = &cmds.Command{ | ||
| Helptext: cmds.HelpText{ | ||
| Tagline: "Decode multibase string", | ||
| LongDescription: ` | ||
| This command expects multibase inside of a file or via stdin: | ||
|
|
||
| > echo -n hello | ipfs multibase encode -b base16 > file | ||
| > cat file | ||
| f68656c6c6f | ||
|
|
||
| > ipfs multibase decode file | ||
| hello | ||
|
|
||
| > cat file | ipfs multibase decode | ||
| hello | ||
| `, | ||
| }, | ||
| Arguments: []cmds.Argument{ | ||
| cmds.FileArg("encoded_file", true, false, "encoded data to decode").EnableStdin(), | ||
| }, | ||
| Run: func(req *cmds.Request, resp cmds.ResponseEmitter, env cmds.Environment) error { | ||
| if err := req.ParseBodyArgs(); err != nil { | ||
| return err | ||
| } | ||
| files := req.Files.Entries() | ||
| file, err := cmdenv.GetFileArg(files) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to access file: %w", err) | ||
| } | ||
| encoded_data, err := ioutil.ReadAll(file) | ||
|
There was a problem hiding this comment. Would it be worth implementing a multibase Decoder that would take an Then this could all be done without having to read the entire file into memory. decReader := mbase.NewDecoder(file)
return resp.emit(decReader)@lidel Seems like this is something that should exist, or am I missing an obvious reason it does not? Seems like a There was a problem hiding this comment. Good question! I filled upstream issue multiformats/go-multibase#44 to discuss this, but out of scope for this PR. |
||
| if err != nil { | ||
| return fmt.Errorf("failed to read file contents: %w", err) | ||
| } | ||
| _, data, err := mbase.Decode(string(encoded_data)) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to decode multibase: %w", err) | ||
| } | ||
| reader := bytes.NewReader(data) | ||
| return resp.Emit(reader) | ||
| }, | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| test_description="Test multibase commands" | ||
|
|
||
| . lib/test-lib.sh | ||
|
|
||
| # note: all "ipfs multibase" commands should work without requiring a repo | ||
|
|
||
| cat <<EOF > bases_expect | ||
| 0 identity | ||
| 0 48 base2 | ||
| b 98 base32 | ||
| B 66 base32upper | ||
| c 99 base32pad | ||
| C 67 base32padupper | ||
| f 102 base16 | ||
| F 70 base16upper | ||
| k 107 base36 | ||
| K 75 base36upper | ||
| m 109 base64 | ||
| M 77 base64pad | ||
| t 116 base32hexpad | ||
| T 84 base32hexpadupper | ||
| u 117 base64url | ||
| U 85 base64urlpad | ||
| v 118 base32hex | ||
| V 86 base32hexupper | ||
| z 122 base58btc | ||
| Z 90 base58flickr | ||
| EOF | ||
|
|
||
| # TODO: expose same cmd under multibase? | ||
| test_expect_success "multibase list" ' | ||
| cut -c 10- bases_expect > expect && | ||
| ipfs multibase list > actual && | ||
| test_cmp expect actual | ||
| ' | ||
|
|
||
| test_expect_success "multibase encode works (stdin)" ' | ||
| echo -n uaGVsbG8 > expected && | ||
| echo -n hello | ipfs multibase encode > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase encode works (file)" ' | ||
| echo -n hello > file && | ||
| echo -n uaGVsbG8 > expected && | ||
| ipfs multibase encode ./file > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase encode -b (custom base)" ' | ||
| echo -n f68656c6c6f > expected && | ||
| echo -n hello | ipfs multibase encode -b base16 > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase decode works (stdin)" ' | ||
| echo -n hello > expected && | ||
| echo -n uaGVsbG8 | ipfs multibase decode > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase decode works (file)" ' | ||
| echo -n uaGVsbG8 > file && | ||
| echo -n hello > expected && | ||
| ipfs multibase decode ./file > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase encode+decode roundtrip" ' | ||
| echo -n hello > expected && | ||
| cat expected | ipfs multibase encode -b base64 | ipfs multibase decode > actual && | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase error on unknown multibase prefix" ' | ||
| echo "Error: failed to decode multibase: selected encoding not supported" > expected && | ||
| echo -n ę-that-should-do-the-trick | ipfs multibase decode 2> actual ; | ||
| test_cmp actual expected | ||
| ' | ||
|
|
||
| test_expect_success "multibase error on a character outside of the base" " | ||
| echo \"Error: failed to decode multibase: encoding/hex: invalid byte: U+007A 'z'\" > expected && | ||
| echo -n f6c6f6cz | ipfs multibase decode 2> actual ; | ||
| test_cmp actual expected | ||
| " | ||
|
|
||
| test_done |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going to merge for now as this seems like it wouldn't hurt and matches what
ipfs ciddoes.However, I don't think this really works properly without applying the flag to each subcommand.
@lidel let's revisit during the RC process what we want to do here and figure out if
ipfs cidhas similar problems.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Continued in #8375 (comment)