aboutsummaryrefslogtreecommitdiffstats
path: root/core/types/dkg/dkg.go
blob: efe846755e713b0c98f1625bcd5d5fd1141a5b75 (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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 dexon-consensus 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 dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package dkg

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"

    "github.com/dexon-foundation/dexon/rlp"

    "github.com/dexon-foundation/dexon-consensus/common"
    "github.com/dexon-foundation/dexon-consensus/core/crypto"
    cryptoDKG "github.com/dexon-foundation/dexon-consensus/core/crypto/dkg"
    "github.com/dexon-foundation/dexon-consensus/core/types"
)

// NewID creates a DKGID from NodeID.
func NewID(ID types.NodeID) cryptoDKG.ID {
    return cryptoDKG.NewID(ID.Hash[:])
}

// PrivateShare describe a secret share in DKG protocol.
type PrivateShare struct {
    ProposerID   types.NodeID         `json:"proposer_id"`
    ReceiverID   types.NodeID         `json:"receiver_id"`
    Round        uint64               `json:"round"`
    PrivateShare cryptoDKG.PrivateKey `json:"private_share"`
    Signature    crypto.Signature     `json:"signature"`
}

// Equal checks equality between two PrivateShare instances.
func (p *PrivateShare) Equal(other *PrivateShare) bool {
    return p.ProposerID.Equal(other.ProposerID) &&
        p.ReceiverID.Equal(other.ReceiverID) &&
        p.Round == other.Round &&
        p.Signature.Type == other.Signature.Type &&
        bytes.Compare(p.Signature.Signature, other.Signature.Signature) == 0 &&
        bytes.Compare(
            p.PrivateShare.Bytes(), other.PrivateShare.Bytes()) == 0
}

// MasterPublicKey decrtibe a master public key in DKG protocol.
type MasterPublicKey struct {
    ProposerID      types.NodeID              `json:"proposer_id"`
    Round           uint64                    `json:"round"`
    DKGID           cryptoDKG.ID              `json:"dkg_id"`
    PublicKeyShares cryptoDKG.PublicKeyShares `json:"public_key_shares"`
    Signature       crypto.Signature          `json:"signature"`
}

func (d *MasterPublicKey) String() string {
    return fmt.Sprintf("MasterPublicKey{KP:%s Round:%d}",
        d.ProposerID.String()[:6],
        d.Round)
}

// Equal check equality of two DKG master public keys.
func (d *MasterPublicKey) Equal(other *MasterPublicKey) bool {
    return d.ProposerID.Equal(other.ProposerID) &&
        d.Round == other.Round &&
        d.DKGID.GetHexString() == other.DKGID.GetHexString() &&
        d.PublicKeyShares.Equal(&other.PublicKeyShares) &&
        d.Signature.Type == other.Signature.Type &&
        bytes.Compare(d.Signature.Signature, other.Signature.Signature) == 0
}

type rlpMasterPublicKey struct {
    ProposerID      types.NodeID
    Round           uint64
    DKGID           []byte
    PublicKeyShares *cryptoDKG.PublicKeyShares
    Signature       crypto.Signature
}

// EncodeRLP implements rlp.Encoder
func (d *MasterPublicKey) EncodeRLP(w io.Writer) error {
    return rlp.Encode(w, rlpMasterPublicKey{
        ProposerID:      d.ProposerID,
        Round:           d.Round,
        DKGID:           d.DKGID.GetLittleEndian(),
        PublicKeyShares: &d.PublicKeyShares,
        Signature:       d.Signature,
    })
}

// DecodeRLP implements rlp.Decoder
func (d *MasterPublicKey) DecodeRLP(s *rlp.Stream) error {
    var dec rlpMasterPublicKey
    if err := s.Decode(&dec); err != nil {
        return err
    }

    id, err := cryptoDKG.BytesID(dec.DKGID)
    if err != nil {
        return err
    }

    *d = MasterPublicKey{
        ProposerID:      dec.ProposerID,
        Round:           dec.Round,
        DKGID:           id,
        PublicKeyShares: *dec.PublicKeyShares,
        Signature:       dec.Signature,
    }
    return err
}

