Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
Davide Pesavento | 8aad372 | 2017-09-16 20:57:28 -0400 | [diff] [blame] | 2 | /* |
Davide Pesavento | 794f687 | 2017-05-15 23:33:38 -0400 | [diff] [blame] | 3 | * Copyright (c) 2013-2017 Regents of the University of California. |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 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: |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 38 | /** |
Davide Pesavento | 9219f58 | 2017-09-17 13:58:29 -0400 | [diff] [blame] | 39 | * @brief Create a module to generate HMAC using digest algorithm @p algo and key @p key |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 40 | * @pre @p key must not be nullptr, and @p size must be a positive integer. |
| 41 | */ |
| 42 | HmacFilter(DigestAlgorithm algo, const uint8_t* key, size_t keyLen); |
| 43 | |
Davide Pesavento | 8aad372 | 2017-09-16 20:57:28 -0400 | [diff] [blame] | 44 | ~HmacFilter(); |
| 45 | |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 46 | private: |
| 47 | /** |
Davide Pesavento | 9219f58 | 2017-09-17 13:58:29 -0400 | [diff] [blame] | 48 | * @brief Write data @p buf into HMAC signer |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 49 | * |
| 50 | * @return The number of bytes that are actually accepted |
| 51 | */ |
Davide Pesavento | 57c07df | 2016-12-11 18:41:45 -0500 | [diff] [blame] | 52 | size_t |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 53 | convert(const uint8_t* buf, size_t size) final; |
| 54 | |
| 55 | /** |
| 56 | * @brief Finalize HMAC calculation and write the HMAC into next module. |
| 57 | */ |
Davide Pesavento | 57c07df | 2016-12-11 18:41:45 -0500 | [diff] [blame] | 58 | void |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 59 | finalize() final; |
| 60 | |
| 61 | private: |
| 62 | class Impl; |
Davide Pesavento | 794f687 | 2017-05-15 23:33:38 -0400 | [diff] [blame] | 63 | const unique_ptr<Impl> m_impl; |
Yingdi Yu | d12fb97 | 2015-08-01 17:38:49 -0700 | [diff] [blame] | 64 | }; |
| 65 | |
| 66 | unique_ptr<Transform> |
| 67 | hmacFilter(DigestAlgorithm algo, const uint8_t* key, size_t keyLen); |
| 68 | |
| 69 | } // namespace transform |
| 70 | } // namespace security |
| 71 | } // namespace ndn |
| 72 | |
| 73 | #endif // NDN_CXX_SECURITY_TRANSFORM_HMAC_FILTER_HPP |