block-cipher.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 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_BLOCK_CIPHER_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_BLOCK_CIPHER_HPP
24 
27 
28 namespace ndn::security::transform {
29 
36 class BlockCipher final : public Transform
37 {
38 public:
48  span<const uint8_t> key, span<const uint8_t> iv);
49 
50  ~BlockCipher() final;
51 
52 private:
56  void
57  preTransform() final;
58 
64  size_t
65  convert(span<const uint8_t> data) final;
66 
70  void
71  finalize() final;
72 
76  void
77  fillOutputBuffer();
78 
82  bool
83  isConverterEmpty() const;
84 
85 private:
86  void
87  initializeAesCbc(span<const uint8_t> key, span<const uint8_t> iv, CipherOperator op);
88 
89 private:
90  class Impl;
91  const unique_ptr<Impl> m_impl;
92 };
93 
94 unique_ptr<Transform>
96  span<const uint8_t> key, span<const uint8_t> iv);
97 
98 } // namespace ndn::security::transform
99 
100 #endif // NDN_CXX_SECURITY_TRANSFORM_BLOCK_CIPHER_HPP
The module to encrypt data using block cipher.
BlockCipher(BlockCipherAlgorithm algo, CipherOperator op, span< const uint8_t > key, span< const uint8_t > iv)
Create a block cipher.
Abstraction of an intermediate transformation module.
unique_ptr< Transform > blockCipher(BlockCipherAlgorithm algo, CipherOperator op, span< const uint8_t > key, span< const uint8_t > iv)
BlockCipherAlgorithm
There are three types of module in a transformation chain: Source, Transform, and Sink.