JarCastingcheckmarx-spring-boot-java-sdk
Java Spring Boot SDK for Checkmarx
Artifacts
Maven artifacts are stored on Sonatype nexus repository manager (synced to maven central) https://oss.sonatype.org/service/local/repositories/releases/content/com/github/checkmarx-ts/cx-spring-boot-sdk/x.x.x/cx-spring-boot-sdk-x.x.x.jar
Note: Check maven version in current pom.xml
Build
mvnw clean build
Note: add -DskipTests -Dgpg.skip flags to skip integration testing and gpg code signing (required for Sonatype)
Usage
Gradle
Include the following dependency in your maven project
compile('com.github.checkmarx-ts:cx-spring-boot-sdk:X.X.X')
Maven
Include the following dependency in your maven project
<dependency>
<groupId>com.github.checkmarx-ts</groupId>
<artifactId>cx-spring-boot-sdk</artifactId>
<version>X.X.X</version>
</dependency>
Main Spring Boot Application
In the main spring boot application entry endpoint the following package scan must be added: com.checkmarx.sdk
@SpringBootApplication(scanBasePackages={"com.checkmarx.sdk","xxxx.xxxx.xxxx", ...})
CxClient Interface usage
Inject the dependency of CxClient / CxAuthClient / CxOsaClient (WIP). This will inject the service bean to make calls to Checkmarx with
@Component
@Command
public class SampleComponent {
private static final Logger log = org.slf4j.LoggerFactory.getLogger(SampleComponent.class);
private final CxClient cxClient;
Configuration
Checkmarx Specific properties are loaded from CxProperties class (config package).
checkmarx:
version: 9.0 #default is 8.9
username: xxxxx
password: xxxxx
client-secret: xxxxx
base-url: http://cx.local
multi-tenant: true
configuration: Default Configuration
scan-preset: Checkmarx Default
team: \CxServer\SP\Checkmarx #team path separator is / in 9.0+
url: ${checkmarx.base-url}/cxrestapi
#WSDL Config
portal-url: ${checkmarx.base-url}/cxwebinterface/Portal/CxWebService.asmx
These values can be injected at runtime by using environment variables and/or command line parameters. See the following: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html
Note: The only required properties are username/password/base-url/team
