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.
11 #include "allocators.h"
12 #include "serialize.h"
18 #include <openssl/ec.h> // for EC_KEY definition
21 // const unsigned int PRIVATE_KEY_SIZE = 192;
22 // const unsigned int PUBLIC_KEY_SIZE = 41;
23 // const unsigned int SIGNATURE_SIZE = 48;
26 // const unsigned int PRIVATE_KEY_SIZE = 222;
27 // const unsigned int PUBLIC_KEY_SIZE = 49;
28 // const unsigned int SIGNATURE_SIZE = 57;
31 // const unsigned int PRIVATE_KEY_SIZE = 250;
32 // const unsigned int PUBLIC_KEY_SIZE = 57;
33 // const unsigned int SIGNATURE_SIZE = 66;
36 // const unsigned int PRIVATE_KEY_SIZE = 279;
37 // const unsigned int PUBLIC_KEY_SIZE = 65;
38 // const unsigned int SIGNATURE_SIZE = 72;
40 // see www.keylength.com
41 // script supports up to 75 for single byte push
43 class key_error : public std::runtime_error
46 explicit key_error(const std::string& str) : std::runtime_error(str) {}
49 /** A reference to a CKey: the Hash160 of its serialized public key */
50 class CKeyID : public uint160
53 CKeyID() : uint160(0) { }
54 CKeyID(const uint160 &in) : uint160(in) { }
57 /** A reference to a CScript: the Hash160 of its serialization (see script.h) */
58 class CScriptID : public uint160
61 CScriptID() : uint160(0) { }
62 CScriptID(const uint160 &in) : uint160(in) { }
65 /** An encapsulated public key. */
68 std::vector<unsigned char> vchPubKey;
73 CPubKey(const std::vector<unsigned char> &vchPubKeyIn) : vchPubKey(vchPubKeyIn) { }
74 friend bool operator==(const CPubKey &a, const CPubKey &b) { return a.vchPubKey == b.vchPubKey; }
75 friend bool operator!=(const CPubKey &a, const CPubKey &b) { return a.vchPubKey != b.vchPubKey; }
76 friend bool operator<(const CPubKey &a, const CPubKey &b) { return a.vchPubKey < b.vchPubKey; }
82 CKeyID GetID() const {
83 return CKeyID(Hash160(vchPubKey));
86 uint256 GetHash() const {
87 return Hash(vchPubKey.begin(), vchPubKey.end());
90 bool IsValid() const {
91 return vchPubKey.size() == 33 || vchPubKey.size() == 65;
94 bool IsCompressed() const {
95 return vchPubKey.size() == 33;
98 std::vector<unsigned char> Raw() const {
103 void EncryptData(const std::vector<unsigned char>& data, std::vector<unsigned char>& encrypted);
107 // secure_allocator is defined in allocators.h
108 // CPrivKey is a serialized private key, with all parameters included (279 bytes)
109 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CPrivKey;
110 // CSecret is a serialization of just the secret parameter (32 bytes)
111 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CSecret;
113 /** An encapsulated OpenSSL Elliptic Curve key (public and/or private) */
119 bool fCompressedPubKey;
121 void SetCompressedPubKey();
129 CKey(const CSecret& b, bool fCompressed=true);
131 CKey& operator=(const CKey& b);
136 bool IsCompressed() const;
138 void MakeNewKey(bool fCompressed=true);
139 bool SetPrivKey(const CPrivKey& vchPrivKey);
140 bool SetSecret(const CSecret& vchSecret, bool fCompressed = true);
141 CSecret GetSecret(bool &fCompressed) const;
142 CSecret GetSecret() const;
143 CPrivKey GetPrivKey() const;
144 bool SetPubKey(const CPubKey& vchPubKey);
145 CPubKey GetPubKey() const;
147 bool Sign(uint256 hash, std::vector<unsigned char>& vchSig);
149 // create a compact signature (65 bytes), which allows reconstructing the used public key
150 // The format is one header byte, followed by two times 32 bytes for the serialized r and s values.
151 // The header byte: 0x1B = first key with even y, 0x1C = first key with odd y,
152 // 0x1D = second key with even y, 0x1E = second key with odd y
153 bool SignCompact(uint256 hash, std::vector<unsigned char>& vchSig);
155 // reconstruct public key from a compact signature
156 // This is only slightly more CPU intensive than just verifying it.
157 // If this function succeeds, the recovered public key is guaranteed to be valid
158 // (the signature is a valid signature of the given data for that key)
159 bool SetCompactSignature(uint256 hash, const std::vector<unsigned char>& vchSig);
161 bool Verify(uint256 hash, const std::vector<unsigned char>& vchSig);
163 // Verify a compact signature
164 bool VerifyCompact(uint256 hash, const std::vector<unsigned char>& vchSig);
168 // Check whether an element of a signature (r or s) is valid.
169 static bool CheckSignatureElement(const unsigned char *vch, int len, bool half);
171 // Reserialize to DER
172 static bool ReserealizeSignature(std::vector<unsigned char>& vchSig);
175 void EncryptData(const std::vector<unsigned char>& data, std::vector<unsigned char>& encrypted);
178 void DecryptData(const std::vector<unsigned char>& encrypted, std::vector<unsigned char>& data);
190 bool operator!=(const CPoint &a);
193 // Initialize from octets stream
194 bool setBytes(const std::vector<unsigned char> &vchBytes);
196 // Initialize from pubkey
197 bool setPubKey(const CPubKey &vchPubKey);
199 // Serialize to octets stream
200 bool getBytes(std::vector<unsigned char> &vchBytes);
202 // ECC multiplication by specified multiplier
203 bool ECMUL(const CBigNum &bnMultiplier);
206 bool ECMULGEN(const CBigNum &bnMultiplier, const CPoint &qPoint);
208 bool IsInfinity() { return EC_POINT_is_at_infinity(group, point) != 0; }
211 class CMalleablePubKey
216 friend class CMalleableKey;
218 static const unsigned char CURRENT_VERSION = 1;
221 CMalleablePubKey() { }
222 CMalleablePubKey(const CMalleablePubKey& mpk)
224 pubKeyL = mpk.pubKeyL;
225 pubKeyH = mpk.pubKeyH;
227 CMalleablePubKey(const std::vector<unsigned char> &vchPubKeyPair) { setvch(vchPubKeyPair); }
228 CMalleablePubKey(const std::string& strMalleablePubKey) { SetString(strMalleablePubKey); }
229 CMalleablePubKey(const CPubKey &pubKeyInL, const CPubKey &pubKeyInH) : pubKeyL(pubKeyInL), pubKeyH(pubKeyInH) { }
236 bool IsValid() const {
237 return pubKeyL.IsValid() && pubKeyH.IsValid();
240 bool operator==(const CMalleablePubKey &b);
241 bool operator!=(const CMalleablePubKey &b) { return !(*this == b); }
242 CMalleablePubKey& operator=(const CMalleablePubKey& mpk) {
243 pubKeyL = mpk.pubKeyL;
244 pubKeyH = mpk.pubKeyH;
248 std::string ToString() const;
249 bool SetString(const std::string& strMalleablePubKey);
251 CKeyID GetID() const {
252 return pubKeyL.GetID();
255 bool setvch(const std::vector<unsigned char> &vchPubKeyPair);
256 std::vector<unsigned char> Raw() const;
258 CPubKey& GetL() { return pubKeyL; }
259 CPubKey& GetH() { return pubKeyH; }
260 void GetVariant(CPubKey &R, CPubKey &vchPubKeyVariant);
269 friend class CMalleableKeyView;
273 CMalleableKey(const CMalleableKey &b);
274 CMalleableKey(const CSecret &L, const CSecret &H);
278 READWRITE(vchSecretL);
279 READWRITE(vchSecretH);
282 std::string ToString() const;
283 bool SetString(const std::string& strMalleablePubKey);
284 std::vector<unsigned char> Raw() const;
285 CMalleableKey& operator=(const CMalleableKey& mk) {
286 vchSecretL = mk.vchSecretL;
287 vchSecretH = mk.vchSecretH;
294 bool IsValid() const { return !IsNull() && GetMalleablePubKey().IsValid(); }
295 bool SetSecrets(const CSecret &pvchSecretL, const CSecret &pvchSecretH);
297 CSecret GetSecretL() const { return vchSecretL; }
298 CSecret GetSecretH() const { return vchSecretH; }
300 CKeyID GetID() const {
301 return GetMalleablePubKey().GetID();
303 CMalleablePubKey GetMalleablePubKey() const;
304 bool CheckKeyVariant(const CPubKey &R, const CPubKey &vchPubKeyVariant) const;
305 bool CheckKeyVariant(const CPubKey &R, const CPubKey &vchPubKeyVariant, CKey &privKeyVariant) const;
308 class CMalleableKeyView
315 CMalleableKeyView() { };
316 CMalleableKeyView(const CMalleableKey &b);
317 CMalleableKeyView(const std::string &strMalleableKey);
319 CMalleableKeyView(const CMalleableKeyView &b);
320 CMalleableKeyView& operator=(const CMalleableKey &b);
321 ~CMalleableKeyView();
324 READWRITE(vchSecretL);
325 READWRITE(vchPubKeyH);
328 bool IsValid() const;
329 std::string ToString() const;
330 bool SetString(const std::string& strMalleablePubKey);
331 std::vector<unsigned char> Raw() const;
332 CMalleableKeyView& operator=(const CMalleableKeyView& mkv) {
333 vchSecretL = mkv.vchSecretL;
334 vchPubKeyH = mkv.vchPubKeyH;
338 CKeyID GetID() const {
339 return GetMalleablePubKey().GetID();
341 CMalleablePubKey GetMalleablePubKey() const;
342 CMalleableKey GetMalleableKey(const CSecret &vchSecretH) const { return CMalleableKey(vchSecretL, vchSecretH); }
343 bool CheckKeyVariant(const CPubKey &R, const CPubKey &vchPubKeyVariant) const;
345 bool operator <(const CMalleableKeyView& kv) const { return vchPubKeyH.GetID() < kv.vchPubKeyH.GetID(); }