Skip to content

Commit

Permalink
Fix or ignore gosec issues
Browse files Browse the repository at this point in the history
* fix a few other linting issues
  • Loading branch information
dopey committed Aug 19, 2022
1 parent ed77956 commit 85fa039
Show file tree
Hide file tree
Showing 26 changed files with 394 additions and 187 deletions.
334 changes: 294 additions & 40 deletions .golangci.yml
@@ -1,42 +1,78 @@
run:
# Timeout for analysis, e.g. 30s, 5m.
# Default: 1m
timeout: 3m

skip-dirs:
- pkg



# This file contains only configs which differ from defaults.
# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
linters-settings:
govet:
check-shadowing: true
settings:
printf:
funcs:
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
revive:
min-confidence: 0
gocyclo:
min-complexity: 10
maligned:
suggest-new: true
dupl:
threshold: 100
goconst:
min-len: 2
min-occurrences: 2
cyclop:
# The maximal code complexity to report.
# Default: 10
max-complexity: 30
# The maximal average package complexity.
# If it's higher than 0.0 (float) the check is enabled
# Default: 0.0
package-average: 10.0

depguard:
list-type: blacklist
packages:
# logging is allowed only by logutils.Log, logrus
# is allowed to use only in logutils package
- github.com/sirupsen/logrus
misspell:
locale: US
lll:
line-length: 140
goimports:
local-prefixes: github.com/golangci/golangci-lint

dupl:
threshold: 100

errcheck:
# Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
# Such cases aren't reported by default.
# Default: false
check-type-assertions: true

funlen:
# Checks the number of lines in a function.
# If lower than 0, disable the check.
# Default: 60
lines: 100
# Checks the number of statements in a function.
# If lower than 0, disable the check.
# Default: 40
statements: 50

gocognit:
# Minimal code complexity to report
# Default: 30 (but we recommend 10-20)
min-complexity: 20

goconst:
min-len: 2
min-occurrences: 2

gocritic:
enabled-tags:
- performance
- style
- experimental
- diagnostic
# Settings passed to gocritic.
# The settings key is the name of a supported gocritic checker.
# The list of supported checkers can be find in https://go-critic.github.io/overview.
settings:
captLocal:
# Whether to restrict checker to params only.
# Default: true
paramsOnly: false
underef:
# Whether to skip (*x).method() calls where x is a pointer receiver.
# Default: true
skipRecvDeref: false
disabled-checks:
- commentFormatting
- commentedOutCode
Expand All @@ -46,28 +82,246 @@ linters-settings:
- tooManyResultsChecker
- unnamedResult

gocyclo:
min-complexity: 10

gomnd:
# List of function patterns to exclude from analysis.
# Values always ignored: `time.Date`
# Default: []
ignored-functions:
- os.Chmod
- os.Mkdir
- os.MkdirAll
- os.OpenFile
- os.WriteFile
- prometheus.ExponentialBuckets
- prometheus.ExponentialBucketsRange
- prometheus.LinearBuckets
- strconv.FormatFloat
- strconv.FormatInt
- strconv.FormatUint
- strconv.ParseFloat
- strconv.ParseInt
- strconv.ParseUint

gomodguard:
blocked:
# List of blocked modules.
# Default: []
modules:
- github.com/golang/protobuf:
recommendations:
- google.golang.org/protobuf
reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
- github.com/satori/go.uuid:
recommendations:
- github.com/google/uuid
reason: "satori's package is not maintained"
- github.com/gofrs/uuid:
recommendations:
- github.com/google/uuid
reason: "see recommendation from dev-infra team: https://confluence.gtforge.com/x/gQI6Aw"

goimports:
local-prefixes: github.com/golangci/golangci-lint

govet:
check-shadowing: true
# Enable all analyzers.
# Default: false
enable-all: true
# Disable analyzers by name.
# Run `go tool vet help` to see all analyzers.
# Default: []
disable:
- fieldalignment # too strict
# Settings per analyzer.
settings:
printf:
funcs:
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf

lll:
line-length: 140

maligned:
suggest-new: true

misspell:
locale: US

