1. checkmarx-ts/cxflow@1.0.6

checkmarx-ts/cxflow@1.0.6

Partner
Sections
Checkmarx CxFlow orb for executing Checkmarx Scans and Publishing results to various feedback channels. Additional information regarding Checkmarx can be found here: https://checkmarx.atlassian.net/wiki/spaces/KC/overview Additional information regarding CxFlow can be found here: https://github.com/checkmarx-ltd/cx-flow/wiki The following Environment Variables must be set within your CircleCI project for this orb to function: CHECKMARX_URL: High level dns entry for the Checkmarx Instance including protocol/port (i.e. https://cxsast.example.com) CHECKMARX_USERNAME: Service Account within Checkmarx that will be used for triggering scans and retrieving results CHECKMARX_PASSWORD: Password of the Service Account. CHECKMARX_CLIENT_SECRET: Client secret key associated with your Checkmarx SAST account AST_CLIENT_ID: Service account Client ID for Checkmarx AST AST_CLIENT_SECRET: Client secret key associated with your Checkmarx AST account SCA_USERNAME: Service Account within Checkmarx SCA that will be used for triggering scans and retrieving results SCA_PASSWORD: Password of the Checkmarx SCA Service Account SCA_TENANT: Tenant information of the Checkmarx SCA account CXGO_CLIENT_SECRET: Client secret key associated with your Checkmarx CxGo account
Created: May 12, 2020Version Published: March 30, 2022Releases: 7
Org Usage:
< 25

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: cxflow: checkmarx-ts/cxflow@1.0.6

Use cxflow elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Usage Examples

checkmarx-results-command

Retrieve latest results for a given Checkmarx project and store a Json Vulnerability report as an artifact

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 jobs: cx-results: executor: cxflow/default steps: - cxflow/results: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 project: Riches report-file: checkmarx-results.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx - store_artifacts: path: checkmarx-results.json orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-results: jobs: - cx-results: filters: branches: only: master version: 2

checkmarx-results-job

Checkout code and run Checkmarx Scan and store the report as an artifact

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 orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cxflow/results: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 filters: branches: only: - master project: CxProject report-file: vulns.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx version: 2

checkmarx-scan-command

Checkout code, run Checkmarx Scan, wait for results and store a Json Vulnerability report as an artifact

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 jobs: cx-scan: executor: cxflow/default steps: - checkout - cxflow/scan: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 preset: Checkmarx Express report-file: checkmarx.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx - store_artifacts: path: checkmarx.json orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cx-scan: filters: branches: only: master version: 2

checkmarx-scan-job

Retrieve latest results for a given Checkmarx project and store a Json Vulnerability report as an artifact

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 orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cxflow/scan: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 filters: branches: only: - master preset: Checkmarx Express project: CxProject report-file: vulns.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx version: 2

Jobs

results

Job to retrieve the latest Checkmarx scan results and publish results in in Json format or using a desired bug tracker supported by CxFlow

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app
Select an Application Name used by downstream bug tracker systems
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
apply-filters
Select report filter criteria
No
'--filter-severity=High --filter-severity=Medium --filter-severity=Low'
string
ast-apiUrl
AST scan API URL
No
''
string
ast-incremental
AST scan incremental?
No
false
boolean
ast-preset
Preset for Checkmarx AST Scan
No
Checkmarx Default
string
ast-webAppUrl
AST scan Web App URL
No
''
string
auth-scopes
Checkmarx Access Control Scopes
No
sast_rest_api
string
break
Break build based on Checkmarx findings?
No
false
boolean
bug-tracker
Select a proper bug tracker
No
Json
string
checkmarx-url
Provide Checkmarx URL
No
${CHECKMARX_URL}
string
cxgo-base-url
Base URL for CxGo scan
No
https://api.checkmarx.net
string
cxgo-configuration
Configuration for CxGo scan
No
''
string
cxgo-multi-tenant
Multi Tenant for CxGo
No
true
boolean
cxgo-portal-url
Portal URL for CxGo scan
No
https://cloud.checkmarx.net
string
cxgo-scan-preset
Scan presets for CxGo
No
''
string
no-output-timeout
Use this to configure the no_output_timeout value of the test run
No
10m
string
params
Additional CLI parameters
No
''
string
project
Select a Checkmarx Project
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
report-file
Report filename
No
cx.json
string
report-folder
Folder to save report
No
./
string
sca-accessControlUrl
SCA SCAN Access Control URL
No
''
string
sca-apiUrl
SCA Scan API URL
No
''
string
sca-appUrl
SCA Scan URL
No
''
string
scanners
Vulnerabiility scanners
No
sast
string
tag
Select a Checkmarx version
No
latest
string
team
Select a Checkmarx Team
No
\CxServer\SP\Company
string
version
Select a Checkmarx version
No
'8.9'
string

