-
Notifications
You must be signed in to change notification settings - Fork 109
/
resultcollector.go
495 lines (438 loc) · 15 KB
/
resultcollector.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
/*
Copyright © 2019 Red Hat Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"bufio"
"bytes"
"context"
"crypto/tls"
"crypto/x509"
goerrors "errors"
"flag"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/http/httputil"
"os"
"path/filepath"
"strings"
"sync"
"time"
backoff "github.com/cenkalti/backoff/v3"
"github.com/dsnet/compress/bzip2"
libgocrypto "github.com/openshift/library-go/pkg/crypto"
"github.com/operator-framework/operator-sdk/pkg/log/zap"
"github.com/spf13/cobra"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client/config"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
compv1alpha1 "github.com/openshift/compliance-operator/pkg/apis/compliance/v1alpha1"
"github.com/openshift/compliance-operator/pkg/controller/common"
"github.com/openshift/compliance-operator/pkg/utils"
)
var resultcollectorCmd = &cobra.Command{
Use: "resultscollector",
Short: "A tool to do an OpenSCAP scan from a pod.",
Long: "A tool to do an OpenSCAP scan from a pod.",
Run: resultCollectorMain,
}
var (
timeoutErr = goerrors.New("Timed out waiting for results file")
)
func init() {
rootCmd.AddCommand(resultcollectorCmd)
defineResultcollectorFlags(resultcollectorCmd)
}
type scapresultsConfig struct {
ArfFile string
XccdfFile string
ExitCodeFile string
CmdOutputFile string
WarningsOutputFile string
ScanName string
ConfigMapName string
NodeName string
Namespace string
ResultServerURI string
Timeout int64
Cert string
Key string
CA string
}
func defineResultcollectorFlags(cmd *cobra.Command) {
cmd.Flags().String("arf-file", "", "The ARF file to watch.")
cmd.Flags().String("results-file", "", "The XCCDF results file to watch.")
cmd.Flags().String("exit-code-file", "", "A file containing the oscap command's exit code.")
cmd.Flags().String("oscap-output-file", "", "A file containing the oscap command's output.")
cmd.Flags().String("warnings-output-file", "", "A file containing the warnings to output.")
cmd.Flags().String("owner", "", "The compliance scan that owns the configMap objects.")
cmd.Flags().String("config-map-name", "", "The configMap to upload to, typically the podname.")
cmd.Flags().String("node-name", "", "The node that was scanned.")
cmd.Flags().String("namespace", "openshift-compliance", "Running pod namespace.")
cmd.Flags().Int64("timeout", 3600, "How long to wait for the file.")
cmd.Flags().String("resultserveruri", "", "The resultserver URI name.")
cmd.Flags().String("tls-client-cert", "", "The path to the client and CA PEM cert bundle.")
cmd.Flags().String("tls-client-key", "", "The path to the client PEM key.")
cmd.Flags().String("tls-ca", "", "The path to the CA certificate.")
flags := cmd.Flags()
flags.AddFlagSet(zap.FlagSet())
// Add flags registered by imported packages (e.g. glog and
// controller-runtime)
flags.AddGoFlagSet(flag.CommandLine)
}
func parseConfig(cmd *cobra.Command) *scapresultsConfig {
var conf scapresultsConfig
conf.ArfFile = getValidStringArg(cmd, "arf-file")
conf.XccdfFile = getValidStringArg(cmd, "results-file")
conf.ExitCodeFile = getValidStringArg(cmd, "exit-code-file")
conf.CmdOutputFile = getValidStringArg(cmd, "oscap-output-file")
conf.ScanName = getValidStringArg(cmd, "owner")
conf.ConfigMapName = getValidStringArg(cmd, "config-map-name")
conf.Namespace = getValidStringArg(cmd, "namespace")
conf.Cert = getValidStringArg(cmd, "tls-client-cert")
conf.Key = getValidStringArg(cmd, "tls-client-key")
conf.CA = getValidStringArg(cmd, "tls-ca")
conf.Timeout, _ = cmd.Flags().GetInt64("timeout")
conf.ResultServerURI, _ = cmd.Flags().GetString("resultserveruri")
// Set default if needed
if conf.ResultServerURI == "" {
conf.ResultServerURI = "http://" + conf.ScanName + "-rs:8080/"
}
conf.WarningsOutputFile, _ = cmd.Flags().GetString("warnings-output-file")
// platform scans have no node name
conf.NodeName, _ = cmd.Flags().GetString("node-name")
logf.SetLogger(zap.Logger())
return &conf
}
func getOpenSCAPScanInstance(name, namespace string, client *complianceCrClient) (*compv1alpha1.ComplianceScan, error) {
key := types.NamespacedName{Name: name, Namespace: namespace}
scan := &compv1alpha1.ComplianceScan{}
err := client.client.Get(context.TODO(), key, scan)
if err != nil {
log.Error(err, "Error getting scan instance", "ComplianceScan.Name", scan.Name, "ComplianceScan.Namespace", scan.Namespace)
return nil, err
}
return scan, nil
}
func resultsFileReady(fname string, fFound chan *os.File) (bool, error) {
// Note that we're cleaning the filename path above.
// Also note that the file is not being closed here and should
// be closed by the channel receiver.
// #nosec
file, err := os.Open(fname)
if err == nil {
fileinfo, statErr := file.Stat()
// Only try to use the file if it already has contents.
// This way we avoid race conditions between the side-car and
// this script.
if statErr == nil && fileinfo.Size() > 0 {
fFound <- file
return true, nil
} else {
return false, file.Close()
}
} else if !os.IsNotExist(err) {
log.Error(err, "Couldn't open results file")
// We mark this as "ready" as there's nothing else to do.
// This will stop the go-routine
return true, fmt.Errorf("couldn't open result file: %w", err)
}
return false, nil
}
func probeResultsFile(fname string, fFound chan *os.File, errs chan error) {
for {
ready, err := resultsFileReady(fname, fFound)
if err != nil {
errs <- err
}
if ready {
return
}
time.Sleep(1 * time.Second)
}
}
func waitForResultsFile(filename string, timeout int64) (*os.File, error) {
readFileTimeoutChan := make(chan *os.File, 1)
errs := make(chan error)
// G304 (CWE-22) is addressed by this.
cleanFileName := filepath.Clean(filename)
go probeResultsFile(cleanFileName, readFileTimeoutChan, errs)
select {
case file := <-readFileTimeoutChan:
log.Info("Results file found, will upload it.", "resuts-file", filename)
close(readFileTimeoutChan)
return file, nil
case err := <-errs:
outErr := fmt.Errorf("error reading result file: %w", err)
log.Error(outErr, "Timeout. Aborting.")
return nil, outErr
case <-time.After(time.Duration(timeout) * time.Second):
log.Error(timeoutErr, "Timeout. Aborting.")
return nil, timeoutErr
}
}
func resultNeedsCompression(size int64) bool {
return size > 1048570
}
func compressResults(contents io.Reader) (io.Reader, error) {
// Encode the contents ascii, compress it with gzip, b64encode it so it
// can be stored in the configmap.
var buffer bytes.Buffer
w, err := bzip2.NewWriter(&buffer, &bzip2.WriterConfig{Level: bzip2.BestCompression})
if err != nil {
return nil, err
}
defer w.Close()
_, err = io.Copy(w, contents)
if err != nil {
return nil, err
}
return &buffer, nil
}
type resultFileContents struct {
contents io.Reader
compressed bool
close func() error
}
func readResultsFile(filename string, timeout int64) (*resultFileContents, error) {
var err error
var rfContents resultFileContents
cleanFileName := filepath.Clean(filename)
handle, err := waitForResultsFile(cleanFileName, timeout)
if err != nil {
os.Exit(1)
}
// #nosec
defer handle.Close()
// #nosec
contentsfile, err := os.Open(cleanFileName)
if err != nil {
return nil, err
}
rfContents.contents = bufio.NewReader(contentsfile)
// Using stat avoids us having to read the file's contents
statInfo, err := os.Stat(cleanFileName)
if err != nil {
return nil, err
}
if resultNeedsCompression(statInfo.Size()) {
// #nosec
defer contentsfile.Close()
rfContents.close = func() error {
return nil
}
rfContents.contents, err = compressResults(rfContents.contents)
log.Info("File needs compression", "results-file", filename)
if err != nil {
log.Error(err, "Error: Compression failed")
return nil, err
}
rfContents.compressed = true
log.Info("Compressed results")
} else {
rfContents.close = func() error {
return contentsfile.Close()
}
}
return &rfContents, nil
}
func readWarningsFile(filename string) string {
// No warnings file provided, no need to parse anything
if filename == "" {
return ""
}
contents, err := ioutil.ReadFile(filepath.Clean(filename))
if os.IsNotExist(err) {
// warnings file provided, but no warnings were generated
return ""
}
if err != nil {
DBG("Error while reading warnings file: %v", err)
return ""
}
return strings.Trim(string(contents), "\n")
}
func uploadToResultServer(arfContents *resultFileContents, scapresultsconf *scapresultsConfig) error {
return backoff.Retry(func() error {
url := scapresultsconf.ResultServerURI
log.Info("Trying to upload to resultserver", "url", url)
transport, err := getMutualHttpsTransport(scapresultsconf)
if err != nil {
log.Error(err, "Failed to get https transport")
return err
}
client := &http.Client{Transport: transport}
req, _ := http.NewRequest("POST", url, arfContents.contents)
req.Header.Add("Content-Type", "application/xml")
req.Header.Add("X-Report-Name", scapresultsconf.ConfigMapName)
if arfContents.compressed {
req.Header.Add("Content-Encoding", "bzip2")
}
resp, err := client.Do(req)
if err != nil {
log.Error(err, "Failed to upload results to server")
return err
}
defer resp.Body.Close()
bytesresp, err := httputil.DumpResponse(resp, true)
if err != nil {
log.Error(err, "Failed to parse response")
return err
}
log.Info(string(bytesresp))
return nil
}, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), maxRetries))
}
func uploadResultConfigMap(xccdfContents *resultFileContents, exitcode string,
scapresultsconf *scapresultsConfig, client *complianceCrClient) error {
warnings := readWarningsFile(scapresultsconf.WarningsOutputFile)
return backoff.Retry(func() error {
log.Info("Trying to upload results ConfigMap")
openscapScan, err := getOpenSCAPScanInstance(scapresultsconf.ScanName, scapresultsconf.Namespace, client)
if err != nil {
return err
}
confMap := utils.GetResultConfigMap(openscapScan, scapresultsconf.ConfigMapName, "results",
scapresultsconf.NodeName, xccdfContents.contents, xccdfContents.compressed, exitcode, warnings)
err = client.client.Create(context.TODO(), confMap)
if errors.IsAlreadyExists(err) {
return nil
}
return err
}, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), maxRetries))
}
func uploadErrorConfigMap(errorMsg *resultFileContents, exitcode string,
scapresultsconf *scapresultsConfig, client *complianceCrClient) error {
warnings := readWarningsFile(scapresultsconf.WarningsOutputFile)
return backoff.Retry(func() error {
log.Info("Trying to upload error ConfigMap")
openscapScan, err := getOpenSCAPScanInstance(scapresultsconf.ScanName, scapresultsconf.Namespace, client)
if err != nil {
return err
}
confMap := utils.GetResultConfigMap(openscapScan, scapresultsconf.ConfigMapName, "error-msg",
scapresultsconf.NodeName, errorMsg.contents, errorMsg.compressed, exitcode, warnings)
err = client.client.Create(context.TODO(), confMap)
if errors.IsAlreadyExists(err) {
return nil
}
return err
}, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), maxRetries))
}
func handleCompleteSCAPResults(exitcode string, scapresultsconf *scapresultsConfig, client *complianceCrClient) {
arfContents, err := readResultsFile(scapresultsconf.ArfFile, scapresultsconf.Timeout)
if err != nil {
log.Error(err, "Failed to read ARF file")
os.Exit(1)
}
defer arfContents.close()
xccdfContents, err := readResultsFile(scapresultsconf.XccdfFile, scapresultsconf.Timeout)
if err != nil {
log.Error(err, "Failed to read XCCDF file")
os.Exit(1)
}
defer xccdfContents.close()
var wg sync.WaitGroup
wg.Add(2)
go func() {
serverUploadErr := uploadToResultServer(arfContents, scapresultsconf)
if serverUploadErr != nil {
log.Error(serverUploadErr, "Failed to upload results to server")
os.Exit(1)
}
log.Info("Uploaded to resultserver")
wg.Done()
}()
go func() {
cmUploadErr := uploadResultConfigMap(xccdfContents, exitcode, scapresultsconf, client)
if cmUploadErr != nil {
log.Error(cmUploadErr, "Failed to upload ConfigMap")
os.Exit(1)
}
log.Info("Uploaded ConfigMap")
wg.Done()
}()
wg.Wait()
}
func handleErrorInOscapRun(exitcode string, scapresultsconf *scapresultsConfig, client *complianceCrClient) {
errorMsg, err := readResultsFile(scapresultsconf.CmdOutputFile, scapresultsconf.Timeout)
if err != nil {
log.Error(err, "Failed to read error message output from oscap run")
os.Exit(1)
}
defer errorMsg.close()
err = uploadErrorConfigMap(errorMsg, exitcode, scapresultsconf, client)
if err != nil {
log.Error(err, "Failed to upload error ConfigMap")
os.Exit(1)
}
log.Info("Uploaded ConfigMap")
}
func getOscapExitCode(scapresultsconf *scapresultsConfig) string {
exitcodeContent, err := readResultsFile(scapresultsconf.ExitCodeFile, scapresultsconf.Timeout)
if err != nil {
log.Error(err, "Failed to read oscap error code")
os.Exit(1)
}
defer exitcodeContent.close()
exitcode, _ := ioutil.ReadAll(exitcodeContent.contents)
return strings.Trim(string(exitcode), "\n")
}
func getMutualHttpsTransport(c *scapresultsConfig) (*http.Transport, error) {
cert, err := tls.LoadX509KeyPair(c.Cert, c.Key)
if err != nil {
return nil, err
}
ca, err := ioutil.ReadFile(c.CA)
if err != nil {
return nil, err
}
pool := x509.NewCertPool()
pool.AppendCertsFromPEM(ca)
tlsConfig := &tls.Config{}
// Configures TLS 1.2
tlsConfig = libgocrypto.SecureTLSConfig(tlsConfig)
tlsConfig.RootCAs = pool
tlsConfig.Certificates = []tls.Certificate{cert}
return &http.Transport{
TLSClientConfig: tlsConfig,
}, nil
}
// an exit code of 0 means that the scan returned compliant
// an exit code of 2 means that the scan returned non-compliant
// an exit code of 1 means that the scan encountered an error
func exitCodeIsError(exitcode string) bool {
return exitcode != common.OpenSCAPExitCodeCompliant && exitcode != common.OpenSCAPExitCodeNonCompliant
}
func resultCollectorMain(cmd *cobra.Command, args []string) {
scapresultsconf := parseConfig(cmd)
cfg, err := config.GetConfig()
if err != nil {
log.Error(err, "")
os.Exit(1)
}
crclient, err := createCrClient(cfg)
if err != nil {
log.Error(err, "Cannot create kube client for our types\n")
os.Exit(1)
}
exitcode := getOscapExitCode(scapresultsconf)
log.Info("Got exit-code from file", "exit-code", exitcode)
if exitCodeIsError(exitcode) {
handleErrorInOscapRun(exitcode, scapresultsconf, crclient)
return
}
handleCompleteSCAPResults(exitcode, scapresultsconf, crclient)
}