de.irissmann.arachni.client

Interface ArachniClient

All Known Implementing Classes:

ArachniRestClient

public interface ArachniClient

Interface to send requests to an Arachni Security Scanner instance. Use a builder to get an instance. The following example creates an instance of ArachniRestClient

 
 ArachniClient arachniClient = ArachniRestClientBuilder
   .create("http://127.0.0.1:8080")
   .build();
 
 

Since:

1.0.0

Author:

Ingo Rissmann

See Also:

ArachniRestClientBuilder

Method Summary

Modifier and Type	Method and Description
void	close() Depends on implementation the client close connections to Arachni Security Scanner.
List<String>	getScans() Returns a list with all scan id's.
Scan	performScan(ScanRequest scanRequest) Performs a new scan on the Arachni Rest Server and returns a Scan object.
Scan	performScan(ScanRequest scanRequest, String mergeString) Same as performScan(ScanRequest scanRequest) method but you can specify a Json string that will be merged into the request.

Method Detail

getScans

List<String> getScans()

Returns a list with all scan id's. This method can throw the runtime exception ArachniClientException.

Returns:

List with all scan id's.

Throws:

ArachniClientException

performScan

Scan performScan(ScanRequest scanRequest)

Performs a new scan on the Arachni Rest Server and returns a Scan object. To start a new you have to create a ScanRequest first. Use the returned Scan object for further activities.

Parameters:

scanRequest - Request with all information needed for the scan.

Returns:

A Scan object.

Throws:

ArachniClientException

performScan

Scan performScan(ScanRequest scanRequest,
                 String mergeString)

Same as performScan(ScanRequest scanRequest) method but you can specify a Json string that will be merged into the request.

Parameters:

scanRequest -

mergeString -

Returns:

close

void close()

Depends on implementation the client close connections to Arachni Security Scanner. Use this careful because after calling this method the ArachniClient and all created Scan objects can not be used anymore.

Throws:

ArachniClientException