summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/restriction_set.h
blob: 66f182ebbdc17e0cc7cfef5db90813a9dfa0debd (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/**
 *    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 <memory>
#include <vector>

#include "mongo/db/auth/restriction.h"

namespace mongo {

namespace restriction_detail {

// Represents a set of restrictions, which may be attached to a user or role.
// This set of restrictions is met by a RestrictionEnvironment, if any restriction
// in the set is met by the RestrictionEnvironment, or if the set is empty.
template <typename T,
          template <typename...> class Pointer = std::unique_ptr,
          template <typename...> class Sequence = std::vector>
class RestrictionSetAny : public UnnamedRestriction {
public:
    using element_type = T;
    using pointer_type = Pointer<element_type>;
    using sequence_type = Sequence<pointer_type>;

    RestrictionSetAny() = default;
    explicit RestrictionSetAny(sequence_type restrictions)
        : _restrictions(std::move(restrictions)) {}

    template <typename U>
    explicit RestrictionSetAny(std::unique_ptr<U> restriction) {
        _restrictions.push_back(std::move(restriction));
    }

    Status validate(const RestrictionEnvironment& environment) const final {
        if (_restrictions.empty()) {
            return Status::OK();
        }
        for (const pointer_type& restriction : _restrictions) {
            Status status = restriction->validate(environment);
            if (status.isOK()) {
                return status;
            }
        }
        return Status(ErrorCodes::AuthenticationRestrictionUnmet,
                      str::stream() << "No member restriction in '" << *this << "' met");
    }

    void appendToBuilder(BSONArrayBuilder* builder) const final {
        builder->append(toBSON());
    }

    typename T::serialization_type::bson_type toBSON() const {
        typename T::serialization_type::bson_builder_type builder;
        for (const auto& r : _restrictions) {
            r->appendToBuilder(&builder);
        }
        return T::serialization_type::finalize(&builder);
    }

private:
    void serialize(std::ostream& os) const final {
        os << "{anyOf: [";
        for (const pointer_type& restriction : _restrictions) {
            if (restriction.get() != _restrictions.front().get()) {
                os << ", ";
            }
            os << *restriction;
        }
        os << "]}";
    }

    sequence_type _restrictions;
};

// Represents a set of restrictions which may be attached to a user or role. This set of is met by
// a RestrictionEnvironment, if each set is met by the RestrictionEnvironment.
template <typename T,
          template <typename...> class Pointer = std::unique_ptr,
          template <typename...> class Sequence = std::vector>
class RestrictionSetAll : public UnnamedRestriction {
public:
    using element_type = T;
    using pointer_type = Pointer<element_type>;
    using sequence_type = Sequence<pointer_type>;

    RestrictionSetAll() = default;
    explicit RestrictionSetAll(sequence_type restrictions)
        : _restrictions(std::move(restrictions)) {}

    template <typename U>
    explicit RestrictionSetAll(std::unique_ptr<U> restriction) {
        _restrictions.push_back(std::move(restriction));
    }

    explicit RestrictionSetAll(const T& restriction) {
        _restrictions.push_back(std::make_unique<T>(restriction));
    }

    Status validate(const RestrictionEnvironment& environment) const final {
        for (const pointer_type& restriction : _restrictions) {
            Status status = restriction->validate(environment);
            if (!status.isOK()) {
                return Status(ErrorCodes::AuthenticationRestrictionUnmet,
                              str::stream() << "Restriction '" << *restriction << "' in '" << *this
                                            << "' unmet");
            }
        }
        return Status::OK();
    }

    void appendToBuilder(BSONArrayBuilder* builder) const final {
        builder->append(toBSON());
    }

    typename T::serialization_type::bson_type toBSON() const {
        typename T::serialization_type::bson_builder_type builder;
        for (const auto& r : _restrictions) {
            r->appendToBuilder(&builder);
        }
        return T::serialization_type::finalize(&builder);
    }

private:
    void serialize(std::ostream& os) const final {
        os << "{allOf: [";
        for (const pointer_type& restriction : _restrictions) {
            if (restriction.get() != _restrictions.front().get()) {
                os << ", ";
            }
            os << *restriction;
        }
        os << "]}";
    }

    sequence_type _restrictions;
};
}  // namespace restriction_detail

// Users and roles may have a set of sets of restrictions. The set of set of restrictions is met if
// any of the sets are met. The sets are met if all of their restrictions are met.
// A user may have restrictions, and may have roles with restrictions. If it acquires multiple
// sets of restrictions, then the user's restrictions, and each of their roles' restrictions must
// be met.
template <template <typename...> class Pointer = std::unique_ptr,
          template <typename...> class Sequence = std::vector>
using RestrictionSet = restriction_detail::RestrictionSetAll<NamedRestriction, Pointer, Sequence>;
template <template <typename...> class Pointer = std::unique_ptr,
          template <typename...> class Sequence = std::vector>
using RestrictionDocument =
    restriction_detail::RestrictionSetAny<RestrictionSet<>, Pointer, Sequence>;
template <template <typename...> class Pointer = std::unique_ptr,
          template <typename...> class Sequence = std::vector>
using RestrictionDocumentsSequence =
    restriction_detail::RestrictionSetAll<RestrictionDocument<>, Pointer, Sequence>;

using SharedRestrictionDocument = std::shared_ptr<RestrictionDocument<>>;
using RestrictionDocuments = RestrictionDocumentsSequence<std::shared_ptr>;

}  // namespace mongo