All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
signing-helpers.cpp
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 
23 
24 namespace ndn::security {
25 
26 SigningInfo
27 signingByIdentity(const Name& identityName)
28 {
29  return SigningInfo(SigningInfo::SIGNER_TYPE_ID, identityName);
30 }
31 
32 SigningInfo
33 signingByIdentity(const Identity& identity)
34 {
35  return SigningInfo(identity);
36 }
37 
38 SigningInfo
39 signingByKey(const Name& keyName)
40 {
42 }
43 
44 SigningInfo
45 signingByKey(const Key& key)
46 {
47  return SigningInfo(key);
48 }
49 
50 SigningInfo
51 signingByCertificate(const Name& certName)
52 {
54 }
55 
56 SigningInfo
58 {
60 }
61 
62 SigningInfo
64 {
66 }
67 
68 } // namespace ndn::security
const Name & getName() const noexcept
Get the Data name.
Definition: data.hpp:137
Represents an absolute name.
Definition: name.hpp:45
Represents an NDN certificate.
Definition: certificate.hpp:58
Signing parameters passed to KeyChain.
@ SIGNER_TYPE_CERT
Signer is a certificate, use it directly.
@ SIGNER_TYPE_SHA256
Use a SHA-256 digest only, no signer needs to be specified.
@ SIGNER_TYPE_ID
Signer is an identity, use its default key and default certificate.
@ SIGNER_TYPE_KEY
Signer is a key, use its default certificate.
Frontend handle for an identity in the PIB.
Definition: identity.hpp:44
Frontend handle for a key in the PIB.
Definition: key.hpp:45
Contains the ndn-cxx security framework.
SigningInfo signingByCertificate(const Name &certName)
Return a SigningInfo for signing with a certificate.
SigningInfo signingByKey(const Name &keyName)
Return a SigningInfo for signing with a key.
SigningInfo signingByIdentity(const Name &identityName)
Return a SigningInfo for signing with an identity.
SigningInfo signingWithSha256()
Return a SigningInfo for signing with a SHA-256 digest.