Skip to content

Commit

Permalink
fix: add golangci and context extraction
Browse files Browse the repository at this point in the history
  • Loading branch information
katallaxie committed Jan 28, 2024
1 parent 615d7ce commit 20a0f1a
Show file tree
Hide file tree
Showing 4 changed files with 1,306 additions and 17 deletions.
211 changes: 211 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
run:
deadline: 6m

skip-files:
- "zz_generated\\..+\\.go$"

skip-dirs:
- vendor$

output:
# colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
format: colored-line-number

linters-settings:
errcheck:
# report about not checking of errors in type assetions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: false

# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
check-blank: false

# [deprecated] comma-separated list of pairs of the form pkg:regex
# the regex is used to ignore names within pkg. (default "fmt:.*").
# see https://github.com/kisielk/errcheck#the-deprecated-method for details
ignore: fmt:.*,io/ioutil:^Read.*

govet:
# report about shadowed variables
check-shadowing: false

golint:
# minimal confidence for issues, default is 0.8
min-confidence: 0.8

gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true

goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
local-prefixes: github.com/crossplane/provider-template

gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10

maligned:
# print struct with more effective memory layout or not, false by default
suggest-new: true

dupl:
# tokens count to trigger issue, 150 by default
threshold: 100

goconst:
# minimal length of string constant, 3 by default
min-len: 3
# minimal occurrences count to trigger, 3 by default
min-occurrences: 5

lll:
# tab width in spaces. Default to 1.
tab-width: 1

unused:
# treat code as a program (not a library) and report unused exported identifiers; default is false.
# XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find funcs usages. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false

unparam:
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false

nakedret:
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30
max-func-lines: 30

prealloc:
# XXX: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.

# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
# True by default.
simple: true
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default

gocritic:
# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- performance

settings: # settings passed to gocritic
captLocal: # must be valid enabled check name
paramsOnly: true
rangeValCopy:
sizeThreshold: 32

revive:
severity: warning
confidence: 0.8


linters:
enable:
- megacheck
- govet
- gocyclo
- gocritic
- goconst
- goimports
- gofmt # We enable this as well as goimports for its simplify mode.
- prealloc
- revive
- unconvert
- misspell
- nakedret
- exportloopref
- gosec

disable:
- scopelint
- errcheck

presets:
- bugs
- unused
fast: false


issues:
exclude:
- "G103: Use of unsafe calls should be audited"

# Excluding configuration per-path and per-linter
exclude-rules:
# Exclude some linters from running on tests files.
- path: _test(ing)?\.go
linters:
- gocyclo
- errcheck
- dupl
- gosec
- unparam
- deadcode

# Ease some gocritic warnings on test files.
- path: _test\.go
text: "(unnamedResult|exitAfterDefer)"
linters:
- gocritic

# These are performance optimisations rather than style issues per se.
# They warn when function arguments or range values copy a lot of memory
# rather than using a pointer.
- text: "(hugeParam|rangeValCopy):"
linters:
- gocritic

# This "TestMain should call os.Exit to set exit code" warning is not clever
# enough to notice that we call a helper method that calls os.Exit.
- text: "SA3000:"
linters:
- staticcheck

- text: "k8s.io/api/core/v1"
linters:
- goimports

# This is a "potential hardcoded credentials" warning. It's triggered by
# any variable with 'secret' in the same, and thus hits a lot of false
# positives in Kubernetes land where a Secret is an object type.
- text: "G101:"
linters:
- gosec
- gas

# This is an 'errors unhandled' warning that duplicates errcheck.
- text: "G104:"
linters:
- gosec
- gas

# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
# Default value for this option is true.
exclude-use-default: false

# Show only new issues: if there are unstaged changes or untracked files,
# only those changes are analyzed, else only changes in HEAD~ are analyzed.
# It's a super-useful option for integration of golangci-lint into existing
# large codebase. It's not practical to fix all existing issues at the moment
# of integration: much better don't allow issues in new code.
# Default is false.
new: false

# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-per-linter: 0

# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 0
54 changes: 38 additions & 16 deletions goth.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ package goth
import (
"bytes"
"compress/gzip"
"crypto/rand"
"encoding/base64"
"errors"
"fmt"
"io"
"math/rand"
"math/big"
"strings"
"time"

"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/session"
Expand All @@ -23,9 +23,7 @@ import (

var _ GothHandler = (*BeginAuthHandler)(nil)

const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

var seededRand *rand.Rand = rand.New(rand.NewSource(time.Now().UnixNano()))
const charset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-"

// Params ...
type Params struct {
Expand Down Expand Up @@ -150,7 +148,8 @@ func (s *sessionStore) Update(c *fiber.Ctx, key, value string) error {
}

// ProviderFromContext returns the provider from the request context.
func ProviderFromContext(c *fiber.Ctx) {
func ProviderFromContext(c *fiber.Ctx) string {
return c.Get(fmt.Sprint(providerKey))
}

// BeginAuthHandler ...
Expand Down Expand Up @@ -188,6 +187,8 @@ func NewBeginAuthHandler(config ...Config) fiber.Handler {
type CompleteAuthCompleteHandler struct{}

// New creates a new handler to complete authentication.
//
//nolint:gocyclo
func (CompleteAuthCompleteHandler) New(cfg Config) fiber.Handler {
return func(c *fiber.Ctx) error {
if cfg.Next != nil && cfg.Next(c) {
Expand Down Expand Up @@ -283,7 +284,12 @@ func GetAuthURLFromContext(c *fiber.Ctx, session SessionStore) (string, error) {
return "", err
}

sess, err := provider.BeginAuth(stateFromContext(c))
state, err := stateFromContext(c)
if err != nil {
return "", err
}

sess, err := provider.BeginAuth(state)
if err != nil {
return "", err
}
Expand All @@ -306,6 +312,13 @@ func GetStateFromContext(ctx *fiber.Ctx) string {
return ctx.Query(state)
}

// ContextWithProvider returns a new request context containing the provider.
func ContextWithProvider(ctx *fiber.Ctx, provider string) *fiber.Ctx {
ctx.Set(fmt.Sprint(providerKey), provider)

return ctx
}

// Config caputes the configuration for running the goth middleware.
type Config struct {
// Next defines a function to skip this middleware when returned true.
Expand Down Expand Up @@ -380,21 +393,30 @@ func configDefault(config ...Config) Config {
return cfg
}

func stateFromContext(ctx *fiber.Ctx) string {
func stateFromContext(ctx *fiber.Ctx) (string, error) {
state := ctx.Query(state)
if len(state) > 0 {
return state
return state, nil
}

nonce := generateRandomString(64)
nonce, err := generateRandomString(64)
if err != nil {
return "", err
}

return base64.URLEncoding.EncodeToString(nonce)
return base64.URLEncoding.EncodeToString(nonce), nil
}

func generateRandomString(length int) []byte {
b := make([]byte, length)
for i := range b {
b[i] = charset[seededRand.Intn(len(charset))]
func generateRandomString(n int) ([]byte, error) {
b := make([]byte, n)

for i := 0; i < n; i++ {
num, err := rand.Int(rand.Reader, big.NewInt(int64(len(charset))))
if err != nil {
return b, err
}
b[i] = charset[num.Int64()]
}
return b

return b, nil
}
2 changes: 1 addition & 1 deletion internal/tools/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ import (
_ "github.com/golang/mock/mockgen/model"
_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
_ "mvdan.cc/gofumpt"
)
)
Loading

0 comments on commit 20a0f1a

Please sign in to comment.