Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame^] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /** |
| 3 | * Copyright (c) 2013-2016 Regents of the University of California. |
| 4 | * |
| 5 | * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions). |
| 6 | * |
| 7 | * ndn-cxx library is free software: you can redistribute it and/or modify it under the |
| 8 | * terms of the GNU Lesser General Public License as published by the Free Software |
| 9 | * Foundation, either version 3 of the License, or (at your option) any later version. |
| 10 | * |
| 11 | * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY |
| 12 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 13 | * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. |
| 14 | * |
| 15 | * You should have received copies of the GNU General Public License and GNU Lesser |
| 16 | * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see |
| 17 | * <http://www.gnu.org/licenses/>. |
| 18 | * |
| 19 | * See AUTHORS.md for complete list of ndn-cxx authors and contributors. |
| 20 | */ |
| 21 | |
| 22 | #ifndef NDN_CXX_SECURITY_TRANSFORM_HMAC_FILTER_HPP |
| 23 | #define NDN_CXX_SECURITY_TRANSFORM_HMAC_FILTER_HPP |
| 24 | |
| 25 | #include "transform-base.hpp" |
| 26 | #include "../security-common.hpp" |
| 27 | |
| 28 | namespace ndn { |
| 29 | namespace security { |
| 30 | namespace transform { |
| 31 | |
| 32 | /** |
| 33 | * @brief The module to generate HMAC for input data. |
| 34 | */ |
| 35 | class HmacFilter : public Transform |
| 36 | { |
| 37 | public: |
| 38 | |
| 39 | /** |
| 40 | * @brief Create a HMAC module to generate HMAC using algorithm @p algo and @p key |
| 41 | * @pre @p key must not be nullptr, and @p size must be a positive integer. |
| 42 | */ |
| 43 | HmacFilter(DigestAlgorithm algo, const uint8_t* key, size_t keyLen); |
| 44 | |
| 45 | private: |
| 46 | /** |
| 47 | * @brief write data @p buf into HMAC signer |
| 48 | * |
| 49 | * @return The number of bytes that are actually accepted |
| 50 | */ |
| 51 | virtual size_t |
| 52 | convert(const uint8_t* buf, size_t size) final; |
| 53 | |
| 54 | /** |
| 55 | * @brief Finalize HMAC calculation and write the HMAC into next module. |
| 56 | */ |
| 57 | virtual void |
| 58 | finalize() final; |
| 59 | |
| 60 | private: |
| 61 | class Impl; |
| 62 | unique_ptr<Impl> m_impl; |
| 63 | }; |
| 64 | |
| 65 | unique_ptr<Transform> |
| 66 | hmacFilter(DigestAlgorithm algo, const uint8_t* key, size_t keyLen); |
| 67 | |
| 68 | } // namespace transform |
| 69 | } // namespace security |
| 70 | } // namespace ndn |
| 71 | |
| 72 | #endif // NDN_CXX_SECURITY_TRANSFORM_HMAC_FILTER_HPP |