Explained how to set up the database compatible with the backend.

Use the same parameters in the example runs.

Author: fs191

README.md

@@ -13,4 +13,26 @@ Run the following commands:
 # cabal test
 ```
 
-Example run: ./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/cat_group_query.sql src/psql/cat_attacker.att src/psql/cat_schema.sql src/psql/cat_group_schema.sql
+If PostgreSQL has not been installed yet, it needs to be done before running. The analyser has been tested with versions from 9.5.13 to 10.
+
+After PostgreSQL has been installed, it is necessary to create a database that will be used by the tool. For compatibility with pleak-backend, the database name should be 'ga_propagation'. Permissions on 'ga_propagation' should be given to the user 'ga_propagation', whose password is the same as used inside "pleak-tools/pleak-backend/src/main/java/com/naples/rest/GuessingAdvantageService.java", which is 'ceec4eif7ya' by default. If any other database or user names are used, they should be changed in "GuessingAdvantageService.java" as well. Here is an example of how to do it with Ubuntu system:
+
+    USERNAME@xxxx:~$ sudo -u postgres -i
+    (prompts USERNAME's password)
+    postgres@xxxx:~$ createuser --interactive --pwprompt
+    Enter name of role to add: ga_propagation
+    Enter password for new role: ceec4eif7ya
+    Enter it again: 
+    Shall the new role be a superuser? (y/n) n
+    Shall the new role be allowed to create databases? (y/n) n
+    Shall the new role be allowed to create more new roles? (y/n) n
+
+    postgres@xxxx:~$ psql
+    postgres=# create database ga_propagation;
+    CREATE DATABASE
+    USERNAME=# \q
+
+The tool assumes that the contents of input tables are uploaded to the database by some other application. The example runs will fail if there is no suitable data, i.e. no tables specified in the input schema file.
+
+Example run: ./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/cat_group_query.sql src/psql/cat_attacker.att src/psql/cat_input_schema.sql src/psql/cat_group_output_schema.sql
+

example_runs.txt

@@ -1,15 +1,15 @@
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 5 --connection dbname=banach --leak-mode if-exists -o output.att src/psql/ship_q1.sql src/psql/ship_q1_attacker.att src/psql/ship_q1_input_schema.sql src/psql/ship_q1_output_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 5 --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/ship_q1.sql src/psql/ship_q1_attacker.att src/psql/ship_q1_input_schema.sql src/psql/ship_q1_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/ship_q2.sql src/psql/ship_q2_attacker.att src/psql/ship_q2_input_schema.sql src/psql/ship_q2_output_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/ship_q2.sql src/psql/ship_q2_attacker.att src/psql/ship_q2_input_schema.sql src/psql/ship_q2_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/ship_q3.sql src/psql/ship_q3_attacker.att src/psql/ship_q3_input_schema.sql src/psql/ship_q3_output_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/ship_q3.sql src/psql/ship_q3_attacker.att src/psql/ship_q3_input_schema.sql src/psql/ship_q3_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/cat_select_query.sql src/psql/cat_attacker.att src/psql/cat_schema.sql src/psql/cat_select_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/cat_select_query.sql src/psql/cat_attacker.att src/psql/cat_input_schema.sql src/psql/cat_select_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/cat_group_query.sql src/psql/cat_attacker.att src/psql/cat_schema.sql src/psql/cat_group_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/cat_group_query.sql src/psql/cat_attacker.att src/psql/cat_input_schema.sql src/psql/cat_group_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection dbname=banach --leak-mode if-exists -o output.att src/psql/ship_query.sql src/psql/ship_attacker.att src/psql/ship_schema.sql src/psql/ship_count_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/ship_query.sql src/psql/ship_attacker.att src/psql/ship_schema.sql src/psql/ship_count_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 1000 --connection dbname=banach --leak-mode if-exists -o output.att src/psql/const_query.sql src/psql/const_attacker.att src/psql/const_schema.sql src/psql/const_output_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 1000 --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/const_query.sql src/psql/const_attacker.att src/psql/const_schema.sql src/psql/const_output_schema.sql
 
-./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 100 --connection dbname=banach --leak-mode if-exists -o output.att src/psql/test1.sql src/psql/const_attacker.att src/psql/test1_input_schema.sql src/psql/test1_output_schema.sql
+./dist/build/sql-constraint-propagation/sql-constraint-propagation --iterations 100 --connection "host=localhost dbname=ga_propagation user=ga_propagation password=ceec4eif7ya" --leak-mode if-exists -o output.att src/psql/test1.sql src/psql/const_attacker.att src/psql/test1_input_schema.sql src/psql/test1_output_schema.sql