Package com.beaglesecurity.client

Class BeagleSecurityClientImpl

java.lang.Object

com.beaglesecurity.client.BeagleSecurityClientBase

com.beaglesecurity.client.BeagleSecurityClientImpl

All Implemented Interfaces:

BeagleSecurityClient

public class BeagleSecurityClientImpl
extends BeagleSecurityClientBase
implements BeagleSecurityClient

Field Summary

Fields inherited from class com.beaglesecurity.client.BeagleSecurityClientBase

baseUrl, token

Constructor Summary

Constructors

Constructor	Description
BeagleSecurityClientImpl(String userToken)

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.

Methods inherited from class com.beaglesecurity.client.BeagleSecurityClientBase

convertJsonToObject, handleCommonExceptions

Methods inherited from class java.lang.Object

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

Constructor Detail

BeagleSecurityClientImpl

public BeagleSecurityClientImpl(String userToken)

Parameters:

userToken - is the token generated from beagle security settings for a user

Method Detail

getAllProjects

public List<ProjectWithApplication> getAllProjects()

Description copied from interface: BeagleSecurityClient

Returns all the projects and applications for a particular user

Specified by:

getAllProjects in interface BeagleSecurityClient

Returns:

list of project

getAllProjectWithTeams

public ProjectWithTeam getAllProjectWithTeams()

Description copied from interface: BeagleSecurityClient

Returns all the projects and team projects

Specified by:

getAllProjectWithTeams in interface BeagleSecurityClient

Returns:

all the projects and team projects

createProject

public Project createProject(String projectName,
                             String description)

Description copied from interface: BeagleSecurityClient

Create a new project and return it

Specified by:

createProject in interface BeagleSecurityClient

Parameters:

projectName - Name of project

description - project description

Returns:

created project

createProject

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

Description copied from interface: BeagleSecurityClient

Create a new project in a team and return it

Specified by:

createProject in interface BeagleSecurityClient

Parameters:

projectName - Name of project

description - project description

teamId - team id to create the project

Returns:

created project

modifyProject

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

Description copied from interface: BeagleSecurityClient

Modify an existing project and return it

Specified by:

modifyProject in interface BeagleSecurityClient

Parameters:

projectKey - project key to modify

projectName - Name of project

description - project description

Returns:

modified project

deleteProject

public Project deleteProject(UUID projectKey)

Description copied from interface: BeagleSecurityClient

Delete a project and return it

Specified by:

deleteProject in interface BeagleSecurityClient

Parameters:

projectKey - project key to delete

Returns:

deleted project

getApplication

public Application getApplication(String applicationToken)

Description copied from interface: BeagleSecurityClient

Returns application object corresponds to the given application token.

Specified by:

getApplication in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

Returns:

application object

getApplications

public List<Application> getApplications(UUID projectKey)

Description copied from interface: BeagleSecurityClient

Returns application object corresponds to the given application token.

Specified by:

getApplications in interface BeagleSecurityClient

Parameters:

projectKey - project key to retrieve applications

Returns:

list of applications under project

createApplication

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

Description copied from interface: BeagleSecurityClient

Create a new application and return it

Specified by:

createApplication in interface BeagleSecurityClient

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

modifyApplication

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

Description copied from interface: BeagleSecurityClient

Modify an existing application and return it

Specified by:

modifyApplication in interface BeagleSecurityClient

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

deleteApplication

public Application deleteApplication(String applicationToken)

Description copied from interface: BeagleSecurityClient

Delete an application using application token

Specified by:

deleteApplication in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

Returns:

application object

getSignature

public Signature getSignature(String applicationToken)

Description copied from interface: BeagleSecurityClient

Gets signature of the given application

Specified by:

getSignature in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

Returns:

application object

verifySignature

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

Description copied from interface: BeagleSecurityClient

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

Specified by:

verifySignature in interface BeagleSecurityClient

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

getTestResultJson

public String getTestResultJson(String applicationToken,
                                String resultToken)

Description copied from interface: BeagleSecurityClient

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

Specified by:

getTestResultJson in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

resultToken - is the test start token to fetch result

Returns:

json result

startTest

public StartTest startTest(String applicationToken)

Description copied from interface: BeagleSecurityClient

Starts a new test

Specified by:

startTest in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

Returns:

start test result

getTestStatus

public TestStatus getTestStatus(String applicationToken,
                                String resultToken)

Description copied from interface: BeagleSecurityClient

Gets the status of a running session

Specified by:

getTestStatus in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

resultToken - token of a session

Returns:

status of the session

stopTest

public boolean stopTest(String applicationToken)

Description copied from interface: BeagleSecurityClient

Stop a running test

Specified by:

stopTest in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

Returns:

boolean true if stop test success, false otherwise

getTestSessions

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

Description copied from interface: BeagleSecurityClient

Gets a number of test sessions under an application

Specified by:

getTestSessions in interface BeagleSecurityClient

Parameters:

applicationToken - is the unique token of application

count - is the number of records to fetch

Returns:

list of sessions

getTestRunningSessions

public List<TestRunningSession> getTestRunningSessions()

Description copied from interface: BeagleSecurityClient

Gets all running sessions under a user

Specified by:

getTestRunningSessions in interface BeagleSecurityClient

Returns:

list of running sessions

getTeamTestRunningSessions

public List<TestRunningSession> getTeamTestRunningSessions(String teamId)

Description copied from interface: BeagleSecurityClient

Gets all running sessions under a team

Specified by:

getTeamTestRunningSessions in interface BeagleSecurityClient

Parameters:

teamId - team id to find running session

Returns:

list of running sessions