-
Notifications
You must be signed in to change notification settings - Fork 479
/
magefile.go
746 lines (621 loc) · 16 KB
/
magefile.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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
//go:build mage
// +build mage
/*
Velociraptor - Dig Deeper
Copyright (C) 2019-2024 Rapid7 Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package main
import (
"bytes"
"errors"
"fmt"
"io/ioutil"
"os"
"path"
"path/filepath"
"regexp"
"runtime"
"strconv"
"strings"
"time"
"github.com/Masterminds/semver/v3"
"github.com/magefile/mage/mg"
"github.com/magefile/mage/sh"
"gopkg.in/yaml.v2"
"www.velocidex.com/golang/velociraptor/constants"
"www.velocidex.com/golang/velociraptor/json"
)
var (
assets = map[string]string{
"artifacts/b0x.yaml": "artifacts/assets/ab0x.go",
"config/b0x.yaml": "config/ab0x.go",
"gui/velociraptor/b0x.yaml": "gui/velociraptor/ab0x.go",
"crypto/b0x.yaml": "crypto/ab0x.go",
}
index_template = "gui/velociraptor/build/index.html"
// apt-get install gcc-mingw-w64-x86-64
mingw_xcompiler = "x86_64-w64-mingw32-gcc"
// apt-get install gcc-mingw-w64
mingw_xcompiler_32 = "i686-w64-mingw32-gcc"
musl_xcompiler = "musl-gcc"
name = "velociraptor"
version = "v" + constants.VERSION
base_tags = " server_vql extras "
)
type Builder struct {
goos string
arch string
extension string
extra_tags string
extra_flags []string
extra_ldflags string
cc string
disable_cgo bool
debug_build bool
// Set to override the output filename.
filename string
extra_name string
}
func (self *Builder) Name() string {
if self.filename != "" {
return self.filename
}
if self.goos == "windows" {
self.extension = ".exe"
}
name := fmt.Sprintf("%s-%s-%s-%s%s",
name, version,
self.goos,
self.arch,
self.extension)
if self.disable_cgo {
name += "-nocgo"
}
name += self.extra_name
return name
}
func (self *Builder) Env() map[string]string {
env := make(map[string]string)
env["GOOS"] = self.goos
env["GOARCH"] = self.arch
if self.disable_cgo {
env["CGO_ENABLED"] = "0"
} else {
env["CGO_ENABLED"] = "1"
}
// If we are cross compiling, set the right compiler.
if (runtime.GOOS == "linux" || runtime.GOOS == "darwin") &&
self.goos == "windows" {
if self.arch == "amd64" {
if mingwxcompiler_exists() {
env["CC"] = mingw_xcompiler
}
} else {
if mingwxcompiler32_exists() {
env["CC"] = mingw_xcompiler_32
}
}
}
if self.cc != "" {
env["CC"] = self.cc
}
fmt.Printf("Build Environment: %v\n", json.MustMarshalString(env))
return env
}
func (self Builder) Run() error {
if err := os.Mkdir("output", 0700); err != nil && !os.IsExist(err) {
return fmt.Errorf("failed to create output: %v", err)
}
err := ensure_assets()
if err != nil {
return err
}
basic_flags := "-w -s "
if self.debug_build {
basic_flags = ""
}
tags := base_tags + self.extra_tags
args := []string{
"build",
"-o", filepath.Join("output", self.Name()),
"-tags", tags,
"-ldflags= " + basic_flags +
self.extra_ldflags + flags(),
}
args = append(args, self.extra_flags...)
args = append(args, "./bin/")
return sh.RunWith(self.Env(), mg.GoCmd(), args...)
}
func Auto() error {
return Builder{goos: runtime.GOOS,
filename: "velociraptor",
extra_tags: " release yara ",
arch: runtime.GOARCH}.Run()
}
func AutoDev() error {
return Builder{goos: runtime.GOOS,
arch: runtime.GOARCH,
extra_tags: " yara ",
filename: "velociraptor",
extra_flags: []string{"-race"}}.Run()
}
// Build all the release versions. Darwin we build separately on a
// Mac.
func Release() error {
err := Clean()
if err != nil {
return err
}
err = UpdateDependentTools()
if err != nil {
return err
}
err = UpdateVersionInfo()
if err != nil {
return err
}
err = build_gui_files()
if err != nil {
return err
}
if runtime.GOOS == "linux" {
err := Linux()
if err != nil {
return err
}
if mingwxcompiler_exists() {
err := Windows()
if err != nil {
return err
}
return Windowsx86()
}
}
if runtime.GOOS == "darwin" {
return Darwin()
}
return Windows()
}
func Linux() error {
return Builder{
extra_tags: " release yara ",
goos: "linux",
arch: "amd64"}.Run()
}
func LinuxMusl() error {
return Builder{
extra_tags: " release yara ",
goos: "linux",
cc: "musl-gcc",
extra_name: "-musl",
extra_ldflags: "-linkmode external -extldflags \"-static\"",
arch: "amd64"}.Run()
}
func LinuxMuslDebug() error {
return Builder{
extra_tags: " release yara ",
goos: "linux",
cc: "musl-gcc",
extra_name: "-musl-debug",
debug_build: true,
extra_ldflags: "-linkmode external -extldflags \"-static\"",
arch: "amd64"}.Run()
}
func LinuxMusl386() error {
return Builder{
extra_tags: " release yara disable_gui ",
goos: "linux",
cc: "musl-gcc",
extra_name: "-musl",
disable_cgo: true,
extra_ldflags: "-linkmode external -extldflags \"-static\"",
arch: "386"}.Run()
}
// A Linux binary without the GUI
func LinuxBare() error {
return Builder{
extra_tags: " release yara disable_gui ",
goos: "linux",
arch: "amd64"}.Run()
}
func Freebsd() error {
return Builder{
extra_tags: " release yara ",
goos: "freebsd",
// When building on actual freebsd we should have c
// compilers, otherwise disable cgo.
disable_cgo: runtime.GOOS != "freebsd",
arch: "amd64"}.Run()
}
func Aix() error {
return Builder{
extra_tags: " release yara ",
goos: "aix",
disable_cgo: true,
arch: "ppc64",
}.Run()
}
func PPCLinux() error {
return Builder{
extra_tags: " release yara ",
goos: "linux",
disable_cgo: true,
arch: "ppc64le",
}.Run()
}
func Version() error {
fmt.Println(constants.VERSION)
return nil
}
func Arm() error {
return Builder{
extra_tags: " release yara ",
goos: "linux",
disable_cgo: true,
arch: "arm",
}.Run()
}
// Builds a Development binary. This does not embed things like GUI
// resources to allow them to be loaded from the local directory.
func Dev() error {
return Builder{goos: "linux", arch: "amd64",
extra_flags: []string{"-race"}}.Run()
}
// Cross compile the windows binary using mingw. Note that this does
// not run the race detector because the ubuntu distribution of mingw
// does not include tsan.
func Windows() error {
return Builder{
extra_tags: " release yara ",
goos: "windows",
arch: "amd64"}.Run()
}
// Windows client without a gui.
func WindowsBare() error {
return Builder{
extra_tags: " release yara disable_gui ",
goos: "windows",
arch: "amd64"}.Run()
}
func WindowsDev() error {
return Builder{
goos: "windows",
extra_tags: " release yara ",
filename: "velociraptor.exe",
arch: "amd64"}.Run()
}
// Windows binary with race detection. This requires building on
// windows (ie not cross compiling). You will need to install gcc
// first using https://jmeubank.github.io/tdm-gcc/ as well as the Go
// windows distribution and optionally the windows node distribution
// (for the GUI).
func WindowsTest() error {
return Builder{
goos: "windows",
extra_tags: " release yara ",
filename: "velociraptor.exe",
arch: "amd64",
extra_flags: []string{"-race"}}.Run()
}
func Windowsx86() error {
return Builder{
extra_tags: " release yara ",
goos: "windows",
arch: "386"}.Run()
}
func WindowsArm() error {
return Builder{
extra_tags: " release yara ",
goos: "windows",
disable_cgo: true,
arch: "arm64"}.Run()
}
func Darwin() error {
return Builder{goos: "darwin",
extra_tags: " release yara ",
arch: "amd64"}.Run()
}
func DarwinM1() error {
return Builder{goos: "darwin",
extra_tags: " release yara ",
arch: "arm64"}.Run()
}
func LinuxM1() error {
return Builder{goos: "linux",
extra_tags: " release yara ",
disable_cgo: true,
arch: "arm64"}.Run()
}
// To install cross compilers: apt-get install gcc-aarch64-linux-gnu
func LinuxArm64() error {
return Builder{goos: "linux",
extra_tags: " release yara ",
cc: "aarch64-linux-gnu-gcc",
arch: "arm64"}.Run()
}
func DarwinBase() error {
return Builder{goos: "darwin",
extra_tags: " release ",
disable_cgo: true,
arch: "amd64"}.Run()
}
func Clean() error {
for _, target := range assets {
err := sh.Rm(target)
if err != nil {
return err
}
}
return nil
}
// Only build the assets without building the actual code.
func Assets() error {
err := build_gui_files()
if err != nil {
return err
}
return ensure_assets()
}
func build_gui_files() error {
cwd, err := os.Getwd()
if err != nil {
return err
}
defer os.Chdir(cwd)
err = os.Chdir("gui/velociraptor")
if err != nil {
return err
}
err = sh.RunV("npm", "ci")
if err != nil {
return err
}
err = sh.RunV("npm", "run", "build")
if err != nil {
return err
}
// Recreate the keep files since sometimes they get removed.
for _, keep_path := range []string{
"build/.keep",
} {
os.MkdirAll(path.Dir(keep_path), 0600)
fd, err := os.OpenFile(keep_path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
if err == nil {
fd.Close()
}
}
return nil
}
func flags() string {
timestamp := time.Now().Format(time.RFC3339)
flags := fmt.Sprintf(` -X "www.velocidex.com/golang/velociraptor/config.build_time=%s"`, timestamp)
flags += fmt.Sprintf(` -X "www.velocidex.com/golang/velociraptor/config.commit_hash=%s"`, hash())
// If we are running on the CI pipeline we need to know the run
// number and URL so we can report them.
if os.Getenv("GITHUB_SERVER_URL") != "" {
flags += fmt.Sprintf(` -X "www.velocidex.com/golang/velociraptor/config.ci_run_url=%s"`,
os.ExpandEnv("$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"))
}
return flags
}
// hash returns the git hash for the current repo or "" if none.
func hash() string {
hash, _ := sh.Output("git", "rev-parse", "--short", "HEAD")
return hash
}
func fileb0x(asset string) error {
err := sh.Run("fileb0x", asset)
if err != nil {
err = sh.Run(mg.GoCmd(), "install", "github.com/Velocidex/fileb0x@d54f4040016051dd9657ce04d0ae6f31eab99bc6")
if err != nil {
return err
}
err = sh.Run("fileb0x", asset)
}
return err
}
func ensure_assets() error {
// Fixup the vite build - this is a hack but i cant figure vite
// now.
replace_string_in_file(
index_template, `="/app/assets/index`,
`="{{.BasePath}}/app/assets/index`)
for asset, target := range assets {
before := timestamp_of(target)
err := fileb0x(asset)
if err != nil {
return err
}
// Only do this if the file has changed.
if before != timestamp_of(target) {
err = replace_string_in_file(target, "func init()", "func Init()")
if err != nil {
return err
}
}
}
return UpdateDependentTools()
}
func mingwxcompiler_exists() bool {
err := sh.Run(mingw_xcompiler, "--version")
return err == nil
}
func musl_exists() bool {
err := sh.Run(musl_xcompiler, "--version")
return err == nil
}
func mingwxcompiler32_exists() bool {
err := sh.Run(mingw_xcompiler_32, "--version")
return err == nil
}
// Temporarily manipulate the generated file until
// https://github.com/UnnoTed/fileb0x/pull/46 goes in.
func replace_string_in_file(filename string, old string, new string) error {
read, err := ioutil.ReadFile(filename)
if err != nil {
return err
}
newContents := strings.Replace(string(read), old, new, -1)
return ioutil.WriteFile(filename, []byte(newContents), 0644)
}
func timestamp_of(path string) int64 {
stat, err := os.Stat(path)
if os.IsNotExist(err) || err != nil {
return 0
}
return stat.ModTime().UnixNano()
}
func UpdateDependentTools() error {
// Do not update dependencies for dev builds as the uploaded
// binaries do not exist yet.
if strings.Contains(constants.VERSION, "dev") {
return nil
}
v, err := semver.NewVersion(constants.VERSION)
if err != nil {
return err
}
template := "artifacts/definitions/Server/Internal/ToolDependencies.tmpl"
fd, err := os.Open(template)
if err != nil {
return err
}
defer fd.Close()
data, err := ioutil.ReadAll(fd)
if err != nil {
return err
}
outfile := strings.ReplaceAll(template, "tmpl", "yaml")
outfd, err := os.OpenFile(outfile,
os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
if err != nil {
return err
}
defer outfd.Close()
data = bytes.ReplaceAll(data, []byte("<VERSION>"), []byte(constants.VERSION))
data = bytes.ReplaceAll(data, []byte("<VERSION_BARE>"),
[]byte(fmt.Sprintf("%d.%d", v.Major(), v.Minor())))
_, err = outfd.Write(data)
return err
}
func UpdateVersionInfo() error {
read, err := ioutil.ReadFile("docs/winres/winres_template.json")
if err != nil {
return err
}
v, err := semver.NewVersion(constants.VERSION)
if err != nil {
return err
}
var prerelease int64
prerelease_str := v.Prerelease()
if prerelease_str != "" {
if !strings.HasPrefix(prerelease_str, "rc") {
return errors.New("Prerelease version should start with rc")
}
prerelease, err = strconv.ParseInt(prerelease_str[2:], 0, 0)
if err != nil {
return errors.New("Prerelease version should start with rc followed by numbers")
}
}
version := fmt.Sprintf("%d.%d.%d.%d", v.Major(), v.Minor(),
v.Patch(), prerelease)
newContents := strings.Replace(string(read), "0.0.0.0", version, -1)
err = ioutil.WriteFile("docs/winres/winres.json",
[]byte(newContents), 0644)
if err != nil {
return err
}
command := []string{"make",
"--in", "docs/winres/winres.json", "--out", "bin/rsrc"}
err = sh.Run("go-winres", command...)
if err != nil {
err = sh.Run(mg.GoCmd(), "install", "github.com/tc-hib/go-winres@d743268d7ea168077ddd443c4240562d4f5e8c3e")
if err != nil {
return err
}
err = sh.Run("go-winres", command...)
return err
}
return nil
}
type Package struct {
Name string // declared name
Path string // full import path
Funcs []Function // list of dead functions within it
}
type Function struct {
Name string // name (sans package qualifier)
Position Position // file/line/column of function declaration
}
type Position struct {
File string // name of file
Line, Col int // line and byte index, both 1-based
}
type Ignore struct {
IgnoreFiles []string `yaml:"IgnoreFiles"`
IgnoreFunctions []string `yaml:"IgnoreFunctions"`
IgnoreMatches []string `yaml:"IgnoreMatches"`
}
func Deadcode() error {
fd, err := os.Open("./docs/deadcode.yaml")
if err != nil {
return err
}
data, err := ioutil.ReadAll(fd)
if err != nil {
return err
}
ignore := &Ignore{}
err = yaml.Unmarshal(data, ignore)
if err != nil {
return err
}
ignore_filenames := regexp.MustCompile(strings.Join(ignore.IgnoreFiles, "|"))
ignore_functions := regexp.MustCompile(strings.Join(ignore.IgnoreFunctions, "|"))
ignore_matches := regexp.MustCompile(strings.Join(ignore.IgnoreMatches, "|"))
out, err := sh.OutCmd("deadcode")("-tags", "server_vql extras", "-json", "./bin")
if err != nil {
return err
}
var packages []Package
err = json.Unmarshal([]byte(out), &packages)
if err != nil {
return err
}
count := 0
suppressed := 0
for _, p := range packages {
for _, i := range p.Funcs {
count++
if ignore_filenames.MatchString(i.Position.File) {
suppressed++
continue
}
if ignore_functions.MatchString(i.Name) {
suppressed++
continue
}
line := fmt.Sprintf("%v:%v (Line %v)",
i.Position.File, i.Name, i.Position.Line)
if ignore_matches.MatchString(line) {
suppressed++
continue
}
fmt.Println(line)
}
}
fmt.Printf("deadcode reported %v functions, %v were suppressed\n",
count, suppressed)
return nil
}