Skip to content

Commit

Permalink
Update RSPEC before release (#7934)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Tim-Pohlmann
Tim-Pohlmann committed Aug 31, 2023
1 parent 668e37d commit 598c579
Show file tree
Hide file tree
Showing 12 changed files with 217 additions and 55 deletions.
2 changes: 1 addition & 1 deletion analyzers/rspec/cs/S1200.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Classes should not be coupled to too many other classes (Single Responsibility Principle)",
"title": "Classes should not be coupled to too many other classes",
"type": "CODE_SMELL",
"code": {
"impacts": {
Expand Down
181 changes: 166 additions & 15 deletions analyzers/rspec/cs/S2115.html
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,190 @@
<p>When accessing a database, an empty password should be avoided as it introduces a weakness.</p>
<h2>Why is this an issue?</h2>
<p>When relying on the password authentication mode for the database connection, a secure password should be chosen.</p>
<p>This rule raises an issue when an empty password is used.</p>
<h3>Noncompliant code example</h3>
<pre>
<p>When a database does not require a password for authentication, it allows anyone to access and manipulate the data stored within it. Exploiting
this vulnerability typically involves identifying the target database and establishing a connection to it without the need for any authentication
credentials.</p>
<h3>What is the potential impact?</h3>
<p>Once connected, an attacker can perform various malicious actions, such as viewing, modifying, or deleting sensitive information, potentially
leading to data breaches or unauthorized access to critical systems. It is crucial to address this vulnerability promptly to ensure the security and
integrity of the database and the data it contains.</p>
<h4>Unauthorized Access to Sensitive Data</h4>
<p>When a database lacks a password for authentication, it opens the door for unauthorized individuals to gain access to sensitive data. This can
include personally identifiable information (PII), financial records, intellectual property, or any other confidential information stored in the
database. Without proper access controls in place, malicious actors can exploit this vulnerability to retrieve sensitive data, potentially leading to
identity theft, financial loss, or reputational damage.</p>
<h4>Compromise of System Integrity</h4>
<p>Without a password requirement, unauthorized individuals can gain unrestricted access to a database, potentially compromising the integrity of the
entire system. Attackers can inject malicious code, alter configurations, or manipulate data within the database, leading to system malfunctions,
unauthorized system access, or even complete system compromise. This can disrupt business operations, cause financial losses, and expose the
organization to further security risks.</p>
<h4>Unwanted Modifications or Deletions</h4>
<p>The absence of a password for database access allows anyone to make modifications or deletions to the data stored within it. This poses a
significant risk, as unauthorized changes can lead to data corruption, loss of critical information, or the introduction of malicious content. For
example, an attacker could modify financial records, tamper with customer orders, or delete important files, causing severe disruptions to business
processes and potentially leading to financial and legal consequences.</p>
<p>Overall, the lack of a password configured to access a database poses a serious security risk, enabling unauthorized access, data breaches, system
compromise, and unwanted modifications or deletions. It is essential to address this vulnerability promptly to safeguard sensitive data, maintain
system integrity, and protect the organization from potential harm.</p>
<h2>How to fix it in Entity Framework Core</h2>
<h3>Code examples</h3>
<p>The following code uses an empty password to connect to a SQL Server database.</p>
<p>The vulnerability can be fixed by using Windows authentication (sometimes referred to as integrated security).</p>
<h4>Noncompliant code example</h4>
<pre data-diff-id="302" data-diff-type="noncompliant">
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseSqlServer("Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password="); // Noncompliant
}
</pre>
<p>In <a href="https://docs.microsoft.com/en-us/troubleshoot/aspnet/create-web-config">Web.config</a></p>
<pre>
<h4>Compliant solution</h4>
<pre data-diff-id="302" data-diff-type="compliant">
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseSqlServer("Server=myServerAddress;Database=myDataBase;Integrated Security=True");
}
</pre>
<h3>How does this work?</h3>
<h4>Windows authentication (integrated security)</h4>
<p>When the connection string includes the <code>Integrated Security=true</code> parameter, it enables Windows authentication (sometimes called
integrated security) for the database connection. With integrated security, the user’s Windows credentials are used to authenticate and authorize
access to the database. It eliminates the need for a separate username and password for the database connection. Integrated security simplifies
authentication and leverages the existing Windows authentication infrastructure for secure database access in your C# application.</p>
<p>It’s important to note that when using integrated security, the user running the application must have the necessary permissions to access the
database. Ensure that the user account running the application has the appropriate privileges and is granted access to the database.</p>
<p>The syntax employed in connection strings varies by provider:</p>
<table>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td><p>Syntax</p></td>
<td><p>Supported by</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=true;</code></p></td>
<td><p>SQL Server, Oracle, Postgres</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=SSPI;</code></p></td>
<td><p>SQL Server, OLE DB</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=yes;</code></p></td>
<td><p>MySQL</p></td>
</tr>
<tr>
<td><p><code>Trusted_Connection=true;</code></p></td>
<td><p>SQL Server</p></td>
</tr>
<tr>
<td><p><code>Trusted_Connection=yes;</code></p></td>
<td><p>ODBC</p></td>
</tr>
</tbody>
</table>
<p>Note: Some providers such as MySQL do not support Windows authentication with .NET Core.</p>
<h3>Pitfalls</h3>
<h4>Hard-coded passwords</h4>
<p>It could be tempting to replace the empty password with a hard-coded one. Hard-coding passwords in the code can pose significant security risks.
Here are a few reasons why it is not recommended:</p>
<ol>
<li> Security Vulnerability: Hard-coded passwords can be easily discovered by anyone who has access to the code, such as other developers or
attackers. This can lead to unauthorized access to the database and potential data breaches. </li>
<li> Lack of Flexibility: Hard-coded passwords make it difficult to change the password without modifying the code. If the password needs to be
updated, it would require recompiling and redeploying the code, which can be time-consuming and error-prone. </li>
<li> Version Control Issues: Storing passwords in code can lead to version control issues. If the code is shared or stored in a version control
system, the password will be visible to anyone with access to the repository, which is a security risk. </li>
</ol>
<p>To mitigate these risks, it is recommended to use secure methods for storing and retrieving passwords, such as using environment variables,
configuration files, or secure key management systems. These methods allow for better security, flexibility, and separation of sensitive information
from the codebase.</p>
<h2>How to fix it in ASP.NET</h2>
<h3>Code examples</h3>
<p>The following configuration file uses an empty password to connect to a database.</p>
<p>The vulnerability can be fixed by using Windows authentication (sometimes referred to as integrated security)</p>
<h4>Noncompliant code example</h4>
<pre data-diff-id="301" data-diff-type="noncompliant">
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;configuration&gt;
&lt;connectionStrings&gt;
&lt;add name="myConnection" connectionString="Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=" /&gt; &lt;!-- Noncompliant --&gt;
&lt;/connectionStrings&gt;
&lt;/configuration&gt;
</pre>
<h3>Compliant solution</h3>
<pre>
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseSqlServer("Server=myServerAddress;Database=myDataBase;Integrated Security=True");
}
</pre>
<p>In <a href="https://docs.microsoft.com/en-us/troubleshoot/aspnet/create-web-config">Web.config</a></p>
<pre>
<h4>Compliant solution</h4>
<pre data-diff-id="301" data-diff-type="compliant">
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;configuration&gt;
&lt;connectionStrings&gt;
&lt;add name="myConnection" connectionString="Server=myServerAddress;Database=myDataBase;Integrated Security=True" /&gt;
&lt;/connectionStrings&gt;
&lt;/configuration&gt;
</pre>
<h3>How does this work?</h3>
<h4>Windows authentication (integrated security)</h4>
<p>When the connection string includes the <code>Integrated Security=true</code> parameter, it enables Windows authentication (sometimes called
integrated security) for the database connection. With integrated security, the user’s Windows credentials are used to authenticate and authorize
access to the database. It eliminates the need for a separate username and password for the database connection. Integrated security simplifies
authentication and leverages the existing Windows authentication infrastructure for secure database access in your C# application.</p>
<p>It’s important to note that when using integrated security, the user running the application must have the necessary permissions to access the
database. Ensure that the user account running the application has the appropriate privileges and is granted access to the database.</p>
<p>The syntax employed in connection strings varies by provider:</p>
<table>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td><p>Syntax</p></td>
<td><p>Supported by</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=true;</code></p></td>
<td><p>SQL Server, Oracle, Postgres</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=SSPI;</code></p></td>
<td><p>SQL Server, OLE DB</p></td>
</tr>
<tr>
<td><p><code>Integrated Security=yes;</code></p></td>
<td><p>MySQL</p></td>
</tr>
<tr>
<td><p><code>Trusted_Connection=true;</code></p></td>
<td><p>SQL Server</p></td>
</tr>
<tr>
<td><p><code>Trusted_Connection=yes;</code></p></td>
<td><p>ODBC</p></td>
</tr>
</tbody>
</table>
<p>Note: Some providers such as MySQL do not support Windows authentication with .NET Core.</p>
<h3>Pitfalls</h3>
<h4>Hard-coded passwords</h4>
<p>It could be tempting to replace the empty password with a hard-coded one. Hard-coding passwords in the code can pose significant security risks.
Here are a few reasons why it is not recommended:</p>
<ol>
<li> Security Vulnerability: Hard-coded passwords can be easily discovered by anyone who has access to the code, such as other developers or
attackers. This can lead to unauthorized access to the database and potential data breaches. </li>
<li> Lack of Flexibility: Hard-coded passwords make it difficult to change the password without modifying the code. If the password needs to be
updated, it would require recompiling and redeploying the code, which can be time-consuming and error-prone. </li>
<li> Version Control Issues: Storing passwords in code can lead to version control issues. If the code is shared or stored in a version control
system, the password will be visible to anyone with access to the repository, which is a security risk. </li>
</ol>
<p>To mitigate these risks, it is recommended to use secure methods for storing and retrieving passwords, such as using environment variables,
configuration files, or secure key management systems. These methods allow for better security, flexibility, and separation of sensitive information
from the codebase.</p>
<h2>Resources</h2>
<ul>
<li> <a href="https://docs.microsoft.com/en-us/troubleshoot/aspnet/create-web-config">Create the Web.config file for an ASP.NET application</a>
</li>
</ul>
<h3>Standards</h3>
<ul>
<li> <a href="https://owasp.org/Top10/A07_2021-Identification_and_Authentication_Failures/">OWASP Top 10 2021 Category A7</a> - Identification and
Authentication Failures </li>
Expand Down
2 changes: 1 addition & 1 deletion analyzers/rspec/cs/S2115.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"impacts": {
"SECURITY": "HIGH"
},
"attribute": "COMPLETE"
"attribute": "TRUSTWORTHY"
},
"status": "ready",
"remediation": {
Expand Down
2 changes: 1 addition & 1 deletion analyzers/rspec/cs/S2696.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p>This rule raises an issue each time a <code>static</code> field is updated from a non-static method or property.</p>
<h2>Why is this an issue?</h2>
<p>Updating a <code>static</code> field from a non-<code>static</code> method introduces ignificant challenges and potential bugs. Multiple class
<p>Updating a <code>static</code> field from a non-<code>static</code> method introduces significant challenges and potential bugs. Multiple class
instances and threads can access and modify the <code>static</code> field concurrently, leading to unintended consequences for other instances or
threads (unexpected behavior, <a href="https://www.c-sharpcorner.com/UploadFile/1d42da/race-conditions-in-threading-C-Sharp/">race conditions</a> and
synchronization problems).</p>
Expand Down
49 changes: 24 additions & 25 deletions analyzers/rspec/cs/S2931.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,37 @@ <h2>Why is this an issue?</h2>
and therefore to be itself <code>IDisposable</code>. A class is considered to own an <code>IDisposable</code> field resource if it created the object
referenced by the field.</p>
<h3>Noncompliant code example</h3>
<pre>
<pre data-diff-id="1" data-diff-type="noncompliant">
public class ResourceHolder // Noncompliant; doesn't implement IDisposable
{
private FileStream fs; // This member is never Disposed
public void OpenResource(string path)
{
this.fs = new FileStream(path, FileMode.Open); // I create the FileStream, I'm owning it
}
public void CloseResource()
{
this.fs.Close();
}
private FileStream fs; // This member is never Disposed
public void OpenResource(string path)
{
this.fs = new FileStream(path, FileMode.Open); // I create the FileStream, I'm owning it
}
public void CloseResource()
{
this.fs.Close();
}
}
</pre>
<h3>Compliant solution</h3>
<pre>
<pre data-diff-id="1" data-diff-type="compliant">
public class ResourceHolder : IDisposable
{
&nbsp;&nbsp;private FileStream fs;
&nbsp;&nbsp;public void OpenResource(string path)
&nbsp;&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;this.fs = new FileStream(path, FileMode.Open); // I create the FileStream, I'm owning it
&nbsp;&nbsp;}
&nbsp;&nbsp;public void CloseResource()
&nbsp;&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;this.fs.Close();
&nbsp;&nbsp;}

