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-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_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 inline namespace v2 {
48 class Certificate;
49 } // inline namespace v2
50 
55 verifySignature(const InputBuffers& blobs, span<const uint8_t> sig, const transform::PublicKey& key);
56 
61 [[deprecated("use the overload that takes a span<>")]]
62 inline bool
63 verifySignature(const InputBuffers& blobs, const uint8_t* sig, size_t sigLen,
64  const transform::PublicKey& key)
65 {
66  return verifySignature(blobs, {sig, sigLen}, key);
67 }
68 
74 verifySignature(const InputBuffers& blobs, span<const uint8_t> sig, span<const uint8_t> key);
75 
81 verifySignature(const Data& data, span<const uint8_t> key);
82 
89 verifySignature(const Interest& interest, span<const uint8_t> key);
90 
95 verifySignature(const Data& data, const transform::PublicKey& key);
96 
102 verifySignature(const Interest& interest, const transform::PublicKey& key);
103 
108 verifySignature(const Data& data, const pib::Key& key);
109 
115 verifySignature(const Interest& interest, const pib::Key& key);
116 
123 verifySignature(const Data& data, const optional<Certificate>& cert);
124 
132 verifySignature(const Interest& interest, const optional<Certificate>& cert);
133 
138 verifySignature(const Data& data, const tpm::Tpm& tpm, const Name& keyName,
139  DigestAlgorithm digestAlgorithm);
140 
146 verifySignature(const Interest& interest, const tpm::Tpm& tpm, const Name& keyName,
147  DigestAlgorithm digestAlgorithm);
148 
149 } // namespace security
150 } // namespace ndn
151 
152 #endif // NDN_CXX_SECURITY_VERIFICATION_HELPERS_HPP
#define NDN_CXX_NODISCARD
Definition: backports.hpp:68
Represents a Data packet.
Definition: data.hpp:38
Represents an Interest packet.
Definition: interest.hpp:50
Represents an absolute name.
Definition: name.hpp:46
Abstraction of public key in crypto transformation.
Definition: public-key.hpp:36
bool verifySignature(const InputBuffers &blobs, span< const uint8_t > sig, const transform::PublicKey &key)
Verify blobs using key against sig.
@ Data
Definition: tlv.hpp:66
@ Interest
Definition: tlv.hpp:65
Definition: data.cpp:25
span< const uint8_t > sig