scan

Job to trigger scans of current code base to Checkmarx and publish results in in Json format or using a desired bug tracker supported by CxFlow

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app
Select an Application Name used by downstream bug tracker systems
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
apply-filters
Select report filter criteria
No
'--filter-severity=High --filter-severity=Medium --filter-severity=Low'
string
ast-apiUrl
AST scan API URL
No
''
string
ast-incremental
AST scan incremental?
No
false
boolean
ast-preset
Preset for Checkmarx AST Scan
No
Checkmarx Default
string
ast-webAppUrl
AST scan Web App URL
No
''
string
auth-scopes
Checkmarx Access Control Scopes
No
sast_rest_api
string
break
Break build based on Checkmarx findings?
No
false
boolean
bug-tracker
Select a proper bug tracker
No
Json
string
checkmarx-url
Provide Checkmarx URL
No
${CHECKMARX_URL}
string
cxgo-base-url
Base URL for CxGo scan
No
https://api.checkmarx.net
string
cxgo-configuration
Configuration for CxGo scan
No
''
string
cxgo-multi-tenant
Multi Tenant for CxGo
No
true
boolean
cxgo-portal-url
Portal URL for CxGo scan
No
https://cloud.checkmarx.net
string
cxgo-scan-preset
Scan presets for CxGo
No
''
string
incremental
Incremental Scans?
No
true
boolean
no-output-timeout
Use this to configure the no_output_timeout value of the test run
No
10m
string
params
Additional CLI parameters
No
''
string
preset
Select a Checkmarx Preset
No
Checkmarx Express
string
project
Select a Checkmarx Project
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
report-file
Report filename
No
cx.json
string
report-folder
Folder to save report
No
./
string
sca-accessControlUrl
SCA SCAN Access Control URL
No
''
string
sca-apiUrl
SCA Scan API URL
No
''
string
sca-appUrl
SCA Scan URL
No
''
string
scan-configuration
Select a Scan Engine Configuration
No
Default Configuration
string
scan-timeout
Maximum time to wait for a scan to complete (in minutes)
No
120
integer
scanners
Vulnerabiility scanners
No
sast
string
tag
Select a Checkmarx version
No
latest
string
team
Select a Checkmarx Team
No
\CxServer\SP\Company
string
version
Select a Checkmarx version
No
'8.9'
string

Commands

results

