-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into rh/onlynever
- Loading branch information
Showing
30 changed files
with
1,003 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
.../main/kotlin/de/fraunhofer/aisec/codyze/backends/cpg/coko/evaluators/ArgumentEvaluator.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright (c) 2024, Fraunhofer AISEC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package de.fraunhofer.aisec.codyze.backends.cpg.coko.evaluators | ||
|
|
||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.CokoCpgBackend | ||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.CpgFinding | ||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.dsl.cpgGetAllNodes | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.EvaluationContext | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.Evaluator | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.Finding | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.dsl.Op | ||
| import de.fraunhofer.aisec.cpg.graph.declarations.VariableDeclaration | ||
| import de.fraunhofer.aisec.cpg.graph.followPrevEOGEdgesUntilHit | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.CallExpression | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.Expression | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.Literal | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.Reference | ||
|
|
||
| context(CokoCpgBackend) | ||
| class ArgumentEvaluator(val targetCall: Op, val argPos: Int, val originCall: Op) : Evaluator { | ||
| override fun evaluate(context: EvaluationContext): List<CpgFinding> { | ||
| // Get all good calls and the associated variables | ||
| val originCalls = originCall.cpgGetAllNodes() | ||
| val variables = originCalls.mapNotNull { | ||
| it.tryGetVariableDeclaration() | ||
| } | ||
| val findings = mutableListOf<CpgFinding>() | ||
| // Get all target calls using the variable and check whether it is in a good state | ||
| val targetCalls = targetCall.cpgGetAllNodes() | ||
| for (call in targetCalls) { | ||
| val arg: VariableDeclaration? = | ||
| (call.arguments.getOrNull(argPos) as? Reference)?.refersTo as? VariableDeclaration | ||
| if (arg in variables && arg?.allowsInvalidPaths(originCalls.toList(), call) == false) { | ||
| findings.add( | ||
| CpgFinding( | ||
| message = "Complies with rule: " + | ||
| "arg $argPos of \"${call.code}\" stems from a call to \"$originCall\"", | ||
| kind = Finding.Kind.Pass, | ||
| node = call, | ||
| relatedNodes = listOfNotNull(originCalls.firstOrNull { it.tryGetVariableDeclaration() == arg }) | ||
| ) | ||
| ) | ||
| } else { | ||
| findings.add( | ||
| CpgFinding( | ||
| message = "Violation against rule: " + | ||
| "arg $argPos of \"${call.code}\" does not stem from a call to \"$originCall\"", | ||
| kind = Finding.Kind.Fail, | ||
| node = call, | ||
| relatedNodes = listOf() | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| return findings | ||
| } | ||
|
|
||
| /** | ||
| * Tries to resolve which variable is modified by a CallExpression | ||
| * @return The VariableExpression modified by the CallExpression or null | ||
| */ | ||
| private fun CallExpression.tryGetVariableDeclaration(): VariableDeclaration? { | ||
| return when (val nextDFG = this.nextDFG.firstOrNull()) { | ||
| is VariableDeclaration -> nextDFG | ||
| is Reference -> nextDFG.refersTo as? VariableDeclaration | ||
| else -> null | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This method tries to get all possible CallExpressions that try to override the variable value | ||
| * @return The CallExpressions modifying the variable | ||
| */ | ||
| private fun VariableDeclaration.getOverrides(): List<Expression> { | ||
| val assignments = this.typeObservers.mapNotNull { (it as? Reference)?.prevDFG?.firstOrNull() } | ||
| // Consider overwrites caused by CallExpressions and Literals | ||
| return assignments.mapNotNull { | ||
| when (it) { | ||
| is CallExpression -> it | ||
| is Literal<*> -> it | ||
| else -> null | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This method checks whether there are any paths with forbidden values for the variable that end in the target call | ||
| * @param allowedCalls The calls that set the variable to an allowed value | ||
| * @param targetCall The target call using the variable as an argument | ||
| * @return whether there is at least one path that allows an invalid value for the variable to reach the target | ||
| */ | ||
| private fun VariableDeclaration.allowsInvalidPaths( | ||
| allowedCalls: List<CallExpression>, | ||
| targetCall: CallExpression | ||
| ): Boolean { | ||
| // Get every MemberCall that tries to override our variable, ignoring allowed calls | ||
| val interferingDeclarations = this.getOverrides().toMutableList() - allowedCalls.toSet() | ||
| // Check whether there is a path from any invalid call to our target call that is not overridden at least once | ||
| val targetToNoise = targetCall.followPrevEOGEdgesUntilHit { interferingDeclarations.contains(it) }.fulfilled | ||
| .filterNot { badPath -> allowedCalls.any { goodCall -> goodCall in badPath } } | ||
| return targetToNoise.isNotEmpty() | ||
| } | ||
| } |
115 changes: 115 additions & 0 deletions
115
.../main/kotlin/de/fraunhofer/aisec/codyze/backends/cpg/coko/evaluators/PrecedesEvaluator.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * Copyright (c) 2022, Fraunhofer AISEC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package de.fraunhofer.aisec.codyze.backends.cpg.coko.evaluators | ||
|
|
||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.CokoCpgBackend | ||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.CpgFinding | ||
| import de.fraunhofer.aisec.codyze.backends.cpg.coko.dsl.cpgGetNodes | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.EvaluationContext | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.Evaluator | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.Finding | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.dsl.Op | ||
| import de.fraunhofer.aisec.codyze.specificationLanguages.coko.core.dsl.Rule | ||
| import de.fraunhofer.aisec.cpg.graph.* | ||
| import de.fraunhofer.aisec.cpg.graph.edge.Properties | ||
| import kotlin.reflect.full.findAnnotation | ||
|
|
||
| context(CokoCpgBackend) | ||
| class PrecedesEvaluator(val prevOp: Op, val thisOp: Op) : Evaluator { | ||
|
|
||
| private val defaultFailMessage: String by lazy { | ||
| "It is not preceded by any of these calls: $prevOp." | ||
| } | ||
|
|
||
| private val defaultPassMessage = "" | ||
|
|
||
| override fun evaluate(context: EvaluationContext): List<CpgFinding> { | ||
| val (unreachableThisNodes, thisNodes) = | ||
| with(this@CokoCpgBackend) { thisOp.cpgGetNodes().toSet() } | ||
| .partition { it.isUnreachable() } | ||
|
|
||
| val prevNodes = with(this@CokoCpgBackend) { prevOp.cpgGetNodes().toSet() } | ||
|
|
||
| val findings = mutableListOf<CpgFinding>() | ||
|
|
||
| // add all unreachable `this` nodes as NotApplicable findings | ||
| findings.addAll( | ||
| unreachableThisNodes.map { | ||
| CpgFinding( | ||
| message = "Rule is not applicable for \"${it.code}\" because it is unreachable", | ||
| kind = Finding.Kind.NotApplicable, | ||
| node = it | ||
| ) | ||
| } | ||
| ) | ||
|
|
||
| val ruleAnnotation = context.rule.findAnnotation<Rule>() | ||
| val failMessage = ruleAnnotation?.failMessage?.takeIf { it.isNotEmpty() } ?: defaultFailMessage | ||
| val passMessage = ruleAnnotation?.passMessage?.takeIf { it.isNotEmpty() } ?: defaultPassMessage | ||
|
|
||
| for (target in thisNodes) { | ||
| val paths = target.followPrevEOGEdgesUntilHit { prevNodes.contains(it) } | ||
|
|
||
| val newFindings = | ||
| if (paths.fulfilled.isNotEmpty() && paths.failed.isEmpty()) { | ||
| val availablePrevNodes = paths.fulfilled.mapNotNull { it.firstOrNull() } | ||
| // All paths starting from `from` end in one of the `that` nodes | ||
| listOf( | ||
| CpgFinding( | ||
| message = "Complies with rule: ${availablePrevNodes.joinToString( | ||
| prefix = "\"", | ||
| separator = "\", \"", | ||
| postfix = "\"", | ||
| transform = { node -> node.code ?: node.toString() } | ||
| )} precedes ${target.code}. $passMessage", | ||
| kind = Finding.Kind.Pass, | ||
| node = target, | ||
| relatedNodes = availablePrevNodes | ||
| ) | ||
| ) | ||
| } else { | ||
| // Some (or all) paths starting from `from` do not end in any of the `that` nodes | ||
| paths.failed.map { failedPath -> | ||
| // make a finding for each failed path | ||
| CpgFinding( | ||
| message = | ||
| "Violation against rule in execution path to \"${target.code}\". $failMessage", | ||
| kind = Finding.Kind.Fail, | ||
| node = target, | ||
| // improve: specify paths more precisely | ||
| // for example one branch passes and one fails skip part in path after branches are combined | ||
| relatedNodes = listOf(failedPath.first()) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| findings.addAll(newFindings) | ||
| } | ||
|
|
||
| return findings | ||
| } | ||
|
|
||
| /** Checks if this node is unreachable */ | ||
| private fun Node.isUnreachable(): Boolean { | ||
| val prevPaths = this.followPrevEOGEdgesUntilHit { | ||
| it.prevEOGEdges.isNotEmpty() && it.prevEOGEdges.all { | ||
| edge -> | ||
| edge.getProperty(Properties.UNREACHABLE) == true | ||
| } | ||
| } | ||
| return prevPaths.fulfilled.isNotEmpty() | ||
| } | ||
| } |
Oops, something went wrong.