Skip to content

SONARPY-273 Update rule S2068 to avoid FPs on comparisons and method … #558

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
andrea-guarino-sonarsource merged 2 commits into from
Feb 10, 2020
Merged

SONARPY-273 Update rule S2068 to avoid FPs on comparisons and method … #558

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
cacd248
SONARPY-273 Update rule S2068 to avoid FPs on comparisons and method …
guillaume-dequenne Feb 10, 2020
0d026ba
Rule S2068: Avoid raising issues on docstrings
guillaume-dequenne Feb 10, 2020
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
7 changes: 0 additions & 7 deletions its/ruling/src/test/resources/expected/python-S2068.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@
'project:buildbot-0.8.6p1/buildbot/status/client.py':[
563,
],
'project:buildbot-0.8.6p1/buildbot/status/web/authz.py':[
140,
161,
],
'project:buildbot-0.8.6p1/buildbot/test/unit/test_changes_pb.py':[
44,
48,
Expand Down Expand Up @@ -164,9 +160,6 @@
259,
276,
],
'project:twisted-12.1.0/twisted/conch/test/test_ssh.py':[
332,
],
'project:twisted-12.1.0/twisted/manhole/telnet.py':[
95,
],
Expand Down
82 changes: 18 additions & 64 deletions python-checks/src/main/java/org/sonar/python/checks/hotspots/HardCodedCredentialsCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,26 @@
import org.sonar.plugins.python.api.symbols.Symbol;
import org.sonar.plugins.python.api.tree.Argument;
import org.sonar.plugins.python.api.tree.AssignmentStatement;
import org.sonar.plugins.python.api.tree.BinaryExpression;
import org.sonar.plugins.python.api.tree.CallExpression;
import org.sonar.plugins.python.api.tree.ClassDef;
import org.sonar.plugins.python.api.tree.DictionaryLiteral;
import org.sonar.plugins.python.api.tree.DictionaryLiteralElement;
import org.sonar.plugins.python.api.tree.Expression;
import org.sonar.plugins.python.api.tree.ExpressionList;
import org.sonar.plugins.python.api.tree.FileInput;
import org.sonar.plugins.python.api.tree.FunctionDef;
import org.sonar.plugins.python.api.tree.HasSymbol;
import org.sonar.plugins.python.api.tree.KeyValuePair;
import org.sonar.plugins.python.api.tree.Name;
import org.sonar.plugins.python.api.tree.Parameter;
import org.sonar.plugins.python.api.tree.ParameterList;
import org.sonar.plugins.python.api.tree.QualifiedExpression;
import org.sonar.plugins.python.api.tree.RegularArgument;
import org.sonar.plugins.python.api.tree.StringElement;
import org.sonar.plugins.python.api.tree.StringLiteral;
import org.sonar.plugins.python.api.tree.SubscriptionExpression;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.plugins.python.api.tree.Tree.Kind;
import org.sonar.python.tree.TreeUtils;

@Rule(key = "S2068")
public class HardCodedCredentialsCheck extends PythonSubscriptionCheck {
Expand Down Expand Up @@ -101,15 +103,14 @@ private Stream<Pattern> literalPatterns() {
// Avoid raising on prepared statements
String credentials = Stream.of(credentialWords.split(","))
.map(String::trim).collect(Collectors.joining("|"));
literalPatterns = toPatterns("=(?!.*(" + credentials + "))[^:%'?\\s]+");
literalPatterns = toPatterns("=(?!.*(" + credentials + "))[^:%'?{\\s]+");
}
return literalPatterns.stream();
}

