-
Notifications
You must be signed in to change notification settings - Fork 18
/
action.yml
405 lines (405 loc) · 14.9 KB
/
action.yml
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
name: 'Checkmarx Scan'
description: 'Find vulnerabilities in your code using Checkmarx SAST solution'
author: 'Miguel Freitas'
inputs:
cxAction:
description: 'Checkmarx CLI Action'
required: false
default: 'Scan'
cxVersion:
description: 'Checkmarx Version'
required: false
default: '2021.1.1'
cxServer:
description: 'IP address or resolvable name of CxSAST web server.'
required: true
default: 'https://company.checkmarx.com'
cxUsername:
description: 'Checkmarx Username'
required: true
default: '[email protected]'
cxToken:
description: 'Checkmarx Token'
required: false
default: ''
cxPassword:
description: 'Checkmarx Password'
required: true
default: ''
cxTeam:
description: 'Checkmarx Team'
required: true
default: ''
cxProject:
description: 'Checkmarx Project Name'
required: false
default: ''
cxPreset:
description: 'If not provided, will use preset defined in existing project or, for a new project, the default preset.'
required: false
default: 'Checkmarx Default'
cxHigh:
description: 'Threshold for High Severity Vulnerabilities'
required: false
default: -1
cxMedium:
description: 'Threshold for Medium Severity Vulnerabilities'
required: false
default: -1
cxLow:
description: 'Threshold for Low Severity Vulnerabilities'
required: false
default: -1
cxComment:
description: 'Saves a comment with the scan results. For example -comment important scan.'
required: false
default: ''
cxForceScan:
description: 'Force scan on source code, which has not been changed since the last scan of the same project. (Not compatible with -Incremental option.)'
required: false
default: false
cxIncremental:
description: 'Run incremental scan instead of a full scan.'
required: false
default: false
cxExcludeFolders:
description: 'Comma separated list of folder name patterns to exclude from scan. For example, exclude all test and log folders: -locationPathExclude test*,log_*'
required: false
default: ''
cxExcludeFiles:
description: 'Comma separated list of file name patterns to exclude from scan. For example, exclude all files with .class extension: -locationFilesExclude *.class'
required: false
default: ''
cxConfiguration:
description: 'Code language configuration. Possible values are : Default Configuration, Japanese (Shift-JIS). If configuration is not set, Default Configuration is used.'
required: false
default: 'Default Configuration'
cxPrivate:
description: 'Scan will not be visible to other users.'
required: false
default: false
cxReportXML:
description: 'SAST Scan Report in XML format'
required: false
default: ''
cxReportPDF:
description: 'SAST Scan Report in PDF format'
required: false
default: ''
cxReportRTF:
description: 'SAST Scan Report in RTF format'
required: false
default: ''
cxReportCSV:
description: 'SAST Scan Report in CSV format'
required: false
default: ''
cxLog:
description: 'Log file to be created.'
required: false
default: ''
cxVerbose:
description: 'Turns on verbose mode. All messages and events will be sent to the console or log file.'
required: false
default: true
cxOsaHigh:
description: 'OSA high severity vulnerability threshold. If the number of high vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
required: false
default: -1
cxOsaMedium:
description: 'OSA medium severity vulnerability threshold. If the number of medium vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
required: false
default: -1
cxOsaLow:
description: 'OSA low severity vulnerability threshold. If the number of high vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
required: false
default: -1
cxOsaLocationPath:
description: 'Local or network path to sources or source repository branch. May include multiple list of folders (local or shared) separated by comma.'
required: false
default: ''
cxOsaArchiveToExtract:
description: 'Comma separated list of file extensions to extract in the OSA scan.
For example: -OsaArchiveToExtract *.zip extracts only files with .zip extension.'
required: false
default: ''
cxOsaFilesInclude:
description: 'Comma separated list of file name patterns to exclude from the OSA scan.
For example: *.dll will include only dll files.'
required: false
default: ''
cxOsaFilesExclude:
description: 'Comma separated list of file name patterns to exclude from the OSA scan.
Exclude extensions by using *.<extension>, or exclude files by using */<file>.
Examples: -OsaFilesExclude *.class excludes all files which start with the .class.
Examples: -OsaFilesExclude */plexus-utils-1.5.6.jar excludes all files which start with plexus-utils-1.5.6.jar.'
required: false
default: ''
cxOsaPathExclude:
description: 'Comma separated list of folder path patterns to exclude from the OSA scan.
For example: -OsaPathExclude test excludes all folders which start with test prefix.'
required: false
default: ''
cxOsaReportHtml:
description: 'Generate CxOSA HTML report.'
required: false
default: ''
cxOsaReportPDF:
description: 'Generate CxOSA PDF report.'
required: false
default: ''
cxOsaDepth:
description: 'Extraction depth of files to include in the OSA scan.'
required: false
default: ''
cxExecutePackageDependency:
description: 'Retrieve all supported package dependencies before performing OSA scan (see Remarks section).'
required: false
default: false
cxOsaJson:
description: 'Generate CxOSA JSON report.'
required: false
default: ''
cxScaUsername:
description: 'SCA Username'
required: false
default: ''
cxScaPassword:
description: 'SCA Password'
required: false
default: ''
cxScaAccount:
description: 'SCA Account Name'
required: false
default: ''
cxScaApiUrl:
description: 'SCA API URL'
required: false
default: ''
cxScaAcessControlUrl:
description: 'SCA Access Control URL'
required: false
default: ''
cxScaWebAppUrl:
description: 'SCA Web App URL'
required: false
default: ''
cxScaHigh:
description: 'SCA High Threshold'
required: false
default: -1
cxScaMedium:
description: 'SCA Medium Threshold'
required: false
default: -1
cxScaLow:
description: 'SCA Low Threshold'
required: false
default: -1
cxScaLocationPath:
description: 'SCA Location Path'
required: false
default: ''
cxScaFilesInclude:
description: 'SCA Files Include'
required: false
default: ''
cxScaFilesExclude:
description: 'SCA Files Exclude'
required: false
default: ''
cxScaPathExclude:
description: 'SCA Folders Exclude'
required: false
default: ''
cxCheckPolicy:
description: 'This parameter will break the build if the CxOSA policy is violated.'
required: false
default: false
cxSkipIfFail:
description: 'Skip Checkmarx Action Step if Fail'
required: false
default: false
cxTrustedCertificates:
description: 'Trust Self-signed Certificates'
required: false
default: false
cxGithubToken:
description: 'Github Token Secret'
required: false
default: ''
cxGithubIssues:
description: 'Create Github Issues'
required: false
default: false
cxGithubLabels:
description: 'Github Labels for Issues created'
required: false
default: 'bug'
cxGithubAssignees:
description: 'Github Assignees for Issues created'
required: false
default: ''
cxGithubMilestone:
description: 'Github Milestone for Issues created'
required: false
default: null
outputs:
cxActionId:
description: 'Github Action ID (e.g. self)'
cxRunId:
description: 'Github Run ID (e.g. 130420638)'
cxWorkflow:
description: 'Github Workflow Name (e.g. My Workflow)'
cxWorkflowUser:
description: 'Github Workflow Actor (e.g. miguelfreitas93)'
cxEvent:
description: 'Github Event Name (e.g. push)'
cxRepository:
description: 'Github Repository Name (e.g. user/repository)'
cxBranch:
description: 'Github Repository Branch (e.g. refs/heads/master)'
cxHeadBranch:
description: 'Github Repository Head Branch - Pull Requests (e.g. refs/heads/master)'
cxBaseBranch:
description: 'Github Repository Base Branch - Pull Requests (e.g. refs/heads/master)'
cxWorkspace:
description: 'Github Workspace Path (e.g. /home/runner/work/checkmarx-github-action/checkmarx-github-action)'
cxCommitSHA:
description: 'Github Commit SHA (e.g. 5748bf5c580dd1ce8853f26eebe123754692c18e)'
cxVersion:
description: 'Checkmarx CLI Version used (e.g. 2020.2.11)'
cxServer:
description: 'Checkmarx Server URL (e.g. https://company.checkmarx.com)'
cxAction:
description: 'Checkmarx CLI Action (e.g. Scan)'
cxLog:
description: 'Checkmarx CLI Log File Path (e.g. /home/runner/work/checkmarx-github-action/checkmarx-github-action/log.log)'
cxCliDownloadUrl:
description: 'Checkmarx CLI Download URL (e.g. https://download.checkmarx.com/9.0.0/Plugins/CxConsolePlugin-2020.2.11.zip)'
cxCliVersionFileName:
description: 'Checkmarx CLI Version File Name (e.g. CxConsolePlugin-2020.2.11)'
cxCmdExecuted:
description: 'Checkmarx CLI Executed Command (e.g. ./cxcli/runCxConsole.sh Scan -CxServer...)'
cxUsername:
description: 'Checkmarx Username'
cxToken:
description: 'Checkmarx Token'
cxPassword:
description: 'Checkmarx Password'
cxTeam:
description: 'Checkmarx Team'
cxProject:
description: 'Checkmarx Project Name'
cxPreset:
description: 'If not provided, will use preset defined in existing project or, for a new project, the default preset.'
cxHigh:
description: 'Threshold for High Severity Vulnerabilities'
cxMedium:
description: 'Threshold for Medium Severity Vulnerabilities'
cxLow:
description: 'Threshold for Low Severity Vulnerabilities'
cxComment:
description: 'Saves a comment with the scan results. For example -comment important scan.'
cxForceScan:
description: 'Force scan on source code, which has not been changed since the last scan of the same project. (Not compatible with -Incremental option.)'
cxIncremental:
description: 'Run incremental scan instead of a full scan.'
cxExcludeFolders:
description: 'Comma separated list of folder name patterns to exclude from scan. For example, exclude all test and log folders: -locationPathExclude test*,log_*'
cxExcludeFiles:
description: 'Comma separated list of file name patterns to exclude from scan. For example, exclude all files with .class extension: -locationFilesExclude *.class'
cxConfiguration:
description: 'Code language configuration. Possible values are : Default Configuration, Japanese (Shift-JIS). If configuration is not set, Default Configuration is used.'
cxPrivate:
description: 'Scan will not be visible to other users.'
cxReportXML:
description: 'SAST Scan Report in XML format'
cxReportPDF:
description: 'SAST Scan Report in PDF format'
cxReportRTF:
description: 'SAST Scan Report in RTF format'
cxReportCSV:
description: 'SAST Scan Report in CSV format'
cxVerbose:
description: 'Turns on verbose mode. All messages and events will be sent to the console or log file.'
cxOsaHigh:
description: 'OSA high severity vulnerability threshold. If the number of high vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
cxOsaMedium:
description: 'OSA medium severity vulnerability threshold. If the number of medium vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
cxOsaLow:
description: 'OSA low severity vulnerability threshold. If the number of high vulnerabilities exceeds the threshold, scan will end with an error (see Error/Exit Codes).'
cxOsaLocationPath:
description: 'Local or network path to sources or source repository branch. May include multiple list of folders (local or shared) separated by comma.'
cxOsaArchiveToExtract:
description: 'Comma separated list of file extensions to extract in the OSA scan.
For example: -OsaArchiveToExtract *.zip extracts only files with .zip extension.'
cxOsaFilesInclude:
description: 'Comma separated list of file name patterns to exclude from the OSA scan.
For example: *.dll will include only dll files.'
cxOsaFilesExclude:
description: 'Comma separated list of file name patterns to exclude from the OSA scan.
Exclude extensions by using *.<extension>, or exclude files by using */<file>.
Examples: -OsaFilesExclude *.class excludes all files which start with the .class.
Examples: -OsaFilesExclude */plexus-utils-1.5.6.jar excludes all files which start with plexus-utils-1.5.6.jar.'
cxOsaPathExclude:
description: 'Comma separated list of folder path patterns to exclude from the OSA scan.
For example: -OsaPathExclude test excludes all folders which start with test prefix.'
cxOsaReportHtml:
description: 'Generate CxOSA HTML report.'
cxOsaReportPDF:
description: 'Generate CxOSA PDF report.'
cxOsaDepth:
description: 'Extraction depth of files to include in the OSA scan.'
cxExecutePackageDependency:
description: 'Retrieve all supported package dependencies before performing OSA scan (see Remarks section).'
cxOsaJson:
description: 'Generate CxOSA JSON report.'
cxScaUsername:
description: 'SCA Username'
cxScaPassword:
description: 'SCA Password'
cxScaAccount:
description: 'SCA Account Name'
cxScaApiUrl:
description: 'SCA API URL'
cxScaAcessControlUrl:
description: 'SCA Access Control URL'
cxScaWebAppUrl:
description: 'SCA Web App URL'
cxScaHigh:
description: 'SCA High Threshold'
cxScaMedium:
description: 'SCA Medium Threshold'
cxScaLow:
description: 'SCA Low Threshold'
cxScaLocationPath:
description: 'SCA Location Path'
cxScaFilesInclude:
description: 'SCA Files Include'
cxScaFilesExclude:
description: 'SCA Files Exclude'
cxScaPathExclude:
description: 'SCA Folders Exclude'
cxCheckPolicy:
description: 'This parameter will break the build if the CxOSA policy is violated.'
cxSkipIfFail:
description: 'Skip Checkmarx Action Step if Fail'
cxTrustedCertificates:
description: 'Trust Self-signed Certificates'
cxGithubToken:
description: 'Github Token Secret'
cxGithubIssues:
description: 'Create Github Issues'
cxGithubLabels:
description: 'Github Labels for Issues created'
cxGithubAssignees:
description: 'Github Assignees for Issues created'
cxGithubMilestone:
description: 'Github Milestone for Issues created'
runs:
using: 'node12'
main: 'src/index.js'
branding:
icon: 'check'
color: 'green'