/usr/include/vmime/security/sasl/SASLMechanism.hpp is in libvmime-dev 0.9.2-5build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | //
// VMime library (http://www.vmime.org)
// Copyright (C) 2002-2013 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_SECURITY_SASL_SASLMECHANISM_HPP_INCLUDED
#define VMIME_SECURITY_SASL_SASLMECHANISM_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#include "vmime/types.hpp"
namespace vmime {
namespace security {
namespace sasl {
class SASLSession;
/** An SASL mechanism.
*/
class VMIME_EXPORT SASLMechanism : public object
{
public:
/** Return the name of this mechanism.
*
* @return mechanism name
*/
virtual const string getName() const = 0;
/** Perform one step of SASL authentication. Accept data from the
* server (challenge), process it and return data to be returned
* in response to the server.
*
* If the challenge is empty (challengeLen == 0), the initial
* response is returned, if this mechanism has one.
*
* @param sess SASL session
* @param challenge challenge sent from the server
* @param challengeLen length of challenge
* @param response response to send to the server (allocated by
* this function, free with delete[])
* @param responseLen length of response buffer
* @return true if authentication terminated successfully, or
* false if the authentication process should continue
* @throw exceptions::sasl_exception if an error occurred during
* authentication (in this case, the values in 'response' and
* 'responseLen' are undetermined)
*/
virtual bool step
(shared_ptr <SASLSession> sess,
const byte_t* challenge, const size_t challengeLen,
byte_t** response, size_t* responseLen) = 0;
/** Check whether authentication has completed. If false, more
* calls to evaluateChallenge() are needed to complete the
* authentication process).
*
* @return true if the authentication has finished, or false
* otherwise
*/
virtual bool isComplete() const = 0;
/** Determine if this mechanism has an optional initial response.
* If true, caller should call step() with an empty challenge to
* get the initial response.
*
* @return true if this mechanism has an initial response, or
* false otherwise
*/
virtual bool hasInitialResponse() const = 0;
/** Encode data according to negotiated SASL mechanism. This
* might mean that data is integrity or privacy protected.
*
* @param sess SASL session
* @param input input buffer
* @param inputLen length of input buffer
* @param output output buffer (allocated bu the function,
* free with delete[])
* @param outputLen length of output buffer
* @throw exceptions::sasl_exception if an error occurred during
* the encoding of data (in this case, the values in 'output' and
* 'outputLen' are undetermined)
*/
virtual void encode(shared_ptr <SASLSession> sess,
const byte_t* input, const size_t inputLen,
byte_t** output, size_t* outputLen) = 0;
/** Decode data according to negotiated SASL mechanism. This
* might mean that data is integrity or privacy protected.
*
* @param sess SASL session
* @param input input buffer
* @param inputLen length of input buffer
* @param output output buffer (allocated bu the function,
* free with delete[])
* @param outputLen length of output buffer
* @throw exceptions::sasl_exception if an error occurred during
* the encoding of data (in this case, the values in 'output' and
* 'outputLen' are undetermined)
*/
virtual void decode(shared_ptr <SASLSession> sess,
const byte_t* input, const size_t inputLen,
byte_t** output, size_t* outputLen) = 0;
};
} // sasl
} // security
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_SASL_SUPPORT
#endif // VMIME_SECURITY_SASL_SASLMECHANISM_HPP_INCLUDED
|