sasl_client_authenticate.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 "mongo/base/status.h"
#include "mongo/bson/bsontypes.h"
#include "mongo/client/dbclientinterface.h"
#include "mongo/client/export_macros.h"

namespace mongo {
    class BSONObj;

    extern MONGO_CLIENT_API Status (MONGO_CLIENT_FUNC *saslClientAuthenticate)(
        DBClientWithCommands* client,
        const BSONObj& saslParameters);

    MONGO_CLIENT_API Status MONGO_CLIENT_FUNC saslExtractPayload(const BSONObj& cmdObj, std::string* payload, BSONType* type);

    // Constants

    extern MONGO_CLIENT_API const char* const saslStartCommandName;

    extern MONGO_CLIENT_API const char* const saslContinueCommandName;

    extern MONGO_CLIENT_API const char* const saslCommandAutoAuthorizeFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandCodeFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandConversationIdFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandDoneFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandErrmsgFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandMechanismFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandMechanismListFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandPasswordFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandPayloadFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandUserFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandUserDBFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandServiceHostnameFieldName;

    extern MONGO_CLIENT_API const char* const saslCommandServiceNameFieldName;

    extern MONGO_CLIENT_API const char* const saslDefaultDBName;

    extern MONGO_CLIENT_API const char* const saslDefaultServiceName;

    // Field whose value should be set to true if the field in saslCommandPasswordFieldName needs to
    // be digested.
    extern MONGO_CLIENT_API const char* const saslCommandDigestPasswordFieldName;
}