Skip to content
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.

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

Added token validation and http only csharp rules. #10

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
using System.Web;

// Example of bad usage.
using System.Web;

class ExampleClass
{
public void ExampleMethod()
{
HttpCookie httpCookie = new HttpCookie("cookieName");
httpCookie.HttpOnly = false;
}
}

// Solution with the fix applied.
using System.Web;

class ExampleClass
{
public void ExampleMethod()
{
HttpCookie httpCookie = new HttpCookie("cookieName");
httpCookie.HttpOnly = true;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
rules:
- id: csharp_httpOnly_true_for_httpCookie
languages:
- csharp
message: |
Security threat detected when allowing untrusted tokens to make it through validation.
patterns:
- pattern-inside: |
using System.Web;
...
- pattern-inside: |
HttpCookie $HTTPCOOKIE = new HttpCookie($X);
...
- pattern: |
$HTTPCOOKIE.HttpOnly = false;
fix: $HTTPCOOKIE.HttpOnly = true;
severity: WARNING
metadata:
references: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca5404
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
rules:
- id: token_audience_validation_check_enabled
languages:
- csharp
message: |
The tokens allowed do not meet the minimum security recommendations!
patterns:
- pattern-inside:
using Microsoft.IdentityModel.Tokens;
...
- pattern-inside:
TokenValidationParameters $PARAMETERS = new TokenValidationParameters();
...
- pattern:
$PARAMETERS.ValidateAudience = false;
fix: $PARAMETERS.ValidateAudience = true;
severity: WARNING
metadata:
references: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca5404
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
rules:
- id: token_issuer_validation_check_enabled
languages:
- csharp
message: |
Insecure token validation.
patterns:
- pattern-inside:
using Microsoft.IdentityModel.Tokens;
...
- pattern-inside:
TokenValidationParameters $PARAMETERS = new TokenValidationParameters();
...
- pattern:
$PARAMETERS.ValidateIssuer = false;
severity: WARNING
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a fix possible for this rule as well?

Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
rules:
- id: token_lifetime_validation_check_enabled
languages:
- csharp
message: |
Insecure token validation.
patterns:
- pattern-inside:
using Microsoft.IdentityModel.Tokens;
...
- pattern-inside:
TokenValidationParameters $PARAMETERS = new TokenValidationParameters();
...
- pattern:
$PARAMETERS.ValidateLifetime = false;
fix: $PARAMETERS.ValidateLifetime = true;
severity: WARNING
metadata:
references: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca5404
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
rules:
- id: token_audience_validation_check_enabled
languages:
- csharp
message: |
The tokens allowed do not meet the minimum security recommendations!
patterns:
- pattern-inside:
using Microsoft.IdentityModel.Tokens;
...
- pattern-inside:
TokenValidationParameters $PARAMETERS = new TokenValidationParameters();
...
- pattern:
$PARAMETERS.RequireExpirationTime = false;
severity: WARNING
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is a fix possible for this rule as well?

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
using System;
using Microsoft.IdentityModel.Tokens;

// Example of bad usage.
class BadUsageExample
{
public void ExampleMethod()
{
TokenValidationParameters parameters = new TokenValidationParameters();
parameters.RequireExpirationTime = false;
parameters.ValidateAudience = false;
parameters.ValidateIssuer = false;
parameters.ValidateLifetime = false;
}
}

// Solution with the fix applied.
class SolutionFixForExampleAbove
{
public void SolutionMethod()
{
TokenValidationParameters parameters = new TokenValidationParameters();
parameters.RequireExpirationTime = true;
parameters.ValidateAudience = true;
parameters.ValidateIssuer = true;
parameters.ValidateLifetime = true;
}
}