A B C D G H I M P R S U

A

addCredentials(String, String) - Method in class de.irissmann.arachni.client.rest.ArachniRestClientBuilder

Here you can set username and password if the Arachni REST API is secured with Basic Authentication.

addExcludePathPatterns(String) - Method in class de.irissmann.arachni.client.request.ScopeBuilder

Excludes resources whose URL matches the pattern.

ArachniClient - Interface in de.irissmann.arachni.client

Interface to send requests to an Arachni Security Scanner instance.

ArachniClientException - Exception in de.irissmann.arachni.client

This runtime exception will be thrown if something unforeseen is happen.

ArachniClientException(String) - Constructor for exception de.irissmann.arachni.client.ArachniClientException

Constructor for a new ArachniClientException.

ArachniClientException(String, Exception) - Constructor for exception de.irissmann.arachni.client.ArachniClientException

Constructor for a new ArachniClientException.

ArachniRestClient - Class in de.irissmann.arachni.client.rest

Implementation that use the Arachni REST interface.

ArachniRestClientBuilder - Class in de.irissmann.arachni.client.rest

Builder to get an instance of the ArachniRestClient implementation.

B

build() - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Returns an instance of HttpParameters to change the default values for a new scan.

build() - Method in class de.irissmann.arachni.client.request.ScanRequestBuilder

Checks the mandatory parameters and creates the ScanRequest.

build() - Method in class de.irissmann.arachni.client.request.ScopeBuilder

Returns a instance of Scope to change the default settings.

build() - Method in class de.irissmann.arachni.client.rest.ArachniRestClientBuilder

Returns a instance of ArachniRestClient.

C

close() - Method in interface de.irissmann.arachni.client.ArachniClient

Depends on implementation the client close connections to Arachni Security Scanner.

close() - Method in class de.irissmann.arachni.client.rest.ArachniRestClient

create() - Static method in class de.irissmann.arachni.client.request.HttpParameters

Returns a builder to create a HttpParameters object.

create() - Static method in class de.irissmann.arachni.client.request.ScanRequest

create() - Static method in class de.irissmann.arachni.client.request.Scope

Returns a builder to create a Scope object.

create(String) - Static method in class de.irissmann.arachni.client.rest.ArachniRestClientBuilder

Returns an instance of this class.

D

de.irissmann.arachni.client - package de.irissmann.arachni.client

de.irissmann.arachni.client.request - package de.irissmann.arachni.client.request

de.irissmann.arachni.client.response - package de.irissmann.arachni.client.response

de.irissmann.arachni.client.rest - package de.irissmann.arachni.client.rest

G

getAuditedPages() - Method in class de.irissmann.arachni.client.response.Statistics

Returns the number of pages already audited.

getErrors() - Method in class de.irissmann.arachni.client.response.ScanResponse

Returns a list with error messages from scan if an error was happened.

getFoundPages() - Method in class de.irissmann.arachni.client.response.Statistics

Returns the number of pages found for the scan.

getId() - Method in class de.irissmann.arachni.client.Scan

Returns the id of the scan.

getReportHtml(OutputStream) - Method in class de.irissmann.arachni.client.rest.ScanRestImpl

getReportHtml(OutputStream) - Method in class de.irissmann.arachni.client.Scan

Writes the scan HTML report in a given OutputStream as a zip file.

getReportJson() - Method in class de.irissmann.arachni.client.rest.ScanRestImpl

getReportJson() - Method in class de.irissmann.arachni.client.Scan

Retrieve the scan report as JSON string.

getScans() - Method in interface de.irissmann.arachni.client.ArachniClient

Returns a list with all scan id's.

getScans() - Method in class de.irissmann.arachni.client.rest.ArachniRestClient

getSeed() - Method in class de.irissmann.arachni.client.response.ScanResponse

getStatistics() - Method in class de.irissmann.arachni.client.response.ScanResponse

Returns some statistics from the scan.

getStatus() - Method in class de.irissmann.arachni.client.response.ScanResponse

Returns the scan status.

H

http(HttpParameters) - Method in class de.irissmann.arachni.client.request.ScanRequestBuilder

Sets the HTTP parameters for the site under scan.

HttpParameters - Class in de.irissmann.arachni.client.request

Defines Http parameter settings for scan request.

HttpParametersBuilder - Class in de.irissmann.arachni.client.request

This is a builder to create an instance of HttpParameters.

I

isBusy() - Method in class de.irissmann.arachni.client.response.ScanResponse

Return true when the scan is still in progress, otherwise false.

M

monitor() - Method in class de.irissmann.arachni.client.rest.ScanRestImpl

monitor() - Method in class de.irissmann.arachni.client.Scan

Monitors the scan and returns a ReportScan object.

P

pageLimit(int) - Method in class de.irissmann.arachni.client.request.ScopeBuilder

This option limits how many pages should be included in the scan.

PATH_SCANS - Static variable in class de.irissmann.arachni.client.rest.ArachniRestClient

performScan(ScanRequest) - Method in interface de.irissmann.arachni.client.ArachniClient

Performs a new scan on the Arachni Rest Server and returns a Scan object.

performScan(ScanRequest) - Method in class de.irissmann.arachni.client.rest.ArachniRestClient

R

requestConcurrency(int) - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Sets the maximum amount of requests to be active at any given time; this usually directly translates to the amount of open connections.

requestQueueSize(int) - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Maximum amount of requests to keep in the client queue.

requestRedirectLimit(int) - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Limits the amount of redirects the client should follow for each request.

requestTimeout(int) - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Limit how long the client should wait for a response from the server.

responseMaxSize(int) - Method in class de.irissmann.arachni.client.request.HttpParametersBuilder

Limits the size of response bodies the client accepts.

S

Scan - Class in de.irissmann.arachni.client

With a Scan instance you can get all informations and reports from Arachni Security Scanner.

ScanRequest - Class in de.irissmann.arachni.client.request

A ScanRequest is needed to perform a new scan.

ScanRequestBuilder - Class in de.irissmann.arachni.client.request

Use this builder to create a ScanRequest.

ScanRequestBuilder() - Constructor for class de.irissmann.arachni.client.request.ScanRequestBuilder

ScanResponse - Class in de.irissmann.arachni.client.response

Monitoring an active scan will return a ScanResponse.

ScanResponse() - Constructor for class de.irissmann.arachni.client.response.ScanResponse

ScanRestImpl - Class in de.irissmann.arachni.client.rest

This is a REST API implementation of the Scan interface.

scope(Scope) - Method in class de.irissmann.arachni.client.request.ScanRequestBuilder

Sets the scope for the site under scan.

Scope - Class in de.irissmann.arachni.client.request

Defines scope parameter settings for a scan request.

ScopeBuilder - Class in de.irissmann.arachni.client.request

This is a builder to create an instance of Scope.

ScopeBuilder() - Constructor for class de.irissmann.arachni.client.request.ScopeBuilder

shutdown() - Method in class de.irissmann.arachni.client.rest.ScanRestImpl

shutdown() - Method in class de.irissmann.arachni.client.Scan

This call needs to take place after each scan is done in order to prevent zombie processes.

Statistics - Class in de.irissmann.arachni.client.response

Some scan statistics.

Statistics() - Constructor for class de.irissmann.arachni.client.response.Statistics

U

url(String) - Method in class de.irissmann.arachni.client.request.ScanRequestBuilder

Sets the URL of the site to scan.

A B C D G H I M P R S U