From 2d278d7af64ab7d0ba09226aa94454a4842e6c3c Mon Sep 17 00:00:00 2001 From: Benny Smit Date: Thu, 20 Jul 2023 13:21:32 +0200 Subject: [PATCH 1/3] added descriptions to TaintConfigSchema.json to explain its semantics --- config/TaintConfigSchema.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/config/TaintConfigSchema.json b/config/TaintConfigSchema.json index d5599b5170..54edc3ca52 100644 --- a/config/TaintConfigSchema.json +++ b/config/TaintConfigSchema.json @@ -14,29 +14,36 @@ R"( "description": "Version of this taint configuration" }, "functions": { + "description": "Array of functions you want to include in your analysis", "type": "array", "properties": { "name": { - "type": "string" + "type": "string", + "description": "Name of the function in the llvm IR (look for possible mangling)" }, "ret": { - "enum": ["source", "sink", "sanitizer"] + "enum": ["source", "sink", "sanitizer"], + "description": "tag the returned value as source sink or sanitizer" }, "params": { + "description": "tags function parameters as source, sink or sanitizer", "properties": { "source": { + "description": "zero based indices of source tags", "type": "array", "properties": { "type": ["number", "string"] } }, "sink": { + "description": "zero based indices of sink tags. A Leak is detected if the function gets called with source taged value in this indices.", "type": "array", "properties": { "type": ["number", "string"] } }, "sanitizer": { + "description": "zero based indices of sanitizer tags", "type": "array", "properties": { "type": ["number", "string"] From 1dab9f964ad28ea4669b255a3c615ba96d937efa Mon Sep 17 00:00:00 2001 From: Martin Mory Date: Tue, 25 Jul 2023 11:39:03 +0200 Subject: [PATCH 2/3] capitalize first letter of descriptions consistently --- config/TaintConfigSchema.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config/TaintConfigSchema.json b/config/TaintConfigSchema.json index 54edc3ca52..4d10117c0b 100644 --- a/config/TaintConfigSchema.json +++ b/config/TaintConfigSchema.json @@ -23,27 +23,27 @@ R"( }, "ret": { "enum": ["source", "sink", "sanitizer"], - "description": "tag the returned value as source sink or sanitizer" + "description": "Tags the returned value as source sink or sanitizer" }, "params": { - "description": "tags function parameters as source, sink or sanitizer", + "description": "Tags function parameters as source, sink or sanitizer", "properties": { "source": { - "description": "zero based indices of source tags", + "description": "Zero based indices of source tags", "type": "array", "properties": { "type": ["number", "string"] } }, "sink": { - "description": "zero based indices of sink tags. A Leak is detected if the function gets called with source taged value in this indices.", + "description": "Zero based indices of sink tags. A Leak is detected if the function gets called with source taged value in this indices.", "type": "array", "properties": { "type": ["number", "string"] } }, "sanitizer": { - "description": "zero based indices of sanitizer tags", + "description": "Zero based indices of sanitizer tags", "type": "array", "properties": { "type": ["number", "string"] From 5974ff698405a0f1a8a1a712715c922eb603ab58 Mon Sep 17 00:00:00 2001 From: Martin Mory Date: Wed, 26 Jul 2023 10:55:31 +0200 Subject: [PATCH 3/3] Remove parentheses which broke the compilation --- config/TaintConfigSchema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/TaintConfigSchema.json b/config/TaintConfigSchema.json index 4d10117c0b..25264e2566 100644 --- a/config/TaintConfigSchema.json +++ b/config/TaintConfigSchema.json @@ -19,7 +19,7 @@ R"( "properties": { "name": { "type": "string", - "description": "Name of the function in the llvm IR (look for possible mangling)" + "description": "Name of the function in the llvm IR, look for possible mangling" }, "ret": { "enum": ["source", "sink", "sanitizer"],