-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rules/sdk: add pass to reject time.Now()
time.Now() uses local clocks that unfortunately when used in distributed consensus introduce lots of skew and can be exploited in vulnerabilities. Instead there is consensus aware clock whose timestamp is embedded in the current Block. This pass rejects usages as per https://forum.cosmos.network/t/cosmos-sdk-vulnerability-retrospective-security-advisory-jackfruit-october-12-2021/5349 Updates #1
- Loading branch information
Showing
5 changed files
with
102 additions
and
2 deletions.
There are no files selected for viewing
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
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
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
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,76 @@ | ||
// (c) Copyright 2021 Hewlett Packard Enterprise Development LP | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package sdk | ||
|
||
import ( | ||
"errors" | ||
"go/ast" | ||
|
||
"github.com/securego/gosec/v2" | ||
) | ||
|
||
// This static analyzer discourages the use of time.Now() as it was discovered that | ||
// its usage caused local non-determinism as reported and detailed at | ||
// https://forum.cosmos.network/t/cosmos-sdk-vulnerability-retrospective-security-advisory-jackfruit-october-12-2021/5349 | ||
|
||
type timeNowCheck struct { | ||
gosec.MetaData | ||
calls gosec.CallList | ||
} | ||
|
||
func (tmc *timeNowCheck) ID() string { return tmc.MetaData.ID } | ||
|
||
func (tmc *timeNowCheck) Match(node ast.Node, ctx *gosec.Context) (*gosec.Issue, error) { | ||
// We want to catch all function invocations as well as assignments of any of the form: | ||
// .Value = time.Now().* | ||
// fn := time.Now | ||
switch n := node.(type) { | ||
default: | ||
// TODO: Add more cases for which time.Now can be aliased or used as a variable. | ||
return nil, nil | ||
|
||
case *ast.CallExpr: | ||
sel, ok := n.Fun.(*ast.SelectorExpr) | ||
if !ok { | ||
return nil, nil | ||
} | ||
if sel.X.(*ast.Ident).Name != "time" { | ||
return nil, nil | ||
} | ||
if sel.Sel.Name != "Now" { | ||
return nil, nil | ||
} | ||
|
||
// Otherwise issue the error. | ||
return nil, errors.New("time.Now() is non-deterministic for distributed computing, you should use the current Block's timestamp") | ||
} | ||
} | ||
|
||
func NewTimeNowRefusal(id string, config gosec.Config) (rule gosec.Rule, nodes []ast.Node) { | ||
calls := gosec.NewCallList() | ||
|
||
tnc := &timeNowCheck{ | ||
MetaData: gosec.MetaData{ | ||
ID: id, | ||
Severity: gosec.High, | ||
Confidence: gosec.High, | ||
What: "Non-determinism from using non-consensus aware time.Now()", | ||
}, | ||
calls: calls, | ||
} | ||
|
||
nodes = append(nodes, (*ast.CallExpr)(nil)) | ||
return tnc, nodes | ||
} |
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