Package com.beaglesecurity.client

Interface BeagleSecurityClient

All Known Implementing Classes:

BeagleSecurityClientImpl

public interface BeagleSecurityClient

Method Summary

Modifier and Type	Method	Description
Application	createApplication(String applicationName, String url, UUID projectKey, ApplicationType type)	Create a new application and return it
Project	createProject(String projectName, String description)	Create a new project and return it
Project	createProject(String projectName, String description, String teamId)	Create a new project in a team and return it
Application	deleteApplication(String applicationToken)	Delete an application using application token
Project	deleteProject(UUID projectKey)	Delete a project and return it
List<ProjectWithApplication>	getAllProjects()	Returns all the projects and applications for a particular user
ProjectWithTeam	getAllProjectWithTeams()	Returns all the projects and team projects
Application	getApplication(String applicationToken)	Returns application object corresponds to the given application token.
List<Application>	getApplications(UUID projectKey)	Returns application object corresponds to the given application token.
Signature	getSignature(String applicationToken)	Gets signature of the given application
List<TestRunningSession>	getTeamTestRunningSessions(String teamId)	Gets all running sessions under a team
String	getTestResultJson(String applicationToken, String resultToken)	Get the result json, which contains entire vulnerabilities found in the penetration testing process in json format
List<TestRunningSession>	getTestRunningSessions()	Gets all running sessions under a user
List<TestSession>	getTestSessions(String applicationToken, int count)	Gets a number of test sessions under an application
TestStatus	getTestStatus(String applicationToken, String resultToken)	Gets the status of a running session
Application	modifyApplication(String applicationToken, String applicationName, String url)	Modify an existing application and return it
Project	modifyProject(UUID projectKey, String projectName, String description)	Modify an existing project and return it
StartTest	startTest(String applicationToken)	Starts a new test
boolean	stopTest(String applicationToken)	Stop a running test
boolean	verifySignature(String applicationToken, SignatureType signatureType, PluginType pluginType)	Verify signature of an application if signatureType is Plug-in, then pluginType needs to provide.

Method Detail

getAllProjects

List<ProjectWithApplication> getAllProjects()

Returns all the projects and applications for a particular user

Returns:

list of project

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getAllProjectWithTeams

ProjectWithTeam getAllProjectWithTeams()

Returns all the projects and team projects

Returns:

all the projects and team projects

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

createProject

Project createProject(String projectName,
                      String description)

Create a new project and return it

Parameters:

projectName - Name of project

description - project description

Returns:

created project

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

ProjectAlreadyExistsException - The given project already exists

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

createProject

Project createProject(String projectName,
                      String description,
                      String teamId)

Create a new project in a team and return it

Parameters:

projectName - Name of project

description - project description

teamId - team id to create the project

Returns:

created project

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

ProjectAlreadyExistsException - The given project already exists

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

modifyProject

Project modifyProject(UUID projectKey,
                      String projectName,
                      String description)

Modify an existing project and return it

Parameters:

projectKey - project key to modify

projectName - Name of project

description - project description

Returns:

modified project

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

ProjectAlreadyExistsException - The given project already exists

InvalidProjectKeyException - The given project key is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

deleteProject

Project deleteProject(UUID projectKey)

Delete a project and return it

Parameters:

projectKey - project key to delete

Returns:

deleted project

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

InvalidProjectKeyException - The given project key is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getApplication

Application getApplication(String applicationToken)

Returns application object corresponds to the given application token.

Parameters:

applicationToken - is the unique token of application

Returns:

application object

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidApplicationTokenException - Given token is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getApplications

List<Application> getApplications(UUID projectKey)

Returns application object corresponds to the given application token.

Parameters:

projectKey - project key to retrieve applications

Returns:

list of applications under project

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidProjectKeyException - Given project key is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

createApplication

Application createApplication(String applicationName,
                              String url,
                              UUID projectKey,
                              ApplicationType type)

Create a new application and return it

Parameters:

applicationName - Name of application

url - website url for penetration testing

projectKey - project key under the application needs to add

type - application type such as WEB or API

Returns:

created application

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

modifyApplication

Application modifyApplication(String applicationToken,
                              String applicationName,
                              String url)

Modify an existing application and return it

Parameters:

applicationToken - token of the application

applicationName - Name of application to modify

url - website url to modify. If domain is verified, then unable to modify url

Returns:

modified application

Throws:

ValidationException - Parameter validation failure exception

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidUrlException - Given url is not valid

UrlAlreadyAddedException - The url is added in another application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

deleteApplication

Application deleteApplication(String applicationToken)

Delete an application using application token

Parameters:

applicationToken - is the unique token of application

Returns:

application object

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidApplicationTokenException - Given token is not valid

TestInProgressException - A test is in progress

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getSignature

Signature getSignature(String applicationToken)

Gets signature of the given application

Parameters:

applicationToken - is the unique token of application

Returns:

application object

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidApplicationTokenException - Given token is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

verifySignature

boolean verifySignature(String applicationToken,
                        SignatureType signatureType,
                        PluginType pluginType)

Verify signature of an application if signatureType is Plug-in, then pluginType needs to provide. Otherwise pluginType will be null

Parameters:

applicationToken - is the unique token of application

signatureType - is type of signature

pluginType - is type of plug-in

Returns:

true if verify signature success

Throws:

GeneralAPIException - General exceptions.

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

InvalidApplicationTokenException - Given token is not valid

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getTestResultJson

String getTestResultJson(String applicationToken,
                         String resultToken)

Get the result json, which contains entire vulnerabilities found in the penetration testing process in json format

Parameters:

applicationToken - is the unique token of application

resultToken - is the test start token to fetch result

Returns:

json result

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

startTest

StartTest startTest(String applicationToken)

Starts a new test

Parameters:

applicationToken - is the unique token of application

Returns:

start test result

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getTestStatus

TestStatus getTestStatus(String applicationToken,
                         String resultToken)

Gets the status of a running session

Parameters:

applicationToken - is the unique token of application

resultToken - token of a session

Returns:

status of the session

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

stopTest

boolean stopTest(String applicationToken)

Stop a running test

Parameters:

applicationToken - is the unique token of application

Returns:

boolean true if stop test success, false otherwise

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getTestSessions

List<TestSession> getTestSessions(String applicationToken,
                                  int count)

Gets a number of test sessions under an application

Parameters:

applicationToken - is the unique token of application

count - is the number of records to fetch

Returns:

list of sessions

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getTestRunningSessions

List<TestRunningSession> getTestRunningSessions()

Gets all running sessions under a user

Returns:

list of running sessions

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error

getTeamTestRunningSessions

List<TestRunningSession> getTeamTestRunningSessions(String teamId)

Gets all running sessions under a team

Parameters:

teamId - team id to find running session

Returns:

list of running sessions

Throws:

GeneralAPIException - General exceptions

PlanNotSupportException - The user plan is not supported

InvalidSessionException - Given token is not valid

UnAuthorizedException - No permission to view the application

ForbiddenException - Forbidden

InternalServerErrorException - Internal server error