-
Notifications
You must be signed in to change notification settings - Fork 176
/
validator.go
346 lines (312 loc) · 15.9 KB
/
validator.go
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
package validator
import (
"errors"
"fmt"
"github.com/onflow/flow-go/consensus/hotstuff"
"github.com/onflow/flow-go/consensus/hotstuff/model"
"github.com/onflow/flow-go/model/flow"
"github.com/onflow/flow-go/module/signature"
)
// Validator is responsible for validating QC, Block and Vote
type Validator struct {
committee hotstuff.Replicas
verifier hotstuff.Verifier
}
var _ hotstuff.Validator = (*Validator)(nil)
// New creates a new Validator instance
func New(
committee hotstuff.Replicas,
verifier hotstuff.Verifier,
) *Validator {
return &Validator{
committee: committee,
verifier: verifier,
}
}
// ValidateTC validates the TimeoutCertificate `TC`.
// During normal operations, the following error returns are expected:
// - model.InvalidTCError if the TC is invalid
// - model.ErrViewForUnknownEpoch if the TC refers unknown epoch
//
// Any other error should be treated as exception
func (v *Validator) ValidateTC(tc *flow.TimeoutCertificate) error {
newestQC := tc.NewestQC
if newestQC == nil {
return newInvalidTCError(tc, fmt.Errorf("TC must include a QC but found nil"))
}
// The TC's view cannot be smaller than the view of the QC it contains.
// Note: we specifically allow for the TC to have the same view as the highest QC.
// This is useful as a fallback, because it allows replicas other than the designated
// leader to also collect votes and generate a QC.
if tc.View < newestQC.View {
return newInvalidTCError(tc, fmt.Errorf("TC's QC cannot be newer than the TC's view"))
}
// 1. Check if there is super-majority of votes
allParticipants, err := v.committee.IdentitiesByEpoch(tc.View)
if err != nil {
return fmt.Errorf("could not get consensus participants at view %d: %w", tc.View, err)
}
signers, err := signature.DecodeSignerIndicesToIdentities(allParticipants, tc.SignerIndices)
if err != nil {
if signature.IsInvalidSignerIndicesError(err) {
return newInvalidTCError(tc, fmt.Errorf("invalid signer indices: %w", err))
}
// unexpected error
return fmt.Errorf("unexpected internal error decoding signer indices: %w", err)
}
// determine whether signers reach minimally required weight threshold for consensus
threshold, err := v.committee.QuorumThresholdForView(tc.View)
if err != nil {
return fmt.Errorf("could not get weight threshold for view %d: %w", tc.View, err)
}
if signers.TotalWeight() < threshold {
return newInvalidTCError(tc, fmt.Errorf("tc signers have insufficient weight of %d (required=%d)", signers.TotalWeight(), threshold))
}
// Verify multi-message BLS sig of TC, by far the most expensive check
err = v.verifier.VerifyTC(signers, tc.SigData, tc.View, tc.NewestQCViews)
if err != nil {
// Considerations about other errors that `VerifyTC` could return:
// * model.InsufficientSignaturesError: we previously checked the total weight of all signers
// meets the supermajority threshold, which is a _positive_ number. Hence, there must be at
// least one signer. Hence, receiving this error would be a symptom of a fatal internal bug.
switch {
case model.IsInvalidFormatError(err):
return newInvalidTCError(tc, fmt.Errorf("TC's signature data has an invalid structure: %w", err))
case errors.Is(err, model.ErrInvalidSignature):
return newInvalidTCError(tc, fmt.Errorf("TC contains invalid signature(s): %w", err))
default:
return fmt.Errorf("cannot verify tc's aggregated signature (tc.View: %d): %w", tc.View, err)
}
}
// verifying that tc.NewestQC is the QC with the highest view.
// Note: A byzantine TC could include `nil` for tc.NewestQCViews, in which case `tc.NewestQCViews[0]`
// would panic. Though, per API specification `verifier.VerifyTC(…)` should return a `model.InvalidFormatError`
// if `signers` and `tc.NewestQCViews` have different length. Hence, the following code is safe only if it is executed
// 1. _after_ checking the quorum threshold (thereby we guarantee that `signers` is not empty); and
// 2. _after_ `verifier.VerifyTC(…)`, which enforces that `signers` and `tc.NewestQCViews` have identical length.
// Only then we can be sure that `tc.NewestQCViews` cannot be nil.
newestQCView := tc.NewestQCViews[0]
for _, view := range tc.NewestQCViews {
if newestQCView < view {
newestQCView = view
}
}
if newestQCView > tc.NewestQC.View {
return newInvalidTCError(tc, fmt.Errorf("included QC (view=%d) should be equal or higher to highest contributed view: %d", tc.NewestQC.View, newestQCView))
}
// Validate QC
err = v.ValidateQC(newestQC)
if err != nil {
if model.IsInvalidQCError(err) {
return newInvalidTCError(tc, fmt.Errorf("invalid QC included in TC: %w", err))
}
if errors.Is(err, model.ErrViewForUnknownEpoch) {
// We require each replica to be bootstrapped with a QC pointing to a finalized block. Consensus safety rules guarantee that
// a QC at least as new as the root QC must be contained in any TC. This is because the TC must include signatures from a
// supermajority of replicas, including at least one honest replica, which attest to their locally highest known QC. Hence,
// any QC included in a TC must be the root QC or newer. Therefore, we should know the Epoch for any QC we encounter.
// receiving a `model.ErrViewForUnknownEpoch` is conceptually impossible, i.e. a symptom of an internal bug or invalid
// bootstrapping information.
return fmt.Errorf("no Epoch information availalbe for QC that was included in TC; symptom of internal bug or invalid bootstrapping information: %s", err.Error())
}
return fmt.Errorf("unexpected internal error while verifying the QC included in the TC: %w", err)
}
return nil
}
// ValidateQC validates the Quorum Certificate `qc`.
// During normal operations, the following error returns are expected:
// - model.InvalidQCError if the QC is invalid
// - model.ErrViewForUnknownEpoch if the QC refers unknown epoch
//
// Any other error should be treated as exception
func (v *Validator) ValidateQC(qc *flow.QuorumCertificate) error {
// Retrieve the initial identities of consensus participants for this epoch,
// and those that signed the QC. IdentitiesByEpoch contains all nodes that were
// authorized to sign during this epoch. Ejection and dynamic weight adjustments
// are not taken into account here. By using an epoch-static set of authorized
// signers, we can check QC validity without needing all ancestor blocks.
allParticipants, err := v.committee.IdentitiesByEpoch(qc.View)
if err != nil {
return fmt.Errorf("could not get consensus participants at view %d: %w", qc.View, err)
}
signers, err := signature.DecodeSignerIndicesToIdentities(allParticipants, qc.SignerIndices)
if err != nil {
if signature.IsInvalidSignerIndicesError(err) {
return newInvalidQCError(qc, fmt.Errorf("invalid signer indices: %w", err))
}
// unexpected error
return fmt.Errorf("unexpected internal error decoding signer indices: %w", err)
}
// determine whether signers reach minimally required weight threshold for consensus
threshold, err := v.committee.QuorumThresholdForView(qc.View)
if err != nil {
return fmt.Errorf("could not get weight threshold for view %d: %w", qc.View, err)
}
if signers.TotalWeight() < threshold {
return newInvalidQCError(qc, fmt.Errorf("QC signers have insufficient weight of %d (required=%d)", signers.TotalWeight(), threshold))
}
// verify whether the signature bytes are valid for the QC
err = v.verifier.VerifyQC(signers, qc.SigData, qc.View, qc.BlockID)
if err != nil {
// Considerations about other errors that `VerifyQC` could return:
// * model.InvalidSignerError: for the time being, we assume that _every_ HotStuff participant
// is also a member of the random beacon committee. Consequently, `InvalidSignerError` should
// not occur atm.
// TODO: if the random beacon committee is a strict subset of the HotStuff committee,
// we expect `model.InvalidSignerError` here during normal operations.
// * model.InsufficientSignaturesError: we previously checked the total weight of all signers
// meets the supermajority threshold, which is a _positive_ number. Hence, there must be at
// least one signer. Hence, receiving this error would be a symptom of a fatal internal bug.
switch {
case model.IsInvalidFormatError(err):
return newInvalidQCError(qc, fmt.Errorf("QC's signature data has an invalid structure: %w", err))
case errors.Is(err, model.ErrInvalidSignature):
return newInvalidQCError(qc, fmt.Errorf("QC contains invalid signature(s): %w", err))
case errors.Is(err, model.ErrViewForUnknownEpoch):
// We have earlier queried the Identities for the QC's view, which must have returned proper values,
// otherwise, we wouldn't reach this code. Therefore, it should be impossible for `verifier.VerifyQC`
// to return ErrViewForUnknownEpoch. To avoid confusion with expected sentinel errors, we only preserve
// the error messages here, but not the error types.
return fmt.Errorf("internal error, as querying identities for view %d succeeded earlier but now the view supposedly belongs to an unknown epoch: %s", qc.View, err.Error())
default:
return fmt.Errorf("cannot verify qc's aggregated signature (qc.BlockID: %x): %w", qc.BlockID, err)
}
}
return nil
}
// ValidateProposal validates the block proposal
// A block is considered as valid if it's a valid extension of existing forks.
// Note it doesn't check if it's conflicting with finalized block
// During normal operations, the following error returns are expected:
// - model.InvalidProposalError if the block is invalid
// - model.ErrViewForUnknownEpoch if the proposal refers unknown epoch
//
// Any other error should be treated as exception
func (v *Validator) ValidateProposal(proposal *model.Proposal) error {
qc := proposal.Block.QC
block := proposal.Block
// validate the proposer's vote and get his identity
_, err := v.ValidateVote(proposal.ProposerVote())
if model.IsInvalidVoteError(err) {
return model.NewInvalidProposalErrorf(proposal, "invalid proposer signature: %w", err)
}
if err != nil {
return fmt.Errorf("error verifying leader signature for block %x: %w", block.BlockID, err)
}
// check the proposer is the leader for the proposed block's view
leader, err := v.committee.LeaderForView(block.View)
if err != nil {
return fmt.Errorf("error determining leader for block %x: %w", block.BlockID, err)
}
if leader != block.ProposerID {
return model.NewInvalidProposalErrorf(proposal, "proposer %s is not leader (%s) for view %d", block.ProposerID, leader, block.View)
}
// The Block must contain a proof that the primary legitimately entered the respective view.
// Transitioning to proposal.Block.View is possible either by observing a QC or a TC for the
// previous round. If and only if the QC is _not_ for the previous round we require a TC for
// the previous view to be present.
lastViewSuccessful := proposal.Block.View == proposal.Block.QC.View+1
if !lastViewSuccessful {
// check if proposal is correctly structured
if proposal.LastViewTC == nil {
return model.NewInvalidProposalErrorf(proposal, "QC in block is not for previous view, so expecting a TC but none is included in block")
}
// check if included TC is for previous view
if proposal.Block.View != proposal.LastViewTC.View+1 {
return model.NewInvalidProposalErrorf(proposal, "QC in block is not for previous view, so expecting a TC for view %d but got TC for view %d", proposal.Block.View-1, proposal.LastViewTC.View)
}
// Check if proposal extends either the newest QC specified in the TC, or a newer QC
// in edge cases a leader may construct a TC and QC concurrently such that TC contains
// an older QC - in these case we still want to build on the newest QC, so this case is allowed.
if proposal.Block.QC.View < proposal.LastViewTC.NewestQC.View {
return model.NewInvalidProposalErrorf(proposal, "TC in block contains a newer QC than the block itself, which is a protocol violation")
}
} else if proposal.LastViewTC != nil {
// last view ended with QC, including TC is a protocol violation
return model.NewInvalidProposalErrorf(proposal, "last view has ended with QC but proposal includes LastViewTC")
}
// Check signatures, keep the most expensive the last to check
// check if included QC is valid
err = v.ValidateQC(qc)
if err != nil {
if model.IsInvalidQCError(err) {
return model.NewInvalidProposalErrorf(proposal, "invalid qc included: %w", err)
}
if errors.Is(err, model.ErrViewForUnknownEpoch) {
// We require each replica to be bootstrapped with a QC pointing to a finalized block. Therefore, we should know the
// Epoch for any QC.View and TC.View we encounter. Receiving a `model.ErrViewForUnknownEpoch` is conceptually impossible,
// i.e. a symptom of an internal bug or invalid bootstrapping information.
return fmt.Errorf("no Epoch information availalbe for QC that was included in proposal; symptom of internal bug or invalid bootstrapping information: %s", err.Error())
}
return fmt.Errorf("unexpected error verifying qc: %w", err)
}
if !lastViewSuccessful {
// check if included TC is valid
err = v.ValidateTC(proposal.LastViewTC)
if err != nil {
if model.IsInvalidTCError(err) {
return model.NewInvalidProposalErrorf(proposal, "proposals TC's is not valid: %w", err)
}
if errors.Is(err, model.ErrViewForUnknownEpoch) {
// We require each replica to be bootstrapped with a QC pointing to a finalized block. Therefore, we should know the
// Epoch for any QC.View and TC.View we encounter. Receiving a `model.ErrViewForUnknownEpoch` is conceptually impossible,
// i.e. a symptom of an internal bug or invalid bootstrapping information.
return fmt.Errorf("no Epoch information availalbe for QC that was included in TC; symptom of internal bug or invalid bootstrapping information: %s", err.Error())
}
return fmt.Errorf("unexpected internal error while verifying the TC included in block: %w", err)
}
}
return nil
}
// ValidateVote validates the vote and returns the identity of the voter who signed
// vote - the vote to be validated
// During normal operations, the following error returns are expected:
// - model.InvalidVoteError for invalid votes
// - model.ErrViewForUnknownEpoch if the vote refers unknown epoch
//
// Any other error should be treated as exception
func (v *Validator) ValidateVote(vote *model.Vote) (*flow.IdentitySkeleton, error) {
voter, err := v.committee.IdentityByEpoch(vote.View, vote.SignerID)
if model.IsInvalidSignerError(err) {
return nil, newInvalidVoteError(vote, err)
}
if err != nil {
return nil, fmt.Errorf("error retrieving voter Identity at view %d: %w", vote.View, err)
}
// check whether the signature data is valid for the vote in the hotstuff context
err = v.verifier.VerifyVote(voter, vote.SigData, vote.View, vote.BlockID)
if err != nil {
// Theoretically, `VerifyVote` could also return a `model.InvalidSignerError`. However,
// for the time being, we assume that _every_ HotStuff participant is also a member of
// the random beacon committee. Consequently, `InvalidSignerError` should not occur atm.
// TODO: if the random beacon committee is a strict subset of the HotStuff committee,
// we expect `model.InvalidSignerError` here during normal operations.
if model.IsInvalidFormatError(err) || errors.Is(err, model.ErrInvalidSignature) {
return nil, newInvalidVoteError(vote, err)
}
if errors.Is(err, model.ErrViewForUnknownEpoch) {
return nil, fmt.Errorf("no Epoch information availalbe for vote; symptom of internal bug or invalid bootstrapping information: %s", err.Error())
}
return nil, fmt.Errorf("cannot verify signature for vote (%x): %w", vote.ID(), err)
}
return voter, nil
}
func newInvalidQCError(qc *flow.QuorumCertificate, err error) error {
return model.InvalidQCError{
BlockID: qc.BlockID,
View: qc.View,
Err: err,
}
}
func newInvalidTCError(tc *flow.TimeoutCertificate, err error) error {
return model.InvalidTCError{
View: tc.View,
Err: err,
}
}
func newInvalidVoteError(vote *model.Vote, err error) error {
return model.InvalidVoteError{
Vote: vote,
Err: err,
}
}