diff options
author | PV99 <pridhvi.vegesna@mongodb.com> | 2020-06-30 21:03:45 +0000 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2020-07-15 00:25:54 +0000 |
commit | 66aba27804f8b363b5165ae01e34c7a5155c6863 (patch) | |
tree | d2d87cb88382ef7c5fc48976fe78cda698acc31f | |
parent | f07b26628c8aaa9cbd68cbeb096c08c778c8c4a8 (diff) | |
download | mongo-66aba27804f8b363b5165ae01e34c7a5155c6863.tar.gz |
SERVER-48866 Parse Versioned API parameters
-rw-r--r-- | jstests/core/version_api_field_parsing.js | 47 | ||||
-rw-r--r-- | src/mongo/db/SConscript | 2 | ||||
-rw-r--r-- | src/mongo/db/initialize_api_parameters.cpp | 52 | ||||
-rw-r--r-- | src/mongo/db/initialize_api_parameters.h | 42 | ||||
-rw-r--r-- | src/mongo/db/initialize_api_parameters.idl | 57 | ||||
-rw-r--r-- | src/mongo/db/service_entry_point_common.cpp | 4 | ||||
-rw-r--r-- | src/mongo/s/commands/strategy.cpp | 3 |
7 files changed, 207 insertions, 0 deletions
diff --git a/jstests/core/version_api_field_parsing.js b/jstests/core/version_api_field_parsing.js new file mode 100644 index 00000000000..524c4749338 --- /dev/null +++ b/jstests/core/version_api_field_parsing.js @@ -0,0 +1,47 @@ +/** + * Checks that the server properly parses "API Version" parameters + * + * @tags: [requires_fcv_46] + */ + +(function() { +"use strict"; + +// If the client passed apiStrict, they must also pass apiVersion. +assert.commandFailedWithCode(db.runCommand({ping: 1, apiStrict: true}), + 4886600, + "Provided apiStrict without passing apiVersion"); + +// If the client passed apiDeprecationErrors, they must also pass apiVersion. +assert.commandFailedWithCode(db.runCommand({ping: 1, apiDeprecationErrors: false}), + 4886600, + "Provided apiDeprecationErrors without passing apiVersion"); + +// If the client passed apiVersion, it must be of type string. +assert.commandFailedWithCode(db.runCommand({ping: 1, apiVersion: 1}), + ErrorCodes.TypeMismatch, + "apiVersion' is the wrong type 'double', expected type 'string'"); + +// If the client passed apiVersion, its value must be "1". +assert.commandFailedWithCode(db.runCommand({ping: 1, apiVersion: "2"}), + ErrorCodes.APIVersionError, + "API version must be \"1\""); + +// If the client passed apiStrict, it must be of type boolean. +assert.commandFailedWithCode(db.runCommand({ping: 1, apiVersion: "1", apiStrict: "true"}), + ErrorCodes.TypeMismatch, + "apiStrict' is the wrong type 'string', expected type 'boolean'"); + +// If the client passed apiDeprecationErrors, it must be of type boolean. +assert.commandFailedWithCode( + db.runCommand({ping: 1, apiVersion: "1", apiDeprecationErrors: "false"}), + ErrorCodes.TypeMismatch, + "apiDeprecationErrors' is the wrong type 'string', expected type 'boolean'"); + +// Sanity check that command works with proper parameters. +assert.commandWorked( + db.runCommand({ping: 1, apiVersion: "1", apiStrict: true, apiDeprecationErrors: true})); +assert.commandWorked( + db.runCommand({ping: 1, apiVersion: "1", apiStrict: false, apiDeprecationErrors: false})); +assert.commandWorked(db.runCommand({ping: 1, apiVersion: "1"})); +})();
\ No newline at end of file diff --git a/src/mongo/db/SConscript b/src/mongo/db/SConscript index ffaa6527748..700b5be4105 100644 --- a/src/mongo/db/SConscript +++ b/src/mongo/db/SConscript @@ -1398,7 +1398,9 @@ env.Library( env.Library( target='shared_request_handling', source=[ + 'initialize_api_parameters.cpp', 'transaction_validation.cpp', + env.Idlc('initialize_api_parameters.idl')[0], ], LIBDEPS=[ 'error_labels', diff --git a/src/mongo/db/initialize_api_parameters.cpp b/src/mongo/db/initialize_api_parameters.cpp new file mode 100644 index 00000000000..e6f31cbb8c5 --- /dev/null +++ b/src/mongo/db/initialize_api_parameters.cpp @@ -0,0 +1,52 @@ +/** + * Copyright (C) 2020-present MongoDB, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the Server Side Public License, version 1, + * as published by MongoDB, Inc. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Server Side Public License for more details. + * + * You should have received a copy of the Server Side Public License + * along with this program. If not, see + * <http://www.mongodb.com/licensing/server-side-public-license>. + * + * As a special exception, the copyright holders give permission to link the + * code of portions of this program with the OpenSSL library under certain + * conditions as described in each individual source file and distribute + * linked combinations including the program with the OpenSSL library. You + * must comply with the Server Side Public License in all respects for + * all of the code used other than as permitted herein. If you modify file(s) + * with this exception, you may extend this exception to your version of the + * file(s), but you are not obligated to do so. If you do not wish to do so, + * delete this exception statement from your version. If you delete this + * exception statement from all source files in the program, then also delete + * it in the license file. + */ + +#include "mongo/db/initialize_api_parameters.h" + +namespace mongo { + +APIParametersFromClient initializeAPIParameters(const BSONObj& requestBody) { + + auto vAPI = APIParametersFromClient::parse("APIParametersFromClient"_sd, requestBody); + + if (vAPI.getApiDeprecationErrors() || vAPI.getApiStrict()) { + uassert(4886600, + "Provided apiStrict and/or apiDeprecationErrors without passing apiVersion", + vAPI.getApiVersion()); + } + + if (vAPI.getApiVersion()) { + uassert(ErrorCodes::APIVersionError, + "API version must be \"1\"", + "1" == vAPI.getApiVersion().value()); + } + return vAPI; +} + +} // namespace mongo diff --git a/src/mongo/db/initialize_api_parameters.h b/src/mongo/db/initialize_api_parameters.h new file mode 100644 index 00000000000..69d216fc7cc --- /dev/null +++ b/src/mongo/db/initialize_api_parameters.h @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2020-present MongoDB, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the Server Side Public License, version 1, + * as published by MongoDB, Inc. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Server Side Public License for more details. + * + * You should have received a copy of the Server Side Public License + * along with this program. If not, see + * <http://www.mongodb.com/licensing/server-side-public-license>. + * + * As a special exception, the copyright holders give permission to link the + * code of portions of this program with the OpenSSL library under certain + * conditions as described in each individual source file and distribute + * linked combinations including the program with the OpenSSL library. You + * must comply with the Server Side Public License in all respects for + * all of the code used other than as permitted herein. If you modify file(s) + * with this exception, you may extend this exception to your version of the + * file(s), but you are not obligated to do so. If you do not wish to do so, + * delete this exception statement from your version. If you delete this + * exception statement from all source files in the program, then also delete + * it in the license file. + */ + +#pragma once + +#include "mongo/db/initialize_api_parameters_gen.h" + +namespace mongo { + +/** + * Parses a command's API Version parameters from a request and stores the apiVersion, apiStrict, + * and apiDeprecationErrors fields. + */ +APIParametersFromClient initializeAPIParameters(const BSONObj& requestBody); + +} // namespace mongo
\ No newline at end of file diff --git a/src/mongo/db/initialize_api_parameters.idl b/src/mongo/db/initialize_api_parameters.idl new file mode 100644 index 00000000000..d44c7402603 --- /dev/null +++ b/src/mongo/db/initialize_api_parameters.idl @@ -0,0 +1,57 @@ +# Copyright (C) 2020-present MongoDB, Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the Server Side Public License, version 1, +# as published by MongoDB, Inc. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# Server Side Public License for more details. +# +# You should have received a copy of the Server Side Public License +# along with this program. If not, see +# <http://www.mongodb.com/licensing/server-side-public-license>. +# +# As a special exception, the copyright holders give permission to link the +# code of portions of this program with the OpenSSL library under certain +# conditions as described in each individual source file and distribute +# linked combinations including the program with the OpenSSL library. You +# must comply with the Server Side Public License in all respects for +# all of the code used other than as permitted herein. If you modify file(s) +# with this exception, you may extend this exception to your version of the +# file(s), but you are not obligated to do so. If you do not wish to do so, +# delete this exception statement from your version. If you delete this +# exception statement from all source files in the program, then also delete +# it in the license file. + +# This IDL file describes the BSON format for an APIParametersFromClient. +# It also handles the serialization to / deserialization from its +# BSON representation for that class. + +global: + cpp_namespace: "mongo" + +imports: + - "mongo/idl/basic_types.idl" + +structs: + + APIParametersFromClient: + description: "Parser for pulling out VersionedAPI parameters from commands" + strict: false + fields: + apiVersion: + description: "The api version specified by the command" + type: string + optional: true + apiStrict: + description: "With apiVersion: 'V' and apiStrict: true, the server rejects requests to + use behaviors not included in V" + type: bool + optional: true + apiDeprecationErrors: + description: "With apiVersion: 'V' and apiDeprecationErrors: true, the server rejects + requests to use behaviors deprecated in V in the current MongoDB release" + type: bool + optional: true
\ No newline at end of file diff --git a/src/mongo/db/service_entry_point_common.cpp b/src/mongo/db/service_entry_point_common.cpp index 15681bc8522..4dc77547321 100644 --- a/src/mongo/db/service_entry_point_common.cpp +++ b/src/mongo/db/service_entry_point_common.cpp @@ -50,6 +50,7 @@ #include "mongo/db/cursor_manager.h" #include "mongo/db/dbdirectclient.h" #include "mongo/db/error_labels.h" +#include "mongo/db/initialize_api_parameters.h" #include "mongo/db/initialize_operation_session_info.h" #include "mongo/db/introspect.h" #include "mongo/db/jsobj.h" @@ -931,6 +932,9 @@ void execCommandDatabase(OperationContext* opCtx, rpc::TrackingMetadata::get(opCtx).initWithOperName(command->getName()); auto const replCoord = repl::ReplicationCoordinator::get(opCtx); + + auto apiParams = initializeAPIParameters(request.body); + sessionOptions = initializeOperationSessionInfo( opCtx, request.body, diff --git a/src/mongo/s/commands/strategy.cpp b/src/mongo/s/commands/strategy.cpp index 26658c8b514..35d00622d7c 100644 --- a/src/mongo/s/commands/strategy.cpp +++ b/src/mongo/s/commands/strategy.cpp @@ -46,6 +46,7 @@ #include "mongo/db/commands.h" #include "mongo/db/curop.h" #include "mongo/db/error_labels.h" +#include "mongo/db/initialize_api_parameters.h" #include "mongo/db/initialize_operation_session_info.h" #include "mongo/db/lasterror.h" #include "mongo/db/logical_clock.h" @@ -346,6 +347,8 @@ void runCommand(OperationContext* opCtx, // Fill out all currentOp details. CurOp::get(opCtx)->setGenericOpRequestDetails(opCtx, nss, command, request.body, opType); + auto apiParams = initializeAPIParameters(request.body); + auto osi = initializeOperationSessionInfo(opCtx, request.body, command->requiresAuth(), |