Improved documentation #3
Merged
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
zan-preston
approved these changes
Oct 17, 2023
Comment on lines
+14
to
+38
| ``` | ||
|
|
||
| Once enabled, configure which rules scalafix will run by adding them to your `.scalafix.conf` file like so: | ||
| ``` | ||
| //.scalafix.conf | ||
| rules = [ | ||
| NoRsaWithoutPadding | ||
| ] | ||
| ``` | ||
|
|
||
|
|
||
| ### Available Rules | ||
|
|
||
| #### NoRsaWithoutPadding | ||
| Relevant semgrep rule: [scala.lang.security.audit.rsa-padding-set.rsa-padding-set](https://semgrep.dev/r?q=scala.lang.security.audit.rsa-padding-set.rsa-padding-set). | ||
|
|
||
| This scalafix rule will raise an error if a `javax.crypto.Cipher` is instantiated using RSA, any mode, with no padding. For example: | ||
|
|
||
| ```scala | ||
| import javax.crypto.Cipher | ||
|
|
||
| val badCipher = Cipher.getInstance("RSA/None/NoPadding") // will raise scalafix error | ||
| val alsoBad = Cipher.getInstance("RSA/ECB/NoPadding") // will raise scalafix error | ||
|
|
||
| val goodCipher = Cipher.getInstance("RSA/ECB/PKCS1Padding") |
There was a problem hiding this comment.
I like this. Very simple and clear
rossabaker
approved these changes
Oct 18, 2023
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.
No description provided.