summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/fle2_compact.h
blob: dae1432a8c27dc7b1957687c3a4909023a1aa07d (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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/**
 *    Copyright (C) 2022-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/base/status_with.h"
#include "mongo/db/commands/fle2_cleanup_gen.h"
#include "mongo/db/commands/fle2_compact_gen.h"
#include "mongo/db/fle_crud.h"

namespace mongo {

struct EncryptedStateCollectionsNamespaces {

    static StatusWith<EncryptedStateCollectionsNamespaces> createFromDataCollection(
        const Collection& edc);

    NamespaceString edcNss;
    NamespaceString escNss;
    NamespaceString ecocNss;
    NamespaceString ecocRenameNss;
    NamespaceString ecocLockNss;
    NamespaceString escDeletesNss;
};

/**
 * Validate a compact request has the right encryption tokens.
 */
void validateCompactRequest(const CompactStructuredEncryptionData& request, const Collection& edc);

/**
 * Validate a cleanup request has the right encryption tokens.
 */
void validateCleanupRequest(const CleanupStructuredEncryptionData& request, const Collection& edc);


void processFLECompactV2(OperationContext* opCtx,
                         const CompactStructuredEncryptionData& request,
                         GetTxnCallback getTxn,
                         const EncryptedStateCollectionsNamespaces& namespaces,
                         ECStats* escStats,
                         ECOCStats* ecocStats);

void processFLECleanup(OperationContext* opCtx,
                       const CleanupStructuredEncryptionData& request,
                       GetTxnCallback getTxn,
                       const EncryptedStateCollectionsNamespaces& namespaces,
                       ECStats* escStats,
                       ECOCStats* ecocStats);

/**
 * Get all unique documents in the ECOC collection in their decrypted form.
 *
 * Used by unit tests.
 */
stdx::unordered_set<ECOCCompactionDocumentV2> getUniqueCompactionDocuments(
    FLEQueryInterface* queryImpl,
    BSONObj tokensObj,
    const NamespaceString& ecocNss,
    ECOCStats* ecocStats);


/**
 * Performs compaction of the ESC entries for the encrypted field/value pair
 * whose tokens are in the provided ECOC compaction document.
 *
 * Used by unit tests.
 */
void compactOneFieldValuePairV2(FLEQueryInterface* queryImpl,
                                const ECOCCompactionDocumentV2& ecocDoc,
                                const NamespaceString& escNss,
                                ECStats* escStats);


/**
 * Performs cleanup of the ESC entries for the encrypted field/value pair
 * whose tokens are in the provided ECOC compaction document.
 *
 * Used by unit tests.
 */
void cleanupOneFieldValuePair(FLEQueryInterface* queryImpl,
                              const ECOCCompactionDocumentV2& ecocDoc,
                              const NamespaceString& escNss,
                              const NamespaceString& escDeletesNss,
                              ECStats* escStats);

/**
 * Container for the _id values of ESC entries that are slated for deletion
 * at the end of a compact or cleanup operation.
 */
class FLECompactESCDeleteSet {
public:
    std::size_t size() const {
        return std::accumulate(deleteIdSets.begin(),
                               deleteIdSets.end(),
                               std::size_t{0},
                               [](const auto& sum, auto& d) { return sum + d.size(); });
    }
    bool empty() const {
        return deleteIdSets.empty();
    }

    void clear() {
        deleteIdSets.clear();
    }

    const PrfBlock& at(size_t index) const;

    std::vector<std::vector<PrfBlock>> deleteIdSets;
};

FLECompactESCDeleteSet readRandomESCNonAnchorIds(OperationContext* opCtx,
                                                 const NamespaceString& escNss,
                                                 size_t memoryLimit,
                                                 ECStats* escStats);

/**
 * Deletes from the ESC collection the non-anchor documents whose _ids
 * appear in the list deleteIds
 */
void cleanupESCNonAnchors(OperationContext* opCtx,
                          const NamespaceString& escNss,
                          const FLECompactESCDeleteSet& deleteSet,
                          size_t maxTagsPerDelete,
                          ECStats* escStats);

/**
 * Deletes from the ESC collection the anchor documents whose _ids
 * appear in the collection escDeletesNss
 */
void cleanupESCAnchors(OperationContext* opCtx,
                       const NamespaceString& escNss,
                       const NamespaceString& escDeletesNss,
                       size_t maxTagsPerDelete,
                       ECStats* escStats);

}  // namespace mongo