nakedret:
# Make an issue if func has more lines of code than this setting, and it has naked returns.
# Default: 30
max-func-lines: 0

nolintlint:
# Exclude following linters from requiring an explanation.
# Default: []
allow-no-explanation: [ funlen, gocognit, lll ]
# Enable to require an explanation of nonzero length after each nolint directive.
# Default: false
require-explanation: true
# Enable to require nolint directives to mention the specific linter being suppressed.
# Default: false
require-specific: true

revive:
min-confidence: 0

rowserrcheck:
# database/sql is always checked
# Default: []
packages:
- github.com/jmoiron/sqlx

tenv:
# The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
# Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
# Default: false
all: true

varcheck:
# Check usage of exported fields and variables.
# Default: false
exported-fields: false # default false # TODO: enable after fixing false positives

linters:
disable-all: true
enable:
- deadcode
- gocritic
- gofmt
- gosimple
- govet
- ineffassign
- misspell
- revive
- staticcheck
- structcheck
- unused
## enabled by default
- deadcode # Finds unused code
- gosimple # Linter for Go source code that specializes in simplifying a code
- govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
- ineffassign # Detects when assignments to existing variables are not used
- staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
- structcheck # Finds unused struct fields
- typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
- unused # Checks Go code for unused constants, variables, functions and types
- varcheck # Finds unused global variables and constants
## disabled by default
- gocritic # Provides diagnostics that check for bugs, performance and style issues.
- gofmt # [replaced by goimports] Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
- goimports # In addition to fixing imports, goimports also formats your code in the same style as gofmt.
- misspell # Finds commonly misspelled English words in comments
- revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.

run:
skip-dirs:
- pkg
## Consider Enabling
#- asasalint # Check for pass []any as any in variadic func(...any)
#- asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
#- bidichk # Checks for dangerous unicode character sequences
#- bodyclose # checks whether HTTP response body is closed successfully
#- contextcheck # check the function whether use a non-inherited context
#- cyclop # checks function and package cyclomatic complexity
#- dupl # Tool for code clone detection
#- durationcheck # check for two durations multiplied together
#- errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
#- errname # Checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error.
#- errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
#- execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds
#- exhaustive # check exhaustiveness of enum switch statements
#- exportloopref # checks for pointers to enclosing loop variables
#- forbidigo # Forbids identifiers
#- funlen # Tool for detection of long functions
#- gochecknoglobals # check that no global variables exist
#- gochecknoinits # Checks that no init functions are present in Go code
#- gocognit # Computes and checks the cognitive complexity of functions
#- goconst # Finds repeated strings that could be replaced by a constant
#- gocyclo # Computes and checks the cyclomatic complexity of functions
#- godot # Check if comments end in a period
#- gomnd # An analyzer to detect magic numbers.
#- gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
#- gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
#- goprintffuncname # Checks that printf-like functions are named with f at the end
#- lll # Reports long lines
#- makezero # Finds slice declarations with non-zero initial length
#- nakedret # Finds naked returns in functions greater than a specified function length
#- nestif # Reports deeply nested if statements
#- nilerr # Finds the code that returns nil even if it checks that the error is not nil.
#- nilnil # Checks that there is no simultaneous return of nil error and an invalid value.
#- noctx # noctx finds sending http request without context.Context
#- nolintlint # Reports ill-formed or insufficient nolint directives
#- nonamedreturns # Reports all named returns
#- nosprintfhostport # Checks for misuse of Sprintf to construct a host with port in a URL.
#- predeclared # find code that shadows one of Go's predeclared identifiers
#- promlinter # Check Prometheus metrics naming via promlint
#- rowserrcheck # checks whether Err of rows is checked successfully
#- sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed.
#- stylecheck # Stylecheck is a replacement for golint
#- tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
#- testpackage # linter that makes you use a separate _test package
#- tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
#- unconvert # Remove unnecessary type conversions
#- unparam # Reports unused function parameters
#- wastedassign # wastedassign finds wasted assignment statements.
#- whitespace # Tool for detection of leading and trailing whitespace
#- wrapcheck # Checks that errors returned from external packages are wrapped
## you may want to enable
#- decorder # check declaration order and count of types, constants, variables and functions
#- exhaustruct # Checks if all structure fields are initialized
#- goheader # Checks is file header matches to pattern
#- ireturn # Accept Interfaces, Return Concrete Types
#- prealloc # [premature optimization, but can be used in some cases] Finds slice declarations that could potentially be preallocated
#- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
#
## disabled
#- containedctx # containedctx is a linter that detects struct contained context.Context field
#- depguard # [replaced by gomodguard] Go linter that checks if package imports are in a list of acceptable packages
#- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
#- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted.
#- forcetypeassert # [replaced by errcheck] finds forced type assertions
#- gci # Gci controls golang package import order and makes it always deterministic.
#- godox # Tool for detection of FIXME, TODO and other comment keywords
#- goerr113 # [too strict] Golang linter to check the errors handling expressions
#- gofumpt # [replaced by goimports, gofumports is not available yet] Gofumpt checks whether code was gofumpt-ed.
#- grouper # An analyzer to analyze expression groups.
#- ifshort # Checks that your code uses short syntax for if-statements whenever possible
#- importas # Enforces consistent import aliases
#- maintidx # maintidx measures the maintainability index of each function.
#- nlreturn # [too strict and mostly code is not more readable] nlreturn checks for a new line before return and branch statements to increase code clarity
#- nosnakecase # Detects snake case of variable naming and function name. # TODO: maybe enable after https://github.com/sivchari/nosnakecase/issues/14
#- paralleltest # [too many false positives] paralleltest detects missing usage of t.Parallel() method in your Go test
#- tagliatelle # Checks the struct tags.
#- thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
#- wsl # [too strict and mostly code is not more readable] Whitespace Linter - Forces you to use empty lines!
## deprecated
#- exhaustivestruct # [deprecated, replaced by exhaustruct] Checks if all struct's fields are initialized
#- golint # [deprecated, replaced by revive] Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
#- interfacer # [deprecated] Linter that suggests narrower interface types
#- maligned # [deprecated, replaced by govet fieldalignment] Tool to detect Go structs that would take less memory if their fields were sorted
#- scopelint # [deprecated, replaced by exportloopref] Scopelint checks for unpinned variables in go programs

