cpg/de.fraunhofer.aisec.codyze.backends.cpg.coko.dsl

Package-level declarations

Types

Result

enum Result : Enum<Result>

A data class that serves as a ternary value for the analysis result.

Properties

cpg

val CokoBackend.cpg: TranslationResult

Functions

allResult

fun <T> Array<T>.allResult(predicate: (T) -> Result?): Result

fun <T> Iterable<T>.allResult(predicate: (T) -> Result?): Result

returns VALID if all Results are VALID, otherwise returns OPEN if any result is OPEN, otherwise returns INVALID

and

fun Result.and(other: Result): Result

precedence order for ternary and: OPEN INVALID VALID

anyResult

fun <T> Array<T>.anyResult(predicate: (T) -> Result?): Result

fun <T> Iterable<T>.anyResult(predicate: (T) -> Result?): Result

returns VALID if any Result is VALID, otherwise returns OPEN if any result is OPEN, otherwise returns INVALID

cpgCall

fun CokoBackend.cpgCall(name: String, predicate: CallExpression.() -> Boolean = { true }): List<CallExpression>

Returns a list of CallExpressions with the matching name and fulfilling predicate.

cpgCallFqn

fun CokoBackend.cpgCallFqn(fqn: String, predicate: CallExpression.() -> Boolean = { true }): List<CallExpression>

Returns a list of CallExpressions with the matching fqn (fully-qualified name) and fulfilling predicate.

cpgConstructor

fun CokoBackend.cpgConstructor(classFqn: String, predicate: CallExpression.() -> Boolean = { true }): List<ConstructExpression>

Returns a list of ConstructExpressions with the matching classFqn and fulfilling predicate.

cpgFlowsTo

infix fun Any.cpgFlowsTo(that: Node): Result

Checks if there's a data flow path from "this" to that.

infix fun Any.cpgFlowsTo(that: Collection<Node>): Result

Checks if there's a data flow path from "this" to any of the elements in that.

cpgGetAllNodes

fun Op.cpgGetAllNodes(): Collection<CallExpression>

Get all Nodes that are associated with this Op.

fun DataItem<*>.cpgGetAllNodes(): Nodes

Get all Nodes that are associated with this DataItem.

cpgGetNodes

fun Op.cpgGetNodes(): Map<CallExpression, Result>

Get all Nodes that are associated with this Op and fulfill the Signatures of the Definitions.

fun DataItem<*>.cpgGetNodes(): Nodes

Get all Nodes that are associated with this DataItem.

cpgMemberExpr

fun CokoBackend.cpgMemberExpr(predicate: MemberExpression.() -> Boolean): List<MemberExpression>

Returns a list of MemberExpressions with the matching something.

cpgSignature

fun CallExpression.cpgSignature(vararg parameters: Any?, hasVarargs: Boolean = false): Result

Checks if the CallExpression matches the signature specified with parameters. Returns false if there are nulls in parameters,

cpgVariable

fun CokoBackend.cpgVariable(name: String): List<ValueDeclaration>

Returns a list of ValueDeclarations with the matching name.

cpgVariableFqn

fun CokoBackend.cpgVariableFqn(fqn: String): List<ValueDeclaration>

Returns a list of ValueDeclarations with the matching fqn.

findUsages

fun Node.findUsages(depth: Int = 5): Collection<Node>

To generate more interesting Findings we want to find key points where the forbidden operation influences other code. For this we traverse the DFG for a fixed amount of steps and search for all usages of declared values.