com.checkmarx.sdk.config.CxProperties Maven / Gradle / Ivy
package com.checkmarx.sdk.config;
import com.checkmarx.sdk.utils.ScanUtils;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.annotation.PostConstruct;
@Component
@ConfigurationProperties(prefix = "checkmarx")
@Validated
public class CxProperties {
public static final String CONFIG_PREFIX = "sast";
private Double version = 8.9;
private String username;
private String password;
private String clientId = "resource_owner_client";
private String soapClientId = "resource_owner_sast_client";
private String clientSecret;
private String soapClientSecret;
private String scope = "sast_rest_api";
private String soapScope = "sast_api";
private String baseUrl;
private String url;
private String acUrl;
private boolean multiTenant = true;
private String teamScript;
private String projectScript;
private String scanPreset = Constants.CX_DEFAULT_PRESET;
private String configuration = Constants.CX_DEFAULT_CONFIGURATION;
private String excludeFiles;
private String excludeFolders;
private Boolean incremental = false;
private String gitClonePath;
private Integer incrementalThreshold = 7;
private Integer incrementalNumScans = 5;
private String team;
private Boolean offline = false;
private Boolean preserveXml = false;
private Integer scanTimeout = 120;
private String jiraProjectField = "jira-project";
private String jiraIssuetypeField = "jira-issuetype";
private String jiraCustomField = "jira-fields";
private String jiraAssigneeField = "jira-assignee";
private Integer httpConnectionTimeout = 30000;
private Integer httpReadTimeout = 120000;
private Integer scanPolling = 20000;
private Integer reportPolling = 5000;
private Integer reportTimeout = 300000;
private Integer codeSnippetLength = 2500;
private String TEAM_PATH_SEPARATOR_9 = "/";
private String TEAM_PATH_SEPARATOR_8 = "\\";
private String portalUrl;
// TODO:, JeffA this needs to be removed.
private String portalPackage = "checkmarx.wsdl.portal";
private String htmlStrip = "";
public String getUsername() {
return this.username;
}
public String getPassword() {
return this.password;
}
public String getClientId() {
return this.clientId;
}
public String getClientSecret() {
return this.clientSecret;
}
public String getBaseUrl() {
return this.baseUrl;
}
public String getUrl() {
return this.url;
}
public boolean isMultiTenant() {
return this.multiTenant;
}
public Boolean getIncremental() {
return this.incremental;
}
public Integer getIncrementalThreshold() {
return this.incrementalThreshold;
}
public Integer getIncrementalNumScans(){
return this.incrementalNumScans;
}
public String getScanPreset() {
return this.scanPreset;
}
public String getConfiguration() {
return this.configuration;
}
public String getTeam() {
return this.team;
}
public Boolean getOffline() {
return this.offline;
}
public Boolean getPreserveXml() {
return preserveXml;
}
public void setPreserveXml(Boolean preserveXml) {
this.preserveXml = preserveXml;
}
public Integer getScanTimeout() {
return this.scanTimeout;
}
public String getJiraProjectField() {
return this.jiraProjectField;
}
public String getJiraCustomField() {
return this.jiraCustomField;
}
public String getJiraIssuetypeField() {
return this.jiraIssuetypeField;
}
public String getPortalUrl() {
return this.portalUrl;
}
public String getPortalPackage() {
return this.portalPackage;
}
public String getHtmlStrip() {
return this.htmlStrip;
}
public void setUsername(String username) {
this.username = username;
}
public void setPassword(String password) {
this.password = password;
}
public void setClientId(String clientId) {
this.clientId = clientId;
}
public void setClientSecret(String clientSecret) {
this.clientSecret = clientSecret;
}
public void setBaseUrl(String baseUrl) {
this.baseUrl = baseUrl;
}
public void setUrl(String url) {
this.url = url;
}
public void setMultiTenant(boolean multiTenant) {
this.multiTenant = multiTenant;
}
public String getTeamScript() {
return teamScript;
}
public void setTeamScript(String teamScript) {
this.teamScript = teamScript;
}
public String getProjectScript() {
return projectScript;
}
public void setProjectScript(String projectScript) {
this.projectScript = projectScript;
}
public void setIncremental(Boolean incremental) {
this.incremental = incremental;
}
public void setIncrementalThreshold(Integer incrementalThreshold){
this.incrementalThreshold = incrementalThreshold;
}
public void setIncrementalNumScans(Integer incrementalNumScans){
this.incrementalNumScans = incrementalNumScans;
}
public void setScanPreset(String scanPreset) {
this.scanPreset = scanPreset;
}
public void setConfiguration(String configuration) {
this.configuration = configuration;
}
public void setTeam(String team) {
this.team = team;
}
public void setOffline(Boolean offline) {
this.offline = offline;
}
public void setScanTimeout(Integer scanTimeout) {
this.scanTimeout = scanTimeout;
}
public void setJiraProjectField(String jiraProjectField) {
this.jiraProjectField = jiraProjectField;
}
public void setJiraIssuetypeField(String jiraIssuetypeField) {
this.jiraIssuetypeField = jiraIssuetypeField;
}
public void setJiraCustomField(String jiraCustomField) {
this.jiraCustomField = jiraCustomField;
}
public void setPortalUrl(String portalUrl) {
this.portalUrl = portalUrl;
}
/*
public void setPortalPackage(String portalPackage) {
this.portalPackage = portalPackage;
}
*/
public void setHtmlStrip(String htmlStrip) {
this.htmlStrip = htmlStrip;
}
public String getJiraAssigneeField() {
return this.jiraAssigneeField;
}
public void setJiraAssigneeField(String jiraAssigneeField) {
this.jiraAssigneeField = jiraAssigneeField;
}
public String getExcludeFiles() {
return excludeFiles;
}
public void setExcludeFiles(String excludeFiles) {
this.excludeFiles = excludeFiles;
}
public String getExcludeFolders() {
return excludeFolders;
}
public void setExcludeFolders(String excludeFolders) {
this.excludeFolders = excludeFolders;
}
public Integer getHttpConnectionTimeout() {
return httpConnectionTimeout;
}
public void setHttpConnectionTimeout(Integer httpConnectionTimeout) {
this.httpConnectionTimeout = httpConnectionTimeout;
}
public Integer getHttpReadTimeout() {
return httpReadTimeout;
}
public void setHttpReadTimeout(Integer httpReadTimeout) {
this.httpReadTimeout = httpReadTimeout;
}
public Integer getScanPolling() {
return scanPolling;
}
public void setScanPolling(Integer scanPolling) {
this.scanPolling = scanPolling;
}
public Integer getReportTimeout() {
return reportTimeout;
}
public void setReportTimeout(Integer reportTimeout) {
this.reportTimeout = reportTimeout;
}
public Double getVersion() {
return version;
}
public void setVersion(Double version) {
this.version = version;
}
public String getAcUrl() {
return acUrl;
}
public void setAcUrl(String acUrl) {
this.acUrl = acUrl;
}
public String getScope() {
return scope;
}
public void setScope(String scope) {
this.scope = scope;
}
public Integer getReportPolling() {
return reportPolling;
}
public void setReportPolling(Integer reportPolling) {
this.reportPolling = reportPolling;
}
public Boolean getEnableOsa() {
//return enableOsa;
return false;
}
public Integer getCodeSnippetLength() {
return codeSnippetLength;
}
public void setCodeSnippetLength(Integer codeSnippetLength) {
this.codeSnippetLength = codeSnippetLength;
}
public String getSoapClientId() {
return soapClientId;
}
public void setSoapClientId(String soapClientId) {
this.soapClientId = soapClientId;
}
public String getSoapClientSecret() {
if(ScanUtils.empty(soapClientSecret)){
return clientSecret; //default to clientSecret that was provided
}
return soapClientSecret;
}
public void setSoapClientSecret(String soapClientSecret) {
this.soapClientSecret = soapClientSecret;
}
public String getSoapScope() {
return soapScope;
}
public void setSoapScope(String soapScope) {
this.soapScope = soapScope;
}
public String getTeamPathSeparator(){
if(version < 9.0){
return TEAM_PATH_SEPARATOR_8;
}
else{
return TEAM_PATH_SEPARATOR_9;
}
}
public String getGitClonePath(){
if(this.gitClonePath == null){
if (System.getProperty("os.name").startsWith("Windows")) {
// includes: Windows 2000, Windows 95, Windows 98, Windows NT, Windows Vista, Windows XP
return Constants.WINDOWS_PATH;
} else {
// everything else
return Constants.UNIX_PATH;
}
}
else {
return this.gitClonePath;
}
}
public void setGitClonePath(String gitClonePath) {
this.gitClonePath = gitClonePath;
}
@PostConstruct
private void initTeam(){
if(team != null && !team.startsWith(getTeamPathSeparator())){
this.team = getTeamPathSeparator().concat(this.team);
}
}
}