1 /* 2 * Copyright (c) 2010 SURFnet bv 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 20 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 22 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 24 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 /***************************************************************************** 28 MacAlgorithm.h 29 30 Base class for MAC algorithm classes 31 *****************************************************************************/ 32 33 #ifndef _SOFTHSM_V2_MACALGORITHM_H 34 #define _SOFTHSM_V2_MACALGORITHM_H 35 36 #include <string> 37 #include "config.h" 38 #include "SymmetricKey.h" 39 #include "RNG.h" 40 41 struct MacAlgo 42 { 43 enum Type 44 { 45 Unknown, 46 HMAC_MD5, 47 HMAC_SHA1, 48 HMAC_SHA224, 49 HMAC_SHA256, 50 HMAC_SHA384, 51 HMAC_SHA512, 52 HMAC_GOST, 53 CMAC_DES, 54 CMAC_AES 55 }; 56 }; 57 58 class MacAlgorithm 59 { 60 public: 61 // Base constructors 62 MacAlgorithm(); 63 64 // Destructor ~MacAlgorithm()65 virtual ~MacAlgorithm() { } 66 67 // Signing functions 68 virtual bool signInit(const SymmetricKey* key); 69 virtual bool signUpdate(const ByteString& dataToSign); 70 virtual bool signFinal(ByteString& signature); 71 72 // Verification functions 73 virtual bool verifyInit(const SymmetricKey* key); 74 virtual bool verifyUpdate(const ByteString& originalData); 75 virtual bool verifyFinal(ByteString& signature); 76 77 // Key 78 virtual unsigned long getMinKeySize(); 79 virtual unsigned long getMaxKeySize(); 80 virtual void recycleKey(SymmetricKey* toRecycle); 81 82 // Return the MAC size 83 virtual size_t getMacSize() const = 0; 84 85 protected: 86 // The current key 87 const SymmetricKey* currentKey; 88 89 private: 90 // The current operation 91 enum 92 { 93 NONE, 94 SIGN, 95 VERIFY 96 } 97 currentOperation; 98 }; 99 100 #endif // !_SOFTHSM_V2_MACALGORITHM_H 101 102