• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

lightningnetwork / lnd / 11046369098

26 Sep 2024 05:50AM UTC coverage: 58.654% (-0.07%) from 58.727%
11046369098

push

github

web-flow
Merge pull request #9134 from ellemouton/checkPayAddrBeforeDeref

routerrpc: check payaddr before using for probing

40 of 57 new or added lines in 11 files covered. (70.18%)

251 existing lines in 30 files now uncovered.

129452 of 220703 relevant lines covered (58.65%)

28207.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

71.02
/zpay32/encode.go
1
package zpay32
2

3
import (
4
        "bytes"
5
        "encoding/binary"
6
        "fmt"
7

8
        "github.com/btcsuite/btcd/btcutil"
9
        "github.com/btcsuite/btcd/btcutil/bech32"
10
        "github.com/btcsuite/btcd/chaincfg"
11
        "github.com/btcsuite/btcd/chaincfg/chainhash"
12
        "github.com/lightningnetwork/lnd/fn"
13
        "github.com/lightningnetwork/lnd/lnwire"
14
)
15

16
// Encode takes the given MessageSigner and returns a string encoding this
17
// invoice signed by the node key of the signer.
18
func (invoice *Invoice) Encode(signer MessageSigner) (string, error) {
179✔
19
        // First check that this invoice is valid before starting the encoding.
179✔
20
        if err := validateInvoice(invoice); err != nil {
182✔
21
                return "", err
3✔
22
        }
3✔
23

24
        // The buffer will encoded the invoice data using 5-bit groups (base32).
25
        var bufferBase32 bytes.Buffer
176✔
26

176✔
27
        // The timestamp will be encoded using 35 bits, in base32.
176✔
28
        timestampBase32 := uint64ToBase32(uint64(invoice.Timestamp.Unix()))
176✔
29

176✔
30
        // The timestamp must be exactly 35 bits, which means 7 groups. If it
176✔
31
        // can fit into fewer groups we add leading zero groups, if it is too
176✔
32
        // big we fail early, as there is not possible to encode it.
176✔
33
        if len(timestampBase32) > timestampBase32Len {
176✔
34
                return "", fmt.Errorf("timestamp too big: %d",
×
35
                        invoice.Timestamp.Unix())
×
36
        }
×
37

38
        // Add zero bytes to the first timestampBase32Len-len(timestampBase32)
39
        // groups, then add the non-zero groups.
40
        zeroes := make([]byte, timestampBase32Len-len(timestampBase32))
176✔
41
        _, err := bufferBase32.Write(zeroes)
176✔
42
        if err != nil {
176✔
43
                return "", fmt.Errorf("unable to write to buffer: %w", err)
×
44
        }
×
45
        _, err = bufferBase32.Write(timestampBase32)
176✔
46
        if err != nil {
176✔
47
                return "", fmt.Errorf("unable to write to buffer: %w", err)
×
48
        }
×
49

50
        // We now write the tagged fields to the buffer, which will fill the
51
        // rest of the data part before the signature.
52
        if err := writeTaggedFields(&bufferBase32, invoice); err != nil {
176✔
53
                return "", err
×
54
        }
×
55

56
        // The human-readable part (hrp) is "ln" + net hrp + optional amount,
57
        // except for signet where we add an additional "s" to differentiate it
58
        // from the older testnet3 (Core devs decided to use the same hrp for
59
        // signet as for testnet3 which is not optimal for LN). See
60
        // https://github.com/lightningnetwork/lightning-rfc/pull/844 for more
61
        // information.
62
        hrp := "ln" + invoice.Net.Bech32HRPSegwit
176✔
63
        if invoice.Net.Name == chaincfg.SigNetParams.Name {
183✔
64
                hrp = "lntbs"
7✔
65
        }
7✔
66
        if invoice.MilliSat != nil {
313✔
67
                // Encode the amount using the fewest possible characters.
137✔
68
                am, err := encodeAmount(*invoice.MilliSat)
137✔
69
                if err != nil {
137✔
70
                        return "", err
×
71
                }
×
72
                hrp += am
137✔
73
        }
74

75
        // The signature is over the single SHA-256 hash of the hrp + the
76
        // tagged fields encoded in base256.
77
        taggedFieldsBytes, err := bech32.ConvertBits(bufferBase32.Bytes(), 5, 8, true)
176✔
78
        if err != nil {
176✔
79
                return "", err
×
80
        }
×
81

82
        toSign := append([]byte(hrp), taggedFieldsBytes...)
176✔
83

176✔
84
        // We use compact signature format, and also encoded the recovery ID
176✔
85
        // such that a reader of the invoice can recover our pubkey from the
176✔
86
        // signature.
176✔
87
        sign, err := signer.SignCompact(toSign)
176✔
88
        if err != nil {
176✔
89
                return "", err
×
90
        }
×
91

92
        // From the header byte we can extract the recovery ID, and the last 64
93
        // bytes encode the signature.
94
        recoveryID := sign[0] - 27 - 4
176✔
95
        sig, err := lnwire.NewSigFromWireECDSA(sign[1:])
176✔
96
        if err != nil {
176✔
97
                return "", err
×
98
        }
×
99

100
        // If the pubkey field was explicitly set, it must be set to the pubkey
101
        // used to create the signature.
102
        if invoice.Destination != nil {
238✔
103
                signature, err := sig.ToSignature()
62✔
104
                if err != nil {
62✔
105
                        return "", fmt.Errorf("unable to deserialize "+
×
106
                                "signature: %v", err)
×
107
                }
×
108

109
                hash := chainhash.HashB(toSign)
62✔
110
                valid := signature.Verify(hash, invoice.Destination)
62✔
111
                if !valid {
114✔
112
                        return "", fmt.Errorf("signature does not match " +
52✔
113
                                "provided pubkey")
52✔
114
                }
52✔
115
        }
116

117
        // Convert the signature to base32 before writing it to the buffer.
118
        signBase32, err := bech32.ConvertBits(
124✔
119
                append(sig.RawBytes(), recoveryID),
124✔
120
                8, 5, true,
124✔
121
        )
124✔
122
        if err != nil {
124✔
123
                return "", err
×
124
        }
×
125
        bufferBase32.Write(signBase32)
124✔
126

124✔
127
        // Now we can create the bech32 encoded string from the base32 buffer.
124✔
128
        b32, err := bech32.Encode(hrp, bufferBase32.Bytes())
124✔
129
        if err != nil {
124✔
130
                return "", err
×
131
        }
×
132

133
        // Before returning, check that the bech32 encoded string is not greater
134
        // than our largest supported invoice size.
135
        if len(b32) > maxInvoiceLength {
124✔
136
                return "", ErrInvoiceTooLarge
×
137
        }
×
138

139
        return b32, nil
124✔
140
}
141

