blob: 6c5e2ceee7bff31a732a21e596d7a44c9b3b05bc [file] [log] [blame]
Alexander Afanasyev1b58a032017-01-04 14:00:47 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2017 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_SECURITY_COMMAND_INTEREST_SIGNER_HPP
23#define NDN_SECURITY_COMMAND_INTEREST_SIGNER_HPP
24
25#include "v2/key-chain.hpp"
26
27namespace ndn {
28namespace security {
29
30/**
31 * @brief Helper class to prepare command interest name
32 *
33 * The preparer adds timestamp and nonce name components to the supplied name.
34 *
35 * This class is primarily designed to be used as part of CommandInterestSigner, but can also
36 * be using in an application that defines custom signing methods not support by the KeyChain
37 * (such as HMAC-SHA1).
38 *
39 * @sa https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest
40 */
41class CommandInterestPreparer : noncopyable
42{
43public:
Alexander Afanasyev3e2c3a02017-01-19 13:55:56 -080044 CommandInterestPreparer();
45
Alexander Afanasyev1b58a032017-01-04 14:00:47 -080046 /**
47 * @brief Prepare name of the CommandInterest
48 *
49 * This method appends the timestamp and nonce name components to the supplied name.
50 */
51 Name
52 prepareCommandInterestName(Name name);
53
54private:
55 time::milliseconds m_lastUsedTimestamp;
56};
57
58/**
59 * @brief Helper class to create command interests
60 *
61 * The signer adds timestamp and nonce name components to the supplied name, creates an
62 * Interest, and signs it with the KeyChain.
63 *
64 * @sa https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest
65 */
66class CommandInterestSigner : private CommandInterestPreparer
67{
68public:
69 explicit
70 CommandInterestSigner(v2::KeyChain& keyChain);
71
72 /**
73 * @brief Create CommandInterest
74 *
75 * This method appends the timestamp and nonce name components to the supplied name, create
76 * an Interest object and signs it with the keychain.
77 *
78 * Note that signature of the command interest covers only Name of the interest. Therefore,
79 * other fields in the returned interest can be changed without breaking validity of the
80 * signature, because s
81 *
82 * @sa https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest
83 */
84 Interest
85 makeCommandInterest(const Name& name, const SigningInfo& params = v2::KeyChain::getDefaultSigningInfo());
86
87private:
88 v2::KeyChain& m_keyChain;
89};
90
91} // namespace security
92} // namespace ndn
93
94
95#endif // NDN_SECURITY_COMMAND_INTEREST_SIGNER_HPP