@Override
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(Kind.ASSIGNMENT_STMT, ctx -> handleAssignmentStatement((AssignmentStatement) ctx.syntaxNode(), ctx));
context.registerSyntaxNodeConsumer(Kind.COMPARISON, ctx -> handleBinaryExpression((BinaryExpression) ctx.syntaxNode(), ctx));
context.registerSyntaxNodeConsumer(Kind.STRING_LITERAL, ctx -> handleStringLiteral((StringLiteral) ctx.syntaxNode(), ctx));
context.registerSyntaxNodeConsumer(Kind.CALL_EXPR, ctx -> handleCallExpression((CallExpression) ctx.syntaxNode(), ctx));
context.registerSyntaxNodeConsumer(Kind.REGULAR_ARGUMENT, ctx -> handleRegularArgument((RegularArgument) ctx.syntaxNode(), ctx));
Expand Down Expand Up @@ -166,73 +167,30 @@ private void handleCallExpression(CallExpression callExpression, SubscriptionCon
if (callExpression.arguments().isEmpty()) {
return;
}
// Raising issues on pwd.__eq__("literal") calls
if (callExpression.callee().is(Kind.QUALIFIED_EXPR)) {
QualifiedExpression qualifiedExpression = (QualifiedExpression) callExpression.callee();
if (qualifiedExpression.name().name().equals("__eq__")) {
checkEqualsCall(callExpression, qualifiedExpression, ctx);
}
}
Symbol calleeSymbol = callExpression.calleeSymbol();
if (calleeSymbol != null && sensitiveArgumentByFQN().containsKey(calleeSymbol.fullyQualifiedName())) {
checkSensitiveArgument(callExpression, sensitiveArgumentByFQN().get(calleeSymbol.fullyQualifiedName()), ctx);
}
}

private void checkEqualsCall(CallExpression callExpression, QualifiedExpression qualifiedExpression, SubscriptionContext ctx) {
String matchedCredential = matchedCredentialFromQualifiedExpression(qualifiedExpression);
if (matchedCredential != null) {
if (isFirstArgumentAStringLiteral(callExpression)) {
ctx.addIssue(callExpression, String.format(MESSAGE, matchedCredential));
}
} else if (qualifiedExpression.qualifier().is(Kind.STRING_LITERAL)) {
String matched = firstArgumentCredential(callExpression);
if (matched != null) {
ctx.addIssue(callExpression, String.format(MESSAGE, matched));
}
}
}

private String firstArgumentCredential(CallExpression callExpression) {
Argument argument = callExpression.arguments().get(0);
String matchedCredential = null;
if (argument.is(Kind.REGULAR_ARGUMENT)) {
RegularArgument regularArgument = (RegularArgument) argument;
if (regularArgument.expression().is(Kind.NAME)) {
matchedCredential = matchedCredential(((Name) regularArgument.expression()).name(), variablePatterns());
}
}
return matchedCredential;
}

private static boolean isFirstArgumentAStringLiteral(CallExpression callExpression) {
return callExpression.arguments().get(0).is(Kind.REGULAR_ARGUMENT)
&& ((RegularArgument) callExpression.arguments().get(0)).expression().is(Kind.STRING_LITERAL);
}

private String matchedCredentialFromQualifiedExpression(QualifiedExpression qualifiedExpression) {
String matchedCredential = null;
if (qualifiedExpression.qualifier().is(Kind.NAME)) {
matchedCredential = matchedCredential(((Name) qualifiedExpression.qualifier()).name(), variablePatterns());
}
return matchedCredential;
}

private static void checkSensitiveArgument(CallExpression callExpression, int argNb, SubscriptionContext ctx) {
for (int i = 0; i < callExpression.arguments().size(); i++) {
Argument argument = callExpression.arguments().get(i);
if (argument.is(Kind.REGULAR_ARGUMENT)) {
RegularArgument regularArgument = (RegularArgument) argument;
if (regularArgument.keywordArgument() != null) {
return;
} else if (i == argNb && regularArgument.expression().is(Kind.STRING_LITERAL)) {
} else if (i == argNb && regularArgument.expression().is(Kind.STRING_LITERAL) && !((StringLiteral) regularArgument.expression()).trimmedQuotesValue().isEmpty()) {
ctx.addIssue(regularArgument, "Review this potentially hard-coded credential.");
}
}
}
}

private void handleStringLiteral(StringLiteral stringLiteral, SubscriptionContext ctx) {
if (isDocString(stringLiteral)) {
return;
}
if (stringLiteral.stringElements().stream().anyMatch(StringElement::isInterpolated)) {
return;
}
Expand All @@ -245,6 +203,15 @@ private void handleStringLiteral(StringLiteral stringLiteral, SubscriptionContex
}
}

