blob: ef9a42bf6243ea9bc79bb9d771f71632ba81c28f [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Jeff Thompson7b79eb62013-09-12 18:48:29 -07002/**
Yingdi Yuae734272015-07-04 17:38:48 -07003 * Copyright (c) 2013-2016 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * 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.
Jeff Thompson7b79eb62013-09-12 18:48:29 -070020 */
21
22#ifndef NDN_SECURITY_COMMON_HPP
Jeff Thompsone589c3f2013-10-12 17:30:50 -070023#define NDN_SECURITY_COMMON_HPP
Jeff Thompson7b79eb62013-09-12 18:48:29 -070024
Yingdi Yuae734272015-07-04 17:38:48 -070025#include "../common.hpp"
26
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070027#define NDN_CXX_KEEP_SECURITY_V1_ALIASES
28
Jeff Thompson7b79eb62013-09-12 18:48:29 -070029namespace ndn {
30
Yingdi Yuae734272015-07-04 17:38:48 -070031namespace signed_interest {
Yingdi Yu0f5fb692014-06-10 12:07:28 -070032
Yingdi Yuae734272015-07-04 17:38:48 -070033const ssize_t POS_SIG_VALUE = -1;
34const ssize_t POS_SIG_INFO = -2;
35const ssize_t POS_RANDOM_VAL = -3;
36const ssize_t POS_TIMESTAMP = -4;
Yingdi Yu0f5fb692014-06-10 12:07:28 -070037
Junxiao Shi198c3812016-08-12 19:24:18 +000038/** \brief minimal number of components for Command Interest
39 * \sa https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest
40 */
Yingdi Yuae734272015-07-04 17:38:48 -070041const size_t MIN_LENGTH = 4;
Yingdi Yu0f5fb692014-06-10 12:07:28 -070042
Junxiao Shi198c3812016-08-12 19:24:18 +000043/** \brief minimal number of components for Signed Interest
44 * \sa https://redmine.named-data.net/projects/ndn-cxx/wiki/SignedInterest
45 */
46const size_t MIN_LENGTH_SIG_ONLY = 2;
47
Yingdi Yu0f5fb692014-06-10 12:07:28 -070048} // namespace signed_interest
49
Yingdi Yuc08d7d62015-07-16 21:05:11 -070050/**
51 * @brief The type of KeyId component in a key name
52 */
53enum class KeyIdType {
54 /**
55 * @brief User-specified key ID
56 *
57 * It is user's responsibility to assure the uniqueness of the key names.
58 */
59 USER_SPECIFIED = 0,
60 /**
61 * @brief Use the SHA256 hash of the public key as the key id
62 *
63 * This KeyId type guarantees the uniqueness of the key names.
64 */
65 SHA256 = 1,
66 /**
67 * @brief Use a 64-bit random number as the key id
68 *
69 * This KeyId provides roughly uniqueness of the key names.
70 */
71 RANDOM = 2
72};
73
74std::ostream&
75operator<<(std::ostream& os, KeyIdType keyIdType);
76
Yingdi Yu99b2a002015-08-12 12:47:44 -070077enum class KeyType {
78 NONE = 0,
79 RSA = 1,
80 EC = 2,
81 AES = 128
Jeff Thompson7b79eb62013-09-12 18:48:29 -070082};
83
Yingdi Yu99b2a002015-08-12 12:47:44 -070084std::ostream&
85operator<<(std::ostream& os, KeyType keyType);
86
87enum class KeyClass {
88 NONE,
89 PUBLIC,
90 PRIVATE,
91 SYMMETRIC
Jeff Thompson7b79eb62013-09-12 18:48:29 -070092};
Alexander Afanasyevb78bc4d2014-04-09 21:20:52 -070093
Yingdi Yu99b2a002015-08-12 12:47:44 -070094std::ostream&
95operator<<(std::ostream& os, KeyClass keyClass);
96
97enum class DigestAlgorithm {
98 NONE = 0,
99 SHA256 = 1
Jeff Thompson7b79eb62013-09-12 18:48:29 -0700100};
101
Yingdi Yu99b2a002015-08-12 12:47:44 -0700102std::ostream&
103operator<<(std::ostream& os, DigestAlgorithm algorithm);
104
105enum class BlockCipherAlgorithm {
106 NONE,
107 AES_CBC
Jeff Thompson7b79eb62013-09-12 18:48:29 -0700108};
109
Yingdi Yu99b2a002015-08-12 12:47:44 -0700110std::ostream&
111operator<<(std::ostream& os, BlockCipherAlgorithm algorithm);
112
Yingdi Yu87516612015-07-10 18:03:52 -0700113enum class CipherOperator {
114 DECRYPT = 0,
115 ENCRYPT = 1
116};
117
118std::ostream&
119operator<<(std::ostream& os, CipherOperator op);
120
Yingdi Yu99b2a002015-08-12 12:47:44 -0700121enum class AclType {
122 NONE,
123 PUBLIC,
124 PRIVATE
Yingdi Yu2e57a582014-02-20 23:34:43 -0800125};
126
Yingdi Yu99b2a002015-08-12 12:47:44 -0700127std::ostream&
128operator<<(std::ostream& os, AclType aclType);
129
Yingdi Yu0f5fb692014-06-10 12:07:28 -0700130} // namespace ndn
Jeff Thompson7b79eb62013-09-12 18:48:29 -0700131
Yingdi Yuae734272015-07-04 17:38:48 -0700132#endif // NDN_SECURITY_COMMON_HPP