2021-03-09 22:24:35 +00:00
|
|
|
#include "key_manager.hpp"
|
2019-11-22 03:57:41 +00:00
|
|
|
|
2019-11-26 19:42:41 +00:00
|
|
|
#include <system_error>
|
2022-07-16 00:41:14 +00:00
|
|
|
#include <llarp/util/logging.hpp>
|
2021-03-09 22:24:35 +00:00
|
|
|
#include "config.hpp"
|
|
|
|
#include <llarp/crypto/crypto.hpp>
|
|
|
|
#include <llarp/crypto/types.hpp>
|
2019-11-22 03:57:41 +00:00
|
|
|
|
|
|
|
namespace llarp
|
|
|
|
{
|
2019-12-06 18:21:14 +00:00
|
|
|
KeyManager::KeyManager() : m_initialized(false), m_needBackup(false)
|
Config file improvements (#1397)
* Config file API/comment improvements
API improvements:
=================
Make the config API use position-independent tag parameters (Required,
Default{123}, MultiValue) rather than a sequence of bools with
overloads. For example, instead of:
conf.defineOption<int>("a", "b", false, true, 123, [] { ... });
you now write:
conf.defineOption<int>("a", "b", MultiValue, Default{123}, [] { ... });
The tags are:
- Required
- MultiValue
- Default{value}
plus new abilities (see below):
- Hidden
- RelayOnly
- ClientOnly
- Comment{"line1", "line2", "line3"}
Made option definition more powerful:
=====================================
- `Hidden` allows you to define an option that won't show up in the
generated config file if it isn't set.
- `RelayOnly`/`ClientOnly` sets up an option that is only accepted and
only shows up for relay or client configs. (If neither is specified
the option shows up in both modes).
- `Comment{...}` lets the option comments be specified as part of the
defineOption.
Comment improvements
====================
- Rewrote comments for various options to expand on details.
- Inlined all the comments with the option definitions.
- Several options that were missing comments got comments added.
- Made various options for deprecated and or internal options hidden by
default so that they don't show up in a default config file.
- show the section comment (but not option comments) *after* the
[section] tag instead of before it as it makes more sense that way
(particularly for the [bind] section which has a new long comment to
describe how it works).
Disable profiling by default
============================
We had this weird state where we use and store profiling by default but
never *load* it when starting up. This commit makes us just not use
profiling at all unless explicitly enabled.
Other misc changes:
===================
- change default worker threads to 0 (= num cpus) instead of 1, and fix
it to allow 0.
- Actually apply worker-threads option
- fixed default data-dir value erroneously having quotes around it
- reordered ifname/ifaddr/mapaddr (was previously mapaddr/ifaddr/ifname)
as mapaddr is a sort of specialization of ifaddr and so makes more
sense to come after it (particularly because it now references ifaddr
in its help message).
- removed peer-stats option (since we always require it for relays and
never use it for clients)
- removed router profiles filename option (this doesn't need to be
configurable)
- removed defunct `service-node-seed` option
- Change default logging output file to "" (which means stdout), and
also made "-" work for stdout.
* Router hive compilation fixes
* Comments for SNApp SRV settings in ini file
* Add extra blank line after section comments
* Better deprecated option handling
Allow {client,relay}-only options in {relay,client} configs to be
specified as implicitly deprecated options: they warn, and don't set
anything.
Add an explicit `Deprecated` tag and move deprecated option handling
into definition.cpp.
* Move backwards compat options into section definitions
Keep the "addBackwardsCompatibleConfigOptions" only for options in
sections that no longer exist.
* Fix INI parsing issues & C++17-ify
- don't allow inline comments because it seems they aren't allowed in
ini formats in general, and is going to cause problems if there is a
comment character in a value (e.g. an exit auth string). Additionally
it was breaking on a line such as:
# some comment; see?
because it was treating only `; see?` as the comment and then producing
an error message about the rest of the line being invalid.
- make section parsing stricter: the `[` and `]` have to be at the
beginning at end of the line now (after stripping whitespace).
- Move whitespace stripping to the top since everything in here does it.
- chop off string_view suffix/prefix rather than maintaining position
values
- fix potential infinite loop/segfault when given a line such as `]foo[`
* Make config parsing failure fatal
Load() LogError's and returns false on failure, so we weren't aborting
on config file errors.
* Formatting: allow `{}` for empty functions/structs
Instead of using two lines when empty:
{
}
* Make default dns bind 127.0.0.1 on non-Linux
* Don't show empty section; fix tests
We can conceivably have sections that only make sense for clients or
relays, and so want to completely omit that section if we have no
options for the type of config being generated.
Also fixes missing empty lines between tests.
Co-authored-by: Thomas Winget <tewinget@gmail.com>
2020-10-07 22:22:58 +00:00
|
|
|
{}
|
2019-11-22 03:57:41 +00:00
|
|
|
|
|
|
|
bool
|
2021-03-23 19:00:46 +00:00
|
|
|
KeyManager::initialize(const llarp::Config& config, bool genIfAbsent, bool isSNode)
|
2019-11-22 03:57:41 +00:00
|
|
|
{
|
2020-04-07 18:38:56 +00:00
|
|
|
if (m_initialized)
|
2019-11-26 19:42:41 +00:00
|
|
|
return false;
|
|
|
|
|
2021-04-02 15:10:37 +00:00
|
|
|
if (not isSNode)
|
|
|
|
{
|
2023-10-19 23:09:22 +00:00
|
|
|
crypto::identity_keygen(identityKey);
|
|
|
|
crypto::encryption_keygen(encryptionKey);
|
|
|
|
crypto::encryption_keygen(transportKey);
|
2021-04-02 15:10:37 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-10-02 09:48:08 +00:00
|
|
|
const fs::path root = config.router.m_dataDir;
|
2020-04-01 23:11:04 +00:00
|
|
|
|
2020-04-29 19:41:39 +00:00
|
|
|
// utility function to assign a path, using the specified config parameter if present and
|
|
|
|
// falling back to root / defaultName if not
|
|
|
|
auto deriveFile = [&](const std::string& defaultName, const std::string& option) {
|
|
|
|
if (option.empty())
|
|
|
|
{
|
|
|
|
return root / defaultName;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
fs::path file(option);
|
|
|
|
if (not file.is_absolute())
|
2020-10-02 09:48:08 +00:00
|
|
|
file = root / file;
|
2020-04-29 19:41:39 +00:00
|
|
|
|
|
|
|
return file;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
m_rcPath = deriveFile(our_rc_filename, config.router.m_routerContactFile);
|
|
|
|
m_idKeyPath = deriveFile(our_identity_filename, config.router.m_identityKeyFile);
|
|
|
|
m_encKeyPath = deriveFile(our_enc_key_filename, config.router.m_encryptionKeyFile);
|
|
|
|
m_transportKeyPath = deriveFile(our_transport_key_filename, config.router.m_transportKeyFile);
|
2019-11-22 23:11:59 +00:00
|
|
|
|
|
|
|
RouterContact rc;
|
2020-06-04 19:32:38 +00:00
|
|
|
bool exists = rc.Read(m_rcPath);
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not exists and not genIfAbsent)
|
2019-11-22 23:11:59 +00:00
|
|
|
{
|
2019-11-27 18:30:19 +00:00
|
|
|
LogError("Could not read RouterContact at path ", m_rcPath);
|
|
|
|
return false;
|
2019-11-22 23:11:59 +00:00
|
|
|
}
|
|
|
|
|
2019-12-06 18:21:14 +00:00
|
|
|
// we need to back up keys if our self.signed doesn't appear to have a
|
|
|
|
// valid signature
|
2021-03-23 19:00:46 +00:00
|
|
|
m_needBackup = (isSNode and not rc.VerifySignature());
|
2019-12-06 18:21:14 +00:00
|
|
|
|
2019-11-27 18:30:19 +00:00
|
|
|
// if our RC file can't be verified, assume it is out of date (e.g. uses
|
|
|
|
// older encryption) and needs to be regenerated. before doing so, backup
|
|
|
|
// files that will be overwritten
|
2020-04-07 18:38:56 +00:00
|
|
|
if (exists and m_needBackup)
|
2019-11-27 18:30:19 +00:00
|
|
|
{
|
2020-04-07 18:38:56 +00:00
|
|
|
if (!genIfAbsent)
|
2019-11-27 18:30:19 +00:00
|
|
|
{
|
|
|
|
LogError("Our RouterContact ", m_rcPath, " is invalid or out of date");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2020-04-07 18:38:56 +00:00
|
|
|
LogWarn(
|
|
|
|
"Our RouterContact ",
|
|
|
|
m_rcPath,
|
|
|
|
" seems out of date, backing up and regenerating private keys");
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2020-04-07 18:38:56 +00:00
|
|
|
if (!backupKeyFilesByMoving())
|
2019-11-27 18:30:19 +00:00
|
|
|
{
|
2019-12-06 17:13:09 +00:00
|
|
|
LogError(
|
|
|
|
"Could not mv some key files, please ensure key files"
|
2019-11-22 23:11:59 +00:00
|
|
|
" are backed up if needed and remove");
|
|
|
|
return false;
|
|
|
|
}
|
2019-11-27 18:30:19 +00:00
|
|
|
}
|
|
|
|
}
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2023-10-17 20:54:02 +00:00
|
|
|
if (not config.router.m_isRelay)
|
2019-11-27 18:30:19 +00:00
|
|
|
{
|
2019-12-03 19:32:19 +00:00
|
|
|
// load identity key or create if needed
|
2019-12-06 17:13:09 +00:00
|
|
|
auto identityKeygen = [](llarp::SecretKey& key) {
|
2019-12-03 19:32:19 +00:00
|
|
|
// TODO: handle generating from service node seed
|
2023-10-19 23:09:22 +00:00
|
|
|
llarp::crypto::identity_keygen(key);
|
2019-12-03 19:32:19 +00:00
|
|
|
};
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not loadOrCreateKey(m_idKeyPath, identityKey, identityKeygen))
|
2019-12-03 19:32:19 +00:00
|
|
|
return false;
|
|
|
|
}
|
2019-11-26 19:42:41 +00:00
|
|
|
|
2019-11-27 18:30:19 +00:00
|
|
|
// load encryption key
|
2019-12-06 17:13:09 +00:00
|
|
|
auto encryptionKeygen = [](llarp::SecretKey& key) {
|
2023-10-19 23:09:22 +00:00
|
|
|
llarp::crypto::encryption_keygen(key);
|
2019-11-27 18:30:19 +00:00
|
|
|
};
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not loadOrCreateKey(m_encKeyPath, encryptionKey, encryptionKeygen))
|
2019-11-27 18:30:19 +00:00
|
|
|
return false;
|
2019-11-26 19:42:41 +00:00
|
|
|
|
2019-11-27 18:30:19 +00:00
|
|
|
// TODO: transport key (currently done in LinkLayer)
|
2019-12-06 17:13:09 +00:00
|
|
|
auto transportKeygen = [](llarp::SecretKey& key) {
|
2019-12-03 17:58:53 +00:00
|
|
|
key.Zero();
|
2023-10-19 23:09:22 +00:00
|
|
|
crypto::encryption_keygen(key);
|
2019-12-03 17:58:53 +00:00
|
|
|
};
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not loadOrCreateKey(m_transportKeyPath, transportKey, transportKeygen))
|
2019-12-03 17:58:53 +00:00
|
|
|
return false;
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2019-11-26 19:42:41 +00:00
|
|
|
m_initialized = true;
|
2019-11-22 03:57:41 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-11-22 23:11:59 +00:00
|
|
|
bool
|
2020-04-01 23:11:04 +00:00
|
|
|
KeyManager::backupFileByMoving(const fs::path& filepath)
|
2019-11-22 23:11:59 +00:00
|
|
|
{
|
|
|
|
auto findFreeBackupFilename = [](const fs::path& filepath) {
|
2020-04-07 18:38:56 +00:00
|
|
|
for (int i = 0; i < 9; i++)
|
2019-11-22 23:11:59 +00:00
|
|
|
{
|
|
|
|
std::string ext("." + std::to_string(i) + ".bak");
|
|
|
|
fs::path newPath = filepath;
|
|
|
|
newPath += ext;
|
|
|
|
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not fs::exists(newPath))
|
2019-11-22 23:11:59 +00:00
|
|
|
return newPath;
|
|
|
|
}
|
|
|
|
return fs::path();
|
|
|
|
};
|
|
|
|
|
2019-12-06 18:21:14 +00:00
|
|
|
std::error_code ec;
|
|
|
|
bool exists = fs::exists(filepath, ec);
|
2020-04-07 18:38:56 +00:00
|
|
|
if (ec)
|
2019-12-06 18:21:14 +00:00
|
|
|
{
|
2020-04-07 18:38:56 +00:00
|
|
|
LogError("Could not determine status of file ", filepath, ": ", ec.message());
|
2019-12-06 18:21:14 +00:00
|
|
|
return false;
|
|
|
|
}
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not exists)
|
2019-11-22 23:11:59 +00:00
|
|
|
{
|
2019-12-06 18:21:14 +00:00
|
|
|
LogInfo("File ", filepath, " doesn't exist; no backup needed");
|
|
|
|
return true;
|
|
|
|
}
|
2019-11-27 18:30:19 +00:00
|
|
|
|
2019-12-06 18:21:14 +00:00
|
|
|
fs::path newFilepath = findFreeBackupFilename(filepath);
|
2020-04-07 18:38:56 +00:00
|
|
|
if (newFilepath.empty())
|
2019-12-06 18:21:14 +00:00
|
|
|
{
|
|
|
|
LogWarn("Could not find an appropriate backup filename for", filepath);
|
|
|
|
return false;
|
|
|
|
}
|
2019-11-27 18:30:19 +00:00
|
|
|
|
2020-04-07 18:38:56 +00:00
|
|
|
LogInfo("Backing up (moving) key file ", filepath, " to ", newFilepath, "...");
|
2019-12-06 18:21:14 +00:00
|
|
|
|
|
|
|
fs::rename(filepath, newFilepath, ec);
|
2020-04-07 18:38:56 +00:00
|
|
|
if (ec)
|
2019-12-06 18:21:14 +00:00
|
|
|
{
|
|
|
|
LogError("Failed to move key file ", ec.message());
|
|
|
|
return false;
|
|
|
|
}
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2019-12-06 18:21:14 +00:00
|
|
|
return true;
|
|
|
|
}
|
2019-11-22 23:11:59 +00:00
|
|
|
|
2019-12-06 18:21:14 +00:00
|
|
|
bool
|
|
|
|
KeyManager::backupKeyFilesByMoving() const
|
|
|
|
{
|
2020-05-27 03:42:01 +00:00
|
|
|
std::vector<fs::path> files = {m_rcPath, m_idKeyPath, m_encKeyPath, m_transportKeyPath};
|
2019-12-06 18:21:14 +00:00
|
|
|
|
2020-04-07 18:38:56 +00:00
|
|
|
for (auto& filepath : files)
|
2019-12-06 18:21:14 +00:00
|
|
|
{
|
2020-04-07 18:38:56 +00:00
|
|
|
if (not backupFileByMoving(filepath))
|
2019-11-22 23:11:59 +00:00
|
|
|
return false;
|
|
|
|
}
|
2019-11-26 19:42:41 +00:00
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool
|
|
|
|
KeyManager::loadOrCreateKey(
|
2020-10-30 19:53:05 +00:00
|
|
|
fs::path path, llarp::SecretKey& key, std::function<void(llarp::SecretKey& key)> keygen)
|
2019-11-26 19:42:41 +00:00
|
|
|
{
|
2020-10-30 19:51:22 +00:00
|
|
|
if (not fs::exists(path))
|
2019-11-26 19:42:41 +00:00
|
|
|
{
|
2020-10-30 19:51:22 +00:00
|
|
|
LogInfo("Generating new key", path);
|
2019-11-26 19:42:41 +00:00
|
|
|
keygen(key);
|
|
|
|
|
2020-10-30 19:51:22 +00:00
|
|
|
if (!key.SaveToFile(path))
|
2019-11-26 19:42:41 +00:00
|
|
|
{
|
|
|
|
LogError("Failed to save new key");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
2020-10-30 19:51:22 +00:00
|
|
|
LogDebug("Loading key from file ", path);
|
|
|
|
return key.LoadFromFile(path);
|
2019-11-22 23:11:59 +00:00
|
|
|
}
|
|
|
|
|
2019-11-22 03:57:41 +00:00
|
|
|
} // namespace llarp
|