Git Product home page Git Product logo

arachni-client's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.