← Back to branch summary

~ubuntu-branches/debian/experimental/kopete/experimental

« back to all changes in this revision

Viewing changes to protocols/jabber/libjingle/talk/xmpp/saslmechanism.h

  • Committer: Package Import Robot
  • Author(s): Maximiliano Curia
  • Date: 2015-02-24 11:32:57 UTC
  • mfrom: (1.1.41 vivid)
  • Revision ID: package-import@ubuntu.com-20150224113257-gnupg4v7lzz18ij0
Tags: 4:14.12.2-1
* New upstream release (14.12.2).
* Bump Standards-Version to 3.9.6, no changes needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
protocols/jabber/libjingle/talk/xmpp/saslmechanism.h
 
1
/*
 
2
 * libjingle
 
3
 * Copyright 2004--2005, Google Inc.
 
4
 *
 
5
 * Redistribution and use in source and binary forms, with or without 
 
6
 * modification, are permitted provided that the following conditions are met:
 
7
 *
 
8
 *  1. Redistributions of source code must retain the above copyright notice, 
 
9
 *     this list of conditions and the following disclaimer.
 
10
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 
11
 *     this list of conditions and the following disclaimer in the documentation
 
12
 *     and/or other materials provided with the distribution.
 
13
 *  3. The name of the author may not be used to endorse or promote products 
 
14
 *     derived from this software without specific prior written permission.
 
15
 *
 
16
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 
17
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 
18
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 
19
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 
20
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
21
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
22
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
23
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 
24
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 
25
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
26
 */
 
27
 
 
28
#ifndef _SASLMECHANISM_H_
 
29
#define _SASLMECHANISM_H_
 
30
 
 
31
#include <string>
 
32
 
 
33
namespace buzz {
 
34
 
 
35
class XmlElement;
 
36
 
 
37
 
 
38
// Defines a mechnanism to do SASL authentication.
 
39
// Subclass instances should have a self-contained way to present
 
40
// credentials.
 
41
class SaslMechanism {
 
42
 
 
43
public:
 
44
  
 
45
  // Intended to be subclassed
 
46
  virtual ~SaslMechanism() {}
 
47
 
 
48
  // Should return the name of the SASL mechanism, e.g., "PLAIN"
 
49
  virtual std::string GetMechanismName() = 0;
 
50
 
 
51
  // Should generate the initial "auth" request.  Default is just <auth/>.
 
52
  virtual XmlElement * StartSaslAuth();
 
53
 
 
54
  // Should respond to a SASL "<challenge>" request.  Default is
 
55
  // to abort (for mechanisms that do not do challenge-response)
 
56
  virtual XmlElement * HandleSaslChallenge(const XmlElement * challenge);
 
57
 
 
58
  // Notification of a SASL "<success>".  Sometimes information
 
59
  // is passed on success.
 
60
  virtual void HandleSaslSuccess(const XmlElement * success);
 
61
 
 
62
  // Notification of a SASL "<failure>".  Sometimes information
 
63
  // for the user is passed on failure.
 
64
  virtual void HandleSaslFailure(const XmlElement * failure);
 
65
 
 
66
protected:
 
67
  static std::string Base64Encode(const std::string & plain);
 
68
  static std::string Base64Decode(const std::string & encoded);
 
69
  static std::string Base64EncodeFromArray(const char * plain, size_t length);
 
70
};
 
71
 
 
72
}
 
73
 
 
74
#endif