Skip to content

Commit

Permalink
itest: test scbforceclose scenarios
Browse files Browse the repository at this point in the history
 - Make sure channel.backup file is updated upon LND shutdown.
 - Make sure channel.backup file has sufficient information combined
   with seed and password to produce a force close tx and sweep the funds.
 - Make sure that if the latest channel version is used in channel.backup
   file in scbforceclose recovery method, another peer does not penalize.
 - Control for the previous test case: make sure that if an outdated channel
   state in channel.backup is used, another node can penalize.

To decrypt channel.backup and to sign force close tx, KeyRing and Signer objects
are needed. I copy-pasted parts of chantools/lnd/lnd/hdkeychain.go and
chantools/lnd/signer.go to itest/ directory, making types private so they are
not used accidentally by other code.
  • Loading branch information
starius committed Jul 17, 2024
1 parent 24a8d6a commit 72477f3
Show file tree
Hide file tree
Showing 3 changed files with 945 additions and 14 deletions.
88 changes: 88 additions & 0 deletions itest/hdkeychain.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
package itest

import (
"github.com/btcsuite/btcd/btcutil/hdkeychain"
"github.com/btcsuite/btcd/chaincfg"
"github.com/lightningnetwork/lnd/keychain"
)

func deriveChildren(key *hdkeychain.ExtendedKey, path []uint32) (
*hdkeychain.ExtendedKey, error) {

var currentKey = key
for idx, pathPart := range path {
derivedKey, err := currentKey.DeriveNonStandard(pathPart)
if err != nil {
return nil, err
}

// There's this special case in lnd's wallet (btcwallet) where
// the coin type and account keys are always serialized as a
// string and encrypted, which actually fixes the key padding
// issue that makes the difference between DeriveNonStandard and
// Derive. To replicate lnd's behavior exactly, we need to
// serialize and de-serialize the extended key at the coin type
// and account level (depth = 2 or depth = 3). This does not
// apply to the default account (id = 0) because that is always
// derived directly.
depth := derivedKey.Depth()
keyID := pathPart - hdkeychain.HardenedKeyStart
nextID := uint32(0)
if depth == 2 && len(path) > 2 {
nextID = path[idx+1] - hdkeychain.HardenedKeyStart
}
if (depth == 2 && nextID != 0) || (depth == 3 && keyID != 0) {
currentKey, err = hdkeychain.NewKeyFromString(
derivedKey.String(),
)
if err != nil {
return nil, err
}
} else {
currentKey = derivedKey
}
}

return currentKey, nil
}

type hdKeyRing struct {
ExtendedKey *hdkeychain.ExtendedKey
ChainParams *chaincfg.Params
}

func (r *hdKeyRing) DeriveNextKey(_ keychain.KeyFamily) (
keychain.KeyDescriptor, error) {

return keychain.KeyDescriptor{}, nil
}

func (r *hdKeyRing) DeriveKey(keyLoc keychain.KeyLocator) (
keychain.KeyDescriptor, error) {

var empty = keychain.KeyDescriptor{}
const HardenedKeyStart = uint32(hdkeychain.HardenedKeyStart)
derivedKey, err := deriveChildren(r.ExtendedKey, []uint32{
HardenedKeyStart + uint32(keychain.BIP0043Purpose),
HardenedKeyStart + r.ChainParams.HDCoinType,
HardenedKeyStart + uint32(keyLoc.Family),
0,
keyLoc.Index,
})
if err != nil {
return empty, err
}

derivedPubKey, err := derivedKey.ECPubKey()
if err != nil {
return empty, err
}

return keychain.KeyDescriptor{
KeyLocator: keychain.KeyLocator{
Family: keyLoc.Family,
Index: keyLoc.Index,
},
PubKey: derivedPubKey,
}, nil
}
176 changes: 176 additions & 0 deletions itest/hdsigner.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
package itest

import (
"errors"
"fmt"

"github.com/btcsuite/btcd/btcec/v2"
"github.com/btcsuite/btcd/btcec/v2/ecdsa"
"github.com/btcsuite/btcd/btcec/v2/schnorr"
"github.com/btcsuite/btcd/btcutil/hdkeychain"
"github.com/btcsuite/btcd/chaincfg"
"github.com/btcsuite/btcd/txscript"
"github.com/btcsuite/btcd/wire"
"github.com/decred/dcrd/dcrec/secp256k1/v4"
"github.com/lightningnetwork/lnd/input"
"github.com/lightningnetwork/lnd/keychain"
)

type hdSigner struct {
*input.MusigSessionManager

ExtendedKey *hdkeychain.ExtendedKey
ChainParams *chaincfg.Params
}

