Merge pull request #2242 from jimenezrick/upstream-crypto

Closes #2241: Use Keccak-256 from golang.org/x/crypto/sha3 and mention explicitly

11 files changed, 11 insertions, 302 deletions

diff --git a/common/bytes.go b/common/bytes.go
index ba6987a9e..4fb016a97 100644
--- a/common/bytes.go
+++ b/common/bytes.go
@@ -48,22 +48,6 @@ func FromHex(s string) []byte {
 	return nil
 }
 
-type Bytes []byte
-
-func (self Bytes) String() string {
-	return string(self)
-}
-
-func DeleteFromByteSlice(s [][]byte, hash []byte) [][]byte {
-	for i, h := range s {
-		if bytes.Compare(h, hash) == 0 {
-			return append(s[:i:i], s[i+1:]...)
-		}
-	}
-
-	return s
-}
-
 // Number to bytes
 //
 // Returns the number in bytes with the specified base
@@ -154,7 +138,6 @@ func Hex2Bytes(str string) []byte {
 }
 
 func Hex2BytesFixed(str string, flen int) []byte {
-
 	h, _ := hex.DecodeString(str)
 	if len(h) == flen {
 		return h
@@ -167,7 +150,6 @@ func Hex2BytesFixed(str string, flen int) []byte {
 			return hh
 		}
 	}
-
 }
 
 func StringToByteFunc(str string, cb func(str string) []byte) (ret []byte) {
diff --git a/common/bytes_test.go b/common/bytes_test.go
index 816d2082b..2e5208477 100644
--- a/common/bytes_test.go
+++ b/common/bytes_test.go
@@ -27,26 +27,6 @@ type BytesSuite struct{}
 
 var _ = checker.Suite(&BytesSuite{})
 
-func (s *BytesSuite) TestByteString(c *checker.C) {
-	var data Bytes
-	data = []byte{102, 111, 111}
-	exp := "foo"
-	res := data.String()
-
-	c.Assert(res, checker.Equals, exp)
-}
-
-/*
-func (s *BytesSuite) TestDeleteFromByteSlice(c *checker.C) {
-	data := []byte{1, 2, 3, 4}
-	slice := []byte{1, 2, 3, 4}
-	exp := []byte{1, 4}
-	res := DeleteFromByteSlice(data, slice)
-
-	c.Assert(res, checker.DeepEquals, exp)
-}
-
-*/
 func (s *BytesSuite) TestNumberToBytes(c *checker.C) {
 	// data1 := int(1)
 	// res1 := NumberToBytes(data1, 16)
diff --git a/common/compiler/solidity.go b/common/compiler/solidity.go
index aca3a1fc2..8d3304029 100644
--- a/common/compiler/solidity.go
+++ b/common/compiler/solidity.go
@@ -220,7 +220,7 @@ func SaveInfo(info *ContractInfo, filename string) (contenthash common.Hash, err
 	if err != nil {
 		return
 	}
-	contenthash = common.BytesToHash(crypto.Sha3(infojson))
+	contenthash = common.BytesToHash(crypto.Keccak256(infojson))
 	err = ioutil.WriteFile(filename, infojson, 0600)
 	return
 }
diff --git a/common/httpclient/httpclient.go b/common/httpclient/httpclient.go
index 23373ecaf..a0a1efd38 100644
--- a/common/httpclient/httpclient.go
+++ b/common/httpclient/httpclient.go
@@ -74,7 +74,7 @@ func (self *HTTPClient) GetAuthContent(uri string, hash common.Hash) ([]byte, er
 	}
 
 	// check hash to authenticate content
-	chash := crypto.Sha3Hash(content)
+	chash := crypto.Keccak256Hash(content)
 	if chash != hash {
 		return nil, fmt.Errorf("content hash mismatch %x != %x (exp)", hash[:], chash[:])
 	}
diff --git a/common/httpclient/httpclient_test.go b/common/httpclient/httpclient_test.go
index 6c3782e15..670893f8a 100644
--- a/common/httpclient/httpclient_test.go
+++ b/common/httpclient/httpclient_test.go
@@ -36,7 +36,7 @@ func TestGetAuthContent(t *testing.T) {
 	client := New(dir)
 
 	text := "test"
-	hash := crypto.Sha3Hash([]byte(text))
+	hash := crypto.Keccak256Hash([]byte(text))
 	if err := ioutil.WriteFile(path.Join(dir, "test.content"), []byte(text), os.ModePerm); err != nil {
 		t.Fatal("could not write test file", err)
 	}
diff --git a/common/natspec/natspec.go b/common/natspec/natspec.go
index 2e4d8d7a4..8197018cf 100644
--- a/common/natspec/natspec.go
+++ b/common/natspec/natspec.go
@@ -115,7 +115,7 @@ func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, client *httpc
 		err = fmt.Errorf("contract (%v) not found", contractAddress)
 		return
 	}
-	codehash := common.BytesToHash(crypto.Sha3(codeb))
+	codehash := common.BytesToHash(crypto.Keccak256(codeb))
 	// set up nameresolver with natspecreg + urlhint contract addresses
 	reg := registrar.New(xeth)
 
@@ -197,7 +197,7 @@ type userDoc struct {
 func (self *NatSpec) makeAbi2method(abiKey [8]byte) (meth *method) {
 	for signature, m := range self.userDoc.Methods {
 		name := strings.Split(signature, "(")[0]
-		hash := []byte(common.Bytes2Hex(crypto.Sha3([]byte(signature))))
+		hash := []byte(common.Bytes2Hex(crypto.Keccak256([]byte(signature))))
 		var key [8]byte
 		copy(key[:], hash[:8])
 		if bytes.Equal(key[:], abiKey[:]) {
diff --git a/common/natspec/natspec_e2e_test.go b/common/natspec/natspec_e2e_test.go
index 4a9b92eb6..0730391c7 100644
--- a/common/natspec/natspec_e2e_test.go
+++ b/common/natspec/natspec_e2e_test.go
@@ -238,11 +238,11 @@ func TestNatspecE2E(t *testing.T) {
 	// create a contractInfo file (mock cloud-deployed contract metadocs)
 	// incidentally this is the info for the HashReg contract itself
 	ioutil.WriteFile("/tmp/"+testFileName, []byte(testContractInfo), os.ModePerm)
-	dochash := crypto.Sha3Hash([]byte(testContractInfo))
+	dochash := crypto.Keccak256Hash([]byte(testContractInfo))
 
 	// take the codehash for the contract we wanna test
 	codeb := tf.xeth.CodeAtBytes(registrar.HashRegAddr)
-	codehash := crypto.Sha3Hash(codeb)
+	codehash := crypto.Keccak256Hash(codeb)
 
 	reg := registrar.New(tf.xeth)
 	_, err := reg.SetHashToHash(addr, codehash, dochash)
diff --git a/common/natspec/natspec_e2e_test.go.orig b/common/natspec/natspec_e2e_test.go.orig
deleted file mode 100644
index 601a9edbd..000000000
--- a/common/natspec/natspec_e2e_test.go.orig
+++ /dev/null
@@ -1,253 +0,0 @@
-package natspec
-
-import (
-  "fmt"
-  "io/ioutil"
-  "os"
-  "strings"
-  "testing"
-
-  "github.com/ethereum/go-ethereum/accounts"
-  "github.com/ethereum/go-ethereum/common"
-  "github.com/ethereum/go-ethereum/common/docserver"
-  "github.com/ethereum/go-ethereum/common/registrar"
-  "github.com/ethereum/go-ethereum/core"
-  "github.com/ethereum/go-ethereum/core/state"
-  "github.com/ethereum/go-ethereum/crypto"
-  "github.com/ethereum/go-ethereum/eth"
-  xe "github.com/ethereum/go-ethereum/xeth"
-)
-
-const (
-  testBalance = "10000000000000000000"
-
-  testFileName = "long_file_name_for_testing_registration_of_URLs_longer_than_32_bytes.content"
-
-  testNotice = "Register key `utils.toHex(_key)` <- content `utils.toHex(_content)`"
-
-  testExpNotice = "Register key 0xadd1a7d961cff0242089674ec2ef6fca671ab15e1fe80e38859fc815b98d88ab <- content 0xb3a2dea218de5d8bbe6c4645aadbf67b5ab00ecb1a9ec95dbdad6a0eed3e41a7"
-
-  testExpNotice2 = `About to submit transaction (NatSpec notice error: abi key does not match any method): {"params":[{"to":"%s","data": "0x31e12c20"}]}`
-
-  testExpNotice3 = `About to submit transaction (no NatSpec info found for contract: content hash not found for '0x1392c62d05b2d149e22a339c531157ae06b44d39a674cce500064b12b9aeb019'): {"params":[{"to":"%s","data": "0x300a3bbfb3a2dea218de5d8bbe6c4645aadbf67b5ab00ecb1a9ec95dbdad6a0eed3e41a7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000066696c653a2f2f2f746573742e636f6e74656e74"}]}`
-)
-
-const (
-  testUserDoc = `
-{
-  "methods": {
-    "register(uint256,uint256)": {
-      "notice":  "` + testNotice + `"
-    }
-  },
-  "invariants": [
-    { "notice": "" }
-  ],
-  "construction": [
-    { "notice": "" }
-  ]
-}
-`
-  testAbiDefinition = `
-[{
-  "name": "register",
-  "constant": false,
-  "type": "function",
-  "inputs": [{
-    "name": "_key",
-    "type": "uint256"
-  }, {
-    "name": "_content",
-    "type": "uint256"
-  }],
-  "outputs": []
-}]
-`
-
-  testContractInfo = `
-{
-  "userDoc": ` + testUserDoc + `,
-  "abiDefinition": ` + testAbiDefinition + `
-}
-`
-)
-
-type testFrontend struct {
-  t           *testing.T
-  ethereum    *eth.Ethereum
-  xeth        *xe.XEth
-  coinbase    common.Address
-  stateDb     *state.StateDB
-  txc         uint64
-  lastConfirm string
-  wantNatSpec bool
-}
-
-func (self *testFrontend) UnlockAccount(acc []byte) bool {
-  self.ethereum.AccountManager().Unlock(common.BytesToAddress(acc), "password")
-  return true
-}
-
-func (self *testFrontend) ConfirmTransaction(tx string) bool {
-  if self.wantNatSpec {
-    ds := docserver.New("/tmp/")
-    self.lastConfirm = GetNotice(self.xeth, tx, ds)
-  }
-  return true
-}
-
-func testEth(t *testing.T) (ethereum *eth.Ethereum, err error) {
-
-  os.RemoveAll("/tmp/eth-natspec/")
-
-  err = os.MkdirAll("/tmp/eth-natspec/keystore", os.ModePerm)
-  if err != nil {
-    panic(err)
-  }
-
-  // create a testAddress
-  ks := crypto.NewKeyStorePassphrase("/tmp/eth-natspec/keystore", crypto.LightScryptN, crypto.LightScryptP)
-  am := accounts.NewManager(ks)
-  testAccount, err := am.NewAccount("password")
-  if err != nil {
-    panic(err)
-  }
-  testAddress := strings.TrimPrefix(testAccount.Address.Hex(), "0x")
-
-  // set up mock genesis with balance on the testAddress
-  core.GenesisAccounts = []byte(`{
-  "` + testAddress + `": {"balance": "` + testBalance + `"}
-  }`)
-
-  // only use minimalistic stack with no networking
-  ethereum, err = eth.New(&eth.Config{
-    DataDir:        "/tmp/eth-natspec",
-    AccountManager: am,
-    MaxPeers:       0,
-  })
-
-  if err != nil {
-    panic(err)
-  }
-
-  return
-}
-
-func testInit(t *testing.T) (self *testFrontend) {
-  // initialise and start minimal ethereum stack
-  ethereum, err := testEth(t)
-  if err != nil {
-    t.Errorf("error creating ethereum: %v", err)
-    return
-  }
-  err = ethereum.Start()
-  if err != nil {
-    t.Errorf("error starting ethereum: %v", err)
-    return
-  }
-
-  // mock frontend
-  self = &testFrontend{t: t, ethereum: ethereum}
-  self.xeth = xe.New(ethereum, self)
-
-  addr, _ := ethereum.Etherbase()
-  self.coinbase = addr
-  self.stateDb = self.ethereum.ChainManager().State().Copy()
-
-  // initialise the registry contracts
-  reg := registrar.New(self.xeth)
-  err = reg.SetHashReg("", addr)
-  if err != nil {
-    t.Errorf("error creating HashReg: %v", err)
-  }
-  err = reg.SetUrlHint("", addr)
-  if err != nil {
-    t.Errorf("error creating UrlHint: %v", err)
-  }
-  self.applyTxs()
-
-  return
-
-}
-
-// this is needed for transaction to be applied to the state in testing
-// the heavy lifing is done in XEth.ApplyTestTxs
-// this is fragile,
-// and does process leaking since xeth loops cannot quit safely
-// should be replaced by proper mining with testDAG for easy full integration tests
-func (self *testFrontend) applyTxs() {
-  self.txc, self.xeth = self.xeth.ApplyTestTxs(self.stateDb, self.coinbase, self.txc)
-  return
-}
-
-// end to end test
-func TestNatspecE2E(t *testing.T) {
-  t.Skip()
-
-  tf := testInit(t)
-  defer tf.ethereum.Stop()
-
-  // create a contractInfo file (mock cloud-deployed contract metadocs)
-  // incidentally this is the info for the registry contract itself
-  ioutil.WriteFile("/tmp/"+testFileName, []byte(testContractInfo), os.ModePerm)
-  dochash := common.BytesToHash(crypto.Sha3([]byte(testContractInfo)))
-
-  // take the codehash for the contract we wanna test
-  // codehex := tf.xeth.CodeAt(registar.HashRegAddr)
-  codeb := tf.xeth.CodeAtBytes(registrar.HashRegAddr)
-  codehash := common.BytesToHash(crypto.Sha3(codeb))
-
-  // use resolver to register codehash->dochash->url
-  // test if globalregistry works
-  // registrar.HashRefAddr = "0x0"
-  // registrar.UrlHintAddr = "0x0"
-  reg := registrar.New(tf.xeth)
-  _, err := reg.SetHashToHash(tf.coinbase, codehash, dochash)
-  if err != nil {
-    t.Errorf("error registering: %v", err)
-  }
-  _, err = reg.SetUrlToHash(tf.coinbase, dochash, "file:///"+testFileName)
-  if err != nil {
-    t.Errorf("error registering: %v", err)
-  }
-  // apply txs to the state
-  tf.applyTxs()
-
-  // NatSpec info for register method of HashReg contract installed
-  // now using the same transactions to check confirm messages
-
-  tf.wantNatSpec = true // this is set so now the backend uses natspec confirmation
-  _, err = reg.SetHashToHash(tf.coinbase, codehash, dochash)
-  if err != nil {
-    t.Errorf("error calling contract registry: %v", err)
-  }
-
-  fmt.Printf("GlobalRegistrar: %v, HashReg: %v, UrlHint: %v\n", registrar.GlobalRegistrarAddr, registrar.HashRegAddr, registrar.UrlHintAddr)
-  if tf.lastConfirm != testExpNotice {
-    t.Errorf("Wrong confirm message. expected '%v', got '%v'", testExpNotice, tf.lastConfirm)
-  }
-
-  // test unknown method
-  exp := fmt.Sprintf(testExpNotice2, registrar.HashRegAddr)
-  _, err = reg.SetOwner(tf.coinbase)
-  if err != nil {
-    t.Errorf("error setting owner: %v", err)
-  }
-
-  if tf.lastConfirm != exp {
-    t.Errorf("Wrong confirm message, expected '%v', got '%v'", exp, tf.lastConfirm)
-  }
-
-  // test unknown contract
-  exp = fmt.Sprintf(testExpNotice3, registrar.UrlHintAddr)
-
-  _, err = reg.SetUrlToHash(tf.coinbase, dochash, "file:///test.content")
-  if err != nil {
-    t.Errorf("error registering: %v", err)
-  }
-
-  if tf.lastConfirm != exp {
-    t.Errorf("Wrong confirm message, expected '%v', got '%v'", exp, tf.lastConfirm)
-  }
-
-}
diff --git a/common/registrar/ethreg/api.go b/common/registrar/ethreg/api.go
index 1ba422c4d..79a6c2191 100644
--- a/common/registrar/ethreg/api.go
+++ b/common/registrar/ethreg/api.go
@@ -86,7 +86,7 @@ func (api *PrivateRegistarAPI) Register(sender common.Address, addr common.Addre
 	}
 
 	codeb := state.GetCode(addr)
-	codeHash := common.BytesToHash(crypto.Sha3(codeb))
+	codeHash := common.BytesToHash(crypto.Keccak256(codeb))
 	contentHash := common.HexToHash(contentHashHex)
 
 	_, err = registrar.New(api.be).SetHashToHash(sender, codeHash, contentHash)
diff --git a/common/registrar/registrar.go b/common/registrar/registrar.go
index 24e45edb3..0606f6985 100644
--- a/common/registrar/registrar.go
+++ b/common/registrar/registrar.go
@@ -68,7 +68,7 @@ const (
 )
 
 func abiSignature(s string) string {
-	return common.ToHex(crypto.Sha3([]byte(s))[:4])
+	return common.ToHex(crypto.Keccak256([]byte(s))[:4])
 }
 
 var (
@@ -401,7 +401,7 @@ func storageMapping(addr, key []byte) []byte {
 	data := make([]byte, 64)
 	copy(data[0:32], key[0:32])
 	copy(data[32:64], addr[0:32])
-	sha := crypto.Sha3(data)
+	sha := crypto.Keccak256(data)
 	return sha
 }
 
diff --git a/common/registrar/registrar_test.go b/common/registrar/registrar_test.go
index 68ee65ab4..b2287803c 100644
--- a/common/registrar/registrar_test.go
+++ b/common/registrar/registrar_test.go
@@ -31,7 +31,7 @@ type testBackend struct {
 var (
 	text     = "test"
 	codehash = common.StringToHash("1234")
-	hash     = common.BytesToHash(crypto.Sha3([]byte(text)))
+	hash     = common.BytesToHash(crypto.Keccak256([]byte(text)))
 	url      = "bzz://bzzhash/my/path/contr.act"
 )