Skip to content

Commit 22bedc6

Browse files
committed
Fixed some spelling mistages and markup in the readme
1 parent 3f24681 commit 22bedc6

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# TLS-Scanner
2-
TLS-Scanner is a Tool created by the Chair for Network and Data Security from the Ruhr-University Bochum to assist pentesters and security researchers in lthe evaluation of TLS Server configurations.
2+
TLS-Scanner is a tool created by the Chair for Network and Data Security from the Ruhr-University Bochum to assist pentesters and security researchers in the evaluation of TLS Server configurations.
33

44
**Please note:** *TLS-Scanner is a research tool intended for TLS developers, pentesters, administrators and researchers. There is no GUI. It is in the first version and may contain some bugs.*
55

66
# Compiling
7-
In order to compile and use TLS-Scanner, you need to have Java installed, as well as TLS-Attacker and the ModifiableVariable package.
7+
In order to compile and use TLS-Scanner, you need to have Java installed, as well as [TLS-Attacker](https://github.com/RUB-NDS/TLS-Attacker-Development)
8+
and the [ModifiableVariables](https://github.com/RUB-NDS/ModifiableVariable).
9+
810
```bash
911
$ cd TLS-Scanner
1012
$ ./mvnw clean package
@@ -20,11 +22,7 @@ If you want to use TLS-Scanner as a library you need to install it with the foll
2022
$ ./mvnw clean install
2123
```
2224

23-
For hints on installing the required libraries checkout the corresponding GitHub repositories:
24-
25-
[TLS-Attacker](https://github.com/RUB-NDS/TLS-Attacker-Development)
26-
27-
[ModifiableVariables](https://github.com/RUB-NDS/ModifiableVariable)
25+
For hints on installing the required libraries checkout the corresponding GitHub repositories.
2826

2927
# Running
3028
In order to run TLS-Scanner you need to run the jar file in the apps/ folder.
@@ -37,7 +35,7 @@ You can specify a host you want to scan with the -connect parameter. If you want
3735

3836

3937
# Results
40-
TLS-Scanner uses the concept of "Checks" which are performed after it collected configuration information. A check which results in "true" is consideres a non optimal choice and is an indicator for a pentester for a possible problem.
38+
TLS-Scanner uses the concept of "checks" which are performed after it collected configuration information. A check which results in "true" is consideres a non optimal choice and is an indicator for a pentester for a possible problem.
4139

4240
There are currently multiple checks implemented:
4341

@@ -58,4 +56,4 @@ There are currently multiple checks implemented:
5856
| PROTOCOLVERSION_SSL2 | Checks if SSL 2 is enabled |
5957
| PROTOCOLVERSION_SSL3 | Checks if SSL 3 is enabled |
6058

61-
**Please note:** *A Check with a _result_ of true is considered non optimal*
59+
**Please note:** *A check with a _result_ of true is considered non optimal*

0 commit comments

Comments
 (0)