summaryrefslogtreecommitdiff
path: root/src/mongo/client/sasl_scramsha1_client_conversation.h
blob: dcf8a5686e42dae2b78a55156be0cbf17e3abf9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 *    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 <http://www.gnu.org/licenses/>.
 *
 *    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 <string>
#include <vector>

#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/crypto/mechanism_scram.h"

namespace mongo {

class SCRAMSHA1ClientCache;
/**
 *  Client side authentication session for SASL PLAIN.
 */
class SaslSCRAMSHA1ClientConversation : public SaslClientConversation {
    MONGO_DISALLOW_COPYING(SaslSCRAMSHA1ClientConversation);

public:
    /**
     * Implements the client side of a SASL PLAIN mechanism session.
     **/
    SaslSCRAMSHA1ClientConversation(SaslClientSession* saslClientSession,
                                    SCRAMSHA1ClientCache* clientCache);

    /**
     * Takes one step in a SCRAM-SHA-1 conversation.
     *
     * @return !Status::OK() for failure. The boolean part indicates if the
     * authentication conversation is finished or not.
     *
     **/
    virtual StatusWith<bool> step(StringData inputData, std::string* outputData);

private:
    /**
     * Generates client-first-message.
     **/
    StatusWith<bool> _firstStep(std::string* outputData);

    /**
     * Parses server-first-message and generate client-final-message.
     **/
    StatusWith<bool> _secondStep(const std::vector<std::string>& input, std::string* outputData);

    /**
     * Generates client-first-message.
     **/
    StatusWith<bool> _thirdStep(const std::vector<std::string>& input, std::string* outputData);

    int _step;
    std::string _authMessage;

    // Secrets and secrets cache
    scram::SCRAMSecrets _credentials;
    SCRAMSHA1ClientCache* const _clientCache;

    // client and server nonce concatenated
    std::string _clientNonce;
};

}  // namespace mongo