GenerateDeterministicKey.cpp

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 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.
*/
//==============================================================================
 
#include <ripple/basics/contract.h>
#include <ripple/beast/crypto/secure_erase.h>
#include <ripple/crypto/GenerateDeterministicKey.h>
#include <ripple/crypto/impl/ec_key.h>
#include <ripple/crypto/impl/openssl.h>
#include <ripple/protocol/digest.h>
#include <array>
#include <openssl/pem.h>
#include <openssl/sha.h>
#include <string>
 
namespace ripple {
 
namespace openssl {
 
struct secp256k1_data
{
    EC_GROUP const* group;
    bignum order;
 
    secp256k1_data()
    {
        group = EC_GROUP_new_by_curve_name(NID_secp256k1);
 
        if (!group)
            LogicError(
                "The OpenSSL library on this system lacks elliptic curve "
                "support.");
 
        bn_ctx ctx;
        order = get_order(group, ctx);
    }
};
 
static secp256k1_data const&
secp256k1curve()
{
    static secp256k1_data const curve{};
    return curve;
}
 
}  // namespace openssl
 
using namespace openssl;
 
static Blob
serialize_ec_point(ec_point const& point)
{
    Blob result(33);
 
    serialize_ec_point(point, &result[0]);
 
    return result;
}
 
template <class FwdIt>
void
copy_uint32(FwdIt out, std::uint32_t v)
{
    *out++ = v >> 24;
    *out++ = (v >> 16) & 0xff;
    *out++ = (v >> 8) & 0xff;
    *out = v & 0xff;
}
 
// Functions to add support for deterministic EC keys
 
// --> seed
// <-- private root generator + public root generator
static bignum
generateRootDeterministicKey(uint128 const& seed)
{
    // find non-zero private key less than the curve's order
    bignum privKey;
    std::uint32_t seq = 0;
 
    do
    {
        // buf: 0                seed               16  seq  20
        //      |<--------------------------------->|<------>|
        std::array<std::uint8_t, 20> buf;
        std::copy(seed.begin(), seed.end(), buf.begin());
        copy_uint32(buf.begin() + 16, seq++);
        auto root = sha512Half(buf);
        beast::secure_erase(buf.data(), buf.size());
        privKey.assign(root.data(), root.size());
        beast::secure_erase(root.data(), root.size());
    } while (privKey.is_zero() || privKey >= secp256k1curve().order);
    beast::secure_erase(&seq, sizeof(seq));
    return privKey;
}
 
// --> seed
// <-- private root generator + public root generator
Blob
generateRootDeterministicPublicKey(uint128 const& seed)
{
    bn_ctx ctx;
 
    bignum privKey = generateRootDeterministicKey(seed);
 
    // compute the corresponding public key point
    ec_point pubKey = multiply(secp256k1curve().group, privKey, ctx);
 
    privKey.clear();  // security erase
 
    return serialize_ec_point(pubKey);
}
 
uint256
generateRootDeterministicPrivateKey(uint128 const& seed)
{
    bignum key = generateRootDeterministicKey(seed);
 
    return uint256_from_bignum_clear(key);
}
 
// Take ripple address.
// --> root public generator (consumes)
// <-- root public generator in EC format
static ec_point
generateRootPubKey(bignum&& pubGenerator)
{
    ec_point pubPoint = bn2point(secp256k1curve().group, pubGenerator.get());
 
    return pubPoint;
}
 
// --> public generator
static bignum
makeHash(Blob const& pubGen, int seq, bignum const& order)
{
    int subSeq = 0;
 
    bignum result;
 
    assert(pubGen.size() == 33);
    do
    {
        // buf: 0          pubGen             33 seq   37 subSeq  41
        //      |<--------------------------->|<------>|<-------->|
        std::array<std::uint8_t, 41> buf;
        std::copy(pubGen.begin(), pubGen.end(), buf.begin());
        copy_uint32(buf.begin() + 33, seq);
        copy_uint32(buf.begin() + 37, subSeq++);
        auto root = sha512Half_s(buf);
        beast::secure_erase(buf.data(), buf.size());
        result.assign(root.data(), root.size());
        beast::secure_erase(root.data(), root.size());
    } while (result.is_zero() || result >= order);
 
    return result;
}
 
// --> public generator
Blob
generatePublicDeterministicKey(Blob const& pubGen, int seq)
{
    // publicKey(n) = rootPublicKey EC_POINT_+ Hash(pubHash|seq)*point
    ec_point rootPubKey = generateRootPubKey(bignum(pubGen));
 
    bn_ctx ctx;
 
    // Calculate the private additional key.
    bignum hash = makeHash(pubGen, seq, secp256k1curve().order);
 
    // Calculate the corresponding public key.
    ec_point newPoint = multiply(secp256k1curve().group, hash, ctx);
 
    // Add the master public key and set.
    add_to(secp256k1curve().group, rootPubKey, newPoint, ctx);
 
    return serialize_ec_point(newPoint);
}
 
// --> root private key
uint256
generatePrivateDeterministicKey(
    Blob const& pubGen,
    uint128 const& seed,
    int seq)
{
    // privateKey(n) = (rootPrivateKey + Hash(pubHash|seq)) % order
    bignum rootPrivKey = generateRootDeterministicKey(seed);
 
    bn_ctx ctx;
 
    // calculate the private additional key
    bignum privKey = makeHash(pubGen, seq, secp256k1curve().order);
 
    // calculate the final private key
    add_to(rootPrivKey, privKey, secp256k1curve().order, ctx);
 
    rootPrivKey.clear();  // security erase
 
    return uint256_from_bignum_clear(privKey);
}
 
}  // namespace ripple