// NewMasterPublicKey returns a new MasterPublicKey instance.
func NewMasterPublicKey() *MasterPublicKey {
    return &MasterPublicKey{
        PublicKeyShares: *cryptoDKG.NewEmptyPublicKeyShares(),
    }
}

// UnmarshalJSON implements json.Unmarshaller.
func (d *MasterPublicKey) UnmarshalJSON(data []byte) error {
    type innertMasterPublicKey MasterPublicKey
    d.PublicKeyShares = *cryptoDKG.NewEmptyPublicKeyShares()
    return json.Unmarshal(data, (*innertMasterPublicKey)(d))
}

// Complaint describe a complaint in DKG protocol.
type Complaint struct {
    ProposerID   types.NodeID     `json:"proposer_id"`
    Round        uint64           `json:"round"`
    PrivateShare PrivateShare     `json:"private_share"`
    Signature    crypto.Signature `json:"signature"`
}

func (c *Complaint) String() string {
    if c.IsNack() {
        return fmt.Sprintf("DKGNackComplaint{CP:%s Round:%d PSP:%s}",
            c.ProposerID.String()[:6], c.Round,
            c.PrivateShare.ProposerID.String()[:6])
    }
    return fmt.Sprintf("DKGComplaint{CP:%s Round:%d PrivateShare:%v}",
        c.ProposerID.String()[:6], c.Round, c.PrivateShare)
}

// Equal checks equality between two Complaint instances.
func (c *Complaint) Equal(other *Complaint) bool {
    return c.ProposerID.Equal(other.ProposerID) &&
        c.Round == other.Round &&
        c.PrivateShare.Equal(&other.PrivateShare) &&
        c.Signature.Type == other.Signature.Type &&
        bytes.Compare(c.Signature.Signature, other.Signature.Signature) == 0
}

// PartialSignature describe a partial signature in DKG protocol.
type PartialSignature struct {
    ProposerID       types.NodeID               `json:"proposer_id"`
    Round            uint64                     `json:"round"`
    Hash             common.Hash                `json:"hash"`
    PartialSignature cryptoDKG.PartialSignature `json:"partial_signature"`
    Signature        crypto.Signature           `json:"signature"`
}

// MPKReady describe a dig ready message in DKG protocol.
type MPKReady struct {
    ProposerID types.NodeID     `json:"proposer_id"`
    Round      uint64           `json:"round"`
    Signature  crypto.Signature `json:"signature"`
}

func (ready *MPKReady) String() string {
    return fmt.Sprintf("DKGMPKReady{RP:%s Round:%d}",
        ready.ProposerID.String()[:6],
        ready.Round)
}

// Equal check equality of two MPKReady instances.
func (ready *MPKReady) Equal(other *MPKReady) bool {
    return ready.ProposerID.Equal(other.ProposerID) &&
        ready.Round == other.Round &&
        ready.Signature.Type == other.Signature.Type &&
        bytes.Compare(ready.Signature.Signature, other.Signature.Signature) == 0
}

// Finalize describe a dig finalize message in DKG protocol.
type Finalize struct {
    ProposerID types.NodeID     `json:"proposer_id"`
    Round      uint64           `json:"round"`
    Signature  crypto.Signature `json:"signature"`
}

func (final *Finalize) String() string {
    return fmt.Sprintf("DKGFinal{FP:%s Round:%d}",
        final.ProposerID.String()[:6],
        final.Round)
}

// Equal check equality of two Finalize instances.
func (final *Finalize) Equal(other *Finalize) bool {
    return final.ProposerID.Equal(other.ProposerID) &&
        final.Round == other.Round &&
        final.Signature.Type == other.Signature.Type &&
        bytes.Compare(final.Signature.Signature, other.Signature.Signature) == 0
}

// IsNack returns true if it's a nack complaint in DKG protocol.
func (c *Complaint) IsNack() bool {
    return len(c.PrivateShare.Signature.Signature) == 0
}