com.contrastsecurity.sdk

Class ContrastSDK

java.lang.Object

com.contrastsecurity.sdk.ContrastSDK

public class ContrastSDK
extends Object

Entry point for using the Contrast REST API. Make an instance of this class and call methods. Easy!

Constructor Summary

Constructors

Constructor and Description
ContrastSDK()
ContrastSDK(String user, String serviceKey, String apiKey) Create a ContrastSDK object that attempts to use the Contrast V3 API.
ContrastSDK(String user, String serviceKey, String apiKey, String restApiURL) Create a ContrastSDK object that will attempt to use the Contrast V3 API

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getAgent(AgentType type, String organizationId) Download a contrast.jar agent associated with this account.
byte[]	getAgent(AgentType type, String organizationId, String profileName) Download a contrast.jar agent associated with this account.
Applications	getApplication(String organizationId, String appId)
Applications	getApplication(String organizationId, String appId, EnumSet<FilterForm.ApplicationExpandValues> expandValues) Get summary information about a single app.
Applications	getApplications(String organizationId) Get the list of applications being monitored by Contrast.
Coverage	getCoverage(String organizationId, String appId) Return coverage data about the monitored Contrast application.
Libraries	getLibraries(String organizationId, String appId)
Libraries	getLibraries(String organizationId, String appId, EnumSet<FilterForm.LibrariesExpandValues> expandValues) Return the libraries of the monitored Contrast application.
Organizations	getProfileDefaultOrganizations() Get the default organization for the user profile.
Organizations	getProfileOrganizations() Get all organizations for the user profile.
Rules	getRules(String organizationId) Get the rules for an organization
Servers	getServers(String organizationId, ServerFilterForm filterForm) Return the servers of the monitored Contrast application.
Servers	getServersWithFilter(String organizationId, ServerFilterForm filterForm) Return the servers of the monitored Contrast application.
Traces	getTraceFilterByRule(String organizationId, String appId, String ruleId, FilterForm form) Get the vulnerabilities in the application by the rule.
TraceListing	getTraceListing(String organizationId, String appId) Get the listing for the traces in the application.
Traces	getTraces(String organizationId, String appId, EnumSet<FilterForm.TraceExpandValue> expandValues) Get the vulnerabilities in the application whose ID is passed in.
Traces	getTracesWithFilter(String organizationId, String appId, FilterForm form) Get the vulnerabilities in the application whose ID is passed in with a filter.
Traces	getTracesWithFilter(String organizationId, String appId, String traceFilterType, String keycode, FilterForm form) Get the vulnerabilities in the application whose ID is passed in with a filter.
static void	main(String[] args)
HttpURLConnection	makeConnection(String url, String method)
InputStream	makeRequest(HttpMethod method, String path)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContrastSDK

public ContrastSDK()

ContrastSDK

public ContrastSDK(String user,
           String serviceKey,
           String apiKey,
           String restApiURL)
            throws IllegalArgumentException

Create a ContrastSDK object that will attempt to use the Contrast V3 API

Parameters:

user - Username (e.g., joe@acme.com)

serviceKey - User service key

apiKey - API Key

restApiURL - the base Contrast API URL

Throws:

IllegalArgumentException - if the API URL is malformed

ContrastSDK

public ContrastSDK(String user,
           String serviceKey,
           String apiKey)

Create a ContrastSDK object that attempts to use the Contrast V3 API. This will use the default api url which is https://app.contrastsecurity.com/Contrast/api

Method Detail

getProfileOrganizations

public Organizations getProfileOrganizations()
                                      throws IOException,
                                             UnauthorizedException

Get all organizations for the user profile.

Returns:

Organization objects with a list of disabled and valid organizations for the user.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getProfileDefaultOrganizations

public Organizations getProfileDefaultOrganizations()
                                             throws IOException,
                                                    UnauthorizedException

Get the default organization for the user profile.

Returns:

Organization object with the default Organizaiton.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getApplication

public Applications getApplication(String organizationId,
                          String appId)
                            throws IOException,
                                   UnauthorizedException

Throws:

IOException

UnauthorizedException

getApplication

public Applications getApplication(String organizationId,
                          String appId,
                          EnumSet<FilterForm.ApplicationExpandValues> expandValues)
                            throws IOException,
                                   UnauthorizedException

Get summary information about a single app.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Applications object that contains one Application; wrapper

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getApplications

public Applications getApplications(String organizationId)
                             throws UnauthorizedException,
                                    IOException

