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
|
/**
* 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
*
* XSECCryptoKeyHMAC := HMAC Keys
*
* Author(s): Berin Lautenbach
*
* $Id$
*
*/
#ifndef XSECCRYPTOKEYHMAC_INCLUDE
#define XSECCRYPTOKEYHMAC_INCLUDE
#include <xsec/enc/XSECCryptoKey.hpp>
#include <xsec/utils/XSECSafeBuffer.hpp>
/**
* \ingroup crypto
*/
/**
* \brief Interface class for HMAC keys.
*
* The library uses classes derived from this to process HMAC keys.
*/
class XSEC_EXPORT XSECCryptoKeyHMAC : public XSECCryptoKey {
public :
/** @name Constructors and Destructors */
//@{
XSECCryptoKeyHMAC() {};
virtual ~XSECCryptoKeyHMAC() {};
//@}
/** @name Key Interface methods */
//@{
/**
* \brief Return the type of this key.
*
* For DSA keys, this allows people to determine whether this is a
* public key, private key or a key pair
*/
virtual XSECCryptoKey::KeyType getKeyType() const {return KEY_HMAC;}
/**
* \brief Replicate key
*/
virtual XSECCryptoKey * clone() const = 0;
//@}
/** @name Optional Interface methods
*
* These functions do not necessarily have to be implmented. They
* are used by XSECKeyInfoResolverDefault to try to create a key from
* KeyInfo elements without knowing anything else.
*
* If an interface class does not implement these functions, a simple
* stub that does nothing should be used.
*/
//@{
/**
* \brief Set the key
*
* Set the key from the buffer
*
* @param inBuf Buffer containing the key
* @param inLength Number of bytes of key in the buffer
*/
virtual void setKey(unsigned char * inBuf, unsigned int inLength) = 0;
/**
* \brief Get the key value
*
* Copy the key into the safeBuffer and return the number of bytes
* copied.
*
* @param outBuf Buffer to copy key into
* @returns number of bytes copied in
*/
virtual unsigned int getKey(safeBuffer &outBuf) const = 0;
//@}
};
#endif /* XSECCRYPTOKEYHMAC_INCLUDE */
|
