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

Validate database names for SQLite handler #2924

Merged
merged 21 commits into from
Jun 30, 2023
Merged

Validate database names for SQLite handler #2924

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8fa95f7
init
noisersup Jun 27, 2023
a3fec92
basic error handling
noisersup Jun 28, 2023
6660760
wip
noisersup Jun 28, 2023
666b9f1
tests
noisersup Jun 28, 2023
bc62b6b
more tests
noisersup Jun 28, 2023
0d8c323
wip
noisersup Jun 28, 2023
b2c2200
wip
noisersup Jun 28, 2023
c8ce865
Merge branch 'validate-db-2749-2' into validate-db-2749
noisersup Jun 28, 2023
b5b05e5
wip
noisersup Jun 29, 2023
77dddee
new error
noisersup Jun 29, 2023
ef766a8
wip
noisersup Jun 29, 2023
99c88b2
revert overcomplication
noisersup Jun 29, 2023
9dec001
remove error
noisersup Jun 29, 2023
06b6d98
altMessage
noisersup Jun 29, 2023
1b4c799
wip
noisersup Jun 30, 2023
a36497d
wip
noisersup Jun 30, 2023
9f0ad39
wip
noisersup Jun 30, 2023
ef461b3
Merge remote-tracking branch 'upstream/main' into validate-db-2749
noisersup Jun 30, 2023
a635ff6
Remove empty test
noisersup Jun 30, 2023
37757ed
Merge branch 'main' into validate-db-2749
mergify[bot] Jun 30, 2023
409396c
Merge branch 'main' into validate-db-2749
mergify[bot] Jun 30, 2023
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
71 changes: 66 additions & 5 deletions integration/basic_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/x/mongo/driver"

"github.com/FerretDB/FerretDB/integration/setup"
"github.com/FerretDB/FerretDB/integration/shareddata"
Expand Down Expand Up @@ -446,6 +447,46 @@ func TestDatabaseName(t *testing.T) {

t.Parallel()

t.Run("NoErr", func(t *testing.T) {
ctx, collection := setup.Setup(t)
for name, tc := range map[string]struct {
db string // database name, defaults to empty string
skip string // optional, skip test with a specified reason
}{
"Dash": {
db: "--",
},
"Underscore": {
db: "__",
},
"Sqlite": {
db: "sqlite_",
},
AlekSi marked this conversation as resolved.
Show resolved Hide resolved
"Number": {
db: "0prefix",
},
"63ok": {
db: strings.Repeat("a", 63),
},
} {
name, tc := name, tc
t.Run(name, func(t *testing.T) {
if tc.skip != "" {
t.Skip(tc.skip)
}

t.Parallel()

// there is no explicit command to create database, so create collection instead
err := collection.Database().Client().Database(tc.db).CreateCollection(ctx, collection.Name())
require.NoError(t, err)

err = collection.Database().Client().Database(tc.db).Drop(ctx)
require.NoError(t, err)
})
}
})

t.Run("Err", func(t *testing.T) {
ctx, collection := setup.Setup(t)

Expand All @@ -471,6 +512,25 @@ func TestDatabaseName(t *testing.T) {
},
altMessage: fmt.Sprintf("Invalid namespace: %s.%s", dbName64, "TestDatabaseName-Err"),
},
"WithASlash": {
db: "/",
err: &mongo.CommandError{
Name: "InvalidNamespace",
Code: 73,
Message: `Invalid namespace specified '/.TestDatabaseName-Err'`,
},
altMessage: `Invalid namespace: /.TestDatabaseName-Err`,
},

"WithABackslash": {
db: "\\",
err: &mongo.CommandError{
Name: "InvalidNamespace",
Code: 73,
Message: `Invalid namespace specified '\.TestDatabaseName-Err'`,
},
altMessage: `Invalid namespace: \.TestDatabaseName-Err`,
},
AlekSi marked this conversation as resolved.
Show resolved Hide resolved
"WithADollarSign": {
db: "name_with_a-$",
err: &mongo.CommandError{
Expand Down Expand Up @@ -517,13 +577,14 @@ func TestDatabaseName(t *testing.T) {
}
})

t.Run("63ok", func(t *testing.T) {
t.Run("Empty", func(t *testing.T) {
t.Parallel()

ctx, collection := setup.Setup(t)

dbName63 := strings.Repeat("a", 63)
err := collection.Database().Client().Database(dbName63).CreateCollection(ctx, collection.Name())
require.NoError(t, err)
collection.Database().Client().Database(dbName63).Drop(ctx)
err := collection.Database().Client().Database("").CreateCollection(ctx, collection.Name())
expectedErr := driver.InvalidOperationError(driver.InvalidOperationError{MissingField: "Database"})
assert.Equal(t, expectedErr, err)
})
}

Expand Down
2 changes: 1 addition & 1 deletion internal/handlers/pg/pgdb/databases.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
)

// validateDatabaseNameRe validates FerretDB database / PostgreSQL schema names.
var validateDatabaseNameRe = regexp.MustCompile("^[a-zA-Z_-][a-zA-Z0-9_-]{0,62}$")
var validateDatabaseNameRe = regexp.MustCompile("^[a-zA-Z0-9_-]{1,63}$")

// Databases returns a sorted list of FerretDB databases / PostgreSQL schemas.
func Databases(ctx context.Context, tx pgx.Tx) ([]string, error) {
Expand Down
13 changes: 11 additions & 2 deletions internal/handlers/sqlite/msg_create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ package sqlite
import (
"context"
"fmt"
"regexp"

"github.com/FerretDB/FerretDB/internal/backends"
"github.com/FerretDB/FerretDB/internal/handlers/common"
Expand All @@ -27,6 +28,9 @@ import (
"github.com/FerretDB/FerretDB/internal/wire"
)

// validateDatabaseNameRe validates FerretDB database name.
var validateDatabaseNameRe = regexp.MustCompile("^[a-zA-Z0-9_-]{1,63}$")

// MsgCreate implements HandlerInterface.
func (h *Handler) MsgCreate(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error) {
document, err := msg.Document()
Expand Down Expand Up @@ -78,6 +82,11 @@ func (h *Handler) MsgCreate(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg,
return nil, err
}

if !validateDatabaseNameRe.MatchString(dbName) {
msg := fmt.Sprintf("Invalid namespace: %s.%s", dbName, collectionName)
return nil, commonerrors.NewCommandErrorMsgWithArgument(commonerrors.ErrInvalidNamespace, msg, "create")
}

db := h.b.Database(dbName)
defer db.Close()

Expand All @@ -98,11 +107,11 @@ func (h *Handler) MsgCreate(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg,

case backends.ErrorCodeIs(err, backends.ErrorCodeCollectionAlreadyExists):
msg := fmt.Sprintf("Collection %s.%s already exists.", dbName, collectionName)
return nil, commonerrors.NewCommandErrorMsg(commonerrors.ErrNamespaceExists, msg)
return nil, commonerrors.NewCommandErrorMsgWithArgument(commonerrors.ErrNamespaceExists, msg, "create")

case backends.ErrorCodeIs(err, backends.ErrorCodeCollectionNameIsInvalid):
msg := fmt.Sprintf("Invalid namespace: %s.%s", dbName, collectionName)
return nil, commonerrors.NewCommandErrorMsg(commonerrors.ErrInvalidNamespace, msg)
return nil, commonerrors.NewCommandErrorMsgWithArgument(commonerrors.ErrInvalidNamespace, msg, "create")

default:
return nil, lazyerrors.Error(err)
Expand Down