rippled
ValidatorKeys_test.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright 2017 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/app/misc/ValidatorKeys.h>
21 #include <ripple/app/misc/Manifest.h>
22 #include <ripple/basics/base64.h>
23 #include <ripple/beast/unit_test.h>
24 #include <ripple/core/Config.h>
25 #include <ripple/core/ConfigSections.h>
26 #include <test/unit_test/SuiteJournal.h>
27 #include <string>
28 
29 namespace ripple {
30 namespace test {
31 
32 class ValidatorKeys_test : public beast::unit_test::suite
33 {
34  // Used with [validation_seed]
35  const std::string seed = "shUwVw52ofnCUX5m7kPTKzJdr4HEH";
36 
37  // Used with [validation_token]
39  "paQmjZ37pKKPMrgadBLsuf9ab7Y7EUNzh27LQrZqoexpAs31nJi";
40 
42  " "
43  "eyJ2YWxpZGF0aW9uX3NlY3JldF9rZXkiOiI5ZWQ0NWY4NjYyNDFjYzE4YTI3NDdiNT\n",
44  " \tQzODdjMDYyNTkwNzk3MmY0ZTcxOTAyMzFmYWE5Mzc0NTdmYTlkYWY2IiwibWFuaWZl "
45  " \n",
46  "\tc3QiOiJKQUFBQUFGeEllMUZ0d21pbXZHdEgyaUNjTUpxQzlnVkZLaWxHZncxL3ZDeE"
47  "\n",
48  "\t "
49  "hYWExwbGMyR25NaEFrRTFhZ3FYeEJ3RHdEYklENk9NU1l1TTBGREFscEFnTms4U0tG\t "
50  "\t\n",
51  "bjdNTzJmZGtjd1JRSWhBT25ndTlzQUtxWFlvdUorbDJWMFcrc0FPa1ZCK1pSUzZQU2\n",
52  "hsSkFmVXNYZkFpQnNWSkdlc2FhZE9KYy9hQVpva1MxdnltR21WcmxIUEtXWDNZeXd1\n",
53  "NmluOEhBU1FLUHVnQkQ2N2tNYVJGR3ZtcEFUSGxHS0pkdkRGbFdQWXk1QXFEZWRGdj\n",
54  "VUSmEydzBpMjFlcTNNWXl3TFZKWm5GT3I3QzBrdzJBaVR6U0NqSXpkaXRROD0ifQ==\n"};
55 
57  "JAAAAAFxIe1FtwmimvGtH2iCcMJqC9gVFKilGfw1/vCxHXXLplc2GnMhAkE1agqXxBwD"
58  "wDbID6OMSYuM0FDAlpAgNk8SKFn7MO2fdkcwRQIhAOngu9sAKqXYouJ+l2V0W+sAOkVB"
59  "+ZRS6PShlJAfUsXfAiBsVJGesaadOJc/aAZokS1vymGmVrlHPKWX3Yywu6in8HASQKPu"
60  "gBD67kMaRFGvmpATHlGKJdvDFlWPYy5AqDedFv5TJa2w0i21eq3MYywLVJZnFOr7C0kw"
61  "2AiTzSCjIzditQ8=";
62 
63  // Manifest does not match private key
65  "eyJtYW5pZmVzdCI6IkpBQUFBQVZ4SWUyOVVBdzViZFJudHJ1elVkREk4aDNGV1JWZl\n",
66  "k3SXVIaUlKQUhJd3MxdzZzM01oQWtsa1VXQWR2RnFRVGRlSEpvS1pNY0hlS0RzOExo\n",
67  "b3d3bDlHOEdkVGNJbmFka1l3UkFJZ0h2Q01lQU1aSzlqQnV2aFhlaFRLRzVDQ3BBR1\n",
68  "k0bGtvZHRXYW84UGhzR3NDSUREVTA1d1c3bWNiMjlVNkMvTHBpZmgvakZPRGhFR21i\n",
69  "NWF6dTJMVHlqL1pjQkpBbitmNGhtQTQ0U0tYbGtTTUFqak1rSWRyR1Rxa21SNjBzVG\n",
70  "JaTjZOOUYwdk9UV3VYcUZ6eDFoSGIyL0RqWElVZXhDVGlITEcxTG9UdUp1eXdXbk55\n",
71  "RFE9PSIsInZhbGlkYXRpb25fc2VjcmV0X2tleSI6IjkyRDhCNDBGMzYwMTc5MTkwMU\n",
72  "MzQTUzMzI3NzBDMkUwMTA4MDI0NTZFOEM2QkI0NEQ0N0FFREQ0NzJGMDQ2RkYifQ==\n"};
73 
74 public:
75  void
76  run() override
77  {
78  SuiteJournal journal ("ValidatorKeys_test", *this);
79 
80  // Keys/ID when using [validation_seed]
81  SecretKey const seedSecretKey =
82  generateSecretKey(KeyType::secp256k1, *parseBase58<Seed>(seed));
83  PublicKey const seedPublicKey =
84  derivePublicKey(KeyType::secp256k1, seedSecretKey);
85  NodeID const seedNodeID = calcNodeID(seedPublicKey);
86 
87  // Keys when using [validation_token]
88  auto const tokenSecretKey = *parseBase58<SecretKey>(
90 
91  auto const tokenPublicKey =
92  derivePublicKey(KeyType::secp256k1, tokenSecretKey);
93 
95  BEAST_EXPECT(m);
96  NodeID const tokenNodeID = calcNodeID(m->masterKey);
97 
98  {
99  // No config -> no key but valid
100  Config c;
101  ValidatorKeys k{c, journal};
102  BEAST_EXPECT(k.publicKey.size() == 0);
103  BEAST_EXPECT(k.manifest.empty());
104  BEAST_EXPECT(!k.configInvalid());
105 
106  }
107  {
108  // validation seed section -> empty manifest and valid seeds
109  Config c;
110  c.section(SECTION_VALIDATION_SEED).append(seed);
111 
112  ValidatorKeys k{c, journal};
113  BEAST_EXPECT(k.publicKey == seedPublicKey);
114  BEAST_EXPECT(k.secretKey == seedSecretKey);
115  BEAST_EXPECT(k.nodeID == seedNodeID);
116  BEAST_EXPECT(k.manifest.empty());
117  BEAST_EXPECT(!k.configInvalid());
118  }
119 
120  {
121  // validation seed bad seed -> invalid
122  Config c;
123  c.section(SECTION_VALIDATION_SEED).append("badseed");
124 
125  ValidatorKeys k{c, journal};
126  BEAST_EXPECT(k.configInvalid());
127  BEAST_EXPECT(k.publicKey.size() == 0);
128  BEAST_EXPECT(k.manifest.empty());
129  }
130 
131  {
132  // validator token
133  Config c;
134  c.section(SECTION_VALIDATOR_TOKEN).append(tokenBlob);
135  ValidatorKeys k{c, journal};
136 
137  BEAST_EXPECT(k.publicKey == tokenPublicKey);
138  BEAST_EXPECT(k.secretKey == tokenSecretKey);
139  BEAST_EXPECT(k.nodeID == tokenNodeID);
140  BEAST_EXPECT(k.manifest == tokenManifest);
141  BEAST_EXPECT(!k.configInvalid());
142  }
143  {
144  // invalid validator token
145  Config c;
146  c.section(SECTION_VALIDATOR_TOKEN).append("badtoken");
147  ValidatorKeys k{c, journal};
148  BEAST_EXPECT(k.configInvalid());
149  BEAST_EXPECT(k.publicKey.size() == 0);
150  BEAST_EXPECT(k.manifest.empty());
151  }
152 
153  {
154  // Cannot specify both
155  Config c;
156  c.section(SECTION_VALIDATION_SEED).append(seed);
157  c.section(SECTION_VALIDATOR_TOKEN).append(tokenBlob);
158  ValidatorKeys k{c, journal};
159 
160  BEAST_EXPECT(k.configInvalid());
161  BEAST_EXPECT(k.publicKey.size() == 0);
162  BEAST_EXPECT(k.manifest.empty());
163  }
164 
165  {
166  // Token manifest and private key must match
167  Config c;
168  c.section(SECTION_VALIDATOR_TOKEN).append(invalidTokenBlob);
169  ValidatorKeys k{c, journal};
170 
171  BEAST_EXPECT(k.configInvalid());
172  BEAST_EXPECT(k.publicKey.size() == 0);
173  BEAST_EXPECT(k.manifest.empty());
174  }
175 
176  }
177 }; // namespace test
178 
180 
181 } // namespace test
182 } // namespace ripple
ripple::test::BEAST_DEFINE_TESTSUITE
BEAST_DEFINE_TESTSUITE(AccountDelete, app, ripple)
std::string
STL class.
ripple::test::ValidatorKeys_test::tokenSecretStr
const std::string tokenSecretStr
Definition: ValidatorKeys_test.cpp:38
ripple::calcNodeID
NodeID calcNodeID(PublicKey const &pk)
Calculate the 160-bit node ID from a node public key.
Definition: PublicKey.cpp:307
ripple::test::ValidatorKeys_test::tokenBlob
const std::vector< std::string > tokenBlob
Definition: ValidatorKeys_test.cpp:41
std::vector< std::string >
ripple::test::ValidatorKeys_test
Definition: ValidatorKeys_test.cpp:32
ripple::ValidatorKeys
Validator keys and manifest as set in configuration file.
Definition: ValidatorKeys.h:36
ripple::test::ValidatorKeys_test::tokenManifest
const std::string tokenManifest
Definition: ValidatorKeys_test.cpp:56
ripple::Section::append
void append(std::vector< std::string > const &lines)
Append a set of lines to this section.
Definition: BasicConfig.cpp:41
ripple::base_uint< 160, detail::NodeIDTag >
ripple::test::ValidatorKeys_test::seed
const std::string seed
Definition: ValidatorKeys_test.cpp:35
ripple::PublicKey
A public key.
Definition: PublicKey.h:59
ripple::Config
Definition: Config.h:67
ripple::derivePublicKey
PublicKey derivePublicKey(KeyType type, SecretKey const &sk)
Derive the public key from a secret key.
Definition: SecretKey.cpp:228
ripple::base64_decode
std::string base64_decode(std::string const &data)
Definition: base64.cpp:237
ripple::generateSecretKey
SecretKey generateSecretKey(KeyType type, Seed const &seed)
Generate a new secret key deterministically.
Definition: SecretKey.cpp:199
ripple::test::ValidatorKeys_test::run
void run() override
Definition: ValidatorKeys_test.cpp:76
ripple::SecretKey
A secret key.
Definition: SecretKey.h:36
ripple::test::ValidatorKeys_test::invalidTokenBlob
const std::vector< std::string > invalidTokenBlob
Definition: ValidatorKeys_test.cpp:64
ripple::test::SuiteJournal
Definition: SuiteJournal.h:81
ripple::KeyType::secp256k1
@ secp256k1
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::deserializeManifest
boost::optional< Manifest > deserializeManifest(Slice s)
Constructs Manifest from serialized string.
Definition: app/misc/impl/Manifest.cpp:37
ripple::TokenType::NodePrivate
@ NodePrivate
ripple::BasicConfig::section
Section & section(std::string const &name)
Returns the section with the given name.
Definition: BasicConfig.cpp:140
string