ValidatorList.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2015 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_APP_MISC_VALIDATORLIST_H_INCLUDED
#define RIPPLE_APP_MISC_VALIDATORLIST_H_INCLUDED
 
#include <ripple/app/misc/Manifest.h>
#include <ripple/basics/Log.h>
#include <ripple/basics/UnorderedContainers.h>
#include <ripple/core/TimeKeeper.h>
#include <ripple/crypto/csprng.h>
#include <ripple/json/json_value.h>
#include <ripple/protocol/PublicKey.h>
#include <boost/iterator/counting_iterator.hpp>
#include <boost/range/adaptors.hpp>
#include <boost/thread/shared_mutex.hpp>
#include <mutex>
#include <numeric>
#include <shared_mutex>
 
namespace ripple {
 
// predeclaration
class Overlay;
class HashRouter;
class STValidation;
 
enum class ListDisposition {
    accepted = 0,
 
    same_sequence,
 
    unsupported_version,
 
    untrusted,
 
    stale,
 
    invalid
};
 
std::string
to_string(ListDisposition disposition);
 
struct TrustChanges
{
    explicit TrustChanges() = default;
 
    hash_set<NodeID> added;
    hash_set<NodeID> removed;
};
 
class ValidatorList
{
    struct PublisherList
    {
        explicit PublisherList() = default;
 
        bool available;
        std::vector<PublicKey> list;
        std::size_t sequence;
        TimeKeeper::time_point expiration;
        std::string siteUri;
        std::string rawManifest;
        std::string rawBlob;
        std::string rawSignature;
        std::uint32_t rawVersion;
        uint256 hash;
    };
 
    ManifestCache& validatorManifests_;
    ManifestCache& publisherManifests_;
    TimeKeeper& timeKeeper_;
    boost::filesystem::path const dataPath_;
    beast::Journal const j_;
    boost::shared_mutex mutable mutex_;
    using unique_lock = std::unique_lock<boost::shared_mutex>;
    using shared_lock = std::shared_lock<boost::shared_mutex>;
 
    std::atomic<std::size_t> quorum_;
    boost::optional<std::size_t> minimumQuorum_;
 
    // Published lists stored by publisher master public key
    hash_map<PublicKey, PublisherList> publisherLists_;
 
    // Listed master public keys with the number of lists they appear on
    hash_map<PublicKey, std::size_t> keyListings_;
 
    // The current list of trusted master keys
    hash_set<PublicKey> trustedMasterKeys_;
 
    // The current list of trusted signing keys. For those validators using
    // a manifest, the signing key is the ephemeral key. For the ones using
    // a seed, the signing key is the same as the master key.
    hash_set<PublicKey> trustedSigningKeys_;
 
    PublicKey localPubKey_;
 
    // The master public keys of the current negative UNL
    hash_set<PublicKey> negativeUNL_;
 
    // Currently supported version of publisher list format
    static constexpr std::uint32_t requiredListVersion = 1;
    static const std::string filePrefix_;
 
public:
    ValidatorList(
        ManifestCache& validatorManifests,
        ManifestCache& publisherManifests,
        TimeKeeper& timeKeeper,
        std::string const& databasePath,
        beast::Journal j,
        boost::optional<std::size_t> minimumQuorum = boost::none);
    ~ValidatorList() = default;
 
    struct PublisherListStats
    {
        explicit PublisherListStats(ListDisposition d) : disposition(d)
        {
        }
 
        PublisherListStats(
            ListDisposition d,
            PublicKey key,
            bool avail,
            std::size_t seq)
            : disposition(d), publisherKey(key), available(avail), sequence(seq)
        {
        }
 
        ListDisposition disposition;
        boost::optional<PublicKey> publisherKey;
        bool available = false;
        boost::optional<std::size_t> sequence;
    };
 
    bool
    load(
        PublicKey const& localSigningKey,
        std::vector<std::string> const& configKeys,
        std::vector<std::string> const& publisherKeys);
 
    PublisherListStats
    applyListAndBroadcast(
        std::string const& manifest,
        std::string const& blob,
        std::string const& signature,
        std::uint32_t version,
        std::string siteUri,
        uint256 const& hash,
        Overlay& overlay,
        HashRouter& hashRouter);
 
    PublisherListStats
    applyList(
        std::string const& manifest,
        std::string const& blob,
        std::string const& signature,
        std::uint32_t version,
        std::string siteUri,
        boost::optional<uint256> const& hash = {});
 
    /* Attempt to read previously stored list files. Expected to only be
       called when loading from URL fails.
 
       @return A list of valid file:// URLs, if any.
 
       @par Thread Safety
 
       May be called concurrently
    */
    std::vector<std::string>
    loadLists();
 
    TrustChanges
    updateTrusted(hash_set<NodeID> const& seenValidators);
 
    std::size_t
    quorum() const
    {
        return quorum_;
    }
 
    bool
    trusted(PublicKey const& identity) const;
 
    bool
    listed(PublicKey const& identity) const;
 
    boost::optional<PublicKey>
    getTrustedKey(PublicKey const& identity) const;
 
    boost::optional<PublicKey>
    getListedKey(PublicKey const& identity) const;
 
    bool
    trustedPublisher(PublicKey const& identity) const;
 
    PublicKey
    localPublicKey() const;
 
    void
    for_each_listed(std::function<void(PublicKey const&, bool)> func) const;
 
    void
    for_each_available(std::function<void(
                           std::string const& manifest,
                           std::string const& blob,
                           std::string const& signature,
                           std::uint32_t version,
                           PublicKey const& pubKey,
                           std::size_t sequence,
                           uint256 const& hash)> func) const;
 
    boost::optional<Json::Value>
    getAvailable(boost::beast::string_view const& pubKey);
 
    std::size_t
    count() const;
 
    boost::optional<TimeKeeper::time_point>
    expires() const;
 
    Json::Value
    getJson() const;
 
    using QuorumKeys = std::pair<std::size_t const, hash_set<PublicKey>>;
    QuorumKeys
    getQuorumKeys() const
    {
        shared_lock read_lock{mutex_};
        return {quorum_, trustedSigningKeys_};
    }
 
    hash_set<PublicKey>
    getTrustedMasterKeys() const;
 
    hash_set<PublicKey>
    getNegativeUNL() const;
 
    void
    setNegativeUNL(hash_set<PublicKey> const& negUnl);
 
    std::vector<std::shared_ptr<STValidation>>
    negativeUNLFilter(
        std::vector<std::shared_ptr<STValidation>>&& validations) const;
 
private:
    std::size_t
    count(shared_lock const&) const;
 
    bool
    trusted(shared_lock const&, PublicKey const& identity) const;
 
    boost::optional<PublicKey>
    getTrustedKey(shared_lock const&, PublicKey const& identity) const;
 
    boost::optional<TimeKeeper::time_point>
    expires(shared_lock const&) const;
 
    boost::filesystem::path
    GetCacheFileName(unique_lock const&, PublicKey const& pubKey);
 
    void
    CacheValidatorFile(
        unique_lock const& lock,
        PublicKey const& pubKey,
        PublisherList const& publisher);
 
    ListDisposition
    verify(
        unique_lock const&,
        Json::Value& list,
        PublicKey& pubKey,
        std::string const& manifest,
        std::string const& blob,
        std::string const& signature);
 
    bool
    removePublisherList(unique_lock const&, PublicKey const& publisherKey);
 
    std::size_t
    calculateQuorum(
        std::size_t unlSize,
        std::size_t effectiveUnlSize,
        std::size_t seenSize);
};
}  // namespace ripple
 
#endif