Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update module go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin to v0.44.0 [security] - autoclosed #169

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 16, 2023

Mend Renovate

This PR contains the following updates:

Package Type Update Change
go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin require minor v0.42.0 -> v0.44.0

GitHub Vulnerability Alerts

CVE-2023-45142

Summary

This handler wrapper https://github.com/open-telemetry/opentelemetry-go-contrib/blob/5f7e6ad5a49b45df45f61a1deb29d7f1158032df/instrumentation/net/http/otelhttp/handler.go#L63-L65
out of the box adds labels

  • http.user_agent
  • http.method

that have unbound cardinality. It leads to the server's potential memory exhaustion when many malicious requests are sent to it.

Details

HTTP header User-Agent or HTTP method for requests can be easily set by an attacker to be random and long. The library internally uses httpconv.ServerRequest that records every value for HTTP method and User-Agent.

PoC

Send many requests with long randomly generated HTTP methods or/and User agents (e.g. a million) and observe how memory consumption increases during it.

Impact

In order to be affected, the program has to configure a metrics pipeline, use otelhttp.NewHandler wrapper, and does not filter any unknown HTTP methods or User agents on the level of CDN, LB, previous middleware, etc.

Others

It is similar to already reported vulnerabilities

Workaround for affected versions

As a workaround to stop being affected otelhttp.WithFilter() can be used, but it requires manual careful configuration to not log certain requests entirely.

For convenience and safe usage of this library, it should by default mark with the label unknown non-standard HTTP methods and User agents to show that such requests were made but do not increase cardinality. In case someone wants to stay with the current behavior, library API should allow to enable it.

The other possibility is to disable HTTP metrics instrumentation by passing otelhttp.WithMeterProvider option with noop.NewMeterProvider.

Solution provided by upgrading

In PR https://github.com/open-telemetry/opentelemetry-go-contrib/pull/4277, released with package version 0.44.0, the values collected for attribute http.request.method were changed to be restricted to a set of well-known values and other high cardinality attributes were removed.

References


Configuration

📅 Schedule: Branch creation - "" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

…github.com/gin-gonic/gin/otelgin to v0.44.0 [security]
@renovate renovate bot requested a review from nicolerenee as a code owner October 16, 2023 22:34
@renovate
Copy link
Contributor Author

