-
-
Notifications
You must be signed in to change notification settings - Fork 154
/
deb.go
652 lines (568 loc) · 17.1 KB
/
deb.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
// Package deb implements nfpm.Packager providing .deb bindings.
package deb
import (
"archive/tar"
"bytes"
"compress/gzip"
"crypto/md5" // nolint:gas
"errors"
"fmt"
"io"
"io/ioutil"
"log"
"os"
"path/filepath"
"strings"
"text/template"
"time"
"github.com/blakesmith/ar"
"github.com/goreleaser/chglog"
"github.com/goreleaser/nfpm/v2"
"github.com/goreleaser/nfpm/v2/files"
"github.com/goreleaser/nfpm/v2/internal/sign"
)
const packagerName = "deb"
// nolint: gochecknoinits
func init() {
nfpm.RegisterPackager(packagerName, Default)
}
// nolint: gochecknoglobals
var archToDebian = map[string]string{
"386": "i386",
"arm": "armhf",
"arm5": "armel",
"arm6": "armhf",
"arm7": "armhf",
"mipsle": "mipsel",
"ppc64le": "ppc64el",
}
// Default deb packager.
// nolint: gochecknoglobals
var Default = &Deb{}
// Deb is a deb packager implementation.
type Deb struct{}
// ConventionalFileName returns a file name according
// to the conventions for debian packages. See:
// https://manpages.debian.org/buster/dpkg-dev/dpkg-name.1.en.html
func (*Deb) ConventionalFileName(info *nfpm.Info) string {
arch, ok := archToDebian[info.Arch]
if !ok {
arch = info.Arch
}
version := info.Version
if info.Release != "" {
version += "-" + info.Release
}
if info.Prerelease != "" {
version += "~" + info.Prerelease
}
if info.VersionMetadata != "" {
version += "+" + info.VersionMetadata
}
// package_version_architecture.package-type
return fmt.Sprintf("%s_%s_%s.deb", info.Name, version, arch)
}
// ErrInvalidSignatureType happens if the signature type of a deb is not one of
// origin, maint or archive.
var ErrInvalidSignatureType = errors.New("invalid signature type")
// Package writes a new deb package to the given writer using the given info.
func (*Deb) Package(info *nfpm.Info, deb io.Writer) (err error) { // nolint: funlen
arch, ok := archToDebian[info.Arch]
if ok {
info.Arch = arch
}
if err = info.Validate(); err != nil {
return err
}
dataTarGz, md5sums, instSize, err := createDataTarGz(info)
if err != nil {
return err
}
controlTarGz, err := createControl(instSize, md5sums, info)
if err != nil {
return err
}
debianBinary := []byte("2.0\n")
w := ar.NewWriter(deb)
if err := w.WriteGlobalHeader(); err != nil {
return fmt.Errorf("cannot write ar header to deb file: %w", err)
}
if err := addArFile(w, "debian-binary", debianBinary); err != nil {
return fmt.Errorf("cannot pack debian-binary: %w", err)
}
if err := addArFile(w, "control.tar.gz", controlTarGz); err != nil {
return fmt.Errorf("cannot add control.tar.gz to deb: %w", err)
}
if err := addArFile(w, "data.tar.gz", dataTarGz); err != nil {
return fmt.Errorf("cannot add data.tar.gz to deb: %w", err)
}
// TODO: refactor this
if info.Deb.Signature.KeyFile != "" {
data := io.MultiReader(bytes.NewReader(debianBinary), bytes.NewReader(controlTarGz),
bytes.NewReader(dataTarGz))
sig, err := sign.PGPArmoredDetachSignWithKeyID(data, info.Deb.Signature.KeyFile, info.Deb.Signature.KeyPassphrase, info.Deb.Signature.KeyID)
if err != nil {
return &nfpm.ErrSigningFailure{Err: err}
}
sigType := "origin"
if info.Deb.Signature.Type != "" {
sigType = info.Deb.Signature.Type
}
if sigType != "origin" && sigType != "maint" && sigType != "archive" {
return &nfpm.ErrSigningFailure{
Err: ErrInvalidSignatureType,
}
}
if err := addArFile(w, "_gpg"+sigType, sig); err != nil {
return &nfpm.ErrSigningFailure{
Err: fmt.Errorf("add signature to ar file: %w", err),
}
}
}
return nil
}
func addArFile(w *ar.Writer, name string, body []byte) error {
header := ar.Header{
Name: files.ToNixPath(name),
Size: int64(len(body)),
Mode: 0o644,
ModTime: time.Now(),
}
if err := w.WriteHeader(&header); err != nil {
return fmt.Errorf("cannot write file header: %w", err)
}
_, err := w.Write(body)
return err
}
func createDataTarGz(info *nfpm.Info) (dataTarGz, md5sums []byte, instSize int64, err error) {
var buf bytes.Buffer
compress := gzip.NewWriter(&buf)
out := tar.NewWriter(compress)
// the writers are properly closed later, this is just in case that we have
// an error in another part of the code.
defer out.Close() // nolint: errcheck
defer compress.Close() // nolint: errcheck
created := map[string]bool{}
if err = createEmptyFoldersInsideTarGz(info, out, created); err != nil {
return nil, nil, 0, err
}
md5buf, instSize, err := createFilesInsideTarGz(info, out, created)
if err != nil {
return nil, nil, 0, err
}
if err := out.Close(); err != nil {
return nil, nil, 0, fmt.Errorf("closing data.tar.gz: %w", err)
}
if err := compress.Close(); err != nil {
return nil, nil, 0, fmt.Errorf("closing data.tar.gz: %w", err)
}
return buf.Bytes(), md5buf.Bytes(), instSize, nil
}
func createSymlinkInsideTarGz(file *files.Content, out *tar.Writer) error {
return newItemInsideTarGz(out, []byte{}, &tar.Header{
Name: normalizePath(file.Destination),
Linkname: file.Source,
Typeflag: tar.TypeSymlink,
ModTime: file.FileInfo.MTime,
Format: tar.FormatGNU,
})
}
func createFilesInsideTarGz(info *nfpm.Info, tw *tar.Writer, created map[string]bool) (md5buf bytes.Buffer, instSize int64, err error) {
for _, file := range info.Contents {
if file.Packager != "" && file.Packager != packagerName {
continue
}
if err = createTree(tw, file.Destination, created); err != nil {
return md5buf, 0, err
}
var size int64 // declare early to avoid shadowing err
switch file.Type {
case "ghost":
// skip ghost files in apk
continue
case "symlink":
err = createSymlinkInsideTarGz(file, tw)
case "doc":
// nolint:gocritic
// ignoring `emptyFallthrough: remove empty case containing only fallthrough to default case`
fallthrough
case "licence", "license":
// nolint:gocritic
// ignoring `emptyFallthrough: remove empty case containing only fallthrough to default case`
fallthrough
case "readme":
// nolint:gocritic
// ignoring `emptyFallthrough: remove empty case containing only fallthrough to default case`
fallthrough
case "config", "config|noreplace":
// nolint:gocritic
// ignoring `emptyFallthrough: remove empty case containing only fallthrough to default case`
fallthrough
default:
size, err = copyToTarAndDigest(file, tw, &md5buf)
}
if err != nil {
return md5buf, 0, err
}
instSize += size
}
if info.Changelog != "" {
size, err := createChangelogInsideTarGz(tw, &md5buf, created, info)
if err != nil {
return md5buf, 0, err
}
instSize += size
}
return md5buf, instSize, nil
}
func createEmptyFoldersInsideTarGz(info *nfpm.Info, out *tar.Writer, created map[string]bool) error {
for _, folder := range info.EmptyFolders {
// this .nope is actually not created, because createTree ignore the
// last part of the path, assuming it is a file.
// TODO: should probably refactor this
if err := createTree(out, files.ToNixPath(filepath.Join(folder, ".nope")), created); err != nil {
return err
}
}
return nil
}
func copyToTarAndDigest(file *files.Content, tw *tar.Writer, md5w io.Writer) (int64, error) {
tarFile, err := os.OpenFile(file.Source, os.O_RDONLY, 0o600) //nolint:gosec
if err != nil {
return 0, fmt.Errorf("could not add tarFile to the archive: %w", err)
}
// don't care if it errs while closing...
defer tarFile.Close() // nolint: errcheck,gosec
header, err := tar.FileInfoHeader(file, file.Source)
if err != nil {
log.Print(err)
return 0, err
}
header.Format = tar.FormatGNU
header.Name = normalizePath(file.Destination)
if err := tw.WriteHeader(header); err != nil {
return 0, fmt.Errorf("cannot write header of %s to data.tar.gz: %w", file.Source, err)
}
digest := md5.New() // nolint:gas
if _, err := io.Copy(tw, io.TeeReader(tarFile, digest)); err != nil {
return 0, fmt.Errorf("failed to copy: %w", err)
}
if _, err := fmt.Fprintf(md5w, "%x %s\n", digest.Sum(nil), header.Name); err != nil {
return 0, fmt.Errorf("failed to write md5: %w", err)
}
return file.Size(), nil
}
func createChangelogInsideTarGz(tarw *tar.Writer, md5w io.Writer, created map[string]bool, info *nfpm.Info) (int64, error) {
var buf bytes.Buffer
out := gzip.NewWriter(&buf)
// the writers are properly closed later, this is just in case that we have
// an error in another part of the code.
defer out.Close() // nolint: errcheck
changelogContent, err := formatChangelog(info)
if err != nil {
return 0, err
}
if _, err = out.Write([]byte(changelogContent)); err != nil {
return 0, err
}
if err = out.Close(); err != nil {
return 0, fmt.Errorf("closing changelog.gz: %w", err)
}
changelogData := buf.Bytes()
// https://www.debian.org/doc/manuals/developers-reference/pkgs.de.html#recording-changes-in-the-package
changelogName := normalizePath(fmt.Sprintf("/usr/share/doc/%s/changelog.gz", info.Name))
if err = createTree(tarw, changelogName, created); err != nil {
return 0, err
}
digest := md5.New() // nolint:gas
if _, err = digest.Write(changelogData); err != nil {
return 0, err
}
if _, err = fmt.Fprintf(md5w, "%x %s\n", digest.Sum(nil), changelogName); err != nil {
return 0, err
}
if err = newFileInsideTarGz(tarw, changelogName, changelogData); err != nil {
return 0, err
}
return int64(len(changelogData)), nil
}
func formatChangelog(info *nfpm.Info) (string, error) {
changelog, err := info.GetChangeLog()
if err != nil {
return "", err
}
tpl, err := chglog.DebTemplate()
if err != nil {
return "", err
}
formattedChangelog, err := chglog.FormatChangelog(changelog, tpl)
if err != nil {
return "", err
}
return strings.TrimSpace(formattedChangelog) + "\n", nil
}
// nolint:funlen
func createControl(instSize int64, md5sums []byte, info *nfpm.Info) (controlTarGz []byte, err error) {
var buf bytes.Buffer
compress := gzip.NewWriter(&buf)
out := tar.NewWriter(compress)
// the writers are properly closed later, this is just in case that we have
// an error in another part of the code.
defer out.Close() // nolint: errcheck
defer compress.Close() // nolint: errcheck
var body bytes.Buffer
if err = writeControl(&body, controlData{
Info: info,
InstalledSize: instSize / 1024,
}); err != nil {
return nil, err
}
filesToCreate := map[string][]byte{
"control": body.Bytes(),
"md5sums": md5sums,
"conffiles": conffiles(info),
}
if info.Changelog != "" {
changeLogData, err := formatChangelog(info)
if err != nil {
return nil, err
}
filesToCreate["changelog"] = []byte(changeLogData)
}
triggers := createTriggers(info)
if len(triggers) > 0 {
filesToCreate["triggers"] = triggers
}
for name, content := range filesToCreate {
if err := newFileInsideTarGz(out, name, content); err != nil {
return nil, err
}
}
type fileAndMode struct {
fileName string
mode int64
}
specialFiles := map[string]*fileAndMode{}
specialFiles[info.Scripts.PreInstall] = &fileAndMode{
fileName: "preinst",
mode: 0o755,
}
specialFiles[info.Scripts.PostInstall] = &fileAndMode{
fileName: "postinst",
mode: 0o755,
}
specialFiles[info.Scripts.PreRemove] = &fileAndMode{
fileName: "prerm",
mode: 0o755,
}
specialFiles[info.Scripts.PostRemove] = &fileAndMode{
fileName: "postrm",
mode: 0o755,
}
specialFiles[info.Overridables.Deb.Scripts.Rules] = &fileAndMode{
fileName: "rules",
mode: 0o755,
}
specialFiles[info.Overridables.Deb.Scripts.Templates] = &fileAndMode{
fileName: "templates",
mode: 0o644,
}
specialFiles[info.Overridables.Deb.Scripts.Config] = &fileAndMode{
fileName: "config",
mode: 0o755,
}
for path, destMode := range specialFiles {
if path != "" {
if err := newFilePathInsideTarGz(out, path, destMode.fileName, destMode.mode); err != nil {
return nil, err
}
}
}
if err := out.Close(); err != nil {
return nil, fmt.Errorf("closing control.tar.gz: %w", err)
}
if err := compress.Close(); err != nil {
return nil, fmt.Errorf("closing control.tar.gz: %w", err)
}
return buf.Bytes(), nil
}
func newItemInsideTarGz(out *tar.Writer, content []byte, header *tar.Header) error {
if err := out.WriteHeader(header); err != nil {
return fmt.Errorf("cannot write header of %s file to control.tar.gz: %w", header.Name, err)
}
if _, err := out.Write(content); err != nil {
return fmt.Errorf("cannot write %s file to control.tar.gz: %w", header.Name, err)
}
return nil
}
func newFileInsideTarGz(out *tar.Writer, name string, content []byte) error {
return newItemInsideTarGz(out, content, &tar.Header{
Name: normalizePath(name),
Size: int64(len(content)),
Mode: 0o644,
ModTime: time.Now(),
Typeflag: tar.TypeReg,
Format: tar.FormatGNU,
})
}
func newFilePathInsideTarGz(out *tar.Writer, path, dest string, mode int64) error {
file, err := os.Open(path) //nolint:gosec
if err != nil {
return err
}
content, err := ioutil.ReadAll(file)
if err != nil {
return err
}
return newItemInsideTarGz(out, content, &tar.Header{
Name: normalizePath(dest),
Size: int64(len(content)),
Mode: mode,
ModTime: time.Now(),
Typeflag: tar.TypeReg,
Format: tar.FormatGNU,
})
}
// normalizePath returns a path separated by slashes, all relative path items
// resolved and relative to the current directory (so it starts with "./").
func normalizePath(src string) string {
return "." + files.ToNixPath(filepath.Join("/", src))
}
// this is needed because the data.tar.gz file should have the empty folders
// as well, so we walk through the dst and create all subfolders.
func createTree(tarw *tar.Writer, dst string, created map[string]bool) error {
for _, path := range pathsToCreate(dst) {
path = normalizePath(path) + "/"
if created[path] {
// skipping dir that was previously created inside the archive
// (eg: usr/)
continue
}
if err := tarw.WriteHeader(&tar.Header{
Name: path,
Mode: 0o755,
Typeflag: tar.TypeDir,
Format: tar.FormatGNU,
ModTime: time.Now(),
}); err != nil {
return fmt.Errorf("failed to create folder: %w", err)
}
created[path] = true
}
return nil
}
func pathsToCreate(dst string) []string {
paths := []string{}
base := strings.TrimPrefix(dst, "/")
for {
base = filepath.Dir(base)
if base == "." {
break
}
paths = append(paths, files.ToNixPath(base))
}
// we don't really need to create those things in order apparently, but,
// it looks really weird if we don't.
result := []string{}
for i := len(paths) - 1; i >= 0; i-- {
result = append(result, paths[i])
}
return result
}
func conffiles(info *nfpm.Info) []byte {
// nolint: prealloc
var confs []string
for _, file := range info.Contents {
if file.Packager != "" && file.Packager != packagerName {
continue
}
switch file.Type {
case "config", "config|noreplace":
confs = append(confs, file.Destination)
}
}
return []byte(strings.Join(confs, "\n") + "\n")
}
func createTriggers(info *nfpm.Info) []byte {
var buffer bytes.Buffer
// https://man7.org/linux/man-pages/man5/deb-triggers.5.html
triggerEntries := []struct {
Directive string
TriggerNames *[]string
}{
{"interest", &info.Deb.Triggers.Interest},
{"interest-await", &info.Deb.Triggers.InterestAwait},
{"interest-noawait", &info.Deb.Triggers.InterestNoAwait},
{"activate", &info.Deb.Triggers.Activate},
{"activate-await", &info.Deb.Triggers.ActivateAwait},
{"activate-noawait", &info.Deb.Triggers.ActivateNoAwait},
}
for _, triggerEntry := range triggerEntries {
for _, triggerName := range *triggerEntry.TriggerNames {
fmt.Fprintf(&buffer, "%s %s\n", triggerEntry.Directive, triggerName)
}
}
return buffer.Bytes()
}
const controlTemplate = `
{{- /* Mandatory fields */ -}}
Package: {{.Info.Name}}
Version: {{ if .Info.Epoch}}{{ .Info.Epoch }}:{{ end }}{{.Info.Version}}
{{- if .Info.Release}}-{{ .Info.Release }}{{- end }}
{{- if .Info.Prerelease}}~{{ .Info.Prerelease }}{{- end }}
{{- if .Info.VersionMetadata}}+{{ .Info.VersionMetadata }}{{- end }}
Section: {{.Info.Section}}
Priority: {{.Info.Priority}}
Architecture: {{.Info.Arch}}
{{- /* Optional fields */ -}}
{{- if .Info.Maintainer}}
Maintainer: {{.Info.Maintainer}}
{{- end }}
{{- if .Info.Vendor}}
Vendor: {{.Info.Vendor}}
{{- end }}
Installed-Size: {{.InstalledSize}}
{{- with .Info.Replaces}}
Replaces: {{join .}}
{{- end }}
{{- with .Info.Provides}}
Provides: {{join .}}
{{- end }}
{{- with .Info.Depends}}
Depends: {{join .}}
{{- end }}
{{- with .Info.Recommends}}
Recommends: {{join .}}
{{- end }}
{{- with .Info.Suggests}}
Suggests: {{join .}}
{{- end }}
{{- with .Info.Conflicts}}
Conflicts: {{join .}}
{{- end }}
{{- with .Info.Deb.Breaks}}
Breaks: {{join .}}
{{- end }}
{{- if .Info.Homepage}}
Homepage: {{.Info.Homepage}}
{{- end }}
{{- /* Mandatory fields */}}
Description: {{multiline .Info.Description}}
`
type controlData struct {
Info *nfpm.Info
InstalledSize int64
}
func writeControl(w io.Writer, data controlData) error {
tmpl := template.New("control")
tmpl.Funcs(template.FuncMap{
"join": func(strs []string) string {
return strings.Trim(strings.Join(strs, ", "), " ")
},
"multiline": func(strs string) string {
ret := strings.ReplaceAll(strs, "\n", "\n ")
return strings.Trim(ret, " \n")
},
})
return template.Must(tmpl.Parse(controlTemplate)).Execute(w, data)
}