summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/Sasl.h
blob: 9a9d61b0377a4981ec5cc87f3902d164d9d8f5b2 (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
#ifndef QPID_SASL_H
#define QPID_SASL_H

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 *
 */

#include <memory>
#include <string>
#include "qpid/sys/IntegerTypes.h"

namespace qpid {

namespace sys {
class SecurityLayer;
struct SecuritySettings;
}

/**
 * Interface to SASL support. This class is implemented by platform-specific
 * SASL providers.
 */
class Sasl
{
  public:
    /**
     * Start SASL negotiation with the broker.
     *
     * @param mechanisms Comma-separated list of the SASL mechanism the
     *             client supports.
     * @param externalSecuritySettings security related details from the underlying transport
     */
    virtual std::string start(const std::string& mechanisms,
                              const qpid::sys::SecuritySettings* externalSecuritySettings = 0) = 0;
    virtual std::string step(const std::string& challenge) = 0;
    virtual std::string getMechanism() = 0;
    virtual std::string getUserId() = 0;
    virtual std::auto_ptr<qpid::sys::SecurityLayer> getSecurityLayer(uint16_t maxFrameSize) = 0;    
    virtual ~Sasl() {}
};
} // namespace qpid

#endif  /*!QPID_SASL_H*/