/
contrastExecuteScan.go
135 lines (113 loc) · 4.01 KB
/
contrastExecuteScan.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
package cmd
import (
"encoding/base64"
"fmt"
"strings"
"github.com/SAP/jenkins-library/pkg/command"
"github.com/SAP/jenkins-library/pkg/contrast"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/piperutils"
"github.com/SAP/jenkins-library/pkg/telemetry"
)
type contrastExecuteScanUtils interface {
command.ExecRunner
piperutils.FileUtils
}
type contrastExecuteScanUtilsBundle struct {
*command.Command
*piperutils.Files
}
func newContrastExecuteScanUtils() contrastExecuteScanUtils {
utils := contrastExecuteScanUtilsBundle{
Command: &command.Command{},
Files: &piperutils.Files{},
}
utils.Stdout(log.Writer())
utils.Stderr(log.Writer())
return &utils
}
func contrastExecuteScan(config contrastExecuteScanOptions, telemetryData *telemetry.CustomData) {
utils := newContrastExecuteScanUtils()
reports, err := runContrastExecuteScan(&config, telemetryData, utils)
piperutils.PersistReportsAndLinks("contrastExecuteScan", "./", utils, reports, nil)
if err != nil {
log.Entry().WithError(err).Fatal("step execution failed")
}
}
func validateConfigs(config *contrastExecuteScanOptions) error {
validations := map[string]string{
"server": config.Server,
"organizationId": config.OrganizationID,
"applicationId": config.ApplicationID,
"userApiKey": config.UserAPIKey,
"username": config.Username,
"serviceKey": config.ServiceKey,
}
for k, v := range validations {
if v == "" {
return fmt.Errorf("%s is empty", k)
}
}
if !strings.HasPrefix(config.Server, "https://") {
config.Server = "https://" + config.Server
}
return nil
}
func runContrastExecuteScan(config *contrastExecuteScanOptions, telemetryData *telemetry.CustomData, utils contrastExecuteScanUtils) (reports []piperutils.Path, err error) {
err = validateConfigs(config)
if err != nil {
log.Entry().Errorf("config is invalid: %v", err)
return nil, err
}
auth := getAuth(config)
appAPIUrl, appUIUrl := getApplicationUrls(config)
contrastInstance := contrast.NewContrastInstance(appAPIUrl, config.UserAPIKey, auth)
appInfo, err := contrastInstance.GetAppInfo(appUIUrl, config.Server)
if err != nil {
log.Entry().Errorf("error while getting app info")
return nil, err
}
findings, err := contrastInstance.GetVulnerabilities()
if err != nil {
log.Entry().Errorf("error while getting vulns")
return nil, err
}
contrastAudit := contrast.ContrastAudit{
ToolName: "contrast",
ApplicationUrl: appInfo.Url,
ScanResults: findings,
}
paths, err := contrast.WriteJSONReport(contrastAudit, "./")
if err != nil {
log.Entry().Errorf("error while writing json report")
return nil, err
}
reports = append(reports, paths...)
if config.CheckForCompliance {
for _, results := range findings {
if results.ClassificationName == "Audit All" {
unaudited := results.Total - results.Audited
if unaudited > config.VulnerabilityThresholdTotal {
msg := fmt.Sprintf("Your application %v in organization %v is not compliant. Total unaudited issues are %v which is greater than the VulnerabilityThresholdTotal count %v",
config.ApplicationID, config.OrganizationID, unaudited, config.VulnerabilityThresholdTotal)
return reports, fmt.Errorf(msg)
}
}
}
}
toolRecordFileName, err := contrast.CreateAndPersistToolRecord(utils, appInfo, "./")
if err != nil {
log.Entry().Warning("TR_CONTRAST: Failed to create toolrecord file ...", err)
} else {
reports = append(reports, piperutils.Path{Target: toolRecordFileName})
}
return reports, nil
}
func getApplicationUrls(config *contrastExecuteScanOptions) (string, string) {
appURL := fmt.Sprintf("%s/api/v4/organizations/%s/applications/%s", config.Server, config.OrganizationID, config.ApplicationID)
guiURL := fmt.Sprintf("%s/Contrast/static/ng/index.html#/%s/applications/%s", config.Server, config.OrganizationID, config.ApplicationID)
return appURL, guiURL
}
func getAuth(config *contrastExecuteScanOptions) string {
return base64.StdEncoding.EncodeToString([]byte(config.Username + ":" + config.ServiceKey))
}