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
73
74
75
|
/**
* Copyright (C) 2018-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 <cstdint>
#include "mongo/base/status.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsontypes.h"
namespace mongo {
enum class BSONValidateMode {
// Only fast structural BSON consistency checks.
kDefault,
// Structural BSON consistency and extra fast checks on BSON specifications.
kExtended,
// Structural BSON consistency and extra comprehensive checks on BSON specifications.
kFull,
};
/**
* Checks that the buf holds a BSON object as defined in http://bsonspec.org/spec.html.
* Note that maxLength is the buffer size, NOT the BSON size.
* Validation errors result in returning an InvalidBSON or Overflow status.
* For the default validation mode, the checks are structural only, and include:
* - String, Object, Array, BinData, DBRef, Code, Symbol and CodeWScope lengths are correct.
* - Field names, String, Object, Array, DBRef, Code, Symbol, and CodeWScope end with NUL.
* - Bool values are false (0) or true (1).
* - Correct nesting, not exceeding maximum allowable nesting depth.
* For the extended validation mode, the checks include everything above and:
* - Deprecated types are not used.
* - Contents of array indices are consecutively numbered from zero.
* - Correct UUID and MD5 lengths.
* - Structurally correct encrypted BSON values.
* - Valid regular expression options.
* For the full validation mode, the checks include everything above and:
* - Field names are not duplicated in the same level.
* - Validity of UTF-8 strings.
* - Valid compressed BSON columns.
* Length is only limited by the buffer's maxLength and the inherent 2GB - 1 format limitation.
*/
Status validateBSON(const char* buf,
uint64_t maxLength,
BSONValidateMode mode = BSONValidateMode::kDefault) noexcept;
Status validateBSON(const BSONObj& obj, BSONValidateMode mode = BSONValidateMode::kDefault);
} // namespace mongo
|