Command is used to retrieve the latest Checkmarx scan results and publish results in in Json format or using a desired bug tracker supported by CxFlow

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app
Select an Application Name used by downstream bug tracker systems
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
apply-filters
Select report filter criteria
No
'--filter-severity=High --filter-severity=Medium --filter-severity=Low'
string
ast-apiUrl
AST scan API URL
No
''
string
ast-incremental
AST scan incremental?
No
false
boolean
ast-preset
Preset for Checkmarx AST Scan
No
Checkmarx Default
string
ast-webAppUrl
AST scan Web App URL
No
''
string
auth-scopes
Checkmarx Access Control Scopes
No
sast_rest_api
string
break
Break build based on Checkmarx findings?
No
false
boolean
bug-tracker
Select a proper bug tracker
No
Json
string
checkmarx-url
Provide Checkmarx URL
No
${CHECKMARX_URL}
string
cxgo-base-url
Base URL for CxGo scan
No
https://api.checkmarx.net
string
cxgo-configuration
Configuration for CxGo scan
No
''
string
cxgo-multi-tenant
Multi Tenant for CxGo
No
true
boolean
cxgo-portal-url
Portal URL for CxGo scan
No
https://cloud.checkmarx.net
string
cxgo-scan-preset
Scan presets for CxGo
No
''
string
no-output-timeout
Use this to configure the no_output_timeout value of the test run
No
10m
string
params
Additional CLI parameters
No
''
string
project
Select a Checkmarx Project
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
report-file
Report filename
No
cx.json
string
report-folder
Folder to save report
No
./
string
sca-accessControlUrl
SCA SCAN Access Control URL
No
''
string
sca-apiUrl
SCA Scan API URL
No
''
string
sca-appUrl
SCA Scan APP URL
No
''
string
scanners
Vulnerabiility scanners
No
sast
string
team
Select a Checkmarx Team
No
\CxServer\SP\Company
string
version
Select a Checkmarx version
No
'8.9'
string

scan

Command is used to trigger scans to Checkmarx and publish results in in Json format or using a desired bug tracker supported by CxFlow

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
app
Select an Application Name used by downstream bug tracker systems
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
apply-filters
Select report filter criteria
No
'--filter-severity=High --filter-severity=Medium --filter-severity=Low'
string
ast-apiUrl
AST scan API URL
No
''
string
ast-incremental
AST scan incremental?
No
false
boolean
ast-preset
Preset for Checkmarx AST Scan
No
Checkmarx Default
string
ast-webAppUrl
AST scan Web App URL
No
''
string
auth-scopes
Checkmarx Access Control Scopes
No
sast_rest_api
string
break
Break build based on Checkmarx findings?
No
false
boolean
bug-tracker
Select a proper bug tracker
No
Json
string
checkmarx-url
Provide Checkmarx URL
No
${CHECKMARX_URL}
string
cxgo-base-url
Base URL for CxGo scan
No
https://api.checkmarx.net
string
cxgo-configuration
Configuration for CxGo scan
No
''
string
cxgo-multi-tenant
Multi Tenant for CxGo
No
true
boolean
cxgo-portal-url
Portal URL for CxGo scan
No
https://cloud.checkmarx.net
string
cxgo-scan-preset
Scan presets for CxGo
No
''
string
incremental
Incremental Scans?
No
true
boolean
no-output-timeout
Use this to configure the no_output_timeout value of the test run
No
10m
string
params
Additional CLI parameters
No
''
string
preset
Select a Checkmarx Preset
No
Checkmarx Express
string
project
Select a Checkmarx Project
No
${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH}
string
report-file
Report filename
No
cx.json
string
report-folder
Folder to save report
No
./
string
sca-accessControlUrl
SCA SCAN Access Control URL
No
''
string
sca-apiUrl
SCA Scan API URL
No
''
string
sca-appUrl
SCA Scan APP URL
No
''
string
scan-configuration
Select a Scan Engine Configuration
No
Default Configuration
string
scan-timeout
Maximum time to wait for a scan to complete (in minutes)
No
120
integer
scanners
Vulnerabiility scanners
No
sast
string
team
Select a Checkmarx Team
No
\CxServer\SP\Company
string
version
Select a Checkmarx version
No
'9.4'
string

Executors

default

Select version of CxFlow to use. Any available tag from this list can be used: https://hub.docker.com/r/checkmarx/cx-flow/tags

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
tag
Pick a specific checkmarx/cx-flow image variant: https://hub.docker.com/r/checkmarx/cx-flow/tags
No
latest
string

