/*
* Copyright (C) 2014 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.
*/
#pragma once
#include
#include
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/client/sasl_client_conversation.h"
#include "mongo/client/sasl_client_session.h"
#include "mongo/client/scram_client_cache.h"
#include "mongo/crypto/mechanism_scram.h"
#include "mongo/util/icu.h"
namespace mongo {
/**
* Client side authentication session for SASL PLAIN.
*/
class SaslSCRAMClientConversation : public SaslClientConversation {
MONGO_DISALLOW_COPYING(SaslSCRAMClientConversation);
public:
using SaslClientConversation::SaslClientConversation;
/**
* Takes one step in a SCRAM conversation.
*
* @return !Status::OK() for failure. The boolean part indicates if the
* authentication conversation is finished or not.
*
**/
StatusWith step(StringData inputData, std::string* outputData) override;
/**
* Initialize the Presecrets/Secrets and return signed client proof.
*/
virtual std::string generateClientProof(const std::vector& salt,
size_t iterationCount) = 0;
/**
* Verify the server's signature.
*/
virtual bool verifyServerSignature(StringData sig) const = 0;
/**
* Runs saslPrep except on SHA-1.
*/
virtual StatusWith saslPrep(StringData val) const = 0;
private:
/**
* Generates client-first-message.
**/
StatusWith _firstStep(std::string* outputData);
/**
* Parses server-first-message and generate client-final-message.
**/
StatusWith _secondStep(StringData input, std::string* outputData);
/**
* Generates client-first-message.
**/
StatusWith _thirdStep(StringData input, std::string* outputData);
protected:
int _step{0};
std::string _authMessage;
// client and server nonce concatenated
std::string _clientNonce;
};
template
class SaslSCRAMClientConversationImpl : public SaslSCRAMClientConversation {
public:
SaslSCRAMClientConversationImpl(SaslClientSession* saslClientSession,
SCRAMClientCache* clientCache)
: SaslSCRAMClientConversation(saslClientSession), _clientCache(clientCache) {}
std::string generateClientProof(const std::vector& salt,
size_t iterationCount) final {
auto password = uassertStatusOK(saslPrep(
_saslClientSession->getParameter(SaslClientSession::parameterPassword).toString()));
scram::Presecrets presecrets(password, salt, iterationCount);
auto targetHost = HostAndPort::parse(
_saslClientSession->getParameter(SaslClientSession::parameterServiceHostAndPort));
if (targetHost.isOK()) {
_credentials = _clientCache->getCachedSecrets(targetHost.getValue(), presecrets);
if (!_credentials) {
_credentials = presecrets;
_clientCache->setCachedSecrets(
std::move(targetHost.getValue()), std::move(presecrets), _credentials);
}
} else {
_credentials = presecrets;
}
return _credentials.generateClientProof(_authMessage);
}
bool verifyServerSignature(StringData sig) const final {
return _credentials.verifyServerSignature(_authMessage, sig);
}
StatusWith saslPrep(StringData val) const final {
if (std::is_same::value) {
return val.toString();
} else {
return mongo::saslPrep(val);
}
}
private:
// Secrets and secrets cache
scram::Secrets _credentials;
SCRAMClientCache* const _clientCache;
};
using SaslSCRAMSHA1ClientConversation = SaslSCRAMClientConversationImpl;
} // namespace mongo