142
// writeTaggedFields writes the non-nil tagged fields of the Invoice to the
143
// base32 buffer.
144
func writeTaggedFields(bufferBase32 *bytes.Buffer, invoice *Invoice) error {
176✔
145
        if invoice.PaymentHash != nil {
352✔
146
                err := writeBytes32(bufferBase32, fieldTypeP, *invoice.PaymentHash)
176✔
147
                if err != nil {
176✔
148
                        return err
×
149
                }
×
150
        }
151

152
        if invoice.Description != nil {
336✔
153
                base32, err := bech32.ConvertBits([]byte(*invoice.Description),
160✔
154
                        8, 5, true)
160✔
155
                if err != nil {
160✔
156
                        return err
×
157
                }
×
158
                err = writeTaggedField(bufferBase32, fieldTypeD, base32)
160✔
159
                if err != nil {
160✔
160
                        return err
×
161
                }
×
162
        }
163

164
        if invoice.DescriptionHash != nil {
192✔
165
                err := writeBytes32(
16✔
166
                        bufferBase32, fieldTypeH, *invoice.DescriptionHash,
16✔
167
                )
16✔
168
                if err != nil {
16✔
169
                        return err
×
170
                }
×
171
        }
172

173
        if invoice.Metadata != nil {
183✔
174
                base32, err := bech32.ConvertBits(invoice.Metadata, 8, 5, true)
7✔
175
                if err != nil {
7✔
176
                        return err
×
177
                }
×
178
                err = writeTaggedField(bufferBase32, fieldTypeM, base32)
7✔
179
                if err != nil {
7✔
180
                        return err
×
181
                }
×
182
        }
183

184
        if invoice.minFinalCLTVExpiry != nil {
187✔
185
                finalDelta := uint64ToBase32(*invoice.minFinalCLTVExpiry)
11✔
186
                err := writeTaggedField(bufferBase32, fieldTypeC, finalDelta)
11✔
187
                if err != nil {
11✔
188
                        return err
×
189
                }
×
190
        }
191

192
        if invoice.expiry != nil {
277✔
193
                seconds := invoice.expiry.Seconds()
101✔
194
                expiry := uint64ToBase32(uint64(seconds))
101✔
195
                err := writeTaggedField(bufferBase32, fieldTypeX, expiry)
101✔
196
                if err != nil {
101✔
197
                        return err
×
198
                }
×
199
        }
200

201
        if invoice.FallbackAddr != nil {
186✔
202
                var version byte
10✔
203
                switch addr := invoice.FallbackAddr.(type) {
10✔
204
                case *btcutil.AddressPubKeyHash:
5✔
205
                        version = 17
5✔
206
                case *btcutil.AddressScriptHash:
2✔
207
                        version = 18
2✔
208
                case *btcutil.AddressWitnessPubKeyHash:
2✔
209
                        version = addr.WitnessVersion()
2✔
210
                case *btcutil.AddressWitnessScriptHash:
1✔
211
                        version = addr.WitnessVersion()
1✔
212
                default:
×
213
                        return fmt.Errorf("unknown fallback address type")
×
214
                }
215
                base32Addr, err := bech32.ConvertBits(
10✔
216
                        invoice.FallbackAddr.ScriptAddress(), 8, 5, true)
10✔
217
                if err != nil {
10✔
218
                        return err
×
219
                }
×
220

221
                err = writeTaggedField(bufferBase32, fieldTypeF,
10✔
222
                        append([]byte{version}, base32Addr...))
10✔
223
                if err != nil {
10✔
224
                        return err
×
225
                }
×
226
        }
227

228
        for _, routeHint := range invoice.RouteHints {
184✔
229
                // Each hop hint is encoded using 51 bytes, so we'll make to
8✔
230
                // sure to allocate enough space for the whole route hint.
8✔
231
                routeHintBase256 := make([]byte, 0, hopHintLen*len(routeHint))
8✔
232

8✔
233
                for _, hopHint := range routeHint {
19✔
234
                        hopHintBase256 := make([]byte, hopHintLen)
11✔
235
                        copy(hopHintBase256[:33], hopHint.NodeID.SerializeCompressed())
11✔
236
                        binary.BigEndian.PutUint64(
11✔
237
                                hopHintBase256[33:41], hopHint.ChannelID,
11✔
238
                        )
11✔
239
                        binary.BigEndian.PutUint32(
11✔
240
                                hopHintBase256[41:45], hopHint.FeeBaseMSat,
11✔
241
                        )
11✔
242
                        binary.BigEndian.PutUint32(
11✔
243
                                hopHintBase256[45:49], hopHint.FeeProportionalMillionths,
11✔
244
                        )
11✔
245
                        binary.BigEndian.PutUint16(
11✔
246
                                hopHintBase256[49:51], hopHint.CLTVExpiryDelta,
11✔
247
                        )
11✔
248
                        routeHintBase256 = append(routeHintBase256, hopHintBase256...)
11✔
249
                }
11✔
250

251
                routeHintBase32, err := bech32.ConvertBits(
8✔
252
                        routeHintBase256, 8, 5, true,
8✔
253
                )
8✔
254
                if err != nil {
8✔
255
                        return err
×
256
                }
×
257

258
                err = writeTaggedField(bufferBase32, fieldTypeR, routeHintBase32)
8✔
259
                if err != nil {
8✔
260
                        return err
×
261
                }
×
262
        }
263

264
        for _, path := range invoice.BlindedPaymentPaths {
183✔
265
                var buf bytes.Buffer
7✔
266

7✔
267
                err := path.Encode(&buf)
7✔
268
                if err != nil {
7✔
269
                        return err
×
270
                }
×
271

272
                blindedPathBase32, err := bech32.ConvertBits(
7✔
273
                        buf.Bytes(), 8, 5, true,
7✔
274
                )
7✔
275
                if err != nil {
7✔
276
                        return err
×
277
                }
×
278

279
                err = writeTaggedField(
7✔
280
                        bufferBase32, fieldTypeB, blindedPathBase32,
7✔
281
                )
7✔
282
                if err != nil {
7✔
283
                        return err
×
284
                }
×
285
        }
286

287
        if invoice.Destination != nil {
238✔
288
                // Convert 33 byte pubkey to 53 5-bit groups.
62✔
289
                pubKeyBase32, err := bech32.ConvertBits(
62✔
290
                        invoice.Destination.SerializeCompressed(), 8, 5, true)
62✔
291
                if err != nil {
62✔
292
                        return err
×
293
                }
×
294

295
                if len(pubKeyBase32) != pubKeyBase32Len {
62✔
296
                        return fmt.Errorf("invalid pubkey length: %d",
×
297
                                len(invoice.Destination.SerializeCompressed()))
×
298
                }
×
299

300
                err = writeTaggedField(bufferBase32, fieldTypeN, pubKeyBase32)
62✔
301
                if err != nil {
62✔
302
                        return err
×
303
                }
×
304
        }
305

306
        err := fn.MapOptionZ(invoice.PaymentAddr, func(addr [32]byte) error {
278✔
307
                return writeBytes32(bufferBase32, fieldTypeS, addr)
102✔
308
        })
102✔
309
        if err != nil {
176✔
NEW
310
                return err
×
UNCOV
311
        }
×
312

313
        if invoice.Features.SerializeSize32() > 0 {
199✔
314
                var b bytes.Buffer
23✔
315
                err := invoice.Features.RawFeatureVector.EncodeBase32(&b)
23✔
316
                if err != nil {
23✔
317
                        return err
×
318
                }
×
319

320
                err = writeTaggedField(bufferBase32, fieldType9, b.Bytes())
23✔
321
                if err != nil {
23✔
322
                        return err
×
323
                }
×
324
        }
325

326
        return nil
176✔
327
}
328

