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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
/**
* 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
*
* OpenSSLCryptoProvider := Base class to define an OpenSSL module
*
* Author(s): Berin Lautenbach
*
* $Id$
*
*/
#ifndef OPENSSLCRYPTOPROVIDER_INCLUDE
#define OPENSSLCRYPTOPROVIDER_INCLUDE
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/enc/XSECCryptoProvider.hpp>
#ifdef XSEC_OPENSSL_HAVE_EC
# include <map>
# include <string>
#endif
#if defined (XSEC_HAVE_OPENSSL)
/**
* @defgroup opensslcrypto OpenSSL Interface
* @ingroup crypto
* The OpenSSL/OpenSSL* classes provide an implementation of the
* XSECCrypto interface layer for OpenSSL. The layer is very thin -
* it only provides the functionality necessary to provide cryptographic
* services to the library.
*
* Calling applications need to do the work to initialise OpenSSL, load
* keys from disk etc.
*
*/
/*\@{*/
class XSEC_EXPORT OpenSSLCryptoProvider : public XSECCryptoProvider {
#ifdef XSEC_OPENSSL_HAVE_EC
std::map<std::string,int> m_namedCurveMap;
#endif
public :
/** @name Constructors and Destructors */
//@{
OpenSSLCryptoProvider();
virtual ~OpenSSLCryptoProvider();
//@}
/** @name Hashing (Digest) Functions */
//@{
/**
* \brief Get the provider's maximum digest length.
*
* Call used by the library to max out the buffer sizes it uses.
*
* @returns maximum size to allow for
*/
virtual unsigned int getMaxHashSize() const;
/**
* \brief Return a hashing implementation.
*
* Call used by the library to obtain a hashing implementation from the
* provider.
*
* @returns a pointer to a hashing object.
*/
virtual XSECCryptoHash* hash(XSECCryptoHash::HashType type) const;
/**
* \brief Return an HMAC implementation.
*
* Call used by the library to obtain an HMAC implementation from the
* provider. The caller will need to set the key in the hash
* object with an XSECCryptoKeyHMAC using XSECCryptoHash::setKey().
*
* @returns a pointer to the hashing object.
*/
virtual XSECCryptoHash* HMAC(XSECCryptoHash::HashType type) const;
/**
* \brief Return a HMAC key
*
* Sometimes the library needs to create an HMAC key.
*
* This function allows the library to obtain a key that can then have
* a value set within it.
*/
virtual XSECCryptoKeyHMAC* keyHMAC(void) const;
//@}
/** @name Encoding functions */
//@{
/**
* \brief Return a Base64 encoder/decoder implementation.
*
* Call used by the library to obtain an OpenSSL Base64
* encoder/decoder.
*
* @returns Pointer to the new Base64 encoder.
* @see OpenSSLCryptoBase64
*/
virtual XSECCryptoBase64* base64() const;
//@}
/** @name Keys and Certificates */
//@{
/**
* \brief Return a DSA key implementation object.
*
* Call used by the library to obtain a DSA key object.
*
* @returns Pointer to the new DSA key
* @see OpenSSLCryptoKeyDSA
*/
virtual XSECCryptoKeyDSA* keyDSA() const;
/**
* \brief Return an RSA key implementation object.
*
* Call used by the library to obtain an OpenSSL RSA key object.
*
* @returns Pointer to the new RSA key
* @see OpenSSLCryptoKeyRSA
*/
virtual XSECCryptoKeyRSA* keyRSA() const;
/**
* \brief Return an EC key implementation object.
*
* Call used by the library to obtain an OpenSSL EC key object.
*
* @returns Pointer to the new EC key
* @see OpenSSLCryptoKeyEC
*/
virtual XSECCryptoKeyEC* keyEC() const;
/**
* \brief Return a key implementation object based on DER-encoded input.
*
* Call used by the library to obtain a key object from a DER-encoded key.
*
* @param buf DER-encoded data
* @param buflen length of data
* @param base64 true iff data is base64-encoded
* @returns Pointer to the new key
* @see XSECCryptoKey
*/
virtual XSECCryptoKey* keyDER(const char* buf, unsigned long buflen, bool base64) const;
/**
* \brief Return an X509 implementation object.
*
* Call used by the library to obtain an object that can work
* with X509 certificates.
*
* @returns Pointer to the new X509 object
* @see OpenSSLCryptoX509
*/
virtual XSECCryptoX509* X509() const;
/**
* \brief Determine whether a given algorithm is supported
*
* A call that can be used to determine whether a given
* symmetric algorithm is supported
*/
virtual bool algorithmSupported(XSECCryptoSymmetricKey::SymmetricKeyType alg) const;
/**
* \brief Determine whether a given algorithm is supported
*
* A call that can be used to determine whether a given
* digest algorithm is supported
*/
virtual bool algorithmSupported(XSECCryptoHash::HashType alg) const;
/**
* \brief Return a Symmetric Key implementation object.
*
* Call used by the library to obtain a bulk encryption
* object.
*
* @returns Pointer to the new SymmetricKey object
* @see XSECCryptoSymmetricKey
*/
virtual XSECCryptoSymmetricKey* keySymmetric(XSECCryptoSymmetricKey::SymmetricKeyType alg) const;
/**
* \brief Obtain some random octets
*
* For generation of IVs and the like, the library needs to be able
* to obtain "random" octets. The library uses this call to the
* crypto provider to obtain what it needs.
*
* @param buffer The buffer to place the random data in
* @param numOctets Number of bytes required
* @returns Number of bytes obtained.
*/
virtual unsigned int getRandom(unsigned char* buffer, unsigned int numOctets) const;
#ifdef XSEC_OPENSSL_HAVE_EC
/**
* \brief Map a curve name (in URI form) to a curve NID.
*
* Maps a URI identifying a named curve to a library identifier.
*
* @param curveName the URI identifying the curve
* @returns the corresponding NID
*/
int curveNameToNID(const char* curveName) const;
#endif
//@}
/** @name Information Functions */
//@{
/**
* \brief Returns a string that identifies the Crypto Provider
*/
virtual const XMLCh* getProviderName() const;
//@}
/*\@}*/
};
#endif /* XSEC_HAVE_OPENSSL */
#endif /* OPENSSLCRYPTOPROVIDER_INCLUDE */
|
