aboutsummaryrefslogtreecommitdiff
path: root/cmd/silentct-mon/main.go
blob: 2d070fb6760499d11e000b53306ad3a95ca06e19 (plain)
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
package main

import (
	"context"
	"errors"
	"flag"
	"fmt"
	"log"
	"os"
	"os/signal"
	"strings"
	"sync"
	"syscall"
	"time"

	"rgdd.se/silent-ct/internal/feedback"
	"rgdd.se/silent-ct/internal/flagopt"
	"rgdd.se/silent-ct/internal/ioutil"
	"rgdd.se/silent-ct/internal/logger"
	"rgdd.se/silent-ct/internal/manager"
	"rgdd.se/silent-ct/internal/monitor"
	"rgdd.se/silent-ct/pkg/policy"
)

const usage = `
silentct-mon is a tool that monitors Certificate Transparency logs.  The tool
can operate silently, which means there need not be any output unless a
certificate is possibly mis-issued.  This requires use of the silentct-mac
utility on the trusted systems that legitimately request certificates.

The same list of Certificate Transparency logs as Google Chrome is used.  This
list can be overridden in the silentct-mon configuration file.

Usage: silentct-mon [Options] -d DIRECTORY -f POLICY-FILE

Options:

  -b, --bootstrap      Initializes a new state directory (Default: false)
  -c, --contact        A string that helps log operators know who you are (Default: "")
  -d, --directory      Path to a directory where all state will be stored
  -w, --num-workers    Number of parallel workers to fetch each log with (Default: 1)
  -o, --output-file    File that all output will be written to (Default: stdout)
  -e, --please-exit    Toggle to only run until up-to-date (Default: false)
  -f, --policy-file    Path to the monitor's policy file in JSON format
  -p, --pull-interval  How often nodes are pulled for certificates (Default: 15m)
  -v, --verbosity      Leveled logging output (default: NOTICE)
`

type config struct {
	// Options
	verbosity    string
	bootstrap    bool
	contact      string
	directory    string
	pleaseExit   bool
	policyFile   string
	outputFile   string
	pullInterval time.Duration
	numWorkers   uint

	// Extracted
	log    *logger.Logger
	policy policy.Policy
}

func configure(cmd string, args []string) (cfg config, err error) {
	fs := flag.NewFlagSet(cmd, flag.ContinueOnError)
	fs.Usage = func() {}
	flagopt.BoolOpt(fs, &cfg.bootstrap, "bootstrap", "b", false)
	flagopt.StringOpt(fs, &cfg.contact, "contact", "c", "")
	flagopt.StringOpt(fs, &cfg.directory, "directory", "d", "")
	flagopt.UintOpt(fs, &cfg.numWorkers, "num-workers", "w", 1)
	flagopt.StringOpt(fs, &cfg.outputFile, "output-file", "o", "")
	flagopt.BoolOpt(fs, &cfg.pleaseExit, "please-exit", "e", false)
	flagopt.StringOpt(fs, &cfg.policyFile, "policy-file", "f", "")
	flagopt.DurationOpt(fs, &cfg.pullInterval, "pull-interval", "p", 15*time.Minute)
	flagopt.StringOpt(fs, &cfg.verbosity, "verbosity", "v", logger.LevelNotice.String())
	if err = fs.Parse(args); err != nil {
		return cfg, err
	}

	// Options
	if cfg.directory == "" {
		return cfg, fmt.Errorf("directory is a required option")
	}
	if cfg.numWorkers == 0 || cfg.numWorkers >= 4 {
		return cfg, fmt.Errorf("number of workers must be in [1, 4)")
	}
	output := os.Stdout
	if cfg.outputFile != "" {
		if output, err = os.OpenFile(cfg.outputFile, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644); err != nil {
			return cfg, fmt.Errorf("failed to open output file: %v", err)
		}
	}
	if cfg.policyFile == "" {
		return cfg, fmt.Errorf("policy file is a required option")
	}
	if err := ioutil.ReadJSON(cfg.policyFile, &cfg.policy); err != nil {
		return cfg, err
	}
	if len(cfg.policy.Monitor) == 0 {
		return cfg, fmt.Errorf("policy: need at least one wildcard to monitor")
	}
	lv, err := logger.NewLevel(cfg.verbosity)
	if err != nil {
		return cfg, fmt.Errorf("invalid verbosity: %v", err)
	}
	cfg.log = logger.New(logger.Config{Level: lv, File: output})

	// Arguments
	if len(fs.Args()) != 0 {
		return cfg, fmt.Errorf("trailing arguments are not permitted")
	}

	return cfg, nil
}

func main() {
	cfg, err := configure(os.Args[0], os.Args[1:])
	if err != nil {
		if errors.Is(err, flag.ErrHelp) {
			fmt.Fprintf(os.Stdout, "%s", usage[1:])
			os.Exit(0)
		}
		if !strings.Contains(err.Error(), "flag provided but not defined") {
			fmt.Fprintf(os.Stdout, "%v\n", err)
		}
		os.Exit(1)
	}

	feventCh := make(chan []feedback.Event)
	defer close(feventCh)

	mconfigCh := make(chan monitor.MonitoredLog)
	defer close(mconfigCh)

	meventCh := make(chan monitor.Event)
	defer close(meventCh)

	errorCh := make(chan error)
	defer close(errorCh)

	mgr, err := manager.New(manager.Config{
		Policy:     cfg.policy,
		Bootstrap:  cfg.bootstrap,
		Directory:  cfg.directory,
		Logger:     cfg.log,
		AlertDelay: cfg.pullInterval * 3 / 2,
	}, feventCh, meventCh, mconfigCh, errorCh)
	if err != nil {
		cfg.log.Dief("manager: %v\n", err)
	}
	mon, err := monitor.New(monitor.Config{
		Matcher:    &cfg.policy.Monitor,
		Logger:     cfg.log,
		Contact:    cfg.contact,
		NumWorkers: cfg.numWorkers,
	}, meventCh, mconfigCh, errorCh)
	if err != nil {
		cfg.log.Dief("monitor: %v\n", err)
	}
	fb, err := feedback.New(feedback.Config{
		Policy:       cfg.policy,
		Logger:       cfg.log,
		PullInterval: cfg.pullInterval,
	}, feventCh)
	if err != nil {
		cfg.log.Dief("feedback: %v\n", err)
	}

	if cfg.bootstrap {
		os.Exit(0)
	}
	if cfg.pleaseExit {
		cfg.log.Dief("the --please-exit option is not supported yet\n")
	}

	var wg sync.WaitGroup
	ctx, cancel := context.WithCancel(context.Background())

	wg.Add(1)
	go func() {
		defer wg.Done()
		defer cancel()
		await(ctx)
	}()

	wg.Add(1)
	go func() {
		defer wg.Done()
		defer cancel()
		mon.RunForever(ctx)
	}()

	wg.Add(1)
	go func() {
		defer wg.Done()
		defer cancel()
		fb.RunForever(ctx)
	}()

	os.Exit(func() int {
		defer wg.Wait()
		defer cancel()
		if err := mgr.Run(ctx); err != nil {
			log.Fatalf("manager: %v\n", err)
			return 1
		}
		return 0
	}())
}

func await(ctx context.Context) {
	sigs := make(chan os.Signal, 1)
	defer close(sigs)

	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
	select {
	case <-sigs:
	case <-ctx.Done():
	}
}