sasl_client_session.h

/*    Copyright 2012 10gen Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include <boost/scoped_array.hpp>
#include <string>

#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/client/export_macros.h"
#include "mongo/stdx/functional.h"

namespace mongo {

    class SaslClientSession {
        MONGO_DISALLOW_COPYING(SaslClientSession);
    public:
        typedef stdx::function<SaslClientSession* (const std::string&)> SaslClientSessionFactoryFn;
        static SaslClientSessionFactoryFn create;

        enum Parameter {
            parameterServiceName = 0,
            parameterServiceHostname,
            parameterMechanism,
            parameterUser,
            parameterPassword,
            numParameters  // Must be last
        };

        SaslClientSession();
        virtual ~SaslClientSession();

        virtual void setParameter(Parameter id, const StringData& value);

        virtual bool hasParameter(Parameter id);

        virtual StringData getParameter(Parameter id);

        virtual Status initialize() = 0;

        virtual Status step(const StringData& inputData, std::string* outputData) = 0;

        virtual bool isDone() const = 0;

    private:
        struct DataBuffer {
            boost::scoped_array<char> data;
            size_t size;
        };

        DataBuffer _parameters[numParameters];
    };

}  // namespace mongo