Skip to content

Optimize hardcoded IV detection using semantic model reference counting #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThisaruGuruge merged 2 commits into from
Sep 19, 2025
Merged

Optimize hardcoded IV detection using semantic model reference counting #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e2d190
Simplify hardcoded IV detection using reference counting approach
nureka-rodrigo Sep 19, 2025
1733a91
Update changelog.md
nureka-rodrigo Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Changed
- [Update OIDS of NIST approved post quantum algorithms](https://github.com/ballerina-platform/ballerina-library/issues/7678)
- [Optimize hardcoded IV detection using semantic model reference counting](https://github.com/ballerina-platform/ballerina-library/issues/8257)

## [2.8.0] - 2025-02-11

Expand Down
150 changes: 11 additions & 139 deletions ...main/java/io/ballerina/stdlib/crypto/compiler/staticcodeanalyzer/CryptoAnalyzerUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@

package io.ballerina.stdlib.crypto.compiler.staticcodeanalyzer;

import io.ballerina.compiler.api.SemanticModel;
import io.ballerina.compiler.api.symbols.Symbol;
import io.ballerina.compiler.syntax.tree.BasicLiteralNode;
import io.ballerina.compiler.syntax.tree.CaptureBindingPatternNode;
import io.ballerina.compiler.syntax.tree.ExpressionNode;
import io.ballerina.compiler.syntax.tree.FunctionBodyBlockNode;
import io.ballerina.compiler.syntax.tree.ListConstructorExpressionNode;
import io.ballerina.compiler.syntax.tree.ModuleMemberDeclarationNode;
import io.ballerina.compiler.syntax.tree.ModulePartNode;
import io.ballerina.compiler.syntax.tree.ModuleVariableDeclarationNode;
Expand All @@ -33,7 +36,9 @@
import io.ballerina.projects.Document;
import io.ballerina.projects.DocumentId;
import io.ballerina.projects.Module;
import io.ballerina.projects.plugins.SyntaxNodeAnalysisContext;

import java.util.Optional;
import java.util.function.BiPredicate;
import java.util.function.Predicate;

Expand Down Expand Up @@ -88,7 +93,7 @@ public static boolean isWeakCipherFunction(String functionName) {
* @return true if the function requires secure IVs, false otherwise
*/
public static boolean requiresSecureIV(String functionName) {
return ENCRYPT_AES_GCM.equals(functionName);
return ENCRYPT_AES_GCM.equals(functionName) || ENCRYPT_AES_CBC.equals(functionName);
}

/**
Expand Down Expand Up @@ -235,147 +240,14 @@ public static boolean checkPbkdf2InitializerValue(String initText) {
* @param expression the expression to check
* @return true if the expression is a hardcoded IV, false otherwise
*/
public static boolean isHardcodedIV(ExpressionNode expression) {
// Check for basic literals like 123, "abc", etc.
if (expression instanceof BasicLiteralNode) {
public static boolean isHardcodedIV(ExpressionNode expression, SyntaxNodeAnalysisContext context) {
if (expression instanceof BasicLiteralNode || expression instanceof ListConstructorExpressionNode) {
return true;
} else if (expression instanceof SimpleNameReferenceNode varRef) {
return hasHardcodedIVDeclaration(varRef);
SemanticModel semanticModel = context.semanticModel();
Optional<Symbol> symbolOpt = semanticModel.symbol(varRef);
return symbolOpt.isPresent() && semanticModel.references(symbolOpt.get()).size() == 2;
}
// Check for array literals like [1, 2, 3, 4, ...] or byte array constructions
String sourceCode = expression.toSourceCode().trim();
return isArrayLiteralPattern(sourceCode);
}

/**
* Checks if the source code represents an array literal pattern that indicates
* hardcoded values.
*
* @param sourceCode the source code to check
* @return true if it's an array literal pattern, false otherwise
*/
private static boolean isArrayLiteralPattern(String sourceCode) {
// Check for patterns like [1, 2, 3, ...] or similar hardcoded array constructions
if (sourceCode.startsWith("[") && sourceCode.endsWith("]")) {
String content = sourceCode.substring(1, sourceCode.length() - 1).trim();
if (content.isEmpty()) {
return false;
}
// Check if content contains only numbers, commas, and whitespace (indicating literal values)
return content.matches("^[\\d,\\s]+$");
}
return false;
}

/**
* Checks if the given variable reference refers to a variable with a hardcoded
* IV declaration.
*
* @param varRef the variable reference
* @return true if the variable has a hardcoded IV declaration, false otherwise
*/
private static boolean hasHardcodedIVDeclaration(SimpleNameReferenceNode varRef) {
String varName = varRef.name().text();
return hasHardcodedIVInScope(varRef.parent(), varName);
}

/**
* Checks if a variable with the given name has a hardcoded IV declaration
* within a specific scope.
*
* @param startNode the node to start searching from
* @param varName the name of the variable
* @return true if a hardcoded IV declaration is found, false otherwise
*/
private static boolean hasHardcodedIVInScope(Node startNode, String varName) {
Node current = startNode;
while (current != null) {
if (current instanceof FunctionBodyBlockNode functionBodyBlock) {
if (checkStatementsForHardcodedIV(functionBodyBlock.statements(), varName)) {
return true;
}
} else if (current instanceof ModulePartNode modulePart
&& checkModuleMembersForHardcodedIV(modulePart.members(), varName)) {
return true;
}

current = current.parent();
}
return false;
}

/**
* Checks a list of statements for a hardcoded IV declaration.
*
* @param statements the statements to check
* @param varName the name of the variable
* @return true if a hardcoded IV declaration is found, false otherwise
*/
private static boolean checkStatementsForHardcodedIV(NodeList<StatementNode> statements, String varName) {
for (StatementNode stmt : statements) {
if (isHardcodedIVVariable(stmt, varName)) {
return true;
}
}
return false;
}

/**
* Checks a list of module members for a hardcoded IV declaration.
*
* @param members the module members to check
* @param varName the name of the variable
* @return true if a hardcoded IV declaration is found, false otherwise
*/
private static boolean checkModuleMembersForHardcodedIV(NodeList<ModuleMemberDeclarationNode> members,
String varName) {
for (ModuleMemberDeclarationNode member : members) {
if (isHardcodedIVVariable(member, varName)) {
return true;
}
}
return false;
}

/**
* Checks if the given statement declares a variable with a hardcoded IV value.
*
* @param stmt the statement to check
* @param varName the name of the variable
* @return true if the statement declares a variable with a hardcoded IV, false
* otherwise
*/
private static boolean isHardcodedIVVariable(Node stmt, String varName) {
return isWeakVariableWithInitializer(stmt, varName, CryptoAnalyzerUtils::isHardcodedIVInitializer);
}

/**
* Checks if the given initializer represents a hardcoded IV.
*
* @param initText the initializer text
* @return true if the initializer is a hardcoded IV, false otherwise
*/
private static boolean isHardcodedIVInitializer(String initText) {
initText = initText.trim();

// Check for array literal patterns
if (isArrayLiteralPattern(initText)) {
return true;
}

// Check for patterns that indicate hardcoded values like byte[16] with literal assignments
if (initText.contains("[") && initText.contains("]")) {
return true;
}

// Check for simple literal values
try {
Integer.parseInt(initText);
return true;
} catch (NumberFormatException e) {
// Not a simple integer
}

return false;
}

Expand Down
9 changes: 5 additions & 4 deletions ...io/ballerina/stdlib/crypto/compiler/staticcodeanalyzer/CryptoCipherAlgorithmAnalyzer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public class CryptoCipherAlgorithmAnalyzer implements AnalysisTask<SyntaxNodeAna
private final Reporter reporter;
private static final String BALLERINA_ORG = "ballerina";
private static final String CRYPTO = "crypto";
private static final String IV = "iv";
private final Set<String> cryptoPrefixes = new HashSet<>();

public CryptoCipherAlgorithmAnalyzer(Reporter reporter) {
Expand Down Expand Up @@ -210,7 +211,7 @@ private void checkWeakPbkdf2Usage(FunctionCallExpressionNode functionCall, Synta
}

/**
* Checks if the AES-GCM function is used with hardcoded initialization vectors.
* Checks if the AES-GCM/AES-ECB functions are used with hardcoded initialization vectors.
* For encryptAesGcm(input, key, iv, padding, tagSize), the third parameter (iv)
* is checked.
*
Expand All @@ -228,15 +229,15 @@ private void checkHardcodedIVUsage(FunctionCallExpressionNode functionCall, Synt
// Check for positional arguments
if (ivArgument instanceof PositionalArgumentNode positional) {
ExpressionNode expr = positional.expression();
if (CryptoAnalyzerUtils.isHardcodedIV(expr)) {
if (CryptoAnalyzerUtils.isHardcodedIV(expr, context)) {
report(context, AVOID_REUSING_COUNTER_MODE_VECTORS.getId());
}
} else if (ivArgument instanceof NamedArgumentNode named) {
// Check for named arguments
String paramName = named.argumentName().name().text();
if ("iv".equals(paramName)) {
if (IV.equals(paramName)) {
ExpressionNode expr = named.expression();
if (CryptoAnalyzerUtils.isHardcodedIV(expr)) {
if (CryptoAnalyzerUtils.isHardcodedIV(expr, context)) {
report(context, AVOID_REUSING_COUNTER_MODE_VECTORS.getId());
}
}
Expand Down
Loading