renovate bot commented Oct 16, 2023

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: go.sum
Command failed: docker run --rm --name=renovate_a_sidecar --label=renovate_a_child --memory=3584m -v "/tmp/worker/d646fb/6e8f8a/repos/github/infratographer/x":"/tmp/worker/d646fb/6e8f8a/repos/github/infratographer/x" -v "/tmp/worker/d646fb/6e8f8a/cache":"/tmp/worker/d646fb/6e8f8a/cache" -e GOPATH -e GOPROXY -e GOSUMDB -e GOFLAGS -e CGO_ENABLED -e GIT_CONFIG_KEY_0 -e GIT_CONFIG_VALUE_0 -e GIT_CONFIG_KEY_1 -e GIT_CONFIG_VALUE_1 -e GIT_CONFIG_KEY_2 -e GIT_CONFIG_VALUE_2 -e GIT_CONFIG_COUNT -e CONTAINERBASE_CACHE_DIR -w "/tmp/worker/d646fb/6e8f8a/repos/github/infratographer/x" ghcr.io/containerbase/sidecar:9.23.4 bash -l -c "install-tool golang 1.21.3 && go get -d -t ./... && go mod tidy && go mod tidy"
go: downloading github.com/XSAM/otelsql v0.23.0
go: downloading github.com/cockroachdb/cockroach-go/v2 v2.3.5
go: downloading github.com/spf13/pflag v1.0.5
go: downloading github.com/lib/pq v1.10.9
go: downloading github.com/spf13/viper v1.16.0
go: downloading go.opentelemetry.io/otel v1.18.0
go: downloading github.com/labstack/echo-contrib v0.15.0
go: downloading github.com/labstack/echo/v4 v4.11.1
go: downloading github.com/labstack/echo v3.3.10+incompatible
go: downloading go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho v0.42.0
go: downloading go.uber.org/zap v1.25.0
go: downloading github.com/cenkalti/backoff/v4 v4.2.1
go: downloading github.com/stretchr/testify v1.8.4
go: downloading go.uber.org/goleak v1.2.1
go: downloading github.com/labstack/gommon v0.4.0
go: downloading github.com/MicahParks/keyfunc/v2 v2.1.0
go: downloading github.com/golang-jwt/jwt/v5 v5.0.0
go: downloading github.com/labstack/echo-jwt/v4 v4.2.0
go: downloading go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.42.0
go: downloading github.com/golang-jwt/jwt v3.2.2+incompatible
go: downloading golang.org/x/exp v0.0.0-20230905200255-921286631fa9
go: downloading golang.org/x/oauth2 v0.12.0
go: downloading gopkg.in/square/go-jose.v2 v2.6.0
go: downloading entgo.io/contrib v0.4.5
go: downloading entgo.io/ent v0.12.4
go: downloading github.com/99designs/gqlgen v0.17.38
go: downloading github.com/vektah/gqlparser/v2 v2.5.10
go: downloading github.com/jaevor/go-nanoid v1.3.0
go: downloading github.com/google/uuid v1.3.1
go: downloading github.com/nats-io/nats.go v1.30.2
go: downloading go.opentelemetry.io/otel/trace v1.18.0
go: downloading go.uber.org/multierr v1.11.0
go: downloading github.com/gin-contrib/requestid v0.0.6
go: downloading github.com/gin-contrib/zap v0.1.0
go: downloading github.com/gin-gonic/gin v1.9.1
go: downloading github.com/brianvoe/gofakeit/v6 v6.23.2
go: downloading github.com/pressly/goose/v3 v3.15.0
go: downloading github.com/spf13/cobra v1.7.0
go: downloading go.opentelemetry.io/otel/exporters/jaeger v1.16.0
go: downloading go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.16.0
go: downloading go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.16.0
go: downloading go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.16.0
go: downloading go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.16.0
go: downloading go.opentelemetry.io/otel/sdk v1.16.0
go: downloading go.step.sm/crypto v0.35.1
go: downloading github.com/docker/go-connections v0.4.0
go: downloading github.com/testcontainers/testcontainers-go v0.23.0
go: downloading github.com/jmoiron/sqlx v1.3.5
go: downloading github.com/testcontainers/testcontainers-go/modules/postgres v0.23.0
go: downloading github.com/zsais/go-gin-prometheus v0.1.0
go: downloading go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin v0.44.0
go: downloading github.com/nats-io/nats-server/v2 v2.10.1
go: downloading go.opentelemetry.io/otel/metric v1.18.0
go: downloading github.com/jackc/pgx/v4 v4.18.1
go: downloading github.com/fsnotify/fsnotify v1.6.0
go: downloading github.com/mitchellh/mapstructure v1.5.0
go: downloading github.com/spf13/afero v1.9.5
go: downloading github.com/spf13/cast v1.5.1
go: downloading github.com/spf13/jwalterweatherman v1.1.0
go: downloading github.com/prometheus/client_golang v1.14.0
go: downloading github.com/prometheus/common v0.40.0
go: downloading golang.org/x/crypto v0.13.0
go: downloading golang.org/x/net v0.15.0
go: downloading golang.org/x/time v0.3.0
go: downloading github.com/valyala/fasttemplate v1.2.2
go: downloading github.com/davecgh/go-spew v1.1.1
go: downloading github.com/pmezard/go-difflib v1.0.0
go: downloading gopkg.in/yaml.v3 v3.0.1
go: downloading github.com/mattn/go-colorable v0.1.13
go: downloading github.com/mattn/go-isatty v0.0.19
go: downloading github.com/felixge/httpsnoop v1.0.3
go: downloading golang.org/x/tools v0.13.0
go: downloading ariga.io/atlas v0.14.1-0.20230918065911-83ad451a4935
go: downloading github.com/go-openapi/inflect v0.19.0
go: downloading github.com/vmihailenco/msgpack/v5 v5.0.0-beta.9
go: downloading github.com/go-logr/logr v1.2.4
go: downloading github.com/klauspost/compress v1.17.0
go: downloading github.com/nats-io/nkeys v0.4.5
go: downloading github.com/nats-io/nuid v1.0.1
go: downloading github.com/gin-contrib/sse v0.1.0
go: downloading github.com/inconshreveable/mousetrap v1.1.0
go: downloading go.opentelemetry.io/proto/otlp v0.19.0
go: downloading go.opentelemetry.io/otel/exporters/otlp/internal/retry v1.16.0
go: downloading google.golang.org/genproto/googleapis/rpc v0.0.0-20230911183012-2d3300fd4832
go: downloading google.golang.org/genproto v0.0.0-20230803162519-f966b187b2e5
go: downloading google.golang.org/grpc v1.58.1
go: downloading github.com/go-logr/stdr v1.2.2
go: downloading google.golang.org/protobuf v1.31.0
go: downloading golang.org/x/sys v0.12.0
go: downloading github.com/pkg/errors v0.9.1
go: downloading dario.cat/mergo v1.0.0
go: downloading github.com/containerd/containerd v1.7.3
go: downloading github.com/cpuguy83/dockercfg v0.3.1
go: downloading github.com/docker/docker v24.0.5+incompatible
go: downloading github.com/moby/term v0.5.0
go: downloading github.com/opencontainers/image-spec v1.1.0-rc4
go: downloading github.com/sirupsen/logrus v1.9.3
go: downloading github.com/stretchr/objx v0.5.0
go: downloading github.com/jackc/pgconn v1.14.0
go: downloading github.com/jackc/pgio v1.0.0
go: downloading github.com/jackc/pgproto3/v2 v2.3.2
go: downloading github.com/jackc/pgtype v1.14.0
go: downloading golang.org/x/text v0.13.0
go: downloading github.com/subosito/gotenv v1.4.2
go: downloading github.com/hashicorp/hcl v1.0.0
go: downloading github.com/magiconair/properties v1.8.7
go: downloading gopkg.in/ini.v1 v1.67.0
go: downloading github.com/pelletier/go-toml/v2 v2.0.8
go: downloading github.com/beorn7/perks v1.0.1
go: downloading github.com/cespare/xxhash/v2 v2.2.0
go: downloading github.com/golang/protobuf v1.5.3
go: downloading github.com/prometheus/client_model v0.3.0
go: downloading github.com/prometheus/procfs v0.11.0
go: downloading github.com/minio/highwayhash v1.0.2
go: downloading github.com/nats-io/jwt/v2 v2.5.2
go: downloading github.com/matttproud/golang_protobuf_extensions v1.0.4
go: downloading github.com/valyala/bytebufferpool v1.0.0
go: downloading google.golang.org/appengine v1.6.7
go: downloading github.com/hashicorp/hcl/v2 v2.13.0
go: downloading github.com/zclconf/go-cty v1.8.0
go: downloading github.com/vmihailenco/tagparser v0.1.2
go: downloading github.com/go-playground/validator/v10 v10.14.0
go: downloading github.com/ugorji/go/codec v1.2.11
go: downloading github.com/bytedance/sonic v1.9.1
go: downloading github.com/goccy/go-json v0.10.2
go: downloading github.com/json-iterator/go v1.1.12
go: downloading github.com/grpc-ecosystem/grpc-gateway/v2 v2.14.0
go: downloading filippo.io/edwards25519 v1.0.0
go: downloading github.com/docker/go-units v0.5.0
go: downloading github.com/moby/patternmatcher v0.5.0
go: downloading github.com/moby/sys/sequential v0.5.0
go: downloading github.com/morikuni/aec v1.0.0
go: downloading github.com/docker/distribution v2.8.2+incompatible
go: downloading github.com/opencontainers/go-digest v1.0.0
go: downloading github.com/jackc/chunkreader/v2 v2.0.1
go: downloading github.com/jackc/pgpassfile v1.0.0
go: downloading github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a
go: downloading golang.org/x/mod v0.12.0
go: downloading github.com/gabriel-vasile/mimetype v1.4.2
go: downloading github.com/go-playground/universal-translator v0.18.1
go: downloading github.com/leodido/go-urn v1.2.4
go: downloading github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
go: downloading github.com/modern-go/reflect2 v1.0.2
go: downloading google.golang.org/genproto/googleapis/api v0.0.0-20230803162519-f966b187b2e5
go: downloading github.com/opencontainers/runc v1.1.7
go: downloading github.com/Microsoft/go-winio v0.6.1
go: downloading github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161
go: downloading github.com/agext/levenshtein v1.2.1
go: downloading github.com/apparentlymart/go-textseg/v13 v13.0.0
go: downloading github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7
go: downloading github.com/google/go-cmp v0.5.9
go: downloading github.com/agnivade/levenshtein v1.1.1
go: downloading github.com/go-playground/locales v0.14.1
go: downloading github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311
go: downloading golang.org/x/arch v0.3.0
go: downloading github.com/gogo/protobuf v1.3.2
go: downloading github.com/klauspost/cpuid/v2 v2.2.4
go: downloading github.com/twitchyliquid64/golang-asm v0.15.1
go: downloading go.opentelemetry.io v0.1.0
go: downloading go.opentelemetry.io/otel/exporters/otlp v0.20.1
go: downloading go.opentelemetry.io/otel v1.19.0
go: go.infratographer.com/x/otelx imports
	go.opentelemetry.io/otel/exporters/otlp/otlptrace imports
	go.opentelemetry.io/otel/exporters/otlp/internal: cannot find module providing package go.opentelemetry.io/otel/exporters/otlp/internal
go: go.infratographer.com/x/otelx imports
	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc imports
	go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlpconfig imports
	go.opentelemetry.io/otel/exporters/otlp/internal/envconfig: cannot find module providing package go.opentelemetry.io/otel/exporters/otlp/internal/envconfig
go: module go.opentelemetry.io/otel/exporters/jaeger is deprecated: This module is no longer supported.

@renovate renovate bot requested a review from sfunkhouser as a code owner October 16, 2023 22:34
@renovate renovate bot changed the title fix(deps): update module go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin to v0.44.0 [security] fix(deps): update module go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin to v0.44.0 [security] - autoclosed Oct 26, 2023
@renovate renovate bot closed this Oct 26, 2023
@renovate renovate bot deleted the renovate/go-go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin-vulnerability branch October 26, 2023 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants