Skip to content

CDRIVER-4657 Prohibit extra fields when matching command subdocuments #1297

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

Merged
merged 8 commits into from
Jun 13, 2023
Merged

CDRIVER-4657 Prohibit extra fields when matching command subdocuments #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2ae0ebd
prohibit extra fields in command subdocuments
kevinAlbs May 31, 2023
8666a7e
call visitor_fn when matching arrays
kevinAlbs May 31, 2023
2674d50
copy fle2v2-CreateCollection
kevinAlbs May 31, 2023
f68abda
skip check for on `multi` and `upsert` in updates
kevinAlbs Jun 1, 2023
961982a
silence scan-build
kevinAlbs Jun 7, 2023
c737c72
Apply suggested comment rewordings
kevinAlbs Jun 8, 2023
546387e
document handling of visitor_fn return
kevinAlbs Jun 8, 2023
67b4f7e
remove unnecessary `void*` cast
kevinAlbs Jun 8, 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
116 changes: 114 additions & 2 deletions src/libmongoc/tests/json-test-monitoring.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,47 @@ apm_match_visitor (match_ctx_t *ctx,
visitor_ctx->command_name = bson_strdup (bson_iter_key (doc_iter));
}

// Subdocuments in `command` should not have extra fields.
if (NULL != strstr (ctx->path, ".command") && doc_iter) {
if (BSON_ITER_HOLDS_DOCUMENT (doc_iter) &&
BSON_ITER_HOLDS_DOCUMENT (pattern_iter)) {
bson_t doc_subdoc;
bson_iter_bson (doc_iter, &doc_subdoc);
bson_iter_t doc_subdoc_iter;
bson_iter_init (&doc_subdoc_iter, &doc_subdoc);
while (bson_iter_next (&doc_subdoc_iter)) {
const char *subdoc_key = bson_iter_key (&doc_subdoc_iter);

bson_t pattern_subdoc;
bson_iter_bson (pattern_iter, &pattern_subdoc);
bson_iter_t pattern_subdoc_iter;

bool skip = false;
if (ends_with (ctx->path, "updates") &&
(0 == strcmp ("multi", subdoc_key) ||
0 == strcmp ("upsert", subdoc_key))) {
// libmongoc includes `multi: false` and `upsert: false`.
// Some tests do not include `multi: false` and `upsert: false`
// in expectations. See DRIVERS-2271 and DRIVERS-976.
skip = true;
}

if (!skip && !bson_iter_init_find (&pattern_subdoc_iter,
&pattern_subdoc,
subdoc_key)) {
match_err (
ctx,
"unexpected extra field '%s' in captured event "
"command subdocument of field '%s'. pattern_subdoc=%s",
subdoc_key,
key,
tmp_json (&pattern_subdoc));
return MATCH_ACTION_ABORT;
}
}
}
}

