NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
signer-filter.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 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_SIGNER_FILTER_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_SIGNER_FILTER_HPP
24 
27 
28 namespace ndn {
29 namespace security {
30 namespace transform {
31 
32 class PrivateKey;
33 
37 class SignerFilter final : public Transform
38 {
39 public:
43  SignerFilter(DigestAlgorithm algo, const PrivateKey& key);
44 
45  ~SignerFilter() final;
46 
47 private:
53  size_t
54  convert(span<const uint8_t> buf) final;
55 
59  void
60  finalize() final;
61 
62 private:
63  class Impl;
64  const unique_ptr<Impl> m_impl;
65 };
66 
67 unique_ptr<Transform>
68 signerFilter(DigestAlgorithm algo, const PrivateKey& key);
69 
70 } // namespace transform
71 } // namespace security
72 } // namespace ndn
73 
74 #endif // NDN_CXX_SECURITY_TRANSFORM_SIGNER_FILTER_HPP
There are three types of module in a transformation chain: Source, Transform, and Sink...
Copyright (c) 2011-2015 Regents of the University of California.
unique_ptr< Transform > signerFilter(DigestAlgorithm algo, const PrivateKey &key)
Abstraction of private key in crypto transformation.
Definition: private-key.hpp:38
SignerFilter(DigestAlgorithm algo, const PrivateKey &key)
Create a module to sign using digest algorithm algo and private key key.
Abstraction of an intermediate transformation module.