summaryrefslogtreecommitdiff
path: root/src/mongo/bson/bson_depth.h
blob: ef8ffc3631d108c6f10f6a1c869928e6e19e1574 (plain)
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
/**
 * Copyright (C) 2017 MongoDB Inc.
 *
 * This program is free software: you can redistribute it and/or  modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * 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 GNU Affero General 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 <cstdint>

namespace mongo {
/**
 * Controls the maximum BSON depth tolerated by the server.
 */
struct BSONDepth {
    // The default BSON depth nesting limit.
    static constexpr std::int32_t kDefaultMaxAllowableDepth = 200;

    // The minimum allowable value for the BSON depth parameter.
    static constexpr std::int32_t kBSONDepthParameterFloor = 5;

    // The maximum allowable value for the BSON depth parameter.
    static constexpr std::int32_t kBSONDepthParameterCeiling = 1000;

    // The depth of BSON accepted by the server. Configurable via the 'maxBSONDepth' server
    // parameter.
    static std::int32_t maxAllowableDepth;

    /**
     * Returns the maximum allowable BSON depth as an unsigned integer.
     */
    static std::uint32_t getMaxAllowableDepth();
};
}  // namespace mongo