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
|
/**
* 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 <map>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/crypto/jws_validator.h"
namespace mongo::crypto {
class JWKManager {
public:
using SharedValidator = std::shared_ptr<JWSValidator>;
using KeyMap = std::map<std::string, BSONObj>;
/**
* Fetch a JWKS file from the specified URL, parse them as keys,
* and instantiate JWSValidator instances.
*/
explicit JWKManager(StringData source);
/**
* Parse a BSONObj array of keys, and instantiate JWSValidator instances.
* This was added for testing purposes.
*/
explicit JWKManager(BSONObj keys);
/**
* Fetch a specific JWSValidator from the JWKManager by keyId.
* If the keyId does not exist, it will refresh _keyMaterial and _validators and retry.
* If it still cannot be found, it will return an error.
*/
StatusWith<SharedValidator> getValidator(StringData keyId);
std::size_t size() const {
return _validators->size();
}
/**
* Get a snapshot of the keys the key manager was initialized with. It is not
* modified after initialization and can be used to determine whether
* invalidation is necessary.
* TODO SERVER-73165 Generalize this to better handle invalidation.
*/
const KeyMap& getInitialKeys() const {
return _initialKeyMaterial;
}
/**
* Serialize the JWKs stored in this key manager into the BSONObjBuilder.
*/
void serialize(BSONObjBuilder* bob) const;
private:
void _setAndValidateKeys(const BSONObj& keys, bool isInitialLoad);
void _loadKeysFromUri(bool isInitialLoad);
private:
// Stores the key material that the manager was initialized with.
KeyMap _initialKeyMaterial;
// Stores the current key material of the manager, which may have been refreshed.
std::shared_ptr<KeyMap> _keyMaterial;
boost::optional<std::string> _keyURI;
std::shared_ptr<std::map<std::string, SharedValidator>> _validators;
};
} // namespace mongo::crypto
|