Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 2 | /** |
Yingdi Yu | 6ee2d36 | 2015-07-16 21:48:05 -0700 | [diff] [blame] | 3 | * Copyright (c) 2013-2017 Regents of the University of California. |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 4 | * |
| 5 | * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions). |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 6 | * |
Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 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. |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 20 | */ |
| 21 | |
Yingdi Yu | 6ee2d36 | 2015-07-16 21:48:05 -0700 | [diff] [blame] | 22 | #ifndef NDN_SECURITY_SECURITY_COMMON_HPP |
| 23 | #define NDN_SECURITY_SECURITY_COMMON_HPP |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 24 | |
Yingdi Yu | ae73427 | 2015-07-04 17:38:48 -0700 | [diff] [blame] | 25 | #include "../common.hpp" |
| 26 | |
Alexander Afanasyev | 2fa5939 | 2016-07-29 17:24:23 -0700 | [diff] [blame] | 27 | #define NDN_CXX_KEEP_SECURITY_V1_ALIASES |
| 28 | |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 29 | namespace ndn { |
| 30 | |
Yingdi Yu | ae73427 | 2015-07-04 17:38:48 -0700 | [diff] [blame] | 31 | namespace signed_interest { |
Yingdi Yu | 0f5fb69 | 2014-06-10 12:07:28 -0700 | [diff] [blame] | 32 | |
Yingdi Yu | ae73427 | 2015-07-04 17:38:48 -0700 | [diff] [blame] | 33 | const ssize_t POS_SIG_VALUE = -1; |
| 34 | const ssize_t POS_SIG_INFO = -2; |
Alexander Afanasyev | 70244f4 | 2017-01-04 12:47:12 -0800 | [diff] [blame] | 35 | |
| 36 | /** \brief minimal number of components for Signed Interest |
| 37 | * \sa https://redmine.named-data.net/projects/ndn-cxx/wiki/SignedInterest |
| 38 | */ |
| 39 | const size_t MIN_SIZE = 2; |
| 40 | |
| 41 | /** \deprecated To avoid a potentially breaking change, this value is kept based on the Command |
| 42 | * Interest definition. This value will be eliminated in favor of `MIN_SIZE=2`. |
| 43 | */ |
| 44 | const size_t MIN_LENGTH = 4; |
| 45 | |
| 46 | /** \deprecated Use `MIN_SIZE` |
| 47 | */ |
| 48 | const size_t MIN_LENGTH_SIG_ONLY = 2; |
| 49 | |
| 50 | } // namespace signed_interest |
| 51 | |
| 52 | namespace command_interest { |
| 53 | |
| 54 | using signed_interest::POS_SIG_VALUE; |
| 55 | using signed_interest::POS_SIG_INFO; |
Yingdi Yu | ae73427 | 2015-07-04 17:38:48 -0700 | [diff] [blame] | 56 | const ssize_t POS_RANDOM_VAL = -3; |
| 57 | const ssize_t POS_TIMESTAMP = -4; |
Yingdi Yu | 0f5fb69 | 2014-06-10 12:07:28 -0700 | [diff] [blame] | 58 | |
Junxiao Shi | 198c381 | 2016-08-12 19:24:18 +0000 | [diff] [blame] | 59 | /** \brief minimal number of components for Command Interest |
| 60 | * \sa https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest |
| 61 | */ |
Alexander Afanasyev | 70244f4 | 2017-01-04 12:47:12 -0800 | [diff] [blame] | 62 | const size_t MIN_SIZE = 4; |
Yingdi Yu | 0f5fb69 | 2014-06-10 12:07:28 -0700 | [diff] [blame] | 63 | |
Alexander Afanasyev | 70244f4 | 2017-01-04 12:47:12 -0800 | [diff] [blame] | 64 | } // namespace command_interest |
| 65 | |
| 66 | namespace signed_interest { |
| 67 | |
| 68 | /** |
| 69 | * @deprecated Use command_interest::POS_RANDOM_VAL |
Junxiao Shi | 198c381 | 2016-08-12 19:24:18 +0000 | [diff] [blame] | 70 | */ |
Alexander Afanasyev | 70244f4 | 2017-01-04 12:47:12 -0800 | [diff] [blame] | 71 | using command_interest::POS_RANDOM_VAL; |
| 72 | |
| 73 | /** |
| 74 | * @deprecated Use command_interest::POS_TIMESTAMP |
| 75 | */ |
| 76 | using command_interest::POS_TIMESTAMP; |
Junxiao Shi | 198c381 | 2016-08-12 19:24:18 +0000 | [diff] [blame] | 77 | |
Yingdi Yu | 0f5fb69 | 2014-06-10 12:07:28 -0700 | [diff] [blame] | 78 | } // namespace signed_interest |
| 79 | |
Yingdi Yu | c08d7d6 | 2015-07-16 21:05:11 -0700 | [diff] [blame] | 80 | /** |
| 81 | * @brief The type of KeyId component in a key name |
| 82 | */ |
| 83 | enum class KeyIdType { |
| 84 | /** |
| 85 | * @brief User-specified key ID |
| 86 | * |
| 87 | * It is user's responsibility to assure the uniqueness of the key names. |
| 88 | */ |
| 89 | USER_SPECIFIED = 0, |
| 90 | /** |
| 91 | * @brief Use the SHA256 hash of the public key as the key id |
| 92 | * |
| 93 | * This KeyId type guarantees the uniqueness of the key names. |
| 94 | */ |
| 95 | SHA256 = 1, |
| 96 | /** |
| 97 | * @brief Use a 64-bit random number as the key id |
| 98 | * |
| 99 | * This KeyId provides roughly uniqueness of the key names. |
| 100 | */ |
| 101 | RANDOM = 2 |
| 102 | }; |
| 103 | |
| 104 | std::ostream& |
| 105 | operator<<(std::ostream& os, KeyIdType keyIdType); |
| 106 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 107 | enum class KeyType { |
| 108 | NONE = 0, |
| 109 | RSA = 1, |
| 110 | EC = 2, |
| 111 | AES = 128 |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 112 | }; |
| 113 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 114 | std::ostream& |
| 115 | operator<<(std::ostream& os, KeyType keyType); |
| 116 | |
| 117 | enum class KeyClass { |
| 118 | NONE, |
| 119 | PUBLIC, |
| 120 | PRIVATE, |
| 121 | SYMMETRIC |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 122 | }; |
Alexander Afanasyev | b78bc4d | 2014-04-09 21:20:52 -0700 | [diff] [blame] | 123 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 124 | std::ostream& |
| 125 | operator<<(std::ostream& os, KeyClass keyClass); |
| 126 | |
| 127 | enum class DigestAlgorithm { |
| 128 | NONE = 0, |
| 129 | SHA256 = 1 |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 130 | }; |
| 131 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 132 | std::ostream& |
| 133 | operator<<(std::ostream& os, DigestAlgorithm algorithm); |
| 134 | |
| 135 | enum class BlockCipherAlgorithm { |
| 136 | NONE, |
| 137 | AES_CBC |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 138 | }; |
| 139 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 140 | std::ostream& |
| 141 | operator<<(std::ostream& os, BlockCipherAlgorithm algorithm); |
| 142 | |
Yingdi Yu | 8751661 | 2015-07-10 18:03:52 -0700 | [diff] [blame] | 143 | enum class CipherOperator { |
| 144 | DECRYPT = 0, |
| 145 | ENCRYPT = 1 |
| 146 | }; |
| 147 | |
| 148 | std::ostream& |
| 149 | operator<<(std::ostream& os, CipherOperator op); |
| 150 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 151 | enum class AclType { |
| 152 | NONE, |
| 153 | PUBLIC, |
| 154 | PRIVATE |
Yingdi Yu | 2e57a58 | 2014-02-20 23:34:43 -0800 | [diff] [blame] | 155 | }; |
| 156 | |
Yingdi Yu | 99b2a00 | 2015-08-12 12:47:44 -0700 | [diff] [blame] | 157 | std::ostream& |
| 158 | operator<<(std::ostream& os, AclType aclType); |
| 159 | |
Yingdi Yu | 0f5fb69 | 2014-06-10 12:07:28 -0700 | [diff] [blame] | 160 | } // namespace ndn |
Jeff Thompson | 7b79eb6 | 2013-09-12 18:48:29 -0700 | [diff] [blame] | 161 | |
Yingdi Yu | 6ee2d36 | 2015-07-16 21:48:05 -0700 | [diff] [blame] | 162 | #endif // NDN_SECURITY_SECURITY_COMMON_HPP |