blob: 8a01597ad9ff5488175e421a8fc155af98a70ad2 [file] [log] [blame]
Eric Newberryd82b07c2015-06-20 15:02:07 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Alexander Afanasyevd6d78aa2017-01-02 18:14:23 -08003 * Copyright (c) 2013-2017 Regents of the University of California.
Eric Newberryd82b07c2015-06-20 15:02:07 -07004 *
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_SIGNING_HELPERS_HPP
23#define NDN_CXX_SECURITY_SIGNING_HELPERS_HPP
24
25#include "../common.hpp"
26#include "signing-info.hpp"
27
28namespace ndn {
29namespace security {
30
31/**
32 * \return a SigningInfo for signing with an identity
33 */
34SigningInfo
Alexander Afanasyevd6d78aa2017-01-02 18:14:23 -080035signingByIdentity(const Name& identityName);
36
37/**
38 * \return a SigningInfo for signing with an identity
39 */
40SigningInfo
41signingByIdentity(const Identity& identity);
Eric Newberryd82b07c2015-06-20 15:02:07 -070042
43/**
44 * \return a SigningInfo for signing with a key
45 */
46SigningInfo
47signingByKey(const Name& keyName);
48
49/**
Alexander Afanasyevd6d78aa2017-01-02 18:14:23 -080050 * \return a SigningInfo for signing with a key
51 */
52SigningInfo
53signingByKey(const Key& key);
54
55/**
Eric Newberryd82b07c2015-06-20 15:02:07 -070056 * \return a SigningInfo for signing with a certificate
57 */
58SigningInfo
59signingByCertificate(const Name& certName);
60
61/**
Alexander Afanasyevd6d78aa2017-01-02 18:14:23 -080062 * \return a SigningInfo for signing with a certificate
63 */
64SigningInfo
65signingByCertificate(const v2::Certificate& cert);
66
67/**
Eric Newberryd82b07c2015-06-20 15:02:07 -070068 * \return a SigningInfo for signing with Sha256
69 */
70SigningInfo
71signingWithSha256();
72
73} // namespace security
74
75using security::signingByIdentity;
76using security::signingByKey;
77using security::signingByCertificate;
78using security::signingWithSha256;
79
80} // namespace ndn
81
Alexander Afanasyevd6d78aa2017-01-02 18:14:23 -080082#endif // NDN_CXX_SECURITY_SIGNING_HELPERS_HPP