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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/**
* 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.
*/
/*
* XSEC
*
* OpenSSLCryptoHashHMAC := OpenSSL Implementation of HMAC
*
* Author(s): Berin Lautenbach
*
* $Id$
*
*/
#ifndef OPENSSLCRYPTOHASHHMAC_INCLUDE
#define OPENSSLCRYPTOHASHHMAC_INCLUDE
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/enc/XSECCryptoHash.hpp>
#include <xsec/utils/XSECSafeBuffer.hpp>
// OpenSSL Includes
#if defined (XSEC_HAVE_OPENSSL)
#include <openssl/evp.h>
#include <openssl/hmac.h>
/**
* @ingroup opensslcrypto
*/
/**
* \brief Implementation of HMAC Hash functions in OpenSSL
*
* Uses the OpenSSL EVP_digest functions to implement the various
* HMAC hash functions required by the library.
*
*/
class XSEC_EXPORT OpenSSLCryptoHashHMAC : public XSECCryptoHash {
public :
/** @name Constructors and Destructors */
//@{
/**
* \brief Constructor
*
* Create the object, with the indicated algorithm
* (Currently supports MD5 and SHA1)
*
* @param alg Digest algorithm to use
*/
OpenSSLCryptoHashHMAC(XSECCryptoHash::HashType alg);
/**
* \brief Destructor
*
* Destroy the object. Will ensure any key material is also destroyed
*/
virtual ~OpenSSLCryptoHashHMAC();
//@}
/** @name HMAC Functions */
//@{
/**
*\brief Set the HMAC key
*
* Sets the key - which needs to have a base class of
* OpenSSLCryptoKeyHMAC.
*
* @param key The key the HMAC function should use.
*/
virtual void setKey(const XSECCryptoKey* key);
/**
* \brief Return the string identifier for the OpenSSL interface
*/
virtual const XMLCh* getProviderName() const;
//@}
/** @name Hash Functions */
//{@
/**
* \brief Reset the hash function
*
* Re-initialises the digest structure.
*/
virtual void reset();
/**
* \brief Hash some data.
*
* Take length bytes of data from the data buffer and update the hash
* that already exists. This function may (and normally will) be called
* many times for large blocks of data.
*
* @param data The buffer containing the data to be hashed.
* @param length The number of bytes to be read from data
*/
virtual void hash(unsigned char* data,
unsigned int length);
/**
* \brief Finish up a Digest operation and read the result.
*
* This call tells the CryptoHash object that the input is complete and
* to finalise the Digest. The output of the digest is read into the
* hash buffer (at most maxLength bytes). This is effectively the
* signature for the data that has been run through the HMAC function.
*
* @param hash The buffer the hash should be read into.
* @param maxLength The maximum number of bytes to be read into hash
* @returns The number of bytes copied into the hash buffer
*/
virtual unsigned int finish(unsigned char* hash,
unsigned int maxLength);// Finish and get hash
//@}
/** @name Information functions */
//@{
/**
*\brief
*
* Determine the hash type of this object
*
* @returns The hash type
*/
virtual HashType getHashType() const;
/**
* \brief Get OpenSSL Hash Context
*/
HMAC_CTX* getOpenSSLHMAC_CTX(void) {return mp_hctx;}
//@}
private:
// Not implemented constructors
OpenSSLCryptoHashHMAC();
const EVP_MD * mp_md; // Digest instance
unsigned char m_mdValue[EVP_MAX_MD_SIZE]; // Final output
unsigned int m_mdLen; // Length of digest
HashType m_hashType; // What type of hash is this?
HMAC_CTX * mp_hctx; // Context for HMAC
#if (OPENSSL_VERSION_NUMBER < 0x10100000L)
HMAC_CTX m_hctx_store; // Context for HMAC - store
#endif
safeBuffer m_keyBuf; // The loaded key
unsigned int m_keyLen; // The loaded key length
bool m_initialised;
};
#endif /* XSEC_HAVE_OPENSSL */
#endif /* OPENSSLCRYPTOHASHHMAC_INCLUDE */
|
