1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/**
* Copyright (C) 2021-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/client.h"
#include "mongo/rpc/message.h"
namespace mongo {
/**
* Logs a warning message for use of a legacy opcode or getLastError command once per each unique
* client in 60 minutes-period by default.
* - The specific deprecated op code or command is given by 'op' parameter.
* - Each client is identified by remote IP if client metadata is not available. If client metadata
* is available, a client is identified by client metadata’s application name + driver name +
* driver version.
* - The log message includes the following information.
* - Either client IP and port if client metadata is not available,
* - Or client metadata if client metadata is available.
* - The warning period is defined by 'deprecatedWireOpsWarningPeriodInSeconds' setParameter.
* - The default value is 3600 seconds.
* - If this value is 0, every legacy op code or getLastError request is logged with a warning
* message.
*/
void warnDeprecation(Client& client, StringData op);
/**
* Callback that gets invoked when 'deprecatedWireOpsWarningPeriodInSeconds' setting is changed.
*/
Status onUpdateOfWireOpsWarningPeriod(const int&);
/**
* Logs a warning message and throws if 'cmd' is not an allowed 'OP_QUERY' command.
*
* OP_QUERY commands are no longer serviced by mongos or mongod processes, with the following
* exceptions.
*
* - The isMaster/ismaster/hello OP_QUERY commands are allowed for connection handshake.
*
* - The _isSelf/saslContinue/saslStart OP_QUERY commands are allowed for intra-cluster
* communication in a mixed version cluster. V5.0 nodes may send those commands as OP_QUERY ones.
*/
void checkAllowedOpQueryCommand(Client& client, StringData cmd);
} // namespace mongo
|
