← Back to branch summary

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

« back to all changes in this revision

Viewing changes to protocols/jabber/libjingle/talk/base/messagedigest.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/base/messagedigest.h
 
1
/*
 
2
 * libjingle
 
3
 * Copyright 2004, 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 TALK_BASE_MESSAGEDIGEST_H_
 
29
#define TALK_BASE_MESSAGEDIGEST_H_
 
30
 
 
31
#include <string>
 
32
 
 
33
namespace talk_base {
 
34
 
 
35
// Definitions for the digest algorithms.
 
36
extern const char DIGEST_MD5[];
 
37
extern const char DIGEST_SHA_1[];
 
38
extern const char DIGEST_SHA_224[];
 
39
extern const char DIGEST_SHA_256[];
 
40
extern const char DIGEST_SHA_384[];
 
41
extern const char DIGEST_SHA_512[];
 
42
 
 
43
// A general class for computing hashes.
 
44
class MessageDigest {
 
45
 public:
 
46
  virtual ~MessageDigest() {}
 
47
  // Returns the digest output size (e.g. 16 bytes for MD5).
 
48
  virtual size_t Size() const = 0;
 
49
  // Updates the digest with |len| bytes from |buf|.
 
50
  virtual void Update(const void* buf, size_t len) = 0;
 
51
  // Outputs the digest value to |buf| with length |len|.
 
52
  // Returns the number of bytes written, i.e., Size().
 
53
  virtual size_t Finish(void* buf, size_t len) = 0;
 
54
};
 
55
 
 
56
// A factory class for creating digest objects.
 
57
class MessageDigestFactory {
 
58
 public:
 
59
  static MessageDigest* Create(const std::string& alg);
 
60
};
 
61
 
 
62
// Functions to create hashes.
 
63
 
 
64
// Computes the hash of |in_len| bytes of |input|, using the |digest| hash
 
65
// implementation, and outputs the hash to the buffer |output|, which is
 
66
// |out_len| bytes long. Returns the number of bytes written to |output| if
 
67
// successful, or 0 if |out_len| was too small.
 
68
size_t ComputeDigest(MessageDigest* digest, const void* input, size_t in_len,
 
69
                     void* output, size_t out_len);
 
70
// Like the previous function, but creates a digest implementation based on
 
71
// the desired digest name |alg|, e.g. DIGEST_SHA_1. Returns 0 if there is no
 
72
// digest with the given name.
 
73
size_t ComputeDigest(const std::string& alg, const void* input, size_t in_len,
 
74
                     void* output, size_t out_len);
 
75
// Computes the hash of |input| using the |digest| hash implementation, and
 
76
// returns it as a hex-encoded string.
 
77
std::string ComputeDigest(MessageDigest* digest, const std::string& input);
 
78
// Like the previous function, but creates a digest implementation based on
 
79
// the desired digest name |alg|, e.g. DIGEST_SHA_1. Returns empty string if
 
80
// there is no digest with the given name.
 
81
std::string ComputeDigest(const std::string& alg, const std::string& input);
 
82
// Like the previous function, but returns an explicit result code.
 
83
bool ComputeDigest(const std::string& alg, const std::string& input,
 
84
                   std::string* output);
 
85
 
 
86
// Shorthand way to compute a hex-encoded hash using MD5.
 
87
inline std::string MD5(const std::string& input) {
 
88
  return ComputeDigest(DIGEST_MD5, input);
 
89
}
 
90
 
 
91
// Functions to compute RFC 2104 HMACs.
 
92
 
 
93
// Computes the HMAC of |in_len| bytes of |input|, using the |digest| hash
 
94
// implementation and |key_len| bytes of |key| to key the HMAC, and outputs
 
95
// the HMAC to the buffer |output|, which is |out_len| bytes long. Returns the
 
96
// number of bytes written to |output| if successful, or 0 if |out_len| was too
 
97
// small.
 
98
size_t ComputeHmac(MessageDigest* digest, const void* key, size_t key_len,
 
99
                   const void* input, size_t in_len,
 
100
                   void* output, size_t out_len);
 
101
// Like the previous function, but creates a digest implementation based on
 
102
// the desired digest name |alg|, e.g. DIGEST_SHA_1. Returns 0 if there is no
 
103
// digest with the given name.
 
104
size_t ComputeHmac(const std::string& alg, const void* key, size_t key_len,
 
105
                   const void* input, size_t in_len,
 
106
                   void* output, size_t out_len);
 
107
// Computes the HMAC of |input| using the |digest| hash implementation and |key|
 
108
// to key the HMAC, and returns it as a hex-encoded string.
 
109
std::string ComputeHmac(MessageDigest* digest, const std::string& key,
 
110
                        const std::string& input);
 
111
// Like the previous function, but creates a digest implementation based on
 
112
// the desired digest name |alg|, e.g. DIGEST_SHA_1. Returns empty string if
 
113
// there is no digest with the given name.
 
114
std::string ComputeHmac(const std::string& alg, const std::string& key,
 
115
                        const std::string& input);
 
116
// Like the previous function, but returns an explicit result code.
 
117
bool ComputeHmac(const std::string& alg, const std::string& key,
 
118
                 const std::string& input, std::string* output);
 
119
 
 
120
}  // namespace talk_base
 
121
 
 
122
#endif  // TALK_BASE_MESSAGEDIGEST_H_