if (IS_COMMAND ("find") || IS_COMMAND ("aggregate")) {
/* New query. Next server reply or getMore will set cursor_id. */
visitor_ctx->cursor_id = 0;
Expand Down Expand Up @@ -513,7 +554,7 @@ check_json_apm_events (json_test_ctx_t *ctx, const bson_t *expectations)
match_ctx.retain_dots_in_keys = true;
match_ctx.allow_placeholders = true;
match_ctx.visitor_fn = apm_match_visitor;
match_ctx.visitor_ctx = (void *) &apm_match_visitor_ctx;
match_ctx.visitor_ctx = &apm_match_visitor_ctx;

allow_subset = ctx->config->command_monitoring_allow_subset;

Expand Down Expand Up @@ -608,7 +649,7 @@ test_apm_matching (void)
"}";

match_ctx.visitor_fn = apm_match_visitor;
match_ctx.visitor_ctx = (void *) &match_visitor_ctx;
match_ctx.visitor_ctx = &match_visitor_ctx;

BSON_ASSERT (match_bson_with_ctx (tmp_bson (e1), tmp_bson (e1), &match_ctx));
BSON_ASSERT (
Expand All @@ -617,9 +658,80 @@ test_apm_matching (void)
apm_match_visitor_ctx_reset (&match_visitor_ctx);
}

// Test that documents in command_started_event.command do not permit extra
// fields by default.
static void
test_apm_matching_extra_fields (void)
{
// Extra fields are permitted in `command`.
{
apm_match_visitor_ctx_t match_visitor_ctx = {0};
match_ctx_t match_ctx = {{0}};

const char *event = BSON_STR (
{"command_started_event" : {"command" : {"a" : 1, "b" : 2}}});
const char *pattern =
BSON_STR ({"command_started_event" : {"command" : {"a" : 1}}});

match_ctx.visitor_fn = apm_match_visitor;
match_ctx.visitor_ctx = &match_visitor_ctx;

bool matched =
match_bson_with_ctx (tmp_bson (event), tmp_bson (pattern), &match_ctx);
ASSERT (matched);
apm_match_visitor_ctx_reset (&match_visitor_ctx);
}

// Extra fields are not permitted in `command` sub-documents.
{
apm_match_visitor_ctx_t match_visitor_ctx = {0};
match_ctx_t match_ctx = {{0}};

const char *event = BSON_STR ({
"command_started_event" : {"command" : {"subdoc" : {"a" : 1, "b" : 2}}}
});
const char *pattern = BSON_STR (
{"command_started_event" : {"command" : {"subdoc" : {"a" : 1}}}});

match_ctx.visitor_fn = apm_match_visitor;
match_ctx.visitor_ctx = &match_visitor_ctx;

bool matched =
match_bson_with_ctx (tmp_bson (event), tmp_bson (pattern), &match_ctx);
ASSERT (!matched);
ASSERT_CONTAINS (match_ctx.errmsg, "unexpected extra field 'b'");
apm_match_visitor_ctx_reset (&match_visitor_ctx);
}

// Extra fields are not permitted in `command` sub-arrays.
{
apm_match_visitor_ctx_t match_visitor_ctx = {0};
match_ctx_t match_ctx = {{0}};

const char *event = BSON_STR ({
"command_started_event" :
{"command" : {"subarray" : [ {"a" : 1, "b" : 2} ]}}
});
const char *pattern = BSON_STR ({
"command_started_event" : {"command" : {"subarray" : [ {"a" : 1} ]}}
});

match_ctx.visitor_fn = apm_match_visitor;
match_ctx.visitor_ctx = &match_visitor_ctx;

bool matched =
match_bson_with_ctx (tmp_bson (event), tmp_bson (pattern), &match_ctx);
ASSERT (!matched);
ASSERT_CONTAINS (match_ctx.errmsg, "unexpected extra field 'b'");
apm_match_visitor_ctx_reset (&match_visitor_ctx);
}
}


void
test_apm_install (TestSuite *suite)
{
TestSuite_Add (suite, "/apm_test_matching", test_apm_matching);
TestSuite_Add (
suite, "/apm_test_matching/extra_fields", test_apm_matching_extra_fields);
}
18 changes: 0 additions & 18 deletions src/libmongoc/tests/json/client_side_encryption/legacy/fle2v2-CreateCollection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -343,9 +340,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -851,9 +845,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1048,9 +1039,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1367,9 +1355,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1635,9 +1620,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down
18 changes: 18 additions & 0 deletions src/libmongoc/tests/test-conveniences.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -977,10 +977,14 @@ match_bson_with_ctx (const bson_t *doc, const bson_t *pattern, match_ctx_t *ctx)
match_action_t action =
ctx->visitor_fn (ctx, &pattern_iter, found ? &doc_iter : NULL);
if (action == MATCH_ACTION_ABORT) {
// Visitor encountered a match error.
goto fail;
} else if (action == MATCH_ACTION_SKIP) {
// Visitor handled match of this field. Skip any additional matching
// of this field.
goto next;
}
ASSERT (action == MATCH_ACTION_CONTINUE);
}

if (value->value_type == BSON_TYPE_NULL && found) {
Expand Down Expand Up @@ -1302,6 +1306,20 @@ match_bson_arrays (const bson_t *array, const bson_t *pattern, match_ctx_t *ctx)

derive (ctx, &derived, bson_iter_key (&array_iter));

if (ctx && ctx->visitor_fn) {
match_action_t action =
ctx->visitor_fn (ctx, &pattern_iter, &array_iter);
if (action == MATCH_ACTION_ABORT) {
// Visitor encountered a match error.
return false;
} else if (action == MATCH_ACTION_SKIP) {
// Visitor handled match of this field. Skip any additional matching
// of this field.
continue;
}
ASSERT (action == MATCH_ACTION_CONTINUE);
}

if (!match_bson_value (array_value, pattern_value, &derived)) {
return false;
}
Expand Down