issues:
# Maximum count of issues with the same text.
# Set to 0 to disable.
# Default: 3
max-same-issues: 50

exclude:
- declaration of "err" shadows declaration at line
- should have a package comment, unless it's in another file for this package
- func `CLICommand.
- error strings should not be capitalized or end with punctuation or a newline

exclude-rules:
- source: "^//\\s*go:generate\\s"
linters: [ lll ]
- source: "(noinspection|TODO)"
linters: [ godot ]
- source: "//noinspection"
linters: [ gocritic ]
- source: "^\\s+if _, ok := err\\.\\([^.]+\\.InternalError\\); ok {"
linters: [ errorlint ]
- path: "_test\\.go"
linters:
- bodyclose
- dupl
- funlen
- goconst
- gosec
- noctx
- wrapcheck
3 changes: 0 additions & 3 deletions cmd/step/main.go
Expand Up @@ -41,9 +41,6 @@ import (
_ "github.com/smallstep/certificates/cas/cloudcas"
_ "github.com/smallstep/certificates/cas/softcas"
_ "github.com/smallstep/certificates/cas/stepcas"

// Profiling and debugging
_ "net/http/pprof"
)

// Version is set by an LDFLAG at build time representing the git tag or commit
Expand Down
1 change: 1 addition & 0 deletions command/ca/rekey.go
Expand Up @@ -315,6 +315,7 @@ func rekeyCertificateAction(ctx *cli.Context) error {

// Do not rekey if (cert.notAfter - now) > (expiresIn + jitter)
if expiresIn > 0 {
// nolint:gosec // The random number below is not being used for crypto.
jitter := rand.Int63n(int64(expiresIn / 20))
if d := time.Until(leaf.NotAfter); d > expiresIn+time.Duration(jitter) {
ui.Printf("certificate not rekeyed: expires in %s\n", d.Round(time.Second))
Expand Down

0 comments on commit 85fa039

Please sign in to comment.