Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

services/horizon: Pass through nil ExtraSigners to avoid nil pointer deref #4349

Merged
merged 6 commits into from
Apr 21, 2022
Merged

services/horizon: Pass through nil ExtraSigners to avoid nil pointer deref #4349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
17a88bd
Pass through nil ExtraSigners to avoid nil pointer deref
Shaptic Apr 21, 2022
4096c08
Add more defensive checks around nil derefs
Shaptic Apr 21, 2022
0124da9
Merge branch 'master' into check-signers
Shaptic Apr 21, 2022
19d0e04
Update tests to check for nil ExtraSigners instead of empty
Shaptic Apr 21, 2022
ad77366
Simplify structure existence handling
Shaptic Apr 21, 2022
b0f6471
Merge branch 'check-signers' of github.com:Shaptic/go into check-signers
Shaptic Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions services/horizon/internal/db2/history/fee_bump_scenario.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (

sq "github.com/Masterminds/squirrel"
"github.com/guregu/null"
"github.com/lib/pq"

"github.com/stellar/go/ingest"
"github.com/stellar/go/network"
Expand Down Expand Up @@ -314,7 +313,7 @@ func FeeBumpScenario(tt *test.T, q *Q, successful bool) FeeBumpFixture {
Memo: null.NewString("", false),
TimeBounds: TimeBounds{Lower: null.IntFrom(2), Upper: null.IntFrom(4)},
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Signatures: signatures(fixture.Envelope.FeeBumpSignatures()),
InnerSignatures: signatures(fixture.Envelope.Signatures()),
Successful: successful,
Expand Down
4 changes: 4 additions & 0 deletions services/horizon/internal/db2/history/transaction_batch_insert_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,10 @@ func formatUint32(u *xdr.Uint32) null.Int {
}

func formatSigners(s []xdr.SignerKey) pq.StringArray {
if s == nil {
return nil
}

Comment on lines +252 to +255
Copy link
Member

@leighmcculloch leighmcculloch Apr 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this should have no material effect on the XDR because a nil var length array in XDR is a zero length array. There is no distinction between them, unless we've optionalized the array with a pointer in the XDR, which we didn't for extraSigners.

SignerKey extraSigners<2>;

signers := make([]string, len(s))
for i, key := range s {
signers[i] = key.Address()
Expand Down
27 changes: 13 additions & 14 deletions services/horizon/internal/db2/history/transaction_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (

sq "github.com/Masterminds/squirrel"
"github.com/guregu/null"
"github.com/lib/pq"
"github.com/stellar/go/xdr"

"github.com/stellar/go/ingest"
Expand Down Expand Up @@ -364,7 +363,7 @@ func TestInsertTransaction(t *testing.T) {
Successful: success,
TimeBounds: nullTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
},
},
},
Expand Down Expand Up @@ -400,7 +399,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: nullTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -437,7 +436,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: nullTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: false,
},
},
Expand Down Expand Up @@ -475,7 +474,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("test memo", true),
TimeBounds: infiniteTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -512,7 +511,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("test memo", true),
TimeBounds: infiniteTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -549,7 +548,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("123", true),
TimeBounds: nullTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -586,7 +585,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("fi3vINWiGla+KkV7ZI9wLuGviJ099leQ6SoFCB6fq/E=", true),
TimeBounds: infiniteTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -623,7 +622,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("zdjArlILa/LNv7o7lo/qv5+fVVPNl0yPgZQWB6u+gL4=", true),
TimeBounds: infiniteTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -661,7 +660,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: timeBoundWithMin,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -698,7 +697,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: timeBoundWithMax,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -735,7 +734,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: timeboundsWithMinAndMax,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -778,7 +777,7 @@ func TestInsertTransaction(t *testing.T) {
MinAccountSequence: null.Int{},
MinAccountSequenceAge: null.StringFrom("10"),
MinAccountSequenceLedgerGap: null.IntFrom(2),
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down Expand Up @@ -815,7 +814,7 @@ func TestInsertTransaction(t *testing.T) {
Memo: null.NewString("", false),
TimeBounds: nullTimeBounds,
LedgerBounds: LedgerBounds{Null: true},
ExtraSigners: pq.StringArray{},
ExtraSigners: nil,
Successful: success,
},
},
Expand Down
78 changes: 77 additions & 1 deletion services/horizon/internal/integration/transaction_preconditions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package integration

import (
"bytes"
"encoding/base64"
"fmt"
"strconv"
"sync"
Expand All @@ -9,9 +11,11 @@ import (

sdk "github.com/stellar/go/clients/horizonclient"
"github.com/stellar/go/keypair"
"github.com/stellar/go/network"
"github.com/stellar/go/protocols/horizon"
"github.com/stellar/go/services/horizon/internal/test/integration"
"github.com/stellar/go/txnbuild"
"github.com/stellar/go/xdr"
"github.com/stretchr/testify/assert"
)

Expand Down Expand Up @@ -286,7 +290,6 @@ func TestTransactionPreconditionsMinSequenceNumberLedgerGap(t *testing.T) {
}

func buildTXParams(master *keypair.Full, masterAccount txnbuild.Account, txSequence int64) txnbuild.TransactionParams {

return txnbuild.TransactionParams{
SourceAccount: &txnbuild.SimpleAccount{
AccountID: masterAccount.GetAccountID(),
Expand Down Expand Up @@ -334,3 +337,76 @@ func TestTransactionPreconditionsAccountV3Fields(t *testing.T) {
tt.Equal(uint32(tx.Ledger), account.SequenceLedger)
tt.Equal(strconv.FormatInt(tx.LedgerCloseTime.Unix(), 10), account.SequenceTime)
}

// TestTransactionWithoutPreconditions ensures that Horizon doesn't break when
// we have a PRECOND_NONE type transaction (which is not possible to submit
// through SDKs, but is absolutely still possible).
func TestTransactionWithoutPreconditions(t *testing.T) {
tt := assert.New(t)
itest := integration.NewTest(t, integration.Config{})
if itest.GetEffectiveProtocolVersion() < 19 {
t.Skip("Can't run with protocol < 19")
}

master := itest.Master()
masterAccount := itest.MasterAccount()
seqNum, err := masterAccount.GetSequenceNumber()
tt.NoError(err)

account := xdr.MuxedAccount{}
tt.NoError(account.SetEd25519Address(master.Address()))

payment := txnbuild.Payment{ // dummy op
Destination: master.Address(),
Amount: "1000",
Asset: txnbuild.NativeAsset{},
}
paymentOp, err := payment.BuildXDR()
tt.NoError(err)

envelope := xdr.TransactionEnvelope{
Type: xdr.EnvelopeTypeEnvelopeTypeTx,
V1: &xdr.TransactionV1Envelope{
Tx: xdr.Transaction{
SourceAccount: account,
Fee: xdr.Uint32(1000),
SeqNum: xdr.SequenceNumber(seqNum + 1),
Operations: []xdr.Operation{paymentOp},
Cond: xdr.Preconditions{
Type: xdr.PreconditionTypePrecondNone,
},
},
Signatures: nil,
},
}

// Taken from txnbuild.concatSignatures
h, err := network.HashTransactionInEnvelope(envelope,
integration.StandaloneNetworkPassphrase)
tt.NoError(err)

sig, err := master.SignDecorated(h[:])
tt.NoError(err)

// taken from txnbuild.marshallBinary
var txBytes bytes.Buffer
envelope.V1.Signatures = []xdr.DecoratedSignature{sig}
_, err = xdr.Marshal(&txBytes, envelope)
tt.NoError(err)
b64 := base64.StdEncoding.EncodeToString(txBytes.Bytes())

txResp, err := itest.Client().SubmitTransactionXDR(b64)
tt.NoError(err)
Shaptic marked this conversation as resolved.
Show resolved Hide resolved

fmt.Println(
"envelopeXDR", txResp.EnvelopeXdr,
"resultXDR", txResp.ResultXdr,
// "feeChangesXDR", txResp.feeChangesXDR,
"metaXDR", txResp.FeeMetaXdr,
"hash", txResp.Hash,
)

txResp2, err := itest.Client().TransactionDetail(txResp.Hash)
tt.NoError(err)
tt.Nil(txResp2.Preconditions)
}
24 changes: 13 additions & 11 deletions services/horizon/internal/resourceadapter/transaction.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,26 +55,23 @@ func PopulateTransaction(
}
dest.Signatures = row.Signatures

if row.HasPreconditions() {
dest.Preconditions = &protocol.TransactionPreconditions{}
}
// If we never use this, we'll remove it later. This just defends us against
// nil dereferences.
dest.Preconditions = &protocol.TransactionPreconditions{}

if !row.TimeBounds.Null {
// Action needed in release: horizon-v3.0.0: remove ValidBefore and ValidAfter
dest.ValidBefore = timeString(row.TimeBounds.Upper)
dest.ValidAfter = timeString(row.TimeBounds.Lower)

if dest.Preconditions.TimeBounds == nil {
dest.Preconditions.TimeBounds = &protocol.TransactionPreconditionsTimebounds{}
dest.Preconditions.TimeBounds = &protocol.TransactionPreconditionsTimebounds{
MaxTime: timeString(row.TimeBounds.Upper),
MinTime: timeString(row.TimeBounds.Lower),
}
dest.Preconditions.TimeBounds.MaxTime = timeString(row.TimeBounds.Upper)
dest.Preconditions.TimeBounds.MinTime = timeString(row.TimeBounds.Lower)
}

if !row.LedgerBounds.Null {
if dest.Preconditions.LedgerBounds == nil {
dest.Preconditions.LedgerBounds = &protocol.TransactionPreconditionsLedgerbounds{}
}
dest.Preconditions.LedgerBounds = &protocol.TransactionPreconditionsLedgerbounds{}
if row.LedgerBounds.MinLedger.Valid {
dest.Preconditions.LedgerBounds.MinLedger = uint32(row.LedgerBounds.MinLedger.Int64)
}
Expand All @@ -95,7 +92,7 @@ func PopulateTransaction(
dest.Preconditions.MinAccountSequenceLedgerGap = uint32(row.MinAccountSequenceLedgerGap.Int64)
}

if row.ExtraSigners != nil {
if len(row.ExtraSigners) > 0 {
dest.Preconditions.ExtraSigners = row.ExtraSigners
}

Expand Down Expand Up @@ -136,6 +133,11 @@ func PopulateTransaction(
dest.Links.Succeeds = lb.Linkf("/transactions?order=desc&cursor=%s", dest.PT)
dest.Links.Precedes = lb.Linkf("/transactions?order=asc&cursor=%s", dest.PT)

// If we didn't need the structure, drop it.
if !row.HasPreconditions() {
dest.Preconditions = nil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this necessary, is it because an empty Preconditions is considered not valid json/resource view?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's more like: if we never used it, get rid of it. But only get rid of it after the fact, just in case some weird bug sneaks that would've caused a nil deref.

}

return nil
}

Expand Down