private static boolean isDocString(StringLiteral stringLiteral) {
Tree parent = TreeUtils.firstAncestorOfKind(stringLiteral, Kind.FILE_INPUT, Kind.CLASSDEF, Kind.FUNCDEF);
return Optional.ofNullable(parent)
.map(p -> ((p.is(Kind.FILE_INPUT) && stringLiteral.equals(((FileInput) p).docstring()))
|| (p.is(Kind.CLASSDEF) && stringLiteral.equals(((ClassDef) p).docstring()))
|| (p.is(Kind.FUNCDEF) && stringLiteral.equals(((FunctionDef) p).docstring()))))
.orElse(false);
}

private static boolean isURLWithCredentials(StringLiteral stringLiteral) {
if (!stringLiteral.trimmedQuotesValue().contains("://")) {
return false;
Expand All @@ -261,19 +228,6 @@ private static boolean isURLWithCredentials(StringLiteral stringLiteral) {
return false;
}

private void handleBinaryExpression(BinaryExpression binaryExpression, SubscriptionContext ctx) {
String matchedCredential = null;
if (binaryExpression.leftOperand() instanceof HasSymbol && binaryExpression.rightOperand().is(Tree.Kind.STRING_LITERAL)) {
matchedCredential = credentialSymbolName(((HasSymbol) binaryExpression.leftOperand()).symbol());
}
if (binaryExpression.rightOperand() instanceof HasSymbol && binaryExpression.leftOperand().is(Tree.Kind.STRING_LITERAL)) {
matchedCredential = credentialSymbolName(((HasSymbol) binaryExpression.rightOperand()).symbol());
}
if (matchedCredential != null) {
ctx.addIssue(binaryExpression, String.format(MESSAGE, matchedCredential));
}
}

private void handleAssignmentStatement(AssignmentStatement assignmentStatement, SubscriptionContext ctx) {
ExpressionList lhs = assignmentStatement.lhsExpressions().get(0);
Expression expression = lhs.expressions().get(0);
Expand Down
64 changes: 32 additions & 32 deletions python-checks/src/test/resources/checks/hardCodedCredentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
some docstring
password=hello
no issue
"""
from Crypto.Cipher import AES
import base64
import os
Expand All @@ -17,7 +22,10 @@ def getDecrypted(encodedtext):
return cipher.decrypt(base64.b64decode(encodedtext))

class A:

"""
password=azerty123
OK
"""
passed = "passed"
password = "azerty123" # Noncompliant
password = "azerty123" # Noncompliant
Expand All @@ -27,6 +35,10 @@ class A:
(a, b) = ("some", "thing")

def __init__(self):
"""
password=azerty123
OK
"""
self.passed = "passed"
fieldNameWithPasswordInIt = "azerty123" # Noncompliant {{"password" detected here, review this potentially hard-coded credential.}}
fieldNameWithPasswordInIt = os.getenv("password", "") # OK
Expand All @@ -49,6 +61,8 @@ def a(self,pwd="azerty123", other=None): # Noncompliant {{"pwd" detected here,
var1 = "&password=:password" # OK
var1 = "&password=:param" # OK
var1 = "&password='"+pwd+"'" # OK
var1 = f"&password={pwd}" # OK
var1 = "&password={something}" # OK

url = "http://user:azerty123@domain.com" # Noncompliant {{Review this hard-coded URL, which may contain a credential.}}
url = "https://user:azerty123@domain.com" # Noncompliant {{Review this hard-coded URL, which may contain a credential.}}
Expand All @@ -57,6 +71,8 @@ def a(self,pwd="azerty123", other=None): # Noncompliant {{"pwd" detected here,
url = "http://user@domain.com:80" # OK
url = "http://user@domain.com" # OK
url = "http://domain.com/user:azerty123" # OK
url = "ssh://domain.com/user:azerty123" # OK
url = "unknown://domain.com/user:azerty123" # OK

username = 'admin'
password = pwd
Expand Down Expand Up @@ -85,49 +101,25 @@ def a(self,pwd="azerty123", other=None): # Noncompliant {{"pwd" detected here,
CONNECTION_PASSWORD = "connection.password" # OK
RESETPWD = "/users/resetUserPassword" # OK

if password == 'Password123': # Noncompliant
pass
elif 'Password123' == password: # Noncompliant
pass
elif password.__eq__('Password123'): # Noncompliant {{"password" detected here, review this potentially hard-coded credential.}}
pass
elif something.__eq__('Password123'): # OK
pass
elif password.__eq__(something): # OK
pass
elif password.__eq__(*unpack): # OK
pass
elif 'Password123'.__eq__(password): # Noncompliant {{"password" detected here, review this potentially hard-coded credential.}}
pass
elif 'Password123'.__eq__(something): # OK
pass
elif 'Password123'.__eq__(*unpack): # OK
pass
elif 'Password123'.__eq__("something"): # OK
pass
if password == None: # OK (FN?)
pass
if something == "something": # OK
pass
if password == '': # Noncompliant
pass
if password == "": # Noncompliant
pass
if password == pwd: # OK (FN?)
# To avoid FPs, no issues raised on equality tests
if password == 'Azerty123': # OK
pass
if something.password == "Azerty123": # Noncompliant
elif password.__eq__('Azerty123'): # OK
pass
if foo.bar == "Azerty123": # OK
elif 'Azerty123'.__eq__(password): # OK
pass

hash_map = { 'password': "azerty123"} # Noncompliant {{"password" detected here, review this potentially hard-coded credential.}}
hash_map = { ("a", "b") : "c"} # OK
hash_map = { something : "c"} # OK
hash_map = {'admin_form' : adminForm, **self.admin.context(request),} # OK
hash_map = { 'password': pwd} # OK
hash_map = { 'password': "password"} # OK
hash_map['db_password'] = "azerty123" # Noncompliant
hash_map['db_password'] = pwd # OK
hash_map['something'] = "azerty123" # OK
hash_map[something] = "something" # OK
hash_map['password'] = 'password' # OK

encoded_user = 'gUhd9TxpnQppnZVAf7cv9pa5sgRo2sFmShrr/NK9dz0='
encoded_password = 'gUhd9TxpnQppnZVAf7cv9uVnoE28Vq0bR2Cx6Ku1UQA=' # Noncompliant
Expand All @@ -139,6 +131,8 @@ def db(self, pwd):
mysql.connector.connection.MySQLConnection(host='localhost', user='root', password='password') # OK (avoid FPs)
mysql.connector.connect(host='localhost', user='root', password=pwd) # OK
mysql.connector.connection.MySQLConnection(host='localhost', user='root', password=pwd) # OK
mysql.connector.connection.MySQLConnection(host='localhost', user='root', password='') # OK
mysql.connector.connection.MySQLConnection(host='localhost', user='root', "") # OK

pymysql.connect(host='localhost', user='root', password='Azerty123') # Noncompliant
pymysql.connect('localhost', 'root', 'password') # Noncompliant {{Review this potentially hard-coded credential.}}
Expand All @@ -149,6 +143,10 @@ def db(self, pwd):
pymysql.connect('localhost', 'root', pwd) # OK
pymysql.connections.Connection(host='localhost', user='root', password=pwd) # OK
pymysql.connections.Connection('localhost', 'root', pwd) # OK
pymysql.connect('localhost', 'root', '') # Compliant
pymysql.connect(host='localhost', user='root', password='') # Compliant
pymysql.connections.Connection(host='localhost', user='root', password='') # Compliant
pymysql.connections.Connection('localhost', 'root', '') # Compliant

psycopg2.connect(host='localhost', user='postgres', password='Azerty123') # Noncompliant
psycopg2.connect(host='localhost', user='postgres', password=pwd,) # OK
Expand All @@ -167,6 +165,8 @@ def db(self, pwd):
pg.connect(None, 'localhost', 5432, None, 'postgres', 'password') # Noncompliant
pg.connect(host='localhost', user='postgres', passwd=pwd) # OK
pg.connect(None, 'localhost', 5432, None, 'postgres', pwd) # OK
pg.connect(host='localhost', user='postgres', passwd='') # Compliant
pg.connect(None, 'localhost', 5432, None, 'postgres', '') # Compliant

random.call(None, password = 42) # OK
random.call(None, password = "hello") # Noncompliant
Expand Down