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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/**
* Copyright (C) 2015 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 <memory>
#include <string>
#include "mongo/base/disallow_copying.h"
#include "mongo/db/jsobj.h"
namespace boost {
namespace filesystem {
class path;
} // namespace filesystem
} // namespace boost
namespace mongo {
class DataProtector;
class StringData;
class ServiceContext;
class WiredTigerCustomizationHooks {
public:
static void set(ServiceContext* service,
std::unique_ptr<WiredTigerCustomizationHooks> custHooks);
static WiredTigerCustomizationHooks* get(ServiceContext* service);
virtual ~WiredTigerCustomizationHooks() = default;
/**
* Returns true if the customization hooks are enabled.
*/
virtual bool enabled() const = 0;
/**
* Perform any encryption engine initialization/sanity checking that needs to happen after
* storage engine initialization but before the server starts accepting incoming connections.
*
* Returns true if the server needs to be rebooted because of configuration changes.
*/
virtual bool restartRequired() = 0;
/**
* Gets an additional configuration string for the provided table name on a
* `WT_SESSION::create` call.
*/
virtual std::string getTableCreateConfig(StringData tableName) = 0;
/**
* Returns the maximum size addition when doing transforming temp data.
*/
size_t additionalBytesForProtectedBuffer() {
return 33;
}
/**
* Get the data protector object
*/
virtual std::unique_ptr<DataProtector> getDataProtector() = 0;
/**
* Get an implementation specific path suffix to tag files with
*/
virtual boost::filesystem::path getProtectedPathSuffix() = 0;
/**
* Transform temp data to non-readable form before writing it to disk.
*/
virtual Status protectTmpData(
const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen, size_t* resultLen) = 0;
/**
* Tranforms temp data back to readable form, after reading from disk.
*/
virtual Status unprotectTmpData(
const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen, size_t* resultLen) = 0;
};
// Empty default implementation of the abstract class WiredTigerCustomizationHooks
class EmptyWiredTigerCustomizationHooks : public WiredTigerCustomizationHooks {
public:
~EmptyWiredTigerCustomizationHooks() override;
bool enabled() const override;
bool restartRequired() override;
std::string getTableCreateConfig(StringData tableName) override;
std::unique_ptr<DataProtector> getDataProtector() override;
boost::filesystem::path getProtectedPathSuffix() override;
Status protectTmpData(
const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen, size_t* resultLen) override;
Status unprotectTmpData(
const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen, size_t* resultLen) override;
};
} // namespace mongo
|
