SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Java

Java static code analysis

Unique rules to find Bugs, Vulnerabilities, Security Hotspots, and Code Smells in your JAVA code

  • All rules 733
  • Vulnerability60
  • Bug175
  • Security Hotspot40
  • Code Smell458

  • Quick Fix 65
Filtered: 28 rules found
error-handling
    Impact
      Clean code attribute
        1. Return values should not be ignored when they contain the operation status code

           Bug
        2. Delivering code in production with debug features activated is security-sensitive

           Security Hotspot
        3. "java.nio.Files#delete" should be preferred

           Code Smell
        4. Exceptions should not be created without being thrown

           Bug
        5. Unit tests should throw exceptions

           Code Smell
        6. "catch" clauses should do more than rethrow

           Code Smell
        7. "Iterator.next()" methods should throw "NoSuchElementException"

           Bug
        8. "IllegalMonitorStateException" should not be caught

           Code Smell
        9. "Exception" should not be caught when not required by called methods

           Code Smell
        10. Classes named like "Exception" should extend "Exception" or a subclass

           Code Smell
        11. "InterruptedException" and "ThreadDeath" should not be ignored

           Bug
        12. Exceptions should be either logged or rethrown but not both

           Code Smell
        13. "main" should not "throw" anything

           Code Smell
        14. Exceptions should not be thrown from servlet methods

           Vulnerability
        15. "NullPointerException" should not be caught

           Code Smell
        16. "NullPointerException" should not be explicitly thrown

           Code Smell
        17. "java.lang.Error" should not be extended

           Code Smell
        18. Exception types should not be tested using "instanceof" in catch blocks

           Code Smell
        19. Throwable and Error should not be caught

           Code Smell
        20. Exception handlers should preserve the original exceptions

           Code Smell
        21. Exception classes should have final fields

           Code Smell
        22. Exceptions should not be thrown in finally blocks

           Code Smell
        23. Checked exceptions should not be thrown

           Code Smell
        24. Public methods should throw at most one checked exception

           Code Smell
        25. Jump statements should not occur in "finally" blocks

           Bug
        26. Try-catch blocks should not be nested

           Code Smell
        27. Exceptions in "throws" clauses should not be superfluous

           Code Smell
        28. Generic exceptions should never be thrown

           Code Smell

        Delivering code in production with debug features activated is security-sensitive

        consistency - conventional
        security
        Security Hotspot
        • cwe
        • error-handling
        • spring
        • debug
        • user-experience

        Development tools and frameworks usually have options to make debugging easier for developers. Although these features are useful during development, they should never be enabled for applications deployed in production. Debug instructions or error messages can leak detailed information about the system, like the application’s path or file names.

        Ask Yourself Whether

        • The code or configuration enabling the application debug features is deployed on production servers or distributed to end users.
        • The application runs by default with debug features activated.

        There is a risk if you answered yes to any of those questions.

        Recommended Secure Coding Practices

        Do not enable debugging features on production servers or applications distributed to end users.

        Sensitive Code Example

        Throwable.printStackTrace(...) prints a Throwable and its stack trace to System.Err (by default) which is not easily parseable and can expose sensitive information:

        try {
          /* ... */
        } catch(Exception e) {
          e.printStackTrace(); // Sensitive
        }
        

        EnableWebSecurity annotation for SpringFramework with debug to true enables debugging support:

        import org.springframework.context.annotation.Configuration;
        import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
        
        @Configuration
        @EnableWebSecurity(debug = true) // Sensitive
        public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
          // ...
        }
        

        WebView.setWebContentsDebuggingEnabled(true) for Android enables debugging support:

        import android.webkit.WebView;
        
        WebView.setWebContentsDebuggingEnabled(true); // Sensitive
        WebView.getFactory().getStatics().setWebContentsDebuggingEnabled(true); // Sensitive
        

        Compliant Solution

        Loggers should be used (instead of printStackTrace) to print throwables:

        try {
          /* ... */
        } catch(Exception e) {
          LOGGER.log("context", e);
        }
        

        EnableWebSecurity annotation for SpringFramework with debug to false disables debugging support:

        import org.springframework.context.annotation.Configuration;
        import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
        
        @Configuration
        @EnableWebSecurity(debug = false)
        public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
          // ...
        }
        

        WebView.setWebContentsDebuggingEnabled(false) for Android disables debugging support:

        import android.webkit.WebView;
        
        WebView.setWebContentsDebuggingEnabled(false);
        WebView.getFactory().getStatics().setWebContentsDebuggingEnabled(false);
        

        See

        • OWASP - Top 10 2021 Category A5 - Security Misconfiguration
        • OWASP - Top 10 2017 Category A3 - Sensitive Data Exposure
        • CWE - CWE-489 - Active Debug Code
        • CWE - CWE-215 - Information Exposure Through Debug Information
          Available In:
        • SonarQube IdeCatch issues on the fly,
          in your IDE
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories
        • SonarQube Community BuildAnalyze code in your
          on-premise CI
          Available Since
          9.1
        • SonarQube ServerAnalyze code in your
          on-premise CI
          Developer Edition
          Available Since
          9.1

        © 2008-2025 SonarSource SA. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use