forked from ethereum/go-ethereum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
whisper/whisperv6: initial commit (clone of v5) (ethereum#15324)
- Loading branch information
Showing
18 changed files
with
5,589 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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,206 @@ | ||
// Copyright 2016 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU Lesser General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// The go-ethereum library 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 Lesser General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU Lesser General Public License | ||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
package whisperv6 | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/ethereum/go-ethereum/crypto" | ||
) | ||
|
||
func BenchmarkDeriveKeyMaterial(b *testing.B) { | ||
for i := 0; i < b.N; i++ { | ||
deriveKeyMaterial([]byte("test"), 0) | ||
} | ||
} | ||
|
||
func BenchmarkEncryptionSym(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg, _ := NewSentMessage(params) | ||
_, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Errorf("failed Wrap with seed %d: %s.", seed, err) | ||
b.Errorf("i = %d, len(msg.Raw) = %d, params.Payload = %d.", i, len(msg.Raw), len(params.Payload)) | ||
return | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkEncryptionAsym(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
key, err := crypto.GenerateKey() | ||
if err != nil { | ||
b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err) | ||
} | ||
params.KeySym = nil | ||
params.Dst = &key.PublicKey | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg, _ := NewSentMessage(params) | ||
_, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkDecryptionSymValid(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
msg, _ := NewSentMessage(params) | ||
env, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
f := Filter{KeySym: params.KeySym} | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg := env.Open(&f) | ||
if msg == nil { | ||
b.Fatalf("failed to open with seed %d.", seed) | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkDecryptionSymInvalid(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
msg, _ := NewSentMessage(params) | ||
env, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
f := Filter{KeySym: []byte("arbitrary stuff here")} | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg := env.Open(&f) | ||
if msg != nil { | ||
b.Fatalf("opened envelope with invalid key, seed: %d.", seed) | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkDecryptionAsymValid(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
key, err := crypto.GenerateKey() | ||
if err != nil { | ||
b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err) | ||
} | ||
f := Filter{KeyAsym: key} | ||
params.KeySym = nil | ||
params.Dst = &key.PublicKey | ||
msg, _ := NewSentMessage(params) | ||
env, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg := env.Open(&f) | ||
if msg == nil { | ||
b.Fatalf("fail to open, seed: %d.", seed) | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkDecryptionAsymInvalid(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
key, err := crypto.GenerateKey() | ||
if err != nil { | ||
b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err) | ||
} | ||
params.KeySym = nil | ||
params.Dst = &key.PublicKey | ||
msg, _ := NewSentMessage(params) | ||
env, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
|
||
key, err = crypto.GenerateKey() | ||
if err != nil { | ||
b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err) | ||
} | ||
f := Filter{KeyAsym: key} | ||
|
||
for i := 0; i < b.N; i++ { | ||
msg := env.Open(&f) | ||
if msg != nil { | ||
b.Fatalf("opened envelope with invalid key, seed: %d.", seed) | ||
} | ||
} | ||
} | ||
|
||
func increment(x []byte) { | ||
for i := 0; i < len(x); i++ { | ||
x[i]++ | ||
if x[i] != 0 { | ||
break | ||
} | ||
} | ||
} | ||
|
||
func BenchmarkPoW(b *testing.B) { | ||
InitSingleTest() | ||
|
||
params, err := generateMessageParams() | ||
if err != nil { | ||
b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err) | ||
} | ||
params.Payload = make([]byte, 32) | ||
params.PoW = 10.0 | ||
params.TTL = 1 | ||
|
||
for i := 0; i < b.N; i++ { | ||
increment(params.Payload) | ||
msg, _ := NewSentMessage(params) | ||
_, err := msg.Wrap(params) | ||
if err != nil { | ||
b.Fatalf("failed Wrap with seed %d: %s.", seed, err) | ||
} | ||
} | ||
} |
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,27 @@ | ||
// Copyright 2017 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU Lesser General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// The go-ethereum library 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 Lesser General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU Lesser General Public License | ||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
package whisperv6 | ||
|
||
type Config struct { | ||
MaxMessageSize uint32 `toml:",omitempty"` | ||
MinimumAcceptedPOW float64 `toml:",omitempty"` | ||
} | ||
|
||
var DefaultConfig = Config{ | ||
MaxMessageSize: DefaultMaxMessageSize, | ||
MinimumAcceptedPOW: DefaultMinimumPoW, | ||
} |
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,87 @@ | ||
// Copyright 2016 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU Lesser General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// The go-ethereum library 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 Lesser General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU Lesser General Public License | ||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/* | ||
Package whisper implements the Whisper protocol (version 6). | ||
Whisper combines aspects of both DHTs and datagram messaging systems (e.g. UDP). | ||
As such it may be likened and compared to both, not dissimilar to the | ||
matter/energy duality (apologies to physicists for the blatant abuse of a | ||
fundamental and beautiful natural principle). | ||
Whisper is a pure identity-based messaging system. Whisper provides a low-level | ||
(non-application-specific) but easily-accessible API without being based upon | ||
or prejudiced by the low-level hardware attributes and characteristics, | ||
particularly the notion of singular endpoints. | ||
*/ | ||
package whisperv6 | ||
|
||
import ( | ||
"fmt" | ||
"time" | ||
) | ||
|
||
const ( | ||
EnvelopeVersion = uint64(0) | ||
ProtocolVersion = uint64(5) | ||
ProtocolVersionStr = "5.0" | ||
ProtocolName = "shh" | ||
|
||
statusCode = 0 // used by whisper protocol | ||
messagesCode = 1 // normal whisper message | ||
p2pCode = 2 // peer-to-peer message (to be consumed by the peer, but not forwarded any further) | ||
p2pRequestCode = 3 // peer-to-peer message, used by Dapp protocol | ||
NumberOfMessageCodes = 64 | ||
|
||
paddingMask = byte(3) | ||
signatureFlag = byte(4) | ||
|
||
TopicLength = 4 | ||
signatureLength = 65 | ||
aesKeyLength = 32 | ||
AESNonceLength = 12 | ||
keyIdSize = 32 | ||
|
||
MaxMessageSize = uint32(10 * 1024 * 1024) // maximum accepted size of a message. | ||
DefaultMaxMessageSize = uint32(1024 * 1024) | ||
DefaultMinimumPoW = 0.2 | ||
|
||
padSizeLimit = 256 // just an arbitrary number, could be changed without breaking the protocol (must not exceed 2^24) | ||
messageQueueLimit = 1024 | ||
|
||
expirationCycle = time.Second | ||
transmissionCycle = 300 * time.Millisecond | ||
|
||
DefaultTTL = 50 // seconds | ||
SynchAllowance = 10 // seconds | ||
) | ||
|
||
type unknownVersionError uint64 | ||
|
||
func (e unknownVersionError) Error() string { | ||
return fmt.Sprintf("invalid envelope version %d", uint64(e)) | ||
} | ||
|
||
// MailServer represents a mail server, capable of | ||
// archiving the old messages for subsequent delivery | ||
// to the peers. Any implementation must ensure that both | ||
// functions are thread-safe. Also, they must return ASAP. | ||
// DeliverMail should use directMessagesCode for delivery, | ||
// in order to bypass the expiry checks. | ||
type MailServer interface { | ||
Archive(env *Envelope) | ||
DeliverMail(whisperPeer *Peer, request *Envelope) | ||
} |
Oops, something went wrong.