Skip to content

Commit cf5ed0b

Browse files
authored
Updated README.md to the current source
1 parent 820eb26 commit cf5ed0b

File tree

1 file changed

+6
-30
lines changed

1 file changed

+6
-30
lines changed

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,14 @@ Copyright (c) 2019 Secure Software Engineering Group at Paderborn University and
1414

1515
Contact: Goran Piskachev (goran.piskachev@iem.fraunhofer.de)
1616

17-
# using authcheck
17+
# using authcheck in MacOS or Linux
1818

19-
Two different procedures can be used to run the authcheck: a system independent variant with Docker, or a direct execution of the analysis on the system. To compile the checker's Java code first, use Maven to create Jar file
19+
First, compile the checker's Java code, use Maven to create the Jar file
2020
```$ mvn package```
2121

22-
Using Docker, authcheck can be run independently of the system. There are three ready-made configurations that can be run using different commands. These include the analysis of the application example and the test scenarios.
23-
24-
For execution, Docker-Compose has already been used to configure the Docker containers, which allows the checker to run with one command. The Docker container was defined generically, so that the program to be analyzed, the configurations and the templates must be defined as volumes. These are mounted in the container at runtime. Docker-Compose allows the configuration of the volumes in the file docker-compose.yml.
25-
26-
To analyze the demo example, create the Docker image and run authcheck. Use the command:
27-
```$ docker-compose up -d --build checker ```
28-
29-
With the following command the log files can be viewed:
30-
```$ docker-compose logs -f checker```
31-
32-
The generated HTML report (report.html) is stored in the directory ```../docker/output/default```.
33-
34-
Analyze the test cases:
35-
Use the following command:
36-
```$ docker-compose up -d --build checker-testcases```
37-
38-
With the following command the log files can be viewed:
39-
```$ docker-compose logs -f checker-testcases```
40-
41-
The generated HTML report (report.html) is stored in the directory ```../docker/output/testcases```.
42-
43-
## MacOS and Linux
44-
To run authcheck on MacOS or Linux, configuration file has to be adapted. There are example configurations in the folder configuration. Among them are configuration default.json and configuration testcases.json.
45-
The attributes jceJarPath and rtJarPath must be adapted to the Java Home path. The following command can then be executed to execute authcheck:
46-
```$ java -jar target/Checker-1.0-SNAPSHOT-jar-withdependencies.jar configuration/configuration default.json```
47-
48-
The configuration parameter must be adjusted accordingly. The generated HTML report (report.html) can be found in the report directory.
49-
22+
There are two ready-made configuration files *configuration.json* and *input.json* in *SootAnalysis* directory, which are used for demo analysis of the example application existing in the source. Before running the authcheck on MacOS or Linux, these configuration files needs to be adapted to your settings. The attributes *jceJarPath* and *rtJarPath* must be adapted to the Java Home path.
5023

24+
After that, the following command can used to execute authcheck (in the contex of *SootAnalysis* directory):
25+
```$ java -cp target/Soot-Analysis-1.0-SNAPSHOT-jar-with-dependencies.jar de.fraunhofer.iem.authchecker.Checker configuration.json```
5126

27+
After the running the command successfully, the analysis will create the report.html in the *report* directory, which will contain details and suggestions about the analysis.

0 commit comments

Comments
 (0)