summaryrefslogtreecommitdiff
path: root/src/mongo/rpc/metadata/impersonated_user_metadata.h
blob: f379b509d4cbbf3375942e8d0837a366bcc41540 (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
/**
 * Copyright (C) 2018 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 "boost/optional.hpp"

#include "mongo/db/operation_context.h"
#include "mongo/rpc/metadata/impersonated_user_metadata_gen.h"

namespace mongo {
namespace rpc {

/*
 * The name of the BSON element in message metadata that contains the impersonated user data
 *
 * This is called "$audit" because in pre-4.2 the enterprise audit subsystem already passed
 * the impersonated users info around in metadata for auditing purposes. This has been lifted
 * into the community edition and appears in network messages as "$audit" for backwards
 * compatibility.
 *
 * This metadata should only appear in requests from mongos to mongod.
 */
static constexpr auto kImpersonationMetadataSectionName = "$audit"_sd;

/*
 * A type that maybe contains parsed ImpersonationUserMetadata
 */
using MaybeImpersonatedUserMetadata = boost::optional<ImpersonatedUserMetadata>;

/*
 * Gets the current impersonation data from the OpCtx (assumes readImpersonatedUserMetadata
 * has already been called)
 */
MaybeImpersonatedUserMetadata getImpersonatedUserMetadata(OperationContext* opCtx);

/*
 * Parses any impersonation data out of a metdata bson obj and into the opCtx
 */
void readImpersonatedUserMetadata(const BSONElement& elem, OperationContext* opCtx);

/*
 * Writes the current impersonation metadata off the opCtx and into a BSONObjBuilder
 */
void writeAuthDataToImpersonatedUserMetadata(OperationContext* opCtx, BSONObjBuilder* out);

}  // namespace rpc
}  // namespace mongo