&nbsp;&nbsp;public void Dispose()
&nbsp;&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;this.fs.Dispose();
&nbsp;&nbsp;}
private FileStream fs;
public void OpenResource(string path)
{
this.fs = new FileStream(path, FileMode.Open); // I create the FileStream, I'm owning it
}
public void CloseResource()
{
this.fs.Close();
}
public void Dispose()
{
this.fs.Dispose();
}
}
</pre>
<h2>Resources</h2>
Expand Down
8 changes: 6 additions & 2 deletions analyzers/rspec/cs/S3329.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,12 @@ <h4>Compliant solution</h4>
</pre>
<h3>How does this work?</h3>
<h4>Use unique IVs</h4>
<p>To ensure strong security, the initialization vectors for each encryption operation must be unique and random but they do not have to be
secret.</p>
<p>To ensure high security, initialization vectors must meet two important criteria:</p>
<ul>
<li> IVs must be unique for each encryption operation. </li>
<li> For CBC and CFB modes, a secure FIPS-compliant random number generator should be used to generate unpredictable IVs. </li>
</ul>
<p>The IV does not need be secret, so the IV or information sufficient to determine the IV may be transmitted along with the ciphertext.</p>
<p>In the previous non-compliant example, the problem is not that the IV is hard-coded.<br> It is that the same IV is used for multiple encryption
attempts.</p>
<h2>Resources</h2>
Expand Down
6 changes: 4 additions & 2 deletions analyzers/rspec/cs/S3776.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
},
"status": "ready",
"remediation": {
"func": "Constant\/Issue",
"constantCost": "10min"
"func": "Linear with offset",
"linearDesc": "per complexity point over the threshold",
"linearOffset": "5min",
"linearFactor": "1min"
},
"tags": [
"brain-overload"
Expand Down
4 changes: 2 additions & 2 deletions analyzers/rspec/vbnet/S2589.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h2>How to fix it</h2>
</ul>
<h3>Code examples</h3>
<h4>Noncompliant code example</h4>
<pre>
<pre data-diff-id="1" data-diff-type="noncompliant">
Public Sub Sample(ByVal b As Boolean, ByVal c As Boolean)
Dim a = True
If a Then ' Noncompliant: "a" is always "true"
Expand All @@ -60,7 +60,7 @@ <h4>Noncompliant code example</h4>
End Sub
</pre>
<h4>Compliant solution</h4>
<pre>
<pre data-diff-id="1" data-diff-type="compliant">
Public Sub Sample(ByVal b As Boolean, ByVal c As Boolean, ByVal s As String)
Dim a = IsAllowed()
If a Then ' Compliant
Expand Down
8 changes: 6 additions & 2 deletions analyzers/rspec/vbnet/S3329.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,12 @@ <h4>Compliant solution</h4>
</pre>
<h3>How does this work?</h3>
<h4>Use unique IVs</h4>
<p>To ensure strong security, the initialization vectors for each encryption operation must be unique and random but they do not have to be
secret.</p>
<p>To ensure high security, initialization vectors must meet two important criteria:</p>
<ul>
<li> IVs must be unique for each encryption operation. </li>
<li> For CBC and CFB modes, a secure FIPS-compliant random number generator should be used to generate unpredictable IVs. </li>
</ul>
<p>The IV does not need be secret, so the IV or information sufficient to determine the IV may be transmitted along with the ciphertext.</p>
<p>In the previous non-compliant example, the problem is not that the IV is hard-coded.<br> It is that the same IV is used for multiple encryption
attempts.</p>
<h2>Resources</h2>
Expand Down
6 changes: 4 additions & 2 deletions analyzers/rspec/vbnet/S3776.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
},
"status": "ready",
"remediation": {
"func": "Constant\/Issue",
"constantCost": "10min"
"func": "Linear with offset",
"linearDesc": "per complexity point over the threshold",
"linearOffset": "5min",
"linearFactor": "1min"
},
"tags": [
"brain-overload"
Expand Down
2 changes: 1 addition & 1 deletion analyzers/src/SonarAnalyzer.CSharp/sonarpedia.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"languages": [
"CSH"
],
"latest-update": "2023-08-16T16:04:04.533670700Z",
"latest-update": "2023-08-31T14:13:06.687135300Z",
"options": {
"no-language-in-filenames": true
}
Expand Down
2 changes: 1 addition & 1 deletion analyzers/src/SonarAnalyzer.VisualBasic/sonarpedia.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"languages": [
"VBNET"
],
"latest-update": "2023-08-16T16:04:28.553624200Z",
"latest-update": "2023-08-31T14:13:28.419689600Z",
"options": {
"no-language-in-filenames": true
}
Expand Down

0 comments on commit 598c579

Please sign in to comment.