aboutsummaryrefslogtreecommitdiffstats
path: root/cmd
diff options
context:
space:
mode:
authorJavier Peletier <jpeletier@users.noreply.github.com>2018-07-22 03:49:36 +0800
committerAnton Evangelatov <anton.evangelatov@gmail.com>2018-07-23 21:33:33 +0800
commit427316a7078e1876ad8db9d67550609c961e84f6 (patch)
tree382406ba5b2499076bb53e379aa4619df506d989 /cmd
parent0647c4de7b1b4b2090807a6db0b7a8eafdfa097b (diff)
downloadgo-tangerine-427316a7078e1876ad8db9d67550609c961e84f6.tar.gz
go-tangerine-427316a7078e1876ad8db9d67550609c961e84f6.tar.zst
go-tangerine-427316a7078e1876ad8db9d67550609c961e84f6.zip
swarm/storage/mru: Client-side MRU signatures (#784)
* swarm/storage/mru: Add embedded publickey and remove ENS dep This commit breaks swarm, swarm/api... but tests in swarm/storage/mru pass * swarm: Refactor swarm, swarm/api to mru changes, make tests pass * swarm/storage/mru: Remove self from recv, remove test ens vldtr * swarm/storage/mru: Remove redundant test, expose ResourceHash mthd * swarm/storage/mru: Make HeaderGetter mandatory + godoc fixes * swarm/storage: Remove validator prefix for metadata chunk * swarm/storage/mru: Use Address instead of PublicKey * swarm/storage/mru: Change index from name to metadata chunk addr * swarm/storage/mru: Refactor swarm/api/... to MRU index changes * swarm/storage/mru: Refactor cleanup * swarm/storage/mru: Rebase cleanup * swarm: Use constructor for GenericSigner MRU in swarm.go * swarm/storage: Change to BMTHash for MRU hashing * swarm/storage: Reduce loglevel on chunk validator logs * swarm/storage/mru: Delint * swarm: MRU Rebase cleanup * swarm/storage/mru: client-side mru signatures Rebase to PR #668 and fix all conflicts * swarm/storage/mru: refactor and documentation * swarm/resource/mru: error-checking tests for parseUpdate/newUpdateChunk * swarm/storage/mru: Added resourcemetadata tests * swarm/storage/mru: Added tests for UpdateRequest * swarm/storage/mru: more test coverage for UpdateRequest and comments * swarm/storage/mru: Avoid fake chunks in parseUpdate() * swarm/storage/mru: Documented resource.go extensively moved some functions where they make most sense * swarm/storage/mru: increase test coverage for UpdateRequest and variable name changes throughout to increase consistency * swarm/storage/mru: moved default timestamp to NewCreateRequest- * swarm/storage/mru: lookup refactor * swarm/storage/mru: added comments and renamed raw flag to rawmru * swarm/storage/mru: fix receiver typo * swarm/storage/mru: refactored update chunk new/create * swarm/storage/mru: refactored signature digest to avoid malleability * swarm/storage/mru: optimize update data serialization * swarm/storage/mru: refactor and cleanup * swarm/storage/mru: add timestamp struct and serialization * swarm/storage/mru: fix lint error and mark some old code for deletion * swarm/storage/mru: remove unnecessary variable * swarm/storage/mru: Added more comments throughout * swarm/storage/mru: Refactored metadata chunk layout + extensive error... * swarm/storage/mru: refactor cli parser Changed resource info output to JSON * swarm/storage/mru: refactor serialization for extensibility refactored error messages to NewErrorf * swarm/storage/mru: Moved Signature to resource_sign. Check Sign errors in server tests * swarm/storage/mru: Remove isSafeName() checks * swarm/storage/mru: scrubbed off all references to "block" for time * swarm/storage/mru: removed superfluous isSynced() call. * swarm/storage/mru: remove isMultihash() and ToSafeName functions * swarm/storage/mru: various fixes and comments * swarm/storage/mru: decoupled cli for independent create/update * Made resource name optional * Removed unused LookupPrevious * swarm/storage/mru: Decoupled resource create / update & refactor * swarm/storage/mru: Fixed some comments as per issues raised in PR #743 * swarm/storage/mru: Cosmetic changes as per #743 comments * swarm/storage/mru: refct request encoder/decoder > marshal/unmarshal * swarm/storage/mru: Cosmetic changes as per review in #748 * swarm/storage/mru: removed timestamp proof placeholder * swarm/storage/mru: cosmetic/doc/fixes changes as per comments in #704 * swarm/storage/mru: removed unnecessary check in Handler.update * swarm/storage/mru: Implemented Marshaler/Unmarshaler iface in Request * swarm/storage/mru: Fixed linter error * swarm/storage/mru: removed redundant address in signature digest * swarm/storage/mru: fixed bug: LookupLatestVersionInPeriod not working * swarm/storage/mru: Unfold Request creation API for create or update+create set common time source for mru package * swarm/api/http: fix HandleGetResource error variable shadowed when requesting a resource that does not exist * swarm/storage/mru: Add simple check to detect duplicate updates * swarm/storage/mru: moved Multihash() to the right place. * cmd/swarm: remove unneeded clientaccountmanager.go * swarm/storage/mru: Changed some comments as per reviews in #784 * swarm/storage/mru: Made SignedResourceUpdate.GetDigest() public * swarm/storage/mru: cosmetic changes as per comments in #784 * cmd/swarm: Inverted --multihash flag default * swarm/storage/mru: removed Verify from SignedResourceUpdate.fromChunk * swarm/storage/mru: Moved validation code out of serializer Cosmetic / comment changes * swarm/storage/mru: Added unit tests for UpdateLookup * swarm/storage/mru: Increased coverage of metadata serialization * swarm/storage/mru: Increased test coverage of updateHeader serializers * swarm/storage/mru: Add resourceUpdate serializer test
Diffstat (limited to 'cmd')
-rw-r--r--cmd/swarm/main.go67
-rw-r--r--cmd/swarm/mru.go169
2 files changed, 236 insertions, 0 deletions
diff --git a/cmd/swarm/main.go b/cmd/swarm/main.go
index d66191628..d1dbb44df 100644
--- a/cmd/swarm/main.go
+++ b/cmd/swarm/main.go
@@ -182,6 +182,18 @@ var (
Usage: "Number of recent chunks cached in memory (default 5000)",
EnvVar: SWARM_ENV_STORE_CACHE_CAPACITY,
}
+ SwarmResourceMultihashFlag = cli.BoolFlag{
+ Name: "multihash",
+ Usage: "Determines how to interpret data for a resource update. If not present, data will be interpreted as raw, literal data that will be included in the resource",
+ }
+ SwarmResourceNameFlag = cli.StringFlag{
+ Name: "name",
+ Usage: "User-defined name for the new resource",
+ }
+ SwarmResourceDataOnCreateFlag = cli.StringFlag{
+ Name: "data",
+ Usage: "Initializes the resource with the given hex-encoded data. Data must be prefixed by 0x",
+ }
)
//declare a few constant error messages, useful for later error check comparisons in test
@@ -236,6 +248,41 @@ func init() {
Description: "uploads a file or directory to swarm using the HTTP API and prints the root hash",
},
{
+ CustomHelpTemplate: helpTemplate,
+ Name: "resource",
+ Usage: "(Advanced) Create and update Mutable Resources",
+ ArgsUsage: "<create|update|info>",
+ Description: "Works with Mutable Resource Updates",
+ Subcommands: []cli.Command{
+ {
+ Action: resourceCreate,
+ CustomHelpTemplate: helpTemplate,
+ Name: "create",
+ Usage: "creates a new Mutable Resource",
+ ArgsUsage: "<frequency>",
+ Description: "creates a new Mutable Resource",
+ Flags: []cli.Flag{SwarmResourceNameFlag, SwarmResourceDataOnCreateFlag, SwarmResourceMultihashFlag},
+ },
+ {
+ Action: resourceUpdate,
+ CustomHelpTemplate: helpTemplate,
+ Name: "update",
+ Usage: "updates the content of an existing Mutable Resource",
+ ArgsUsage: "<Manifest Address or ENS domain> <0x Hex data>",
+ Description: "updates the content of an existing Mutable Resource",
+ Flags: []cli.Flag{SwarmResourceMultihashFlag},
+ },
+ {
+ Action: resourceInfo,
+ CustomHelpTemplate: helpTemplate,
+ Name: "info",
+ Usage: "obtains information about an existing Mutable Resource",
+ ArgsUsage: "<Manifest Address or ENS domain>",
+ Description: "obtains information about an existing Mutable Resource",
+ },
+ },
+ },
+ {
Action: list,
CustomHelpTemplate: helpTemplate,
Name: "ls",
@@ -563,6 +610,26 @@ func getAccount(bzzaccount string, ctx *cli.Context, stack *node.Node) *ecdsa.Pr
return decryptStoreAccount(ks, bzzaccount, utils.MakePasswordList(ctx))
}
+// getPrivKey returns the private key of the specified bzzaccount
+// Used only by client commands, such as `resource`
+func getPrivKey(ctx *cli.Context) *ecdsa.PrivateKey {
+ // booting up the swarm node just as we do in bzzd action
+ bzzconfig, err := buildConfig(ctx)
+ if err != nil {
+ utils.Fatalf("unable to configure swarm: %v", err)
+ }
+ cfg := defaultNodeConfig
+ if _, err := os.Stat(bzzconfig.Path); err == nil {
+ cfg.DataDir = bzzconfig.Path
+ }
+ utils.SetNodeConfig(ctx, &cfg)
+ stack, err := node.New(&cfg)
+ if err != nil {
+ utils.Fatalf("can't create node: %v", err)
+ }
+ return getAccount(bzzconfig.BzzAccount, ctx, stack)
+}
+
func decryptStoreAccount(ks *keystore.KeyStore, account string, passwords []string) *ecdsa.PrivateKey {
var a accounts.Account
var err error
diff --git a/cmd/swarm/mru.go b/cmd/swarm/mru.go
new file mode 100644
index 000000000..6176b6d6c
--- /dev/null
+++ b/cmd/swarm/mru.go
@@ -0,0 +1,169 @@
+// Copyright 2016 The go-ethereum Authors
+// This file is part of go-ethereum.
+//
+// go-ethereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// go-ethereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
+
+// Command resource allows the user to create and update signed mutable resource updates
+package main
+
+import (
+ "fmt"
+ "strconv"
+ "strings"
+
+ "github.com/ethereum/go-ethereum/common/hexutil"
+
+ "github.com/ethereum/go-ethereum/cmd/utils"
+ swarm "github.com/ethereum/go-ethereum/swarm/api/client"
+ "github.com/ethereum/go-ethereum/swarm/storage/mru"
+ "gopkg.in/urfave/cli.v1"
+)
+
+func NewGenericSigner(ctx *cli.Context) mru.Signer {
+ return mru.NewGenericSigner(getPrivKey(ctx))
+}
+
+// swarm resource create <frequency> [--name <name>] [--data <0x Hexdata> [--multihash=false]]
+// swarm resource update <Manifest Address or ENS domain> <0x Hexdata> [--multihash=false]
+// swarm resource info <Manifest Address or ENS domain>
+
+func resourceCreate(ctx *cli.Context) {
+ args := ctx.Args()
+
+ var (
+ bzzapi = strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
+ client = swarm.NewClient(bzzapi)
+ multihash = ctx.Bool(SwarmResourceMultihashFlag.Name)
+ initialData = ctx.String(SwarmResourceDataOnCreateFlag.Name)
+ name = ctx.String(SwarmResourceNameFlag.Name)
+ )
+
+ if len(args) < 1 {
+ fmt.Println("Incorrect number of arguments")
+ cli.ShowCommandHelpAndExit(ctx, "create", 1)
+ return
+ }
+ signer := NewGenericSigner(ctx)
+ frequency, err := strconv.ParseUint(args[0], 10, 64)
+ if err != nil {
+ fmt.Printf("Frequency formatting error: %s\n", err.Error())
+ cli.ShowCommandHelpAndExit(ctx, "create", 1)
+ return
+ }
+
+ metadata := mru.ResourceMetadata{
+ Name: name,
+ Frequency: frequency,
+ Owner: signer.Address(),
+ }
+
+ var newResourceRequest *mru.Request
+ if initialData != "" {
+ initialDataBytes, err := hexutil.Decode(initialData)
+ if err != nil {
+ fmt.Printf("Error parsing data: %s\n", err.Error())
+ cli.ShowCommandHelpAndExit(ctx, "create", 1)
+ return
+ }
+ newResourceRequest, err = mru.NewCreateUpdateRequest(&metadata)
+ if err != nil {
+ utils.Fatalf("Error creating new resource request: %s", err)
+ }
+ newResourceRequest.SetData(initialDataBytes, multihash)
+ if err = newResourceRequest.Sign(signer); err != nil {
+ utils.Fatalf("Error signing resource update: %s", err.Error())
+ }
+ } else {
+ newResourceRequest, err = mru.NewCreateRequest(&metadata)
+ if err != nil {
+ utils.Fatalf("Error creating new resource request: %s", err)
+ }
+ }
+
+ manifestAddress, err := client.CreateResource(newResourceRequest)
+ if err != nil {
+ utils.Fatalf("Error creating resource: %s", err.Error())
+ return
+ }
+ fmt.Println(manifestAddress) // output manifest address to the user in a single line (useful for other commands to pick up)
+
+}
+
+func resourceUpdate(ctx *cli.Context) {
+ args := ctx.Args()
+
+ var (
+ bzzapi = strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
+ client = swarm.NewClient(bzzapi)
+ multihash = ctx.Bool(SwarmResourceMultihashFlag.Name)
+ )
+
+ if len(args) < 2 {
+ fmt.Println("Incorrect number of arguments")
+ cli.ShowCommandHelpAndExit(ctx, "update", 1)
+ return
+ }
+ signer := NewGenericSigner(ctx)
+ manifestAddressOrDomain := args[0]
+ data, err := hexutil.Decode(args[1])
+ if err != nil {
+ utils.Fatalf("Error parsing data: %s", err.Error())
+ return
+ }
+
+ // Retrieve resource status and metadata out of the manifest
+ updateRequest, err := client.GetResourceMetadata(manifestAddressOrDomain)
+ if err != nil {
+ utils.Fatalf("Error retrieving resource status: %s", err.Error())
+ }
+
+ // set the new data
+ updateRequest.SetData(data, multihash)
+
+ // sign update
+ if err = updateRequest.Sign(signer); err != nil {
+ utils.Fatalf("Error signing resource update: %s", err.Error())
+ }
+
+ // post update
+ err = client.UpdateResource(updateRequest)
+ if err != nil {
+ utils.Fatalf("Error updating resource: %s", err.Error())
+ return
+ }
+}
+
+func resourceInfo(ctx *cli.Context) {
+ var (
+ bzzapi = strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
+ client = swarm.NewClient(bzzapi)
+ )
+ args := ctx.Args()
+ if len(args) < 1 {
+ fmt.Println("Incorrect number of arguments.")
+ cli.ShowCommandHelpAndExit(ctx, "info", 1)
+ return
+ }
+ manifestAddressOrDomain := args[0]
+ metadata, err := client.GetResourceMetadata(manifestAddressOrDomain)
+ if err != nil {
+ utils.Fatalf("Error retrieving resource metadata: %s", err.Error())
+ return
+ }
+ encodedMetadata, err := metadata.MarshalJSON()
+ if err != nil {
+ utils.Fatalf("Error encoding metadata to JSON for display:%s", err)
+ }
+ fmt.Println(string(encodedMetadata))
+}