-
Notifications
You must be signed in to change notification settings - Fork 31
SONARKT-569 Modify rule S4830: add support for WebViews #4673
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
Merged
antonioaversa
merged 6 commits into
master
from
antonio/SONARKT-569-S4830-add-support-for-webviews
Mar 19, 2025
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4807980
SONARKT-569 Modify rule S4830: add support for WebViews
antonioaversa 50f9a00
Fix list of allowed frameworks
antonioaversa 7009d30
Add Google Support link
antonioaversa b11fd7a
Have non-compliant and compliant code examples next to each other and…
antonioaversa c2a91db
Update rules/S4830/kotlin/how-to-fix-it/android-webview.adoc
antonioaversa 88b5534
Update rules/S4830/kotlin/how-to-fix-it/android-webview.adoc
antonioaversa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
== How to fix it in Android WebView | ||
|
||
=== Code examples | ||
|
||
include::../../common/fix/code-rationale.adoc[] | ||
|
||
The certificate validation gets disabled by overriding the `onReceivedSslError` method of the `WebViewClient` class with an implementation that calls `SslErrorHandler.proceed()` unconditionally, and that never calls `SslErrorHandler.cancel()`. | ||
egon-okerman-sonarsource marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This means that a certificate initially rejected by the system will be accepted by the `WebViewClient`, regardless of its origin. | ||
|
||
=== Noncompliant code example | ||
antonioaversa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[source,kotlin,diff-id=101,diff-type=noncompliant] | ||
---- | ||
class MyWebViewClient : WebViewClient() { | ||
override fun onReceivedSslError(view: WebView, handler: SslErrorHandler, error: SslError) = | ||
handler.proceed() // Noncompliant | ||
} | ||
---- | ||
|
||
=== Compliant solution | ||
antonioaversa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
You need to implement a validation of the server certificate received in the `SslErrorHandler` object, calling `proceed` and `cancel` appropriately. | ||
|
||
[source,kotlin,diff-id=101,diff-type=compliant] | ||
---- | ||
class MyWebViewClient : WebViewClient() { | ||
override fun onReceivedSslError(view: WebView, handler: SslErrorHandler, error: SslError) { | ||
if (error.certificate.isServerCertificateValid()) { | ||
handler.proceed() | ||
} else { | ||
handler.cancel() | ||
} | ||
} | ||
|
||
private fun SslCertificate.isServerCertificateValid(): Boolean { | ||
// Implement the server certificate validation logic here ... | ||
} | ||
} | ||
---- | ||
|
||
=== How does this work? | ||
|
||
include::../../common/fix/validation.adoc[] |
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.