-
Notifications
You must be signed in to change notification settings - Fork 0
/
violation_report.js
322 lines (263 loc) · 10.3 KB
/
violation_report.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
/******
* Script that produces the report of the violation for a given website.
* It works by comparing the consents given by the user and the cookies categories setted during the navigation.
* The model used here is the CookieBlock XGB model
*/
const fs = require('fs');
const { isEmpty } = require('lodash');
const path = require('path');
const model = "cookie_block.xgb";
var no_interaction = false;
// Check number of args passed to the script
if (process.argv.length < 5) {
console.log( 'USAGE: node violation_report.js <url> <predictions_file.json> <list_of_consents>' );
console.log( 'CONSENTS can be:\n no_interaction -> cookies downloaded without any interaction with the CMP \n no_consents -> cookies downloaded after hiding the CMP with COM \n 0 -> necessary cookies \n 1 -> functional cookies \n 2 -> analytics cookies\n 3 -> advertising cookies' );
console.log( 'EXAMPLE: node violation_report.js hdblog.it predictions.json 0 1 2' );
process.exit(1);
}
// Take filename from command line
const jsonFilename = process.argv[3];
const url = process.argv[2];
const cookieDowloadedJsonPath = "./cookies_formatted/" + url + ".json";
// Create consents array to double check the violation
var arguments = process.argv.slice(3);
arguments.forEach((value, index) => {
//console.log(index, value);
});
const consents_array = [];
let i = 0;
for (i; i < arguments.length; i++) {
if (i > 0) {
if ( arguments[i] == 'no_consents' ) {
consents_array.push(0);
} else if ( arguments[i] == 'no_interaction' ) {
consents_array.push(0);
no_interaction = true;
} else {
consents_array.push( parseInt( arguments[i] ) );
}
}
}
//console.log( consents_array );
// Report arrays
const necessary = [];
const functional = [];
const analytics = [];
const advertising = [];
const report = [ necessary, functional, analytics, advertising ];
if ( !urlIsError( url ) ) {
if ( !isJsonEmptyFromFile( cookieDowloadedJsonPath ) ) {
// Read JSON content and parse it
fs.readFile(jsonFilename, 'utf-8', (error, data) => {
if (error) {
console.error('Error while reading the JSON file:', error);
} else {
try {
// Convert the content of the JSON file into a JSON object
const jsonData = JSON.parse(data);
// Add each cookie in the related array based on its category
for ( key in jsonData ) {
/*console.log("KEY: " + key );
console.log("VALUE: " + jsonData[key]);*/
if ( jsonData[key] == 0 ) {
necessary.push( key );
} else if ( jsonData[key] == 1 ) {
functional.push( key );
} else if ( jsonData[key] == 2 ) {
analytics.push( key );
} else if ( jsonData[key] == 3 ) {
advertising.push( key );
}
}
writeFinalReport( report, consents_array );
return;
} catch (parseError) {
console.error('Error while parsing the JSON file:', parseError);
}
}
});
} else {
console.log( "NO COOKIE SET WHILE INTERACTING");
writeWebsiteWithoutViolationInOutput( model, url );
}
} else {
console.log( "COOKIEBLOCK PREDICTION NOT EXECUTE BECAUSE " + url + " CONTAINS ERRORS" );
}
// This function is the one that performs the report on the console.
function writeFinalReport( report, consents_array ) {
var violation = false;
console.log("\n\nCookieBlockXGB model FINAL REPORT OVER WEBSITE: " + url + " \n" );
console.log( "NECESSARY COOKIES = " + report[0] );
console.log( "FUNCTIONAL COOKIES = " + report[1] );
console.log( "ANALYTICS COOKIES = " + report[2] );
console.log( "ADVERTISING COOKIES = " + report[3] );
// Perform the comparison between the consent array and the report array
const all_consents = [0, 1, 2, 3];
const difference =
all_consents.filter((element) => !consents_array.includes(element));
//console.log(difference);
if ( isEmpty(difference) ) {
console.log("ALL PERMISSIONS GIVEN");
} else {
difference.forEach( function (elem) {
if ( !isEmpty( report[elem] ) ) {
//console.log("COOKIES WITH NO CONSENT FOUND!");
violation = true;
}
});
}
if ( violation == true ) {
console.log( "\n⚠️\tVIOLATION FOUND: the consents given have not been respected\t⚠️" );
if ( no_interaction ) {
console.log( "NO INTERACTION WITH THE BANNER PERFORMED --> ONLY NECESSARY COOKIES SHOULD BE SET \n" );
}
var given_consents = "GIVEN CONSENTS FOR: ";
consents_array.forEach( function(elem) {
if ( elem == 0 ) {
given_consents += "Necessary ";
} else if ( elem == 1 ) {
given_consents += "Functional ";
} else if ( elem == 2 ) {
given_consents += "Analytics ";
} else if ( elem == 3 ) {
given_consents += "Advertising ";
}
});
console.log( given_consents + "cookies" );
var violation_string = "FOUND CONSENTS ALSO FOR: ";
difference.forEach( function(elem) {
if ( elem == 0 && !isEmpty(report[0]) ) {
violation_string += "Necessary ";
} else if ( elem == 1 && !isEmpty(report[1]) ) {
violation_string += "Functional ";
} else if ( elem == 2 && !isEmpty(report[2]) ) {
violation_string += "Analytics ";
} else if ( elem == 3 && !isEmpty(report[3]) ) {
violation_string += "Advertising ";
}
});
console.log( violation_string + "cookies" );
// Write website with violation in output to perform statistical analysis at the end
writeWebsiteWithViolationInOutput( model, url );
// Write report in output
writeViolationReportInOutput( model, url, report, given_consents, violation_string );
} else {
console.log( "NO VIOLATION FOUND");
writeWebsiteWithoutViolationInOutput( model, url );
}
}
// Function that records the name of the website under examination inside the folder with all the violations
function writeWebsiteWithViolationInOutput( model, url ) {
// Create folder if it doesn't exists
const violationsFolderPath = path.join(__dirname, 'violations/CookieBlockXGB');
if (!fs.existsSync(violationsFolderPath)) {
fs.mkdirSync(violationsFolderPath);
}
// Create model file for output
const modelFilePath = path.join(violationsFolderPath, `${model}.txt`);
// Check if the file exists, otherwise create it
if (!fs.existsSync(modelFilePath)) {
// Se il file non esiste, crealo
fs.writeFileSync(modelFilePath, '');
}
// Read file content
const currentContent = fs.readFileSync(modelFilePath, 'utf-8');
var content = url + "\n";
fs.appendFile(modelFilePath, content, { flag: 'a+' }, (err) => {
if (err) {
console.log( err );
return;
} else {
console.log(`URL "${url}" aggiunto al file "${model}.txt".`);;
}
});
}
// Function that creates the report for the website under examination.
function writeViolationReportInOutput( model, url, report, given_consents, violation_string ) {
// Create folder if it doesn't exists
const violationsFolderPath = path.join(__dirname, 'violations/CookieBlockXGB/reports');
if (!fs.existsSync(violationsFolderPath)) {
fs.mkdirSync(violationsFolderPath);
}
// Create model file for output
const modelFilePath = path.join(violationsFolderPath, `${url}.txt`);
// Check if the file exists, otherwise create it
if (!fs.existsSync(modelFilePath)) {
// Se il file non esiste, crealo
fs.writeFileSync(modelFilePath, '');
}
// Generate content for the output file
var content = "";
content = "CookieBlockXGB model FINAL REPORT OVER WEBSITE: " + url + " \n";
if ( no_interaction ) {
content += "NO INTERACTION WITH THE BANNER PERFORMED --> ONLY NECESSARY COOKIES SHOULD BE SET \n";
}
content += "NECESSARY COOKIES = " + report[0] + "\n";
content += "FUNCTIONAL COOKIES = " + report[1] + "\n";
content += "ANALYTICS COOKIES = " + report[2] + "\n";
content += "ADVERTISING COOKIES = " + report[3] + "\n";
content += "\n⚠️\tVIOLATION FOUND: the consents given have not been respected\t⚠️\n";
content += given_consents + "cookies\n";
content += violation_string + "cookies";
fs.appendFile(modelFilePath, content, { flag: 'a+' }, (err) => {
if (err) {
console.log( err );
return;
} else {
console.log(`Report for "${url}" written.`);;
}
});
}
// Function that records the name of the website that has no violation.
function writeWebsiteWithoutViolationInOutput( model, url ) {
// Create folder if it doesn't exists
const violationsFolderPath = path.join(__dirname, 'violations/CookieBlockXGB/NO_VIOLATIONS/');
if (!fs.existsSync(violationsFolderPath)) {
fs.mkdirSync(violationsFolderPath);
}
// Create model file for output
const modelFilePath = path.join(violationsFolderPath, `${model}.txt`);
// Check if the file exists, otherwise create it
if (!fs.existsSync(modelFilePath)) {
// Se il file non esiste, crealo
fs.writeFileSync(modelFilePath, '');
}
// Read file content
const currentContent = fs.readFileSync(modelFilePath, 'utf-8');
var content = url + "\n";
fs.appendFile(modelFilePath, content, { flag: 'a+' }, (err) => {
if (err) {
console.log( err );
return;
} else {
console.log(`URL "${url}" added to file "NO_VIOLATIONS/${model}.txt".`);;
}
});
}
function urlIsError( url ) {
const errorsFilePath = './violations/errors/errors.txt';
try {
const fileContent = fs.readFileSync(errorsFilePath, 'utf-8');
const errorUrls = fileContent.split('\n').map(line => line.trim());
//console.log( errorUrls );
//console.log(errorUrls.includes( "https://" + url ));
return errorUrls.includes( "https://" + url);
} catch (error) {
console.error(`Error reading file ${errorsFilePath}: ${error.message}`);
return false;
}
}
function isJsonEmptyFromFile( filePath ) {
try {
const jsonData = fs.readFileSync(filePath, 'utf-8');
// Converte il contenuto in un oggetto JavaScript
const jsonObject = JSON.parse(jsonData);
//console.log( Object.keys(jsonObject).length === 0 && jsonObject.constructor === Object );
// Verifica se l'oggetto è vuoto
return Object.keys(jsonObject).length === 0 && jsonObject.constructor === Object;
} catch (error) {
// Gestisci eventuali errori nella lettura del file o nel parsing del JSON
console.error('Errore durante la lettura o il parsing del file JSON:', error);
return false;
}
}