Arachni Java Client

A Java client to send request to the Arachni REST API.

License

License

Categories

Categories

CLI User Interface
GroupId

GroupId

de.irissmann
ArtifactId

ArtifactId

arachni-client
Last Version

Last Version

1.0.4
Release Date

Release Date

Type

Type

jar
Description

Description

Arachni Java Client
A Java client to send request to the Arachni REST API.
Project URL

Project URL

https://github.com/irissmann/arachni-client.git
Source Code Management

Source Code Management

https://github.com/irissmann/arachni-client.git

Download arachni-client

How to add to project

<!-- https://jarcasting.com/artifacts/de.irissmann/arachni-client/ -->
<dependency>
    <groupId>de.irissmann</groupId>
    <artifactId>arachni-client</artifactId>
    <version>1.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/de.irissmann/arachni-client/
implementation 'de.irissmann:arachni-client:1.0.4'
// https://jarcasting.com/artifacts/de.irissmann/arachni-client/
implementation ("de.irissmann:arachni-client:1.0.4")
'de.irissmann:arachni-client:jar:1.0.4'
<dependency org="de.irissmann" name="arachni-client" rev="1.0.4">
  <artifact name="arachni-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.irissmann', module='arachni-client', version='1.0.4')
)
libraryDependencies += "de.irissmann" % "arachni-client" % "1.0.4"
[de.irissmann/arachni-client "1.0.4"]

Dependencies

compile (5)

Group / Artifact Type Version
org.apache.httpcomponents : httpclient jar 4.5.3
com.google.code.gson : gson jar 2.8.2
ch.qos.logback : logback-core jar 1.2.3
org.slf4j : log4j-over-slf4j jar 1.7.25
org.apache.commons : commons-lang3 jar 3.0

test (5)

Group / Artifact Type Version
ch.qos.logback : logback-classic jar 1.2.3
junit : junit jar 4.12
org.hamcrest : hamcrest-all jar 1.3
com.github.tomakehurst : wiremock jar 2.9.0
org.skyscreamer : jsonassert jar 1.5.0

Project Modules

There are no modules declared in this project.

arachni-client

Introduction

Java client for the Arachni Scanner REST API. It's developed and tested with version 1.5.1-0.5.12 of the Arachni project.

Maven

The arachni-client artifacts are available on Maven central repository.

<!-- https://mvnrepository.com/artifact/de.irissmann/arachni-client -->
<dependency>
    <groupId>de.irissmann</groupId>
    <artifactId>arachni-client</artifactId>
    <version>1.0.1</version>
</dependency>

Usage

This client provides a very simple api to send REST request to an Arachni REST server.

Use the builder to get an instance of the ArachniClient. Just replace the url with the address of your Arachni REST server.

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

If your Arachni REST server is secured with basic authentication, use the following command.

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

To perform a new scan create a ScanRequest. It's best to use the fluent API like in the folling example:

ScanRequest scanRequest = ScanRequest.create().url("http://address:port").build();
Scan scan = arachniClient.performScan(scanRequest);

Request the status from a scan:

ScanResponse response = scan.monitor();

Download a generated HTML report from the server:

OutputStream outstream = new FileOutputStream(reportFile);
scan.getReportHtml(outstream);

For more information see the Java Doc and the ARACHNI REST API.

Versions

Version
1.0.4
1.0.3.1
1.0.3
1.0.2
1.0.1
1.0.0