Create rule S6781: JWT secret keys should not be disclosed #3838
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
sebastien-andrivet-sonarsource
changed the title
Comment on lines
12
to
13
| [Route("login-config")] | ||
| public class LoginConfigController : ControllerBase |
There was a problem hiding this comment.
Suggested change
| [Route("login-config")] | |
| public class LoginConfigController : ControllerBase | |
| [Route("login-example")] | |
| public class LoginExampleController : ControllerBase |
| public class LoginConfigController : ControllerBase | ||
| { | ||
| private readonly IConfiguration _config; | ||
| public LoginConfigController(IConfiguration config) |
There was a problem hiding this comment.
Suggested change
| public LoginConfigController(IConfiguration config) | |
| public LoginExampleController(IConfiguration config) |
| expires: DateTime.Now.AddMinutes(120), | ||
| signingCredentials: credentials); | ||
|
|
||
| return Ok(new JwtSecurityTokenHandler().WriteToken(Sectoken)); |
There was a problem hiding this comment.
Suggested change
| return Ok(new JwtSecurityTokenHandler().WriteToken(Sectoken)); | |
| var token = new JwtSecurityTokenHandler().WriteToken(Sectoken); | |
| return Ok(token); |
|
|
||
| // Code to validate user omitted | ||
|
|
||
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant (key in appsettings.json) |
There was a problem hiding this comment.
Suggested change
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant (key in appsettings.json) | |
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant |
No need to explain it twice 👍 It also increases the size of the code and unnecessarily forces to scroll right to read
| { | ||
| // Code to validate user omitted | ||
|
|
||
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant: hard-coded key in code |
There was a problem hiding this comment.
Suggested change
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant: hard-coded key in code | |
| var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key)); // Noncompliant |
This increases the size of the code and unnecessarily forces to scroll right to read
Comment on lines
74
to
76
| var token = new JwtSecurityTokenHandler().WriteToken(Sectoken); | ||
|
|
||
| return Ok(token); |
There was a problem hiding this comment.
Suggested change
| var token = new JwtSecurityTokenHandler().WriteToken(Sectoken); | |
| return Ok(token); | |
| var token = new JwtSecurityTokenHandler().WriteToken(Sectoken); | |
| return Ok(token); |
|
|
||
| === Code examples | ||
|
|
||
| The following noncompliant code contains a hard-coded secret that can be exposed unintentionally. |
There was a problem hiding this comment.
Suggested change
| The following noncompliant code contains a hard-coded secret that can be exposed unintentionally. | |
| The following noncompliant code uses a secret from the `_config` variable, which means a secret is hardcoded in `appsettings.json` and can be unintentionally exposed along with the code. |
I suggest adding the appsettings comment here:
Comment on lines
48
to
49
| [Route("login-env")] | ||
| public class LoginEnvController : ControllerBase |
There was a problem hiding this comment.
Suggested change
| [Route("login-env")] | |
| public class LoginEnvController : ControllerBase | |
| [Route("login-example")] | |
| public class LoginExampleController : ControllerBase |
| public class LoginEnvController : ControllerBase | ||
| { | ||
| private readonly IConfiguration _config; | ||
| public LoginEnvController(IConfiguration config) |
There was a problem hiding this comment.
Suggested change
| public LoginEnvController(IConfiguration config) | |
| public LoginExampleController(IConfiguration config) |
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can preview this rule here (updated a few minutes after each push).
Review
A dedicated reviewer checked the rule description successfully for: