ethminer/libethereum/KeyManager.h

/*
 This file is part of cpp-ethereum.

 cpp-ethereum is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 cpp-ethereum is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
 */
/** @file KeyManager.h
 * @author Gav Wood <i@gavwood.com>
 * @date 2014
 */

#pragma once

#include <functional>
#include <mutex>
#include <libdevcrypto/SecretStore.h>
#include <libdevcrypto/FileSystem.h>

namespace dev
{

class UnknownPassword: public Exception {};

struct KeyInfo
{
	h256 passHash;
	std::string info;
};

static const auto DontKnowThrow = [](){ BOOST_THROW_EXCEPTION(UnknownPassword()); return std::string(); };

// TODO: This one is specifically for Ethereum, but we can make it generic in due course.
// TODO: hidden-partition style key-store.
/**
 * @brief High-level manager of keys for Ethereum.
 * Usage:
 *
 * Call exists() to check whether there is already a database. If so, get the master password from
 * the user and call load() with it. If not, get a new master password from the user (get them to type
 * it twice and keep some hint around!) and call create() with it.
 */
class KeyManager
{
public:
	KeyManager(std::string const& _keysFile = getDataDir("ethereum") + "/keys.info");
	~KeyManager();

	void setKeysFile(std::string const& _keysFile) { m_keysFile = _keysFile; }
	std::string const& keysFile() const { return m_keysFile; }

	bool exists() const;
	void create(std::string const& _pass);
	bool load(std::string const& _pass);
	void save(std::string const& _pass) const { write(_pass, m_keysFile); }

	std::map<Address, std::pair<std::string, std::string>> keys() const;

	h128 uuid(Address const& _a) const;
	Address address(h128 const& _uuid) const;

	h128 import(Secret const& _s, std::string const& _info, std::string const& _pass, std::string const& _passInfo);
	h128 import(Secret const& _s, std::string const& _info) { return import(_s, _info, m_password, std::string()); }

	SecretStore& store() { return m_store; }
	void importExisting(h128 const& _uuid, std::string const& _info, std::string const& _pass, std::string const& _passInfo);

	Secret secret(Address const& _address, std::function<std::string()> const& _pass = DontKnowThrow) const;
	Secret secret(h128 const& _uuid, std::function<std::string()> const& _pass = DontKnowThrow) const;

	void kill(h128 const& _id) { kill(address(_id)); }
	void kill(Address const& _a);

private:
	h256 hashPassword(std::string const& _pass) const;

	// Only use if previously loaded ok.
	// @returns false if wasn't previously loaded ok.
	bool write(std::string const& _keysFile) const;
	void write(std::string const& _pass, std::string const& _keysFile) const;
	void write(h128 const& _key, std::string const& _keysFile) const;

	// Ethereum keys.
	std::map<Address, h128> m_addrLookup;
	std::map<h128, KeyInfo> m_keyInfo;
	std::map<h256, std::string> m_passwordInfo;

	// Passwords that we're storing.
	mutable std::map<h256, std::string> m_cachedPasswords;

	// The default password for keys in the keystore - protected by the master password.
	std::string m_password;

	SecretStore m_store;
	mutable h128 m_key;
	mutable std::string m_keysFile;
};

}