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-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_VERIFIER_FILTER_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_VERIFIER_FILTER_HPP
24 
27 
28 namespace ndn::security::transform {
29 
30 class PrivateKey;
31 class PublicKey;
32 
38 class VerifierFilter final : public Transform
39 {
40 public:
44  VerifierFilter(DigestAlgorithm algo, const PublicKey& key, span<const uint8_t> sig);
45 
49  VerifierFilter(DigestAlgorithm algo, const PrivateKey& key, span<const uint8_t> sig);
50 
51  ~VerifierFilter() final;
52 
53 private:
54  void
55  init(DigestAlgorithm algo, void* pkey);
56 
62  size_t
63  convert(span<const uint8_t> buf) final;
64 
68  void
69  finalize() final;
70 
71 private:
72  class Impl;
73  const unique_ptr<Impl> m_impl;
74 
75  KeyType m_keyType;
76 };
77 
78 unique_ptr<Transform>
79 verifierFilter(DigestAlgorithm algo, const PublicKey& key, span<const uint8_t> sig);
80 
81 unique_ptr<Transform>
82 verifierFilter(DigestAlgorithm algo, const PrivateKey& key, span<const uint8_t> sig);
83 
84 } // namespace ndn::security::transform
85 
86 #endif // NDN_CXX_SECURITY_TRANSFORM_VERIFIER_FILTER_HPP
Abstraction of a private key in crypto transformations.
Definition: private-key.hpp:39
Abstraction of a public key in crypto transformations.
Definition: public-key.hpp:35
Abstraction of an intermediate transformation module.
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.
unique_ptr< Transform > verifierFilter(DigestAlgorithm algo, const PublicKey &key, span< const uint8_t > sig)
KeyType
The type of a cryptographic key.
There are three types of module in a transformation chain: Source, Transform, and Sink.
span< const uint8_t > sig