Skip to content

Commit

Permalink
Validate churner request (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
mooselumph authored Nov 14, 2023
1 parent b98b2d3 commit 8870629
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 16 deletions.
6 changes: 5 additions & 1 deletion churner/churner.go
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,11 @@ func (c *churner) getOperatorsToChurn(ctx context.Context, quorumIDs []uint8, op
return nil, nil
}

if operatorSetParams.MaxOperatorCount != uint32(len(operatorStakes[i])) {
if operatorSetParams.MaxOperatorCount == 0 {
return nil, errors.New("maxOperatorCount is 0")
}

if uint32(len(operatorStakes[i])) < operatorSetParams.MaxOperatorCount {
// quorum is not full, so we can continue
continue
}
Expand Down
1 change: 1 addition & 0 deletions churner/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const (
FailReasonPrevApprovalNotExpired FailReason = "prev_approval_not_expired" // Expiry: previous approval hasn't expired
FailReasonInvalidSignature FailReason = "invalid_signature" // Invalid signature: operator's signature is wong
FailReasonProcessChurnRequestFailed FailReason = "failed_process_churn_request" // Failed to process churn request
FailReasonInvalidRequest FailReason = "invalid_request" // Invalid request: request is malformed
)

type MetricsConfig struct {
Expand Down
61 changes: 47 additions & 14 deletions churner/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ func (s *Server) Start(metricsConfig MetricsConfig) error {
}

func (s *Server) Churn(ctx context.Context, req *pb.ChurnRequest) (*pb.ChurnReply, error) {

err := s.validateChurnRequest(ctx, req)
if err != nil {
s.metrics.IncrementFailedRequestNum("Churn", FailReasonInvalidRequest)
return nil, fmt.Errorf("invalid request: %w", err)
}

timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
s.metrics.ObserveLatency("Churn", f*1000) // make milliseconds
}))
Expand All @@ -64,20 +71,6 @@ func (s *Server) Churn(ctx context.Context, req *pb.ChurnRequest) (*pb.ChurnRepl
return nil, fmt.Errorf("previous approval not expired, retry in %d", s.latestExpiry-now.Unix())
}

for quorumID := range req.GetQuorumIds() {
if quorumID >= int(s.churner.QuorumCount) {
err := s.churner.UpdateQuorumCount(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get onchain quorum count: %w", err)
}

if quorumID >= int(s.churner.QuorumCount) {
s.metrics.IncrementFailedRequestNum("Churn", FailReasonQuorumIdOutOfRange)
return nil, fmt.Errorf("Invalid request: the quorum_id must be in range [0, %d], but found %d", s.churner.QuorumCount-1, quorumID)
}
}
}

request := createChurnRequest(req)

operatorToRegisterAddress, err := s.churner.VerifyRequestSignature(ctx, request)
Expand Down Expand Up @@ -125,6 +118,46 @@ func (s *Server) checkShouldBeRateLimited(now time.Time, request ChurnRequest) e
return nil
}

func (s *Server) validateChurnRequest(ctx context.Context, req *pb.ChurnRequest) error {

if len(req.OperatorRequestSignature) != 64 {
return fmt.Errorf("invalid signature length")
}

if len(req.OperatorToRegisterPubkeyG1) != 64 {
return fmt.Errorf("invalid operatorToRegisterPubkeyG1 length")
}

if len(req.OperatorToRegisterPubkeyG2) != 128 {
return fmt.Errorf("invalid operatorToRegisterPubkeyG2 length")
}

if len(req.Salt) != 32 {
return fmt.Errorf("invalid salt length")
}

// TODO: ensure that all quorumIDs are valid
if len(req.QuorumIds) == 0 {
return fmt.Errorf("invalid quorumIds length")
}

for quorumID := range req.GetQuorumIds() {
if quorumID >= int(s.churner.QuorumCount) {
err := s.churner.UpdateQuorumCount(ctx)
if err != nil {
return fmt.Errorf("failed to get onchain quorum count: %w", err)
}

if quorumID >= int(s.churner.QuorumCount) {
return fmt.Errorf("invalid request: the quorum_id must be in range [0, %d], but found %d", s.churner.QuorumCount-1, quorumID)
}
}
}

return nil

}

func createChurnRequest(req *pb.ChurnRequest) *ChurnRequest {
signature := &core.Signature{G1Point: new(core.G1Point).Deserialize(req.GetOperatorRequestSignature())}

Expand Down
2 changes: 1 addition & 1 deletion churner/server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ func TestChurnWithInvalidQuorum(t *testing.T) {
}, nil)

_, err := s.Churn(ctx, request)
assert.ErrorContains(t, err, "Invalid request: the quorum_id must be in range [0, 0], but found 1")
assert.ErrorContains(t, err, "invalid request: the quorum_id must be in range [0, 0], but found 1")
}

func setupMockTransactor() {
Expand Down

0 comments on commit 8870629

Please sign in to comment.