You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,22 @@ A framework for the automated vulnerability analysis in IP-based networks that e
5
5
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.
6
6
7
7
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.
9
9
10
10
11
11
## Current Features of Modules
12
12
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
14
14
-[x] Do an analysis based on the scan results to discover CVE / NVD entries that affect the discovered software
15
15
-[x] Brute force credentials for SSH & Telnet services via Hydra and a configurable wordlist
16
16
-[x] Brute force directories and files on a webserver via a configurable wordlist
17
17
-[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.
18
18
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).
20
20
21
21
22
22
## 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).
24
24
25
25
26
26
## Usage
@@ -36,7 +36,7 @@ To simply run AVAIN on some target ``192.168.42.1``, call it like so:
36
36
```
37
37
avain -n 192.168.42.1
38
38
```
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.
@@ -45,7 +45,7 @@ Three more examples of how you can call AVAIN:
45
45
46
46
47
47
## 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.
49
49
50
50
51
51
## Contribution & Bugs
@@ -57,4 +57,4 @@ AVAIN is licensed under the MIT license, see [here](https://github.com/DustinBor
57
57
58
58
59
59
## 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.
0 commit comments