Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

review fix 21 Aug #66

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Traceable API Security Testing Plugin
<img>![img.png](img.png)</img>
<img src="docs/images/img.png"/>

# Introduction
<p align="justify">
In the world full of microservices, there are cosmic number of APIs that a single organization exposes for internal and external use. But with the advantage of APIs making microservices architecture possible, there also comes the downside of data abuse, exposure and security. More the APIs exposed, an organization becomes more and more vulnerable to API attacks such as the <a href="https://owasp.org/www-project-top-ten/">OWASPs Top 10</a>. To solve this problem <a href="www.traceable.ai">TRACEABLE AI</a> helps you by continuously securing your APIs, bringing you deep visibility, real-time protection, and threat analytics. Traceable AI combines distributed tracing and advanced context-based behavioral analytics to deliver modern API security to your cloud-native and API-based applications.
Expand Down Expand Up @@ -37,23 +38,23 @@ To get your scan token go to [app.traceable.ai](https://app.traceable.ai/) and l
<li>In the dialog "Generate new Token" and remember/note the scan token you generate.</li>
</ol>

<img src="src/main/webapp/img/Readme_get_token.png"/>
<img src="docs/images/Readme_get_token.png"/>

### 3. Add Build Step


<ol>
<li>To add AST scan job, create a new item in jenkins as a Freestyle project.</li>
<li>Add Traceable AST as the build step for the job.</li>
<img src="src/main/webapp/img/Readme_add_build.png"/>
<img src="docs/images/Readme_add_build.png"/>
<li>Fill the configuration fields for the job.</li>
<li>Click on Advanced button to fill additional configuration fields.</li>
<li>Apply and Save.</li>

</ol>
Client Token and Traffic environment are required fields and Client Token is the same as the scan token we generated.
<p></p>
<img src="src/main/webapp/img/Readme_add_configuration.png"/>
<img src="docs/images/Readme_add_configuration.png"/>

### 4. View Traceable AST Report

Expand All @@ -64,7 +65,7 @@ Client Token and Traffic environment are required fields and Client Token is the
</ol>
The scan report shows the number of vulnerabilities found for each type of plugin category.
<p></p>
<img src="src/main/webapp/img/Readme_report.png"/>
<img src="docs/images/Readme_report.png"/>

<h6>List of Available Configuration Options:</h6>

Expand Down
File renamed without changes
11 changes: 3 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>4.83</version>
<version>4.86</version>
<relativePath />
</parent>
<groupId>io.jenkins.plugins</groupId>
Expand Down Expand Up @@ -49,19 +49,14 @@
<dependency>
<!-- Pick up common dependencies for the selected LTS line: https://github.com/jenkinsci/bom#usage -->
<groupId>io.jenkins.tools.bom</groupId>
<artifactId>bom-2.332.x</artifactId>
<version>1763.v092b_8980a_f5e</version>
<artifactId>bom-2.440.x</artifactId>
<version>3276.vcd71db_867fb_2</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.aspose</groupId>
<artifactId>aspose-html</artifactId>
<version>24.5</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>structs</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import java.io.IOException;
import jenkins.tasks.SimpleBuildStep;
import lombok.extern.slf4j.Slf4j;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand Down Expand Up @@ -482,6 +483,7 @@ private void runScript(FilePath workspace, TaskListener listener, String scriptP
}

@Extension
@Symbol("scanInitAndRun")
public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

private final String STEP_NAME = "Traceable AST - Initialize and Run";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import java.io.IOException;
import jenkins.tasks.SimpleBuildStep;
import lombok.extern.slf4j.Slf4j;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand Down Expand Up @@ -424,6 +425,7 @@ private void runScript(FilePath workspace, TaskListener listener, String scriptP
}

@Extension
@Symbol("scanInit")
public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

private final String STEP_NAME = "Traceable AST - Initialize";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import hudson.util.Secret;
import java.io.IOException;
import jenkins.tasks.SimpleBuildStep;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand Down Expand Up @@ -69,6 +70,7 @@ public void perform(Run<?, ?> run, FilePath workspace, EnvVars env, Launcher lau
}

@Extension
@Symbol("scanResult")
public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

private final String STEP_NAME = "Traceable AST - Generate Scan Result";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import io.jenkins.plugins.traceable.ast.scan.utils.RunScript;
import java.io.IOException;
import jenkins.tasks.SimpleBuildStep;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand Down Expand Up @@ -96,6 +97,7 @@ private void runScript(FilePath workspace, TaskListener listener, String scriptP
}

@Extension
@Symbol("scanRun")
public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

private final String STEP_NAME = "Traceable AST - Run";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import jenkins.tasks.SimpleBuildStep;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.StringUtils;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand Down Expand Up @@ -124,6 +125,7 @@ private String runScript(
}

@Extension
@Symbol("apiInspectorRun")
public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

private final String STEP_NAME = "Traceable API Inspector";
Expand Down
Loading