mirror of
https://github.com/trufflesecurity/trufflehog.git
synced 2024-11-10 07:04:24 +00:00
Fix SQL Server detector tests (#2716)
These tests were broken so I fixed them and updated them to use testcontainers, which is more robust and used in the JDBC detector tests.
This commit is contained in:
Cody Rose
GitHub
parent
81a9c813a1
commit
ba5ad5d8a9
2 changed files with 60 additions and 72 deletions
|
|
@ -73,6 +73,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
|
|||
var ping = func(config msdsn.Config) (bool, error) {
|
||||
cleanConfig := msdsn.Config{}
|
||||
cleanConfig.Host = config.Host
|
||||
cleanConfig.Port = config.Port
|
||||
cleanConfig.User = config.User
|
||||
cleanConfig.Password = config.Password
|
||||
cleanConfig.Database = config.Database
|
||||
|
|
|
|||
|
|
@ -4,22 +4,42 @@
|
|||
package sqlserver
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/brianvoe/gofakeit/v7"
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/google/go-cmp/cmp/cmpopts"
|
||||
"github.com/testcontainers/testcontainers-go"
|
||||
"github.com/testcontainers/testcontainers-go/modules/mssql"
|
||||
|
||||
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
|
||||
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
|
||||
)
|
||||
|
||||
func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
password := gofakeit.Password(true, true, true, false, false, 10)
|
||||
|
||||
container, err := mssql.RunContainer(
|
||||
ctx,
|
||||
testcontainers.WithImage("mcr.microsoft.com/azure-sql-edge"),
|
||||
mssql.WithAcceptEULA(),
|
||||
mssql.WithPassword(password))
|
||||
if err != nil {
|
||||
t.Fatalf("could not start container: %v", err)
|
||||
}
|
||||
|
||||
defer container.Terminate(ctx)
|
||||
|
||||
port, err := container.MappedPort(ctx, "1433")
|
||||
if err != nil {
|
||||
t.Fatalf("could get mapped port: %v", err)
|
||||
}
|
||||
|
||||
type args struct {
|
||||
ctx context.Context
|
||||
data []byte
|
||||
|
|
@ -38,15 +58,20 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
s: Scanner{},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
data: []byte("Server=localhost;Initial Catalog=master;User ID=sa;Password=P@ssw0rd!;Persist Security Info=true;MultipleActiveResultSets=true;"),
|
||||
data: []byte(fmt.Sprintf("Server=localhost;Port=%s;Initial Catalog=master;User ID=sa;Password=%s;Persist Security Info=true;MultipleActiveResultSets=true;",
|
||||
port.Port(),
|
||||
password)),
|
||||
verify: true,
|
||||
},
|
||||
want: []detectors.Result{
|
||||
{
|
||||
DetectorType: detectorspb.DetectorType_SQLServer,
|
||||
Raw: []byte("P@ssw0rd!"),
|
||||
RawV2: []byte("sqlserver://sa:P%40ssw0rd%21@localhost?database=master&disableRetry=false"),
|
||||
Redacted: "sqlserver://sa:********@localhost?database=master&disableRetry=false",
|
||||
Raw: []byte(password),
|
||||
RawV2: []byte(urlEncode(fmt.Sprintf("sqlserver://sa:%s@localhost:%s?database=master&dial+timeout=15&disableretry=false",
|
||||
password,
|
||||
port.Port()))),
|
||||
Redacted: fmt.Sprintf("sqlserver://sa:********@localhost:%s?database=master&dial+timeout=15&disableretry=false",
|
||||
port.Port()),
|
||||
Verified: true,
|
||||
},
|
||||
},
|
||||
|
|
@ -57,15 +82,17 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
s: Scanner{},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
data: []byte("Server=localhost;User ID=sa;Password=123"),
|
||||
data: []byte(fmt.Sprintf("Server=localhost;Port=%s;User ID=sa;Password=123", port.Port())),
|
||||
verify: true,
|
||||
},
|
||||
want: []detectors.Result{
|
||||
{
|
||||
DetectorType: detectorspb.DetectorType_SQLServer,
|
||||
Raw: []byte("123"),
|
||||
RawV2: []byte("sqlserver://sa:123@localhost?disableRetry=false"),
|
||||
Redacted: "sqlserver://sa:********@localhost?disableRetry=false",
|
||||
RawV2: []byte(fmt.Sprintf("sqlserver://sa:123@localhost:%s?dial+timeout=15&disableretry=false",
|
||||
port.Port())),
|
||||
Redacted: fmt.Sprintf("sqlserver://sa:********@localhost:%s?dial+timeout=15&disableretry=false",
|
||||
port.Port()),
|
||||
Verified: false,
|
||||
},
|
||||
},
|
||||
|
|
@ -76,7 +103,7 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
s: Scanner{},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
data: []byte(`<add name="Sample2" value="SERVER=server_name;DATABASE=database_name;user=user_name;pwd=plaintextpassword;encrypt=true;Timeout=120;MultipleActiveResultSets=True;" />`),
|
||||
data: []byte(`<add name="Sample2" value="SERVER=server_name;DATABASE=database_name;user=user_name;pwd=plaintextpassword;Timeout=120;MultipleActiveResultSets=True;" />`),
|
||||
verify: true,
|
||||
},
|
||||
want: nil,
|
||||
|
|
@ -87,15 +114,20 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
s: Scanner{},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
data: []byte(`<add name="test db" value="SERVER=localhost;DATABASE=master;user=sa;password=P@ssw0rd!;encrypt=true;Timeout=120;MultipleActiveResultSets=True;" />`),
|
||||
data: []byte(fmt.Sprintf(`<add name="test db" value="SERVER=localhost;PORT=%s;DATABASE=master;user=sa;password=%s;Timeout=120;MultipleActiveResultSets=True;" />`,
|
||||
port.Port(),
|
||||
password)),
|
||||
verify: true,
|
||||
},
|
||||
want: []detectors.Result{
|
||||
{
|
||||
DetectorType: detectorspb.DetectorType_SQLServer,
|
||||
Redacted: "sqlserver://sa:********@localhost?database=master&disableRetry=false",
|
||||
Raw: []byte("P@ssw0rd!"),
|
||||
RawV2: []byte("sqlserver://sa:P%40ssw0rd%21@localhost?database=master&disableRetry=false"),
|
||||
Redacted: fmt.Sprintf("sqlserver://sa:********@localhost:%s?database=master&dial+timeout=15&disableretry=false",
|
||||
port.Port()),
|
||||
Raw: []byte(password),
|
||||
RawV2: []byte(urlEncode(fmt.Sprintf("sqlserver://sa:%s@localhost:%s?database=master&dial+timeout=15&disableretry=false",
|
||||
password,
|
||||
port.Port()))),
|
||||
Verified: true,
|
||||
},
|
||||
},
|
||||
|
|
@ -113,8 +145,8 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
{
|
||||
DetectorType: detectorspb.DetectorType_SQLServer,
|
||||
Raw: []byte("P@ssw0rd!"),
|
||||
RawV2: []byte("sqlserver://sa:P%40ssw0rd%21@unreachablehost?database=master&disableRetry=false"),
|
||||
Redacted: "sqlserver://sa:********@unreachablehost?database=master&disableRetry=false",
|
||||
RawV2: []byte("sqlserver://sa:P%40ssw0rd%21@unreachablehost?database=master&dial+timeout=15&disableretry=false"),
|
||||
Redacted: "sqlserver://sa:********@unreachablehost?database=master&dial+timeout=15&disableretry=false",
|
||||
Verified: false,
|
||||
},
|
||||
},
|
||||
|
|
@ -134,11 +166,6 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
},
|
||||
}
|
||||
|
||||
if err := startSqlServer(); err != nil {
|
||||
t.Fatalf("could not start sql server for integration testing: %v", err)
|
||||
}
|
||||
defer stopSqlServer()
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := Scanner{}
|
||||
|
|
@ -163,47 +190,7 @@ func TestSQLServerIntegration_FromChunk(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
var sqlServerDockerHash string
|
||||
|
||||
func dockerLogLine(hash string, needle string) chan struct{} {
|
||||
ch := make(chan struct{}, 1)
|
||||
go func() {
|
||||
for {
|
||||
out, err := exec.Command("docker", "logs", hash).CombinedOutput()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
if strings.Contains(string(out), needle) {
|
||||
ch <- struct{}{}
|
||||
return
|
||||
}
|
||||
time.Sleep(1 * time.Second)
|
||||
}
|
||||
}()
|
||||
return ch
|
||||
}
|
||||
|
||||
func startSqlServer() error {
|
||||
cmd := exec.Command(
|
||||
"docker", "run", "--rm", "-p", "1433:1433",
|
||||
"-e", "ACCEPT_EULA=1",
|
||||
"-e", "MSSQL_SA_PASSWORD=P@ssw0rd!",
|
||||
"-d", "mcr.microsoft.com/azure-sql-edge",
|
||||
)
|
||||
out, err := cmd.Output()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
sqlServerDockerHash = string(bytes.TrimSpace(out))
|
||||
select {
|
||||
case <-dockerLogLine(sqlServerDockerHash, "EdgeTelemetry starting up"):
|
||||
return nil
|
||||
case <-time.After(30 * time.Second):
|
||||
stopSqlServer()
|
||||
return errors.New("timeout waiting for sql server database to be ready")
|
||||
}
|
||||
}
|
||||
|
||||
func stopSqlServer() {
|
||||
exec.Command("docker", "kill", sqlServerDockerHash).Run()
|
||||
func urlEncode(s string) string {
|
||||
parsed, _ := url.Parse(s)
|
||||
return parsed.String()
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue