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.

Sign up for GitHub

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

Jump to bottom

fix(mongodb): escape username and password #3989

Merged
merged 2 commits into from
Dec 9, 2022
Merged

fix(mongodb): escape username and password #3989

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
683c8a1
fix(mongodb): escape username and password
JorTurFer Dec 8, 2022
873a55c
update changelog
JorTurFer Dec 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,10 @@ Follow these instructions if you want to debug the KEDA operator using VS Code.
"request": "launch",
"mode": "debug",
"program": "${workspaceFolder}/main.go",
"env": {"WATCH_NAMESPACE": ""}
"env": {
"WATCH_NAMESPACE": "",
"KEDA_CLUSTER_OBJECT_NAMESPACE": "keda"
}
}
]
}
Expand Down Expand Up @@ -171,7 +174,10 @@ Follow these instructions if you want to debug the KEDA metrics server using VS
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/adapter/main.go",
"env": {"WATCH_NAMESPACE": ""},
"env": {
"WATCH_NAMESPACE": "",
"KEDA_CLUSTER_OBJECT_NAMESPACE": "keda"
},
"args": [
"--authentication-kubeconfig=PATH_TO_YOUR_KUBECONFIG",
"--authentication-skip-lookup",
Expand Down
2 changes: 0 additions & 2 deletions pkg/scalers/couchdb_scaler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,6 @@ func parseCouchDBMetadata(config *ScalerConfig) (*couchDBMetadata, string, error
} else {
// Build connection str
addr := net.JoinHostPort(meta.host, meta.port)
// addr := fmt.Sprintf("%s:%s", meta.host, meta.port)
// auth := fmt.Sprintf("%s:%s", meta.username, meta.password)
connStr = "http://" + addr
}
if val, ok := config.TriggerMetadata["metricName"]; ok {
Expand Down
4 changes: 2 additions & 2 deletions pkg/scalers/mongo_scaler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"errors"
"fmt"
"net"
"net/url"
"strconv"
"time"

Expand Down Expand Up @@ -189,8 +190,7 @@ func parseMongoDBMetadata(config *ScalerConfig) (*mongoDBMetadata, string, error
} else {
// Build connection str
addr := net.JoinHostPort(meta.host, meta.port)
auth := fmt.Sprintf("%s:%s", meta.username, meta.password)
connStr = "mongodb://" + auth + "@" + addr + "/" + meta.dbName
connStr = fmt.Sprintf("mongodb://%s:%s@%s/%s", url.QueryEscape(meta.username), url.QueryEscape(meta.password), addr, meta.dbName)
tomkerkhove marked this conversation as resolved.
Show resolved Hide resolved
}

if val, ok := config.TriggerMetadata["metricName"]; ok {
Expand Down
41 changes: 35 additions & 6 deletions pkg/scalers/mongo_scaler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ import (
"testing"

"github.com/go-logr/logr"
"github.com/stretchr/testify/assert"
"go.mongodb.org/mongo-driver/mongo"
)

var testMongoDBResolvedEnv = map[string]string{
"MongoDB_CONN_STR": "test_conn_str",
"MongoDB_PASSWORD": "test",
"MongoDB_CONN_STR": "mongodb://mongodb0.example.com:27017",
"MongoDB_PASSWORD": "test@password",
}

type parseMongoDBMetadataTestData struct {
Expand All @@ -20,6 +21,11 @@ type parseMongoDBMetadataTestData struct {
raisesError bool
}

type mongoDBConnectionStringTestData struct {
metadataTestData *parseMongoDBMetadataTestData
connectionString string
}

type mongoDBMetricIdentifier struct {
metadataTestData *parseMongoDBMetadataTestData
scalerIndex int
Expand All @@ -36,22 +42,29 @@ var testMONGODBMetadata = []parseMongoDBMetadataTestData{
},
// connectionStringFromEnv
{
metadata: map[string]string{"query": `{"name":"John"}`, "collection": "demo", "queryValue": "12", "connectionStringFromEnv": "Mongo_CONN_STR", "dbName": "test"},
metadata: map[string]string{"query": `{"name":"John"}`, "collection": "demo", "queryValue": "12", "connectionStringFromEnv": "MongoDB_CONN_STR", "dbName": "test"},
authParams: map[string]string{},
resolvedEnv: testMongoDBResolvedEnv,
raisesError: false,
},
// with metric name
{
metadata: map[string]string{"query": `{"name":"John"}`, "metricName": "hpa", "collection": "demo", "queryValue": "12", "connectionStringFromEnv": "Mongo_CONN_STR", "dbName": "test"},
metadata: map[string]string{"query": `{"name":"John"}`, "metricName": "hpa", "collection": "demo", "queryValue": "12", "connectionStringFromEnv": "MongoDB_CONN_STR", "dbName": "test"},
authParams: map[string]string{},
resolvedEnv: testMongoDBResolvedEnv,
raisesError: false,
},
// from passwordFromEnv
{
metadata: map[string]string{"query": `{"name":"John"}`, "metricName": "hpa", "collection": "demo", "queryValue": "12", "passwordFromEnv": "MongoDB_PASSWORD"},
authParams: map[string]string{"dbName": "test", "host": "localshot", "port": "1234", "username": "sample"},
resolvedEnv: testMongoDBResolvedEnv,
raisesError: false,
},
// from trigger auth
{
metadata: map[string]string{"query": `{"name":"John"}`, "metricName": "hpa", "collection": "demo", "queryValue": "12"},
authParams: map[string]string{"dbName": "test", "host": "localshot", "port": "1234", "username": "sample", "password": "secure"},
authParams: map[string]string{"dbName": "test", "host": "localshot", "port": "1234", "username": "sample", "password": "sec@ure"},
resolvedEnv: testMongoDBResolvedEnv,
raisesError: false,
},
Expand All @@ -64,14 +77,20 @@ var testMONGODBMetadata = []parseMongoDBMetadataTestData{
},
}

var mongoDBConnectionStringTestDatas = []mongoDBConnectionStringTestData{
{metadataTestData: &testMONGODBMetadata[2], connectionString: "mongodb://mongodb0.example.com:27017"},
{metadataTestData: &testMONGODBMetadata[3], connectionString: "mongodb://sample:test%40password@localshot:1234/test"},
{metadataTestData: &testMONGODBMetadata[4], connectionString: "mongodb://sample:sec%40ure@localshot:1234/test"},
}

var mongoDBMetricIdentifiers = []mongoDBMetricIdentifier{
{metadataTestData: &testMONGODBMetadata[2], scalerIndex: 0, name: "s0-mongodb-hpa"},
{metadataTestData: &testMONGODBMetadata[2], scalerIndex: 1, name: "s1-mongodb-hpa"},
}

func TestParseMongoDBMetadata(t *testing.T) {
for _, testData := range testMONGODBMetadata {
_, _, err := parseMongoDBMetadata(&ScalerConfig{TriggerMetadata: testData.metadata, AuthParams: testData.authParams})
_, _, err := parseMongoDBMetadata(&ScalerConfig{ResolvedEnv: testData.resolvedEnv, TriggerMetadata: testData.metadata, AuthParams: testData.authParams})
if err != nil && !testData.raisesError {
t.Error("Expected success but got error:", err)
}
Expand All @@ -81,6 +100,16 @@ func TestParseMongoDBMetadata(t *testing.T) {
}
}

func TestParseMongoDBConnectionString(t *testing.T) {
for _, testData := range mongoDBConnectionStringTestDatas {
_, connStr, err := parseMongoDBMetadata(&ScalerConfig{ResolvedEnv: testData.metadataTestData.resolvedEnv, TriggerMetadata: testData.metadataTestData.metadata, AuthParams: testData.metadataTestData.authParams})
if err != nil {
t.Error("Expected success but got error:", err)
}
assert.Equal(t, testData.connectionString, connStr)
}
}

func TestMongoDBGetMetricSpecForScaling(t *testing.T) {
for _, testData := range mongoDBMetricIdentifiers {
meta, _, err := parseMongoDBMetadata(&ScalerConfig{ResolvedEnv: testData.metadataTestData.resolvedEnv, AuthParams: testData.metadataTestData.authParams, TriggerMetadata: testData.metadataTestData.metadata, ScalerIndex: testData.scalerIndex})
Expand Down