NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
verifier-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-2022 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_VERIFIER_FILTER_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_VERIFIER_FILTER_HPP
24 
27 
28 namespace ndn {
29 namespace security {
30 namespace transform {
31 
32 class PrivateKey;
33 class PublicKey;
34 
40 class VerifierFilter final : public Transform
41 {
42 public:
46  VerifierFilter(DigestAlgorithm algo, const PublicKey& key, span<const uint8_t> sig);
47 
51  VerifierFilter(DigestAlgorithm algo, const PrivateKey& key, span<const uint8_t> sig);
52 
53  ~VerifierFilter() final;
54 
55 private:
56  void
57  init(DigestAlgorithm algo, void* pkey);
58 
64  size_t
65  convert(span<const uint8_t> buf) final;
66 
70  void
71  finalize() final;
72 
73 private:
74  class Impl;
75  const unique_ptr<Impl> m_impl;
76 
77  KeyType m_keyType;
78 };
79 
80 unique_ptr<Transform>
81 verifierFilter(DigestAlgorithm algo, const PublicKey& key, span<const uint8_t> sig);
82 
83 unique_ptr<Transform>
84 verifierFilter(DigestAlgorithm algo, const PrivateKey& key, span<const uint8_t> sig);
85 
86 } // namespace transform
87 } // namespace security
88 } // namespace ndn
89 
90 #endif // NDN_CXX_SECURITY_TRANSFORM_VERIFIER_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 > verifierFilter(DigestAlgorithm algo, const PublicKey &key, span< const uint8_t > sig)
The module to verify signatures.
VerifierFilter(DigestAlgorithm algo, const PublicKey &key, span< const uint8_t > sig)
Create a verifier module to verify signature sig using algorithm algo and public key key...
Abstraction of public key in crypto transformation.
Definition: public-key.hpp:35
KeyType
The type of a cryptographic key.
Abstraction of private key in crypto transformation.
Definition: private-key.hpp:38
Abstraction of an intermediate transformation module.
span< const uint8_t > sig