func (s *hdSigner) SignOutputRaw(tx *wire.MsgTx,
signDesc *input.SignDescriptor) (input.Signature, error) {

// First attempt to fetch the private key which corresponds to the
// specified public key.
privKey, err := s.FetchPrivateKey(&signDesc.KeyDesc)
if err != nil {
return nil, err
}

return s.signOutputRawWithPrivateKey(tx, signDesc, privKey)
}

func (s *hdSigner) signOutputRawWithPrivateKey(tx *wire.MsgTx,
signDesc *input.SignDescriptor,
privKey *secp256k1.PrivateKey) (input.Signature, error) {

witnessScript := signDesc.WitnessScript
privKey = maybeTweakPrivKey(signDesc, privKey)

sigHashes := txscript.NewTxSigHashes(tx, signDesc.PrevOutputFetcher)
if txscript.IsPayToTaproot(signDesc.Output.PkScript) {
// Are we spending a script path or the key path? The API is
// slightly different, so we need to account for that to get the
// raw signature.
var (
rawSig []byte
err error
)

switch signDesc.SignMethod {
case input.TaprootKeySpendBIP0086SignMethod,
input.TaprootKeySpendSignMethod:

// This function tweaks the private key using the tap
// root key supplied as the tweak.
rawSig, err = txscript.RawTxInTaprootSignature(
tx, sigHashes, signDesc.InputIndex,
signDesc.Output.Value, signDesc.Output.PkScript,
signDesc.TapTweak, signDesc.HashType,
privKey,
)
if err != nil {
return nil, err
}

case input.TaprootScriptSpendSignMethod:
leaf := txscript.TapLeaf{
LeafVersion: txscript.BaseLeafVersion,
Script: witnessScript,
}
rawSig, err = txscript.RawTxInTapscriptSignature(
tx, sigHashes, signDesc.InputIndex,
signDesc.Output.Value, signDesc.Output.PkScript,
leaf, signDesc.HashType, privKey,
)
if err != nil {
return nil, err
}

default:
return nil, fmt.Errorf("unknown sign method: %v",
signDesc.SignMethod)
}

// The signature returned above might have a sighash flag
// attached if a non-default type was used. We'll slice this
// off if it exists to ensure we can properly parse the raw
// signature.
sig, err := schnorr.ParseSignature(
rawSig[:schnorr.SignatureSize],
)
if err != nil {
return nil, err
}

return sig, nil
}

amt := signDesc.Output.Value
sig, err := txscript.RawTxInWitnessSignature(
tx, sigHashes, signDesc.InputIndex, amt,
witnessScript, signDesc.HashType, privKey,
)
if err != nil {
return nil, err
}

// Chop off the sighash flag at the end of the signature.
return ecdsa.ParseDERSignature(sig[:len(sig)-1])
}

func (s *hdSigner) ComputeInputScript(_ *wire.MsgTx, _ *input.SignDescriptor) (
*input.Script, error) {

return nil, errors.New("unimplemented")
}

func (s *hdSigner) FetchPrivateKey(descriptor *keychain.KeyDescriptor) (
*btcec.PrivateKey, error) {

const HardenedKeyStart = uint32(hdkeychain.HardenedKeyStart)
key, err := deriveChildren(s.ExtendedKey, []uint32{
HardenedKeyStart + uint32(keychain.BIP0043Purpose),
HardenedKeyStart + s.ChainParams.HDCoinType,
HardenedKeyStart + uint32(descriptor.Family),
0,
descriptor.Index,
})
if err != nil {
return nil, err
}

return key.ECPrivKey()
}

// maybeTweakPrivKey examines the single tweak parameters on the passed sign
// descriptor and may perform a mapping on the passed private key in order to
// utilize the tweaks, if populated.
func maybeTweakPrivKey(signDesc *input.SignDescriptor,
privKey *btcec.PrivateKey) *btcec.PrivateKey {

if signDesc.SingleTweak != nil {
return input.TweakPrivKey(privKey, signDesc.SingleTweak)
}

return privKey
}

// ECDH performs a scalar multiplication (ECDH-like operation) between
// the target key descriptor and remote public key. The output
// returned will be the sha256 of the resulting shared point serialized
// in compressed format. If k is our private key, and P is the public
// key, we perform the following operation:
//
// sx := k*P
// s := sha256(sx.SerializeCompressed())
//
// NOTE: This is part of the keychain.ECDHRing interface.
func (s *hdSigner) ECDH(keyDesc keychain.KeyDescriptor,
pubKey *btcec.PublicKey) ([32]byte, error) {

// First, derive the private key.
privKey, err := s.FetchPrivateKey(&keyDesc)
if err != nil {
return [32]byte{}, fmt.Errorf("failed to derive the private "+
"key: %w", err)
}

return (&keychain.PrivKeyECDH{PrivKey: privKey}).ECDH(pubKey)
}
Loading

0 comments on commit 72477f3

Please sign in to comment.