Skip to content

Commit

Permalink
added descriptions to TaintConfigSchema.json to explain its semantics
Browse files Browse the repository at this point in the history
  • Loading branch information
StamesJames committed Jul 20, 2023
1 parent 349656f commit 2d278d7
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions config/TaintConfigSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit 2d278d7

Please sign in to comment.