Get the list of applications being monitored by Contrast.

Parameters:

organizationId - the ID of the organization

Returns:

Applications object that contains the list of Application's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getCoverage

public Coverage getCoverage(String organizationId,
                   String appId)
                     throws IOException,
                            UnauthorizedException

Return coverage data about the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Coverage object for the given app

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getLibraries

public Libraries getLibraries(String organizationId,
                     String appId)
                       throws IOException,
                              UnauthorizedException

Throws:

IOException

UnauthorizedException

getLibraries

public Libraries getLibraries(String organizationId,
                     String appId,
                     EnumSet<FilterForm.LibrariesExpandValues> expandValues)
                       throws IOException,
                              UnauthorizedException

Return the libraries of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Libraries object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getServers

public Servers getServers(String organizationId,
                 ServerFilterForm filterForm)
                   throws IOException,
                          UnauthorizedException

Return the servers of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

Returns:

Servers object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getServersWithFilter

public Servers getServersWithFilter(String organizationId,
                           ServerFilterForm filterForm)
                             throws IOException,
                                    UnauthorizedException

Return the servers of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

Returns:

Servers object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getTraces

public Traces getTraces(String organizationId,
               String appId,
               EnumSet<FilterForm.TraceExpandValue> expandValues)
                 throws IOException,
                        UnauthorizedException

Get the vulnerabilities in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getTraceListing

public TraceListing getTraceListing(String organizationId,
                           String appId)
                             throws IOException,
                                    UnauthorizedException

Get the listing for the traces in the application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

TraceListing object that contains the trace listings for the application

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getTracesWithFilter

public Traces getTracesWithFilter(String organizationId,
                         String appId,
                         FilterForm form)
                           throws IOException,
                                  UnauthorizedException

Get the vulnerabilities in the application whose ID is passed in with a filter.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getTracesWithFilter

public Traces getTracesWithFilter(String organizationId,
                         String appId,
                         String traceFilterType,
                         String keycode,
                         FilterForm form)
                           throws IOException,
                                  UnauthorizedException

Get the vulnerabilities in the application whose ID is passed in with a filter.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

traceFilterType - filter type

keycode - id or key to filter on

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getTraceFilterByRule

public Traces getTraceFilterByRule(String organizationId,
                          String appId,
                          String ruleId,
                          FilterForm form)
                            throws IOException,
                                   UnauthorizedException

Get the vulnerabilities in the application by the rule.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

ruleId - the rule ID to filter on

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getRules

public Rules getRules(String organizationId)
               throws IOException,
                      UnauthorizedException

Get the rules for an organization

Parameters:

organizationId - the ID of the organization

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

IOException - if there was a communication problem

getAgent

public byte[] getAgent(AgentType type,
              String organizationId,
              String profileName)
                throws IOException,
                       UnauthorizedException

Download a contrast.jar agent associated with this account. The user should save this byte array to a file named 'contrast.jar'. This signature takes a parameter which contains the name of the saved engine profile to download.

Parameters:

type - the type of agent you want to download; Java, Java 1.5, .NET, or Node

profileName - the name of the saved engine profile to download,

organizationId - the ID of the organization,

Returns:

a byte[] array of the contrast.jar file contents, which the user should convert to a new File

Throws:

IOException - if there was a communication problem

UnauthorizedException

getAgent

public byte[] getAgent(AgentType type,
              String organizationId)
                throws IOException,
                       UnauthorizedException

Download a contrast.jar agent associated with this account. The user should save this byte array to a file named 'contrast.jar'. This signature takes a parameter which contains the name of the saved engine profile to download.

This uses 'default' as the profile name.

Parameters:

type - the type of agent you want to download; Java, Java 1.5, .NET, or Node

organizationId - the ID of the organization,

Returns:

a byte[] array of the contrast.jar file contents, which the user should convert to a new File

Throws:

IOException - if there was a communication problem

UnauthorizedException

main

public static void main(String[] args)
                 throws UnauthorizedException,
                        IOException,
                        ResourceNotFoundException

Throws:

UnauthorizedException

IOException

ResourceNotFoundException

makeRequest

public InputStream makeRequest(HttpMethod method,
                      String path)
                        throws IOException,
                               UnauthorizedException

Throws:

IOException

UnauthorizedException

makeConnection

public HttpURLConnection makeConnection(String url,
                               String method)
                                 throws IOException

Throws:

IOException