/* Copyright 2012 10gen 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.
*/
#include "mongo/pch.h"
#include "mongo/db/auth/user_cache_invalidator_job.h"
#include
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/client.h"
#include "mongo/db/commands.h"
#include "mongo/db/server_parameters.h"
#include "mongo/s/config.h"
#include "mongo/util/background.h"
#include "mongo/util/log.h"
namespace mongo {
namespace {
// How often to check with the config servers whether authorization information has changed.
int userCacheInvalidationIntervalSecs = 30; // 30 second default
class ExportedInvalidationIntervalParameter : public ExportedServerParameter {
public:
ExportedInvalidationIntervalParameter() :
ExportedServerParameter(ServerParameterSet::getGlobal(),
"userCacheInvalidationIntervalSecs",
&userCacheInvalidationIntervalSecs,
true,
true) {}
virtual Status validate( const int& potentialNewValue )
{
if (potentialNewValue < 1 || potentialNewValue > 86400) {
return Status(ErrorCodes::BadValue,
"userCacheInvalidationIntervalSecs must be between 1 "
"and 86400 (24 hours)");
}
return Status::OK();
}
} exportedIntervalParam;
StatusWith getCurrentCacheGeneration() {
try {
ConnectionString config = configServer.getConnectionString();
ScopedDbConnection conn(config.toString(), 30);
BSONObj result;
conn->runCommand("admin", BSON("_getUserCacheGeneration" << 1), result);
conn.done();
Status status = Command::getStatusFromCommandResult(result);
if (!status.isOK()) {
return StatusWith(status);
}
return StatusWith(result["cacheGeneration"].OID());
} catch (const DBException& e) {
return StatusWith(e.toStatus());
} catch (const std::exception& e) {
return StatusWith(ErrorCodes::UnknownError, e.what());
}
}
} // namespace
UserCacheInvalidator::UserCacheInvalidator(AuthorizationManager* authzManager) :
_authzManager(authzManager) {
_previousCacheGeneration = _authzManager->getCacheGeneration();
}
void UserCacheInvalidator::run() {
Client::initThread("UserCacheInvalidatorThread");
while (true) {
sleepsecs(userCacheInvalidationIntervalSecs);
if (inShutdown()) {
break;
}
StatusWith currentGeneration = getCurrentCacheGeneration();
if (!currentGeneration.isOK()) {
if (currentGeneration.getStatus().code() == ErrorCodes::CommandNotFound) {
warning() << "_getUserCacheGeneration command not found on config server(s), "
"this most likely means you are running an outdated version of mongod "
"on the config servers" << std::endl;
} else {
warning() << "An error occurred while fetching current user cache generation "
"to check if user cache needs invalidation: " <<
currentGeneration.getStatus() << std::endl;
}
// When in doubt, invalidate the cache
_authzManager->invalidateUserCache();
}
if (currentGeneration.getValue() != _previousCacheGeneration) {
log() << "User cache generation changed from " << _previousCacheGeneration <<
" to " << currentGeneration.getValue() << "; invalidating user cache" <<
std::endl;
_authzManager->invalidateUserCache();
_previousCacheGeneration = currentGeneration.getValue();
}
}
}
std::string UserCacheInvalidator::name() const {
return "UserCacheInvalidatorThread";
}
} // namespace mongo