aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/pss/types.go
blob: 1e33ecdcacf0620db9eb9404244e7367f178ba2c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
// Copyright 2018 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 pss

import (
    "encoding/json"
    "fmt"
    "sync"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/hexutil"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/ethereum/go-ethereum/swarm/storage"
    whisper "github.com/ethereum/go-ethereum/whisper/whisperv5"
)

const (
    defaultWhisperTTL = 6000
)

const (
    pssControlSym = 1
    pssControlRaw = 1 << 1
)

var (
    topicHashMutex = sync.Mutex{}
    topicHashFunc  = storage.MakeHashFunc("SHA256")()
    rawTopic       = Topic{}
)

// Topic is the PSS encapsulation of the Whisper topic type
type Topic whisper.TopicType

func (t *Topic) String() string {
    return hexutil.Encode(t[:])
}

// MarshalJSON implements the json.Marshaler interface
func (t Topic) MarshalJSON() (b []byte, err error) {
    return json.Marshal(t.String())
}

// MarshalJSON implements the json.Marshaler interface
func (t *Topic) UnmarshalJSON(input []byte) error {
    topicbytes, err := hexutil.Decode(string(input[1 : len(input)-1]))
    if err != nil {
        return err
    }
    copy(t[:], topicbytes)
    return nil
}

// PssAddress is an alias for []byte. It represents a variable length address
type PssAddress []byte

// MarshalJSON implements the json.Marshaler interface
func (a PssAddress) MarshalJSON() ([]byte, error) {
    return json.Marshal(hexutil.Encode(a[:]))
}

// UnmarshalJSON implements the json.Marshaler interface
func (a *PssAddress) UnmarshalJSON(input []byte) error {
    b, err := hexutil.Decode(string(input[1 : len(input)-1]))
    if err != nil {
        return err
    }
    for _, bb := range b {
        *a = append(*a, bb)
    }
    return nil
}

// holds the digest of a message used for caching
type pssDigest [digestLength]byte

// conceals bitwise operations on the control flags byte
type msgParams struct {
    raw bool
    sym bool
}

func newMsgParamsFromBytes(paramBytes []byte) *msgParams {
    if len(paramBytes) != 1 {
        return nil
    }
    return &msgParams{
        raw: paramBytes[0]&pssControlRaw > 0,
        sym: paramBytes[0]&pssControlSym > 0,
    }
}

func (m *msgParams) Bytes() (paramBytes []byte) {
    var b byte
    if m.raw {
        b |= pssControlRaw
    }
    if m.sym {
        b |= pssControlSym
    }
    paramBytes = append(paramBytes, b)
    return paramBytes
}

// PssMsg encapsulates messages transported over pss.
type PssMsg struct {
    To      []byte
    Control []byte
    Expire  uint32
    Payload *whisper.Envelope
}

func newPssMsg(param *msgParams) *PssMsg {
    return &PssMsg{
        Control: param.Bytes(),
    }
}

// message is flagged as raw / external encryption
func (msg *PssMsg) isRaw() bool {
    return msg.Control[0]&pssControlRaw > 0
}

// message is flagged as symmetrically encrypted
func (msg *PssMsg) isSym() bool {
    return msg.Control[0]&pssControlSym > 0
}

// serializes the message for use in cache
func (msg *PssMsg) serialize() []byte {
    rlpdata, _ := rlp.EncodeToBytes(struct {
        To      []byte
        Payload *whisper.Envelope
    }{
        To:      msg.To,
        Payload: msg.Payload,
    })
    return rlpdata
}

// String representation of PssMsg
func (msg *PssMsg) String() string {
    return fmt.Sprintf("PssMsg: Recipient: %x", common.ToHex(msg.To))
}

// Signature for a message handler function for a PssMsg
//
// Implementations of this type are passed to Pss.Register together with a topic,
type Handler func(msg []byte, p *p2p.Peer, asymmetric bool, keyid string) error

// the stateStore handles saving and loading PSS peers and their corresponding keys
// it is currently unimplemented
type stateStore struct {
    values map[string][]byte
}

func newStateStore() *stateStore {
    return &stateStore{values: make(map[string][]byte)}
}

func (store *stateStore) Load(key string) ([]byte, error) {
    return nil, nil
}

func (store *stateStore) Save(key string, v []byte) error {
    return nil
}

// BytesToTopic hashes an arbitrary length byte slice and truncates it to the length of a topic, using only the first bytes of the digest
func BytesToTopic(b []byte) Topic {
    topicHashMutex.Lock()
    defer topicHashMutex.Unlock()
    topicHashFunc.Reset()
    topicHashFunc.Write(b)
    return Topic(whisper.BytesToTopic(topicHashFunc.Sum(nil)))
}