Skip to content

Commit 558076a

Browse files
committed
Release of version 0.1.2
1 parent 8020a49 commit 558076a

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Changelog
22
This file keeps track of all notable changes between the different versions of AVAIN.
33

4+
## v0.1.2 - 2019-09-22
5+
### Added
6+
- A very detailed wiki
7+
- All Hydra output is now printed in real time to the screen
8+
### Changed
9+
- Greatly shrink README and refer to respective wiki sites
10+
- Hydra SSH is now by default configured to use only 4 tasks
11+
- The user agent for the web/crawler module is now by default configured to use a Linux UA
12+
413
## v0.1.1 - 2019-09-19
514
### Changed
615
- Installation of gobuster on Linux is now indepedent of detected kernel version

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ A framework for the automated vulnerability analysis in IP-based networks that e
55
AVAIN is a modular vulnerability analysis / penetration testing framework for computer networks and individual machines in which its modules can work collaboratively to achieve more sophisticated results. AVAIN can automatically assess the security level of an IP-based network or host. Its final output is a score between 0 and 10, where the higher the score, the more vulnerable / insecure the assessed object. In addition, AVAIN saves all the detailed results from its modules for the user to look at after the assessment. During the assessment, the most relevant parts of every module's output are shown right away.
66

77

8-
Primarly AVAIN is an extensible framework that uses modules to do vulnerability assessment. As such it offers several features that make it easier to develop new modules and make use of existing ones. For more information, look at the [separate wiki page](wiki/Framework-Features). To see how to develop new modules with Python, look at [this](wiki/Creating-a-New-Module) wiki page.
8+
Primarly AVAIN is an extensible framework that uses modules to do vulnerability assessment. As such it offers several features that make it easier to develop new modules and make use of existing ones. For more information, look at the [separate wiki page](https://github.com/DustinBorn/avain/wiki/Framework-Features). To see how to develop new modules with Python, look at [this](https://github.com/DustinBorn/avain/wiki/Creating-a-New-Module) wiki page.
99

1010

1111
## Current Features of Modules
1212
In short, the currently available modules can:
13-
- [x] Faciliate an Nmap scan & somewhat preprocess it
13+
- [x] Faciliate an Nmap scan & somewhat postprocess it
1414
- [x] Do an analysis based on the scan results to discover CVE / NVD entries that affect the discovered software
1515
- [x] Brute force credentials for SSH & Telnet services via Hydra and a configurable wordlist
1616
- [x] Brute force directories and files on a webserver via a configurable wordlist
1717
- [x] Completely scrape a webserver, i.e. crawl paths, find GET / POST parameters and cookies, find source code comments and find new network locations. Moreover, use Selenium to discover content that only becomes visible when opening websites via a browser, so dynamic content.
1818

19-
A more detailed overview of the current modules, what they can do and how they work is available in the [wiki](wiki/Module-Overview). All of AVAIN's modules are highly configurable. As a small example, you can configure authentication cookies to be used while scraping a website. For a full list of configuration parameters and how to use them properly, have look at the separate [wiki page](wiki/Configuration). In addition, while being fairly verbose during the scan, all of result files that contain even more information are stored in AVAIN's output directory. While the file structure should be simple to understand, it is further explained in the [wiki](wiki/Output-Structure).
19+
A more detailed overview of the current modules, what they can do and how they work is available in the [wiki](https://github.com/DustinBorn/avain/wiki/Module-Overview). All of AVAIN's modules are highly configurable. As a small example, you can configure authentication cookies to be used while scraping a website. For a full list of configuration parameters and how to use them properly, have look at the separate [wiki page](https://github.com/DustinBorn/avain/wiki/Configuration). In addition, while being fairly verbose during the scan, all of result files that contain even more information are stored in AVAIN's output directory. While the file structure should be simple to understand, it is further explained in the [wiki](https://github.com/DustinBorn/avain/wiki/Output-Structure).
2020

2121

2222
## Installation
23-
AVAIN was made to work on Unix based systems. It was tested to work on macOS, Ubuntu Linux and Kali Linux. You can either install it directly on your system or use the available Dockerfile. To install it directly & automatically, run the ``install.sh`` script. As the script attempts to install the required software, you may have to run it as *root* or you will get asked for a password. In case the script does not work, you may be good by changing the package manager at the top of the script, if not feel free to open an issue. On macOS you need Homebrew. For more info on the installation process, see the [wiki page](wiki/Installation).
23+
AVAIN was made to work on Unix based systems. It was tested to work on macOS, Ubuntu Linux and Kali Linux. You can either install it directly on your system or use the available Dockerfile. To install it directly & automatically, run the ``install.sh`` script. As the script attempts to install the required software, you may have to run it as *root* or you will get asked for a password. In case the script does not work, you may be good by changing the package manager at the top of the script, if not feel free to open an issue. On macOS you need Homebrew. For more info on the installation process, see the [wiki page](https://github.com/DustinBorn/avain/wiki/Getting-Started).
2424

2525

2626
## Usage
@@ -36,7 +36,7 @@ To simply run AVAIN on some target ``192.168.42.1``, call it like so:
3636
```
3737
avain -n 192.168.42.1
3838
```
39-
Again, the contents of the created output folder should mostly be simple to understand, but a [separate wiki page](wiki/Output-Structure) goes into more detail. Further explanation on AVAIN's usage information is available at [this](wiki/Usage) wiki page.
39+
Again, the contents of the created output folder should mostly be simple to understand, but a [separate wiki page](https://github.com/DustinBorn/avain/wiki/Output-Structure) goes into more detail. Further explanation on AVAIN's usage information is available at [this](https://github.com/DustinBorn/avain/wiki/Usage) wiki page.
4040

4141
Three more examples of how you can call AVAIN:
4242
* ``avain -n 192.168.0.* -uM -p T:80,U:53 -o http_dns_sec``
@@ -45,7 +45,7 @@ Three more examples of how you can call AVAIN:
4545

4646

4747
## Wiki
48-
In case you have more question about AVAIN, the [Wiki](wiki) is very detailed and explains AVAIN in great detail.
48+
In case you have more question about AVAIN, the [wiki](https://github.com/DustinBorn/avain/wiki/) is very detailed and explains AVAIN in great detail.
4949

5050

5151
## Contribution & Bugs
@@ -57,4 +57,4 @@ AVAIN is licensed under the MIT license, see [here](https://github.com/DustinBor
5757

5858

5959
## Miscellaneous
60-
I created AVAIN as part of my Bachelor Thesis at TU Darmstadt (located in Germany) under the guidance of my advisor Rolf Egert. We have presented a paper about AVAIN at NetSys '19. In addition, another paper based on AVAIN has been accepted at the IEEE GLOBECOM 2019 Workshop on Security and Privacy in Smart, Cooperative IoT and CPS. For more info see the [Publications](wiki/Publications) wiki page.
60+
I created AVAIN as part of my Bachelor Thesis at TU Darmstadt (located in Germany) under the guidance of my advisor Rolf Egert. We have presented a paper about AVAIN at NetSys '19. In addition, another paper based on AVAIN has been accepted at the IEEE GLOBECOM 2019 Workshop on Security and Privacy in Smart, Cooperative IoT and CPS. For more info see the [Publications](https://github.com/DustinBorn/avain/wiki/Publications) wiki page.

avain.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
# The following metadata applies to all source code files of AVAIN
1212
__author__ = "Dustin Born"
13-
__version__ = "0.1.0"
13+
__version__ = "0.1.2"
1414
__license__ = "MIT"
1515

1616

0 commit comments

Comments
 (0)