src/alert.cpp

   1 //
   2 // Alert system
   3 //
   4
   5 #include <boost/foreach.hpp>
   6 #include <map>
   7
   8 #include "alert.h"
   9 #include "key.h"
  10 #include "net.h"
  11 #include "sync.h"
  12 #include "ui_interface.h"
  13
  14 using namespace std;
  15
  16 map<uint256, CAlert> mapAlerts;
  17 CCriticalSection cs_mapAlerts;
  18
  19 static const char* pszMainKey = "043fa441fd4203d03f5df2b75ea14e36f20d39f43e7a61aa7552ab9bcd7ecb0e77a3be4585b13fcdaa22ef6e51f1ff6f2929bec2494385b086fb86610e33193195";
  20
  21 // TestNet alerts pubKey
  22 static const char* pszTestKey = "0471dc165db490094d35cde15b1f5d755fa6ad6f2b5ed0f340e3f17f57389c3c2af113a8cbcc885bde73305a553b5640c83021128008ddf882e856336269080496";
  23
  24 // TestNet alerts private key
  25 // "308201130201010420b665cff1884e53da26376fd1b433812c9a5a8a4d5221533b15b9629789bb7e42a081a53081a2020101302c06072a8648ce3d0101022100fffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2f300604010004010704410479be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798483ada7726a3c4655da4fbfc0e1108a8fd17b448a68554199c47d08ffb10d4b8022100fffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141020101a1440342000471dc165db490094d35cde15b1f5d755fa6ad6f2b5ed0f340e3f17f57389c3c2af113a8cbcc885bde73305a553b5640c83021128008ddf882e856336269080496"
  26
  27 void CUnsignedAlert::SetNull()
  28 {
  29     nVersion = 1;
  30     nRelayUntil = 0;
  31     nExpiration = 0;
  32     nID = 0;
  33     nCancel = 0;
  34     setCancel.clear();
  35     nMinVer = 0;
  36     nMaxVer = 0;
  37     setSubVer.clear();
  38     nPriority = 0;
  39
  40     strComment.clear();
  41     strStatusBar.clear();
  42     strReserved.clear();
  43 }
  44
  45 std::string CUnsignedAlert::ToString() const
  46 {
  47     std::string strSetCancel;
  48     BOOST_FOREACH(int n, setCancel)
  49         strSetCancel += strprintf("%d ", n);
  50     std::string strSetSubVer;
  51     BOOST_FOREACH(std::string str, setSubVer)
  52         strSetSubVer += "\"" + str + "\" ";
  53     return strprintf(
  54         "CAlert(\n"
  55         "    nVersion     = %d\n"
  56         "    nRelayUntil  = %" PRId64 "\n"
  57         "    nExpiration  = %" PRId64 "\n"
  58         "    nID          = %d\n"
  59         "    nCancel      = %d\n"
  60         "    setCancel    = %s\n"
  61         "    nMinVer      = %d\n"
  62         "    nMaxVer      = %d\n"
  63         "    setSubVer    = %s\n"
  64         "    nPriority    = %d\n"
  65         "    strComment   = \"%s\"\n"
  66         "    strStatusBar = \"%s\"\n"
  67         ")\n",
  68         nVersion,
  69         nRelayUntil,
  70         nExpiration,
  71         nID,
  72         nCancel,
  73         strSetCancel.c_str(),
  74         nMinVer,
  75         nMaxVer,
  76         strSetSubVer.c_str(),
  77         nPriority,
  78         strComment.c_str(),
  79         strStatusBar.c_str());
  80 }
  81
  82 void CAlert::SetNull()
  83 {
  84     CUnsignedAlert::SetNull();
  85     vchMsg.clear();
  86     vchSig.clear();
  87 }
  88
  89 bool CAlert::IsNull() const
  90 {
  91     return (nExpiration == 0);
  92 }
  93
  94 uint256 CAlert::GetHash() const
  95 {
  96     return Hash(this->vchMsg.begin(), this->vchMsg.end());
  97 }
  98
  99 bool CAlert::IsInEffect() const
 100 {
 101     return (GetAdjustedTime() < nExpiration);
 102 }
 103
 104 bool CAlert::Cancels(const CAlert& alert) const
 105 {
 106     if (!IsInEffect())
 107         return false; // this was a no-op before 31403
 108     return (alert.nID <= nCancel || setCancel.count(alert.nID));
 109 }
 110
 111 bool CAlert::AppliesTo(int nVersion, std::string strSubVerIn) const
 112 {
 113     // TODO: rework for client-version-embedded-in-strSubVer ?
 114     return (IsInEffect() &&
 115             nMinVer <= nVersion && nVersion <= nMaxVer &&
 116             (setSubVer.empty() || setSubVer.count(strSubVerIn)));
 117 }
 118
 119 bool CAlert::AppliesToMe() const
 120 {
 121     return AppliesTo(PROTOCOL_VERSION, FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, std::vector<std::string>()));
 122 }
 123
 124 bool CAlert::RelayTo(CNode* pnode) const
 125 {
 126     if (!IsInEffect())
 127         return false;
 128     // don't relay to nodes which haven't sent their version message
 129     if (pnode->nVersion == 0)
 130         return false;
 131     // returns true if wasn't already contained in the set
 132     if (pnode->setKnown.insert(GetHash()).second)
 133     {
 134         if (AppliesTo(pnode->nVersion, pnode->strSubVer) ||
 135             AppliesToMe() ||
 136             GetAdjustedTime() < nRelayUntil)
 137         {
 138             pnode->PushMessage("alert", *this);
 139             return true;
 140         }
 141     }
 142     return false;
 143 }
 144
 145 bool CAlert::CheckSignature() const
 146 {
 147     CPubKey key;
 148     key.Set(ParseHex(fTestNet ? pszTestKey : pszMainKey));
 149     if (!key.Verify(Hash(vchMsg.begin(), vchMsg.end()), vchSig))
 150         return error("CAlert::CheckSignature() : verify signature failed");
 151
 152     // Now unserialize the data
 153     CDataStream sMsg(vchMsg, SER_NETWORK, PROTOCOL_VERSION);
 154     sMsg >> *(CUnsignedAlert*)this;
 155     return true;
 156 }
 157
 158 CAlert CAlert::getAlertByHash(const uint256 &hash)
 159 {
 160     CAlert retval;
 161     {
 162         LOCK(cs_mapAlerts);
 163         map<uint256, CAlert>::iterator mi = mapAlerts.find(hash);
 164         if(mi != mapAlerts.end())
 165             retval = mi->second;
 166     }
 167     return retval;
 168 }
 169
 170 bool CAlert::ProcessAlert()
 171 {
 172     if (!CheckSignature())
 173         return false;
 174     if (!IsInEffect())
 175         return false;
 176
 177     // alert.nID=max is reserved for if the alert key is
 178     // compromised. It must have a pre-defined message,
 179     // must never expire, must apply to all versions,
 180     // and must cancel all previous
 181     // alerts or it will be ignored (so an attacker can't
 182     // send an "everything is OK, don't panic" version that
 183     // cannot be overridden):
 184     int maxInt = std::numeric_limits<int>::max();
 185     if (nID == maxInt)
 186     {
 187         if (!(
 188                 nExpiration == maxInt &&
 189                 nCancel == (maxInt-1) &&
 190                 nMinVer == 0 &&
 191                 nMaxVer == maxInt &&
 192                 setSubVer.empty() &&
 193                 nPriority == maxInt &&
 194                 strStatusBar == "URGENT: Alert key compromised, upgrade required"
 195                 ))
 196             return false;
 197     }
 198
 199     {
 200         LOCK(cs_mapAlerts);
 201         // Cancel previous alerts
 202         for (map<uint256, CAlert>::iterator mi = mapAlerts.begin(); mi != mapAlerts.end();)
 203         {
 204             const CAlert& alert = (*mi).second;
 205             if (Cancels(alert))
 206             {
 207                 printf("cancelling alert %d\n", alert.nID);
 208                 uiInterface.NotifyAlertChanged((*mi).first, CT_DELETED);
 209                 mapAlerts.erase(mi++);
 210             }
 211             else if (!alert.IsInEffect())
 212             {
 213                 printf("expiring alert %d\n", alert.nID);
 214                 uiInterface.NotifyAlertChanged((*mi).first, CT_DELETED);
 215                 mapAlerts.erase(mi++);
 216             }
 217             else
 218                 mi++;
 219         }
 220
 221         // Check if this alert has been cancelled
 222         BOOST_FOREACH(PAIRTYPE(const uint256, CAlert)& item, mapAlerts)
 223         {
 224             const CAlert& alert = item.second;
 225             if (alert.Cancels(*this))
 226             {
 227                 printf("alert already cancelled by %d\n", alert.nID);
 228                 return false;
 229             }
 230         }
 231
 232         // Add to mapAlerts
 233         mapAlerts.insert(make_pair(GetHash(), *this));
 234         // Notify UI if it applies to me
 235         if(AppliesToMe())
 236             uiInterface.NotifyAlertChanged(GetHash(), CT_NEW);
 237     }
 238
 239     printf("accepted alert %d, AppliesToMe()=%d\n", nID, AppliesToMe());
 240     return true;
 241 }