/**
* Copyright (C) 2017 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 .
*
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kReplication
#include "mongo/platform/basic.h"
#include "mongo/db/logical_time_validator.h"
#include "mongo/base/init.h"
#include "mongo/db/auth/action_set.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/keys_collection_manager.h"
#include "mongo/db/logical_clock.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/service_context.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/log.h"
namespace mongo {
namespace {
const auto getLogicalClockValidator =
ServiceContext::declareDecoration>();
stdx::mutex validatorMutex; // protects access to decoration instance of LogicalTimeValidator.
std::vector advanceClusterTimePrivilege;
MONGO_INITIALIZER(InitializeAdvanceClusterTimePrivilegeVector)(InitializerContext* const) {
ActionSet actions;
actions.addAction(ActionType::advanceClusterTime);
advanceClusterTimePrivilege.emplace_back(ResourcePattern::forClusterResource(), actions);
return Status::OK();
}
Milliseconds kRefreshIntervalIfErrored(200);
} // unnamed namespace
LogicalTimeValidator* LogicalTimeValidator::get(ServiceContext* service) {
stdx::lock_guard lk(validatorMutex);
return getLogicalClockValidator(service).get();
}
LogicalTimeValidator* LogicalTimeValidator::get(OperationContext* ctx) {
return get(ctx->getClient()->getServiceContext());
}
void LogicalTimeValidator::set(ServiceContext* service,
std::unique_ptr newValidator) {
stdx::lock_guard lk(validatorMutex);
auto& validator = getLogicalClockValidator(service);
validator = std::move(newValidator);
}
LogicalTimeValidator::LogicalTimeValidator(std::shared_ptr keyManager)
: _keyManager(keyManager) {}
SignedLogicalTime LogicalTimeValidator::_getProof(const KeysCollectionDocument& keyDoc,
LogicalTime newTime) {
auto key = keyDoc.getKey();
// Compare and calculate HMAC inside mutex to prevent multiple threads computing HMAC for the
// same cluster time.
stdx::lock_guard lk(_mutex);
// Note: _lastSeenValidTime will initially not have a proof set.
if (newTime == _lastSeenValidTime.getTime() && _lastSeenValidTime.getProof()) {
return _lastSeenValidTime;
}
auto signature = _timeProofService.getProof(newTime, key);
SignedLogicalTime newSignedTime(newTime, std::move(signature), keyDoc.getKeyId());
if (newTime > _lastSeenValidTime.getTime() || !_lastSeenValidTime.getProof()) {
_lastSeenValidTime = newSignedTime;
}
return newSignedTime;
}
SignedLogicalTime LogicalTimeValidator::trySignLogicalTime(const LogicalTime& newTime) {
auto keyStatusWith = _getKeyManagerCopy()->getKeyForSigning(nullptr, newTime);
auto keyStatus = keyStatusWith.getStatus();
if (keyStatus == ErrorCodes::KeyNotFound) {
// Attach invalid signature and keyId if we don't have the right keys to sign it.
return SignedLogicalTime(newTime, TimeProofService::TimeProof(), 0);
}
uassertStatusOK(keyStatus);
return _getProof(keyStatusWith.getValue(), newTime);
}
SignedLogicalTime LogicalTimeValidator::signLogicalTime(OperationContext* opCtx,
const LogicalTime& newTime) {
auto keyManager = _getKeyManagerCopy();
auto keyStatusWith = keyManager->getKeyForSigning(nullptr, newTime);
auto keyStatus = keyStatusWith.getStatus();
while (keyStatus == ErrorCodes::KeyNotFound && LogicalClock::get(opCtx)->isEnabled()) {
keyManager->refreshNow(opCtx);
keyStatusWith = keyManager->getKeyForSigning(nullptr, newTime);
keyStatus = keyStatusWith.getStatus();
if (keyStatus == ErrorCodes::KeyNotFound) {
sleepFor(kRefreshIntervalIfErrored);
}
}
uassertStatusOK(keyStatus);
return _getProof(keyStatusWith.getValue(), newTime);
}
Status LogicalTimeValidator::validate(OperationContext* opCtx, const SignedLogicalTime& newTime) {
{
stdx::lock_guard lk(_mutex);
if (newTime.getTime() <= _lastSeenValidTime.getTime()) {
return Status::OK();
}
}
auto keyStatus =
_getKeyManagerCopy()->getKeyForValidation(opCtx, newTime.getKeyId(), newTime.getTime());
uassertStatusOK(keyStatus.getStatus());
const auto& key = keyStatus.getValue().getKey();
const auto newProof = newTime.getProof();
// Cluster time is only sent if a server's clock can verify and sign cluster times, so any
// received cluster times should have proofs.
invariant(newProof);
auto res = _timeProofService.checkProof(newTime.getTime(), newProof.get(), key);
if (res != Status::OK()) {
return res;
}
return Status::OK();
}
void LogicalTimeValidator::init(ServiceContext* service) {
_getKeyManagerCopy()->startMonitoring(service);
}
void LogicalTimeValidator::shutDown() {
stdx::lock_guard lk(_mutexKeyManager);
if (_keyManager) {
_keyManager->stopMonitoring();
}
}
void LogicalTimeValidator::enableKeyGenerator(OperationContext* opCtx, bool doEnable) {
_getKeyManagerCopy()->enableKeyGenerator(opCtx, doEnable);
}
bool LogicalTimeValidator::isAuthorizedToAdvanceClock(OperationContext* opCtx) {
auto client = opCtx->getClient();
// Note: returns true if auth is off, courtesy of
// AuthzSessionExternalStateServerCommon::shouldIgnoreAuthChecks.
return AuthorizationSession::get(client)->isAuthorizedForPrivileges(
advanceClusterTimePrivilege);
}
bool LogicalTimeValidator::shouldGossipLogicalTime() {
return _getKeyManagerCopy()->hasSeenKeys();
}
void LogicalTimeValidator::resetKeyManagerCache() {
log() << "Resetting key manager cache";
{
stdx::lock_guard keyManagerLock(_mutexKeyManager);
invariant(_keyManager);
_keyManager->clearCache();
}
stdx::lock_guard lk(_mutex);
_lastSeenValidTime = SignedLogicalTime();
_timeProofService.resetCache();
}
void LogicalTimeValidator::stopKeyManager() {
stdx::lock_guard keyManagerLock(_mutexKeyManager);
if (_keyManager) {
log() << "Stopping key manager";
_keyManager->stopMonitoring();
_keyManager->clearCache();
stdx::lock_guard lk(_mutex);
_lastSeenValidTime = SignedLogicalTime();
_timeProofService.resetCache();
} else {
log() << "Stopping key manager: no key manager exists.";
}
}
std::shared_ptr LogicalTimeValidator::_getKeyManagerCopy() {
stdx::lock_guard lk(_mutexKeyManager);
invariant(_keyManager);
return _keyManager;
}
} // namespace mongo