Orb Source

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 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing commands: results: description: | Command is used to retrieve the latest Checkmarx scan results and publish results in in Json format or using a desired bug tracker supported by CxFlow parameters: app: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select an Application Name used by downstream bug tracker systems type: string apply-filters: default: --filter-severity=High --filter-severity=Medium --filter-severity=Low description: Select report filter criteria type: string ast-apiUrl: default: "" description: AST scan API URL type: string ast-incremental: default: false description: AST scan incremental? type: boolean ast-preset: default: Checkmarx Default description: Preset for Checkmarx AST Scan type: string ast-webAppUrl: default: "" description: AST scan Web App URL type: string auth-scopes: default: sast_rest_api description: Checkmarx Access Control Scopes type: string break: default: false description: Break build based on Checkmarx findings? type: boolean bug-tracker: default: Json description: Select a proper bug tracker type: string checkmarx-url: default: ${CHECKMARX_URL} description: Provide Checkmarx URL type: string cxgo-base-url: default: https://api.checkmarx.net description: Base URL for CxGo scan type: string cxgo-configuration: default: "" description: Configuration for CxGo scan type: string cxgo-multi-tenant: default: true description: Multi Tenant for CxGo type: boolean cxgo-portal-url: default: https://cloud.checkmarx.net description: Portal URL for CxGo scan type: string cxgo-scan-preset: default: "" description: Scan presets for CxGo type: string no-output-timeout: default: 10m description: | Use this to configure the no_output_timeout value of the test run type: string params: default: "" description: Additional CLI parameters type: string project: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select a Checkmarx Project type: string report-file: default: cx.json description: Report filename type: string report-folder: default: ./ description: Folder to save report type: string sca-accessControlUrl: default: "" description: SCA SCAN Access Control URL type: string sca-apiUrl: default: "" description: SCA Scan API URL type: string sca-appUrl: default: "" description: SCA Scan APP URL type: string scanners: default: sast description: Vulnerabiility scanners type: string team: default: \CxServer\SP\Company description: Select a Checkmarx Team type: string version: default: "8.9" description: Select a Checkmarx version type: string steps: - run: command: | java -jar /app/cx-flow.jar \ --project \ --cx-team="<< parameters.team >>" \ --cx-project="<< parameters.project >>" \ --app="<< parameters.app >>" \ --spring.profiles.active="<< parameters.scanners >>" \ --cx-flow.enabled-vulnerability-scanners="<< parameters.scanners >>" \ --cx-flow.bug-tracker="<< parameters.bug-tracker >>" \ --cx-flow.bug-tracker-impl="<< parameters.bug-tracker >>" \ << parameters.apply-filters >> \ --checkmarx.version=<< parameters.version >> \ --checkmarx.scope="<< parameters.auth-scopes >>" \ --checkmarx.url="<< parameters.checkmarx-url >>/cxrestapi" \ --checkmarx.portal-url="<< parameters.checkmarx-url >>/cxwebinterface/Portal/CxWebService.asmx" \ --sca.appUrl="<< parameters.sca-appUrl >>" \ --sca.apiUrl="<< parameters.sca-apiUrl >>" \ --sca.accessControlUrl="<< parameters.sca-accessControlUrl >>" \ --ast.apiUrl="<< parameters.ast-apiUrl >>" \ --ast.preset="<< parameters.ast-preset >>" \ --ast.incremental="<< parameters.ast-incremental >>" \ --ast.webAppUrl="<< parameters.ast-webAppUrl >>" \ --cxgo.team="<< parameters.team >>" \ --cxgo.base-url="<< parameters.cxgo-base-url >>" \ --cxgo.portal-url="<< parameters.cxgo-portal-url >>" \ --cxgo.multi-tenant="<< parameters.cxgo-multi-tenant >>" \ --cxgo.configuration="<< parameters.cxgo-configuration >>" \ --cxgo.scan-preset="<< parameters.cxgo-scan-preset >>" \ --json.file-name-format="<< parameters.report-file >>" \ --json.data-folder="<< parameters.report-folder >>" \ << parameters.params >> name: Checkmarx Results no_output_timeout: << parameters.no-output-timeout >> scan: description: | Command is used to trigger scans to Checkmarx and publish results in in Json format or using a desired bug tracker supported by CxFlow parameters: app: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select an Application Name used by downstream bug tracker systems type: string apply-filters: default: --filter-severity=High --filter-severity=Medium --filter-severity=Low description: Select report filter criteria type: string ast-apiUrl: default: "" description: AST scan API URL type: string ast-incremental: default: false description: AST scan incremental? type: boolean ast-preset: default: Checkmarx Default description: Preset for Checkmarx AST Scan type: string ast-webAppUrl: default: "" description: AST scan Web App URL type: string auth-scopes: default: sast_rest_api description: Checkmarx Access Control Scopes type: string break: default: false description: Break build based on Checkmarx findings? type: boolean bug-tracker: default: Json description: Select a proper bug tracker type: string checkmarx-url: default: ${CHECKMARX_URL} description: Provide Checkmarx URL type: string cxgo-base-url: default: https://api.checkmarx.net description: Base URL for CxGo scan type: string cxgo-configuration: default: "" description: Configuration for CxGo scan type: string cxgo-multi-tenant: default: true description: Multi Tenant for CxGo type: boolean cxgo-portal-url: default: https://cloud.checkmarx.net description: Portal URL for CxGo scan type: string cxgo-scan-preset: default: "" description: Scan presets for CxGo type: string incremental: default: true description: Incremental Scans? type: boolean no-output-timeout: default: 10m description: | Use this to configure the no_output_timeout value of the test run type: string params: default: "" description: Additional CLI parameters type: string preset: default: Checkmarx Express description: Select a Checkmarx Preset type: string project: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select a Checkmarx Project type: string report-file: default: cx.json description: Report filename type: string report-folder: default: ./ description: Folder to save report type: string sca-accessControlUrl: default: "" description: SCA SCAN Access Control URL type: string sca-apiUrl: default: "" description: SCA Scan API URL type: string sca-appUrl: default: "" description: SCA Scan APP URL type: string scan-configuration: default: Default Configuration description: Select a Scan Engine Configuration type: string scan-timeout: default: 120 description: Maximum time to wait for a scan to complete (in minutes) type: integer scanners: default: sast description: Vulnerabiility scanners type: string team: default: \CxServer\SP\Company description: Select a Checkmarx Team type: string version: default: "9.4" description: Select a Checkmarx version type: string steps: - run: command: | java -jar /app/cx-flow.jar \ --scan \ --cx-team="<< parameters.team >>" \ --cx-project="<< parameters.project >>" \ --app="<< parameters.app >>" \ --spring.profiles.active="<< parameters.scanners >>" \ --f=. \ --cx-flow.bug-tracker="<< parameters.bug-tracker >>" \ --cx-flow.bug-tracker-impl="<< parameters.bug-tracker >>" \ --cx-flow.enabled-vulnerability-scanners="<< parameters.scanners >>" \ << parameters.apply-filters >> \ --checkmarx.version=<< parameters.version >> \ --checkmarx.scope="<< parameters.auth-scopes >>" \ --checkmarx.url="<< parameters.checkmarx-url >>/cxrestapi" \ --checkmarx.portal-url="<< parameters.checkmarx-url >>/cxwebinterface/Portal/CxWebService.asmx" \ --checkmarx.incremental=<< parameters.incremental >> \ --checkmarx.scan-preset="<< parameters.preset >>" \ --checkmarx.configuration="<< parameters.scan-configuration >>" \ --checkmarx.scan-timeout=<< parameters.scan-timeout >> \ --sca.appUrl="<< parameters.sca-appUrl >>" \ --sca.apiUrl="<< parameters.sca-apiUrl >>" \ --sca.accessControlUrl="<< parameters.sca-accessControlUrl >>" \ --ast.apiUrl="<< parameters.ast-apiUrl >>" \ --ast.preset="<< parameters.ast-preset >>" \ --ast.incremental="<< parameters.ast-incremental >>" \ --ast.webAppUrl="<< parameters.ast-webAppUrl >>" \ --cxgo.team="<< parameters.team >>" \ --cxgo.base-url="<< parameters.cxgo-base-url >>" \ --cxgo.portal-url="<< parameters.cxgo-portal-url >>" \ --cxgo.multi-tenant="<< parameters.cxgo-multi-tenant >>" \ --cxgo.configuration="<< parameters.cxgo-configuration >>" \ --cxgo.scan-preset="<< parameters.cxgo-scan-preset >>" \ --json.file-name-format="<< parameters.report-file >>" \ --json.data-folder="<< parameters.report-folder >>" \ << parameters.params >> name: Checkmarx Scan no_output_timeout: << parameters.no-output-timeout >> description: | Checkmarx CxFlow orb for executing Checkmarx Scans and Publishing results to various feedback channels. Additional information regarding Checkmarx can be found here: https://checkmarx.atlassian.net/wiki/spaces/KC/overview Additional information regarding CxFlow can be found here: https://github.com/checkmarx-ltd/cx-flow/wiki The following Environment Variables must be set within your CircleCI project for this orb to function: CHECKMARX_URL: High level dns entry for the Checkmarx Instance including protocol/port (i.e. https://cxsast.example.com) CHECKMARX_USERNAME: Service Account within Checkmarx that will be used for triggering scans and retrieving results CHECKMARX_PASSWORD: Password of the Service Account. CHECKMARX_CLIENT_SECRET: Client secret key associated with your Checkmarx SAST account AST_CLIENT_ID: Service account Client ID for Checkmarx AST AST_CLIENT_SECRET: Client secret key associated with your Checkmarx AST account SCA_USERNAME: Service Account within Checkmarx SCA that will be used for triggering scans and retrieving results SCA_PASSWORD: Password of the Checkmarx SCA Service Account SCA_TENANT: Tenant information of the Checkmarx SCA account CXGO_CLIENT_SECRET: Client secret key associated with your Checkmarx CxGo account display: home_url: https://www.checkmarx.com source_url: https://github.com/checkmarx-ts/checkmarx-cxflow-orb examples: checkmarx-results-command: description: | Retrieve latest results for a given Checkmarx project and store a Json Vulnerability report as an artifact usage: jobs: cx-results: executor: cxflow/default steps: - cxflow/results: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 project: Riches report-file: checkmarx-results.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx - store_artifacts: path: checkmarx-results.json orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-results: jobs: - cx-results: filters: branches: only: master version: 2 checkmarx-results-job: description: | Checkout code and run Checkmarx Scan and store the report as an artifact usage: orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cxflow/results: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 filters: branches: only: - master project: CxProject report-file: vulns.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx version: 2 checkmarx-scan-command: description: | Checkout code, run Checkmarx Scan, wait for results and store a Json Vulnerability report as an artifact usage: jobs: cx-scan: executor: cxflow/default steps: - checkout - cxflow/scan: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 preset: Checkmarx Express report-file: checkmarx.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx - store_artifacts: path: checkmarx.json orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cx-scan: filters: branches: only: master version: 2 checkmarx-scan-job: description: | Retrieve latest results for a given Checkmarx project and store a Json Vulnerability report as an artifact usage: orbs: cxflow: checkmarx-ts/cxflow@1.0.5 version: 2.1 workflows: sast-scan: jobs: - cxflow/scan: ast-apiUrl: http://cx-ast-testing.dev.checkmarx-ts.com ast-incremental: false ast-preset: Checkmarx Default ast-webAppUrl: http://cx-ast-testing.dev.checkmarx-ts.com cxgo-base-url: https://api.checkmarx.net cxgo-configuration: Default Configuration cxgo-multi-tenant: true cxgo-portal-url: https://cloud.checkmarx.net cxgo-scan-preset: 1,2,3,4,5,9 filters: branches: only: - master preset: Checkmarx Express project: CxProject report-file: vulns.json sca-accessControlUrl: https://platform.checkmarx.net sca-apiUrl: https://api.scacheckmarx.com sca-appUrl: https://sca.scacheckmarx.com scanners: sca,ast,cxgo,sast team: \CxServer\SP\Checkmarx version: 2 executors: default: description: | Select version of CxFlow to use. Any available tag from this list can be used: https://hub.docker.com/r/checkmarx/cx-flow/tags docker: - image: checkmarx/cx-flow:<<parameters.tag>> parameters: tag: default: latest description: | Pick a specific checkmarx/cx-flow image variant: https://hub.docker.com/r/checkmarx/cx-flow/tags type: string jobs: results: description: | Job to retrieve the latest Checkmarx scan results and publish results in in Json format or using a desired bug tracker supported by CxFlow executor: name: default tag: << parameters.tag >> parameters: app: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select an Application Name used by downstream bug tracker systems type: string apply-filters: default: --filter-severity=High --filter-severity=Medium --filter-severity=Low description: Select report filter criteria type: string ast-apiUrl: default: "" description: AST scan API URL type: string ast-incremental: default: false description: AST scan incremental? type: boolean ast-preset: default: Checkmarx Default description: Preset for Checkmarx AST Scan type: string ast-webAppUrl: default: "" description: AST scan Web App URL type: string auth-scopes: default: sast_rest_api description: Checkmarx Access Control Scopes type: string break: default: false description: Break build based on Checkmarx findings? type: boolean bug-tracker: default: Json description: Select a proper bug tracker type: string checkmarx-url: default: ${CHECKMARX_URL} description: Provide Checkmarx URL type: string cxgo-base-url: default: https://api.checkmarx.net description: Base URL for CxGo scan type: string cxgo-configuration: default: "" description: Configuration for CxGo scan type: string cxgo-multi-tenant: default: true description: Multi Tenant for CxGo type: boolean cxgo-portal-url: default: https://cloud.checkmarx.net description: Portal URL for CxGo scan type: string cxgo-scan-preset: default: "" description: Scan presets for CxGo type: string no-output-timeout: default: 10m description: | Use this to configure the no_output_timeout value of the test run type: string params: default: "" description: Additional CLI parameters type: string project: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select a Checkmarx Project type: string report-file: default: cx.json description: Report filename type: string report-folder: default: ./ description: Folder to save report type: string sca-accessControlUrl: default: "" description: SCA SCAN Access Control URL type: string sca-apiUrl: default: "" description: SCA Scan API URL type: string sca-appUrl: default: "" description: SCA Scan URL type: string scanners: default: sast description: Vulnerabiility scanners type: string tag: default: latest description: Select a Checkmarx version type: string team: default: \CxServer\SP\Company description: Select a Checkmarx Team type: string version: default: "8.9" description: Select a Checkmarx version type: string steps: - checkout - results: app: << parameters.app >> apply-filters: << parameters.apply-filters >> ast-apiUrl: << parameters.ast-apiUrl >> ast-incremental: << parameters.ast-incremental >> ast-preset: << parameters.ast-preset >> ast-webAppUrl: << parameters.ast-webAppUrl >> auth-scopes: << parameters.auth-scopes >> bug-tracker: << parameters.bug-tracker >> checkmarx-url: << parameters.checkmarx-url >> cxgo-base-url: << parameters.cxgo-base-url >> cxgo-configuration: << parameters.cxgo-configuration >> cxgo-multi-tenant: << parameters.cxgo-multi-tenant >> cxgo-portal-url: << parameters.cxgo-portal-url >> cxgo-scan-preset: << parameters.cxgo-scan-preset >> no-output-timeout: << parameters.no-output-timeout >> params: << parameters.params >> project: << parameters.project >> report-file: << parameters.report-file >> report-folder: << parameters.report-folder >> sca-accessControlUrl: << parameters.sca-accessControlUrl >> sca-apiUrl: << parameters.sca-apiUrl >> sca-appUrl: << parameters.sca-appUrl >> scanners: << parameters.scanners >> team: << parameters.team >> version: << parameters.version >> - store_artifacts: path: << parameters.report-file >> scan: description: | Job to trigger scans of current code base to Checkmarx and publish results in in Json format or using a desired bug tracker supported by CxFlow executor: name: default tag: << parameters.tag >> parameters: app: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select an Application Name used by downstream bug tracker systems type: string apply-filters: default: --filter-severity=High --filter-severity=Medium --filter-severity=Low description: Select report filter criteria type: string ast-apiUrl: default: "" description: AST scan API URL type: string ast-incremental: default: false description: AST scan incremental? type: boolean ast-preset: default: Checkmarx Default description: Preset for Checkmarx AST Scan type: string ast-webAppUrl: default: "" description: AST scan Web App URL type: string auth-scopes: default: sast_rest_api description: Checkmarx Access Control Scopes type: string break: default: false description: Break build based on Checkmarx findings? type: boolean bug-tracker: default: Json description: Select a proper bug tracker type: string checkmarx-url: default: ${CHECKMARX_URL} description: Provide Checkmarx URL type: string cxgo-base-url: default: https://api.checkmarx.net description: Base URL for CxGo scan type: string cxgo-configuration: default: "" description: Configuration for CxGo scan type: string cxgo-multi-tenant: default: true description: Multi Tenant for CxGo type: boolean cxgo-portal-url: default: https://cloud.checkmarx.net description: Portal URL for CxGo scan type: string cxgo-scan-preset: default: "" description: Scan presets for CxGo type: string incremental: default: true description: Incremental Scans? type: boolean no-output-timeout: default: 10m description: | Use this to configure the no_output_timeout value of the test run type: string params: default: "" description: Additional CLI parameters type: string preset: default: Checkmarx Express description: Select a Checkmarx Preset type: string project: default: ${CIRCLE_PROJECT_REPONAME}-${CIRCLE_BRANCH} description: Select a Checkmarx Project type: string report-file: default: cx.json description: Report filename type: string report-folder: default: ./ description: Folder to save report type: string sca-accessControlUrl: default: "" description: SCA SCAN Access Control URL type: string sca-apiUrl: default: "" description: SCA Scan API URL type: string sca-appUrl: default: "" description: SCA Scan URL type: string scan-configuration: default: Default Configuration description: Select a Scan Engine Configuration type: string scan-timeout: default: 120 description: Maximum time to wait for a scan to complete (in minutes) type: integer scanners: default: sast description: Vulnerabiility scanners type: string tag: default: latest description: Select a Checkmarx version type: string team: default: \CxServer\SP\Company description: Select a Checkmarx Team type: string version: default: "8.9" description: Select a Checkmarx version type: string steps: - checkout - scan: app: << parameters.app >> apply-filters: << parameters.apply-filters >> ast-apiUrl: << parameters.ast-apiUrl >> ast-incremental: << parameters.ast-incremental >> ast-preset: << parameters.ast-preset >> ast-webAppUrl: << parameters.ast-webAppUrl >> auth-scopes: << parameters.auth-scopes >> bug-tracker: << parameters.bug-tracker >> checkmarx-url: << parameters.checkmarx-url >> cxgo-base-url: << parameters.cxgo-base-url >> cxgo-configuration: << parameters.cxgo-configuration >> cxgo-multi-tenant: << parameters.cxgo-multi-tenant >> cxgo-portal-url: << parameters.cxgo-portal-url >> cxgo-scan-preset: << parameters.cxgo-scan-preset >> incremental: << parameters.incremental >> no-output-timeout: << parameters.no-output-timeout >> params: << parameters.params >> preset: << parameters.preset >> project: << parameters.project >> report-file: << parameters.report-file >> report-folder: << parameters.report-folder >> sca-accessControlUrl: << parameters.sca-accessControlUrl >> sca-apiUrl: <<parameters.sca-apiUrl >> sca-appUrl: << parameters.sca-appUrl >> scan-configuration: << parameters.scan-configuration >> scan-timeout: << parameters.scan-timeout >> scanners: <<parameters.scanners >> team: << parameters.team >> version: << parameters.version >> - store_artifacts: path: << parameters.report-file >> version: 2.1
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.