329
// writeBytes32 encodes a 32-byte array as base32 and writes it to bufferBase32
330
// under the passed fieldType.
331
func writeBytes32(bufferBase32 *bytes.Buffer, fieldType byte, b [32]byte) error {
291✔
332
        // Convert 32 byte hash to 52 5-bit groups.
291✔
333
        base32, err := bech32.ConvertBits(b[:], 8, 5, true)
291✔
334
        if err != nil {
291✔
335
                return err
×
336
        }
×
337

338
        return writeTaggedField(bufferBase32, fieldType, base32)
291✔
339
}
340

341
// writeTaggedField takes the type of a tagged data field, and the data of
342
// the tagged field (encoded in base32), and writes the type, length and data
343
// to the buffer.
344
func writeTaggedField(bufferBase32 *bytes.Buffer, dataType byte, data []byte) error {
662✔
345
        // Length must be exactly 10 bits, so add leading zero groups if
662✔
346
        // needed.
662✔
347
        lenBase32 := uint64ToBase32(uint64(len(data)))
662✔
348
        for len(lenBase32) < 2 {
934✔
349
                lenBase32 = append([]byte{0}, lenBase32...)
272✔
350
        }
272✔
351

352
        if len(lenBase32) != 2 {
662✔
353
                return fmt.Errorf("data length too big to fit within 10 bits: %d",
×
354
                        len(data))
×
355
        }
×
356

357
        err := bufferBase32.WriteByte(dataType)
662✔
358
        if err != nil {
662✔
359
                return fmt.Errorf("unable to write to buffer: %w", err)
×
360
        }
×
361
        _, err = bufferBase32.Write(lenBase32)
662✔
362
        if err != nil {
662✔
363
                return fmt.Errorf("unable to write to buffer: %w", err)
×
364
        }
×
365
        _, err = bufferBase32.Write(data)
662✔
366
        if err != nil {
662✔
367
                return fmt.Errorf("unable to write to buffer: %w", err)
×
368
        }
×
369

370
        return nil
662✔
371
}
372

373
// uint64ToBase32 converts a uint64 to a base32 encoded integer encoded using
374
// as few 5-bit groups as possible.
375
func uint64ToBase32(num uint64) []byte {
942✔
376
        // Return at least one group.
942✔
377
        if num == 0 {
968✔
378
                return []byte{0}
26✔
379
        }
26✔
380

381
        // To fit an uint64, we need at most is ceil(64 / 5) = 13 groups.
382
        arr := make([]byte, 13)
919✔
383
        i := 13
919✔
384
        for num > 0 {
3,459✔
385
                i--
2,540✔
386
                arr[i] = byte(num & uint64(31)) // 0b11111 in binary
2,540✔
387
                num >>= 5
2,540✔
388
        }
2,540✔
389

390
        // We only return non-zero leading groups.
391
        return arr[i:]
919✔
392
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc