verification-helpers.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_VERIFICATION_HELPERS_HPP
23 #define NDN_CXX_SECURITY_VERIFICATION_HELPERS_HPP
24 
25 #include "ndn-cxx/name.hpp"
27 
28 namespace ndn {
29 
30 class Interest;
31 class Data;
32 
33 namespace security {
34 
35 namespace pib {
36 class Key;
37 } // namespace pib
38 
39 namespace tpm {
40 class Tpm;
41 } // namespace tpm
42 
43 namespace transform {
44 class PublicKey;
45 } // namespace transform
46 
47 class Certificate;
48 
52 [[nodiscard]] bool
53 verifySignature(const InputBuffers& blobs, span<const uint8_t> sig, const transform::PublicKey& key);
54 
59 [[nodiscard]] bool
60 verifySignature(const InputBuffers& blobs, span<const uint8_t> sig, span<const uint8_t> key);
61 
66 [[nodiscard]] bool
67 verifySignature(const Data& data, span<const uint8_t> key);
68 
74 [[nodiscard]] bool
75 verifySignature(const Interest& interest, span<const uint8_t> key);
76 
80 [[nodiscard]] bool
81 verifySignature(const Data& data, const transform::PublicKey& key);
82 
87 [[nodiscard]] bool
88 verifySignature(const Interest& interest, const transform::PublicKey& key);
89 
93 [[nodiscard]] bool
94 verifySignature(const Data& data, const pib::Key& key);
95 
100 [[nodiscard]] bool
101 verifySignature(const Interest& interest, const pib::Key& key);
102 
108 [[nodiscard]] bool
109 verifySignature(const Data& data, const std::optional<Certificate>& cert);
110 
117 [[nodiscard]] bool
118 verifySignature(const Interest& interest, const std::optional<Certificate>& cert);
119 
123 [[nodiscard]] bool
124 verifySignature(const Data& data, const tpm::Tpm& tpm, const Name& keyName,
125  DigestAlgorithm digestAlgorithm);
126 
131 [[nodiscard]] bool
132 verifySignature(const Interest& interest, const tpm::Tpm& tpm, const Name& keyName,
133  DigestAlgorithm digestAlgorithm);
134 
135 } // namespace security
136 } // namespace ndn
137 
138 #endif // NDN_CXX_SECURITY_VERIFICATION_HELPERS_HPP
bool verifySignature(const InputBuffers &blobs, span< const uint8_t > sig, const transform::PublicKey &key)
Verify blobs using key against sig.
@ Name
Definition: tlv.hpp:71
@ Data
Definition: tlv.hpp:69
@ Interest
Definition: tlv.hpp:68
Definition: data.cpp:25
span< const uint8_t > sig