src/key.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2012 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5 #ifndef BITCOIN_KEY_H
   6 #define BITCOIN_KEY_H
   7
   8 #include <stdexcept>
   9 #include <vector>
  10
  11 #include "allocators.h"
  12 #include "serialize.h"
  13 #include "uint256.h"
  14 #include "hash.h"
  15
  16 #include <openssl/ec.h> // for EC_KEY definition
  17
  18 // secp160k1
  19 // const unsigned int PRIVATE_KEY_SIZE = 192;
  20 // const unsigned int PUBLIC_KEY_SIZE  = 41;
  21 // const unsigned int SIGNATURE_SIZE   = 48;
  22 //
  23 // secp192k1
  24 // const unsigned int PRIVATE_KEY_SIZE = 222;
  25 // const unsigned int PUBLIC_KEY_SIZE  = 49;
  26 // const unsigned int SIGNATURE_SIZE   = 57;
  27 //
  28 // secp224k1
  29 // const unsigned int PRIVATE_KEY_SIZE = 250;
  30 // const unsigned int PUBLIC_KEY_SIZE  = 57;
  31 // const unsigned int SIGNATURE_SIZE   = 66;
  32 //
  33 // secp256k1:
  34 // const unsigned int PRIVATE_KEY_SIZE = 279;
  35 // const unsigned int PUBLIC_KEY_SIZE  = 65;
  36 // const unsigned int SIGNATURE_SIZE   = 72;
  37 //
  38 // see www.keylength.com
  39 // script supports up to 75 for single byte push
  40
  41 class key_error : public std::runtime_error
  42 {
  43 public:
  44     explicit key_error(const std::string& str) : std::runtime_error(str) {}
  45 };
  46
  47 /** A reference to a CKey: the Hash160 of its serialized public key */
  48 class CKeyID : public uint160
  49 {
  50 public:
  51     CKeyID() : uint160(0) { }
  52     CKeyID(const uint160 &in) : uint160(in) { }
  53 };
  54
  55 /** A reference to a CScript: the Hash160 of its serialization (see script.h) */
  56 class CScriptID : public uint160
  57 {
  58 public:
  59     CScriptID() : uint160(0) { }
  60     CScriptID(const uint160 &in) : uint160(in) { }
  61 };
  62
  63 /** An encapsulated public key. */
  64 class CPubKey {
  65 private:
  66     std::vector<unsigned char> vchPubKey;
  67     friend class CKey;
  68
  69 public:
  70     CPubKey() { }
  71     CPubKey(const std::vector<unsigned char> &vchPubKeyIn) : vchPubKey(vchPubKeyIn) { }
  72     friend bool operator==(const CPubKey &a, const CPubKey &b) { return a.vchPubKey == b.vchPubKey; }
  73     friend bool operator!=(const CPubKey &a, const CPubKey &b) { return a.vchPubKey != b.vchPubKey; }
  74     friend bool operator<(const CPubKey &a, const CPubKey &b) { return a.vchPubKey < b.vchPubKey; }
  75
  76     IMPLEMENT_SERIALIZE(
  77         READWRITE(vchPubKey);
  78     )
  79
  80     CKeyID GetID() const {
  81         return CKeyID(Hash160(vchPubKey));
  82     }
  83
  84     uint256 GetHash() const {
  85         return Hash(vchPubKey.begin(), vchPubKey.end());
  86     }
  87
  88     bool IsValid() const {
  89         return vchPubKey.size() == 33 || vchPubKey.size() == 65;
  90     }
  91
  92     bool IsCompressed() const {
  93         return vchPubKey.size() == 33;
  94     }
  95
  96     std::vector<unsigned char> Raw() const {
  97         return vchPubKey;
  98     }
  99 };
 100
 101
 102 // secure_allocator is defined in allocators.h
 103 // CPrivKey is a serialized private key, with all parameters included (279 bytes)
 104 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CPrivKey;
 105 // CSecret is a serialization of just the secret parameter (32 bytes)
 106 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CSecret;
 107
 108 /** An encapsulated OpenSSL Elliptic Curve key (public and/or private) */
 109 class CKey
 110 {
 111 protected:
 112     EC_KEY* pkey;
 113     bool fSet;
 114     bool fCompressedPubKey;
 115
 116     void SetCompressedPubKey();
 117
 118 public:
 119
 120     void Reset();
 121
 122     CKey();
 123     CKey(const CKey& b);
 124
 125     CKey& operator=(const CKey& b);
 126
 127     ~CKey();
 128
 129     bool IsNull() const;
 130     bool IsCompressed() const;
 131
 132     void MakeNewKey(bool fCompressed);
 133     bool SetPrivKey(const CPrivKey& vchPrivKey);
 134     bool SetSecret(const CSecret& vchSecret, bool fCompressed = false);
 135     CSecret GetSecret(bool &fCompressed) const;
 136     CPrivKey GetPrivKey() const;
 137     bool SetPubKey(const CPubKey& vchPubKey);
 138     CPubKey GetPubKey() const;
 139
 140     bool Sign(uint256 hash, std::vector<unsigned char>& vchSig);
 141
 142     // create a compact signature (65 bytes), which allows reconstructing the used public key
 143     // The format is one header byte, followed by two times 32 bytes for the serialized r and s values.
 144     // The header byte: 0x1B = first key with even y, 0x1C = first key with odd y,
 145     //                  0x1D = second key with even y, 0x1E = second key with odd y
 146     bool SignCompact(uint256 hash, std::vector<unsigned char>& vchSig);
 147
 148     // reconstruct public key from a compact signature
 149     // This is only slightly more CPU intensive than just verifying it.
 150     // If this function succeeds, the recovered public key is guaranteed to be valid
 151     // (the signature is a valid signature of the given data for that key)
 152     bool SetCompactSignature(uint256 hash, const std::vector<unsigned char>& vchSig);
 153
 154     bool Verify(uint256 hash, const std::vector<unsigned char>& vchSig);
 155
 156     // Verify a compact signature
 157     bool VerifyCompact(uint256 hash, const std::vector<unsigned char>& vchSig);
 158
 159     bool IsValid();
 160 };
 161
 162 #endif