trufflesecurity/trufflehog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

(fix) Remove db_type parameter Postgres detector during making connection (#3989)

Browse Source 
* remove db_type from configuration parameter

* fix integration tests

* use single context for all tests instead of having separate for each
This commit is contained in:
Abdul Basit
2025-03-26 14:47:26 +05:00
committed by GitHub
parent c293bb2cda
commit 1f7636d176
2 changed files with 54 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/detectors/postgres/postgres.go
+10 -1
View File
@@ -129,7 +129,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) ([]dete
// parameters themselves.
if timeout, ok := getDeadlineInSeconds(ctx); ok && timeout > 0 {
params[pgConnectTimeout] = strconv.Itoa(timeout)
} else if timeout <= 0 {
} else if ok && timeout <= 0 {
// Deadline in the context has already exceeded.
break
}
@@ -223,6 +223,15 @@ func verifyPostgres(params map[string]string) (bool, error) {
}()
}
// db_type is not a valid configuration parameter, so we remove it before connecting.
dbType := params[pgDbType]
delete(params, pgDbType)
// we re-add it before returning to preserve in ExtraData
defer func() {
params[pgDbType] = dbType
}()
var connStr string
for key, value := range params {
connStr += fmt.Sprintf("%s='%s'", key, value)
pkg/detectors/postgres/postgres_integration_test.go
+44 -46
View File
@@ -34,6 +34,7 @@ const (
)
func TestPostgres_FromChunk(t *testing.T) {
ctx := context.Background()
if err := startPostgres(); err != nil {
if exitErr, ok := err.(*exec.ExitError); ok {
t.Fatalf("could not start local postgres: %v w/stderr:\n%s", err, string(exitErr.Stderr))
@@ -58,6 +59,10 @@ func TestPostgres_FromChunk(t *testing.T) {
ctx context.Context
data []byte
verify bool
// For tests that require a timeout context, in which case the above ctx will be ignored and new ctx at the
// time of test execution will be created
requiresTimeoutContext bool
}
tests := []struct {
name string
@@ -70,7 +75,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "not found",
s: Scanner{},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte("You cannot find the secret within"),
verify: true,
},
@@ -81,7 +86,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI with ssl mode unset, verified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
@@ -100,7 +105,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI with ssl mode 'prefer', verified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?sslmode=prefer`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
@@ -119,7 +124,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI with ssl mode 'allow', verified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?sslmode=allow`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
@@ -138,7 +143,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI with requiressl=0, verified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?requiressl=0`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
@@ -157,7 +162,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI without database, verified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
@@ -176,7 +181,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "found connection URI, unverified",
s: Scanner{detectLoopback: true},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, inactivePass, postgresHost, postgresPort)),
verify: true,
},
@@ -195,7 +200,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "ignored localhost",
s: Scanner{},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, postgresPass, "localhost", postgresPort)),
verify: true,
},
@@ -206,7 +211,7 @@ func TestPostgres_FromChunk(t *testing.T) {
name: "ignored 127.0.0.1",
s: Scanner{},
args: args{
ctx: context.Background(),
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, postgresPass, "127.0.0.1", postgresPort)),
verify: true,
},
@@ -216,15 +221,12 @@ func TestPostgres_FromChunk(t *testing.T) {
{
name: "found connection URI, unverified due to error - inactive host",
s: Scanner{},
args: func() args {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
return args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, postgresPass, inactiveHost, postgresPort)),
verify: true,
}
}(),
args: args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2`, postgresUser, postgresPass, inactiveHost, postgresPort)),
verify: true,
requiresTimeoutContext: true,
},
want: func() []detectors.Result {
r := detectors.Result{
DetectorType: detectorspb.DetectorType_Postgres,
@@ -241,15 +243,12 @@ func TestPostgres_FromChunk(t *testing.T) {
{
name: "found connection URI, unverified due to error - wrong port",
s: Scanner{detectLoopback: true},
args: func() args {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
return args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s/postgres2`, postgresUser, postgresPass, postgresHost)),
verify: true,
}
}(),
args: args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s/postgres2`, postgresUser, postgresPass, postgresHost)),
verify: true,
requiresTimeoutContext: true,
},
want: func() []detectors.Result {
r := detectors.Result{
DetectorType: detectorspb.DetectorType_Postgres,
@@ -266,15 +265,12 @@ func TestPostgres_FromChunk(t *testing.T) {
{
name: "found connection URI, unverified due to error - ssl not supported (using sslmode)",
s: Scanner{detectLoopback: true},
args: func() args {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
return args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?sslmode=require`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
}
}(),
args: args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?sslmode=require`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
requiresTimeoutContext: true,
},
want: func() []detectors.Result {
r := detectors.Result{
DetectorType: detectorspb.DetectorType_Postgres,
@@ -291,15 +287,11 @@ func TestPostgres_FromChunk(t *testing.T) {
{
name: "found connection URI, unverified due to error - ssl not supported (using requiressl)",
s: Scanner{detectLoopback: true},
args: func() args {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
return args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?requiressl=1`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
}
}(),
args: args{
ctx: ctx,
data: []byte(fmt.Sprintf(`postgresql://%s:%s@%s:%s/postgres2?requiressl=1`, postgresUser, postgresPass, postgresHost, postgresPort)),
verify: true,
},
want: func() []detectors.Result {
r := detectors.Result{
DetectorType: detectorspb.DetectorType_Postgres,
@@ -316,7 +308,13 @@ func TestPostgres_FromChunk(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)
ctx := tt.args.ctx
var cancel context.CancelFunc
if tt.args.requiresTimeoutContext {
ctx, cancel = context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
}
got, err := tt.s.FromData(ctx, tt.args.verify, tt.args.data)
if (err != nil) != tt.wantErr {
t.Errorf("postgres.FromData() error = %v, wantErr %v", err, tt.wantErr)
return