| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| |
| <title>Static Code Analysis | CogniCrypt</title> |
| <meta property="og:title" content="Static Code Analysis | CogniCrypt" /> |
| <meta name="twitter:title" content="Static Code Analysis | CogniCrypt" /> |
| <meta name="description" content="CogniCrypt’s static analysis CogniCryptSAST automatically runs on the code within Eclipse. The static analysis is based on CrySL rules that specify the correct use of an application programming interface (API). CrySL is a domain-specific language that allows to specify usage patterns of APIs. The static analysis reports any deviations from the usage pattern defined within the rules. |
| While the CrySL rules are adjustable, a user of CogniCrypt is not expected to change the rules of CogniCrypt."> |
| <meta property="og:description" content="CogniCrypt’s static analysis CogniCryptSAST automatically runs on the code within Eclipse. The static analysis is based on CrySL rules that specify the correct use of an application programming interface (API). CrySL is a domain-specific language that allows to specify usage patterns of APIs. The static analysis reports any deviations from the usage pattern defined within the rules. |
| While the CrySL rules are adjustable, a user of CogniCrypt is not expected to change the rules of CogniCrypt."> |
| <meta name="twitter:description" content="CogniCrypt’s static analysis CogniCryptSAST automatically runs on the code within Eclipse. The static analysis is based on CrySL rules that specify the correct use of an application programming …"> |
| <meta name="author" content="Eclipse Foundation"/> |
| <link href='https://www.eclipse.org/cognicrypt/favicon.ico' rel='icon' type='image/x-icon'/> |
| <meta name="twitter:card" content="summary" /> |
| <meta property="og:url" content="https://www.eclipse.org/cognicrypt/documentation/codeanalysis/" /> |
| <meta property="og:type" content="website" /> |
| <meta property="og:site_name" content="Securely using Cryptography with CogniCrypt" /> |
| <meta name="keywords" content=""> |
| |
| |
| <meta name="generator" content="Hugo 0.42.1" /> |
| <link rel="canonical" href="https://www.eclipse.org/cognicrypt/documentation/codeanalysis/" /> |
| <link rel="alternate" href="https://www.eclipse.org/cognicrypt/documentation/codeanalysis/index.xml" type="application/rss+xml" title="Securely using Cryptography with CogniCrypt"> |
| |
| <link rel="stylesheet" href="https://www.eclipse.org/cognicrypt/assets/css/bootstrap.css"> |
| |
| |
| |
| <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png"> |
| <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png"> |
| <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png"> |
| <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png"> |
| <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png"> |
| <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png"> |
| <link rel="icon" type="image/png" sizes="192x192" href="/android-icon-192x192.png"> |
| <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"> |
| <link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png"> |
| <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"> |
| <link rel="manifest" href="/manifest.json"> |
| |
| <meta name="msapplication-TileColor" content="#ffffff"> |
| <meta name="msapplication-TileImage" content="/ms-icon-144x144.png"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| |
| <link href="//fonts.googleapis.com/css?family=Libre+Franklin:400,700,300,600,100" rel="stylesheet" type="text/css"> |
| |
| </head> |
| <body> |
| |
| <header class="homepage"> |
| |
| <nav class="navbar navbar-default"> |
| <div class="container"> |
| |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="https://www.eclipse.org/cognicrypt/"> |
| <img alt="Eclipse CogniCrypt" src="https://www.eclipse.org/cognicrypt//assets/images/cognicrypt-logo.png"> |
| </a> |
| </div> |
| |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| |
| |
| |
| <li> |
| <a class="" href="/cognicrypt/publications/"> |
| |
| Publications |
| </a> |
| |
| </li> |
| |
| |
| <li> |
| <a class="" href="/cognicrypt/downloads/"> |
| |
| Downloads |
| </a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| <a href="#" data-toggle="dropdown" class="dropdown-toggle"> |
| |
| |
| <span>Documentation</span> |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| |
| <li><a href="/cognicrypt/documentation/codegen/">Code Generation</a> </li> |
| |
| <li><a href="/cognicrypt/documentation/crysl/">CrySL Language</a> </li> |
| |
| <li class="active"><a href="/cognicrypt/documentation/codeanalysis/">Static Code Analysis</a> </li> |
| |
| </ul> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| <a href="#" data-toggle="dropdown" class="dropdown-toggle"> |
| |
| |
| <span>Contributing</span> |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| |
| <li><a href="/cognicrypt/contributing#bugs">Bugs and Feature Requests</a> </li> |
| |
| <li><a href="/cognicrypt/contributing#code">Code Contributions</a> </li> |
| |
| <li><a href="/cognicrypt/contributing#prim">Cryptographic Primitives</a> </li> |
| |
| <li><a href="/cognicrypt/contributing#tasks">Cryptographic Tasks</a> </li> |
| |
| </ul> |
| |
| </li> |
| |
| |
| <li> |
| <a class="" href="/cognicrypt/news/"> |
| |
| News |
| </a> |
| |
| </li> |
| |
| |
| <li class="dropdown eclipse-more hidden-xs"> |
| <a data-toggle="dropdown" class="dropdown-toggle" role="button">More<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li> |
| |
| <div class="yamm-content"> |
| <div class="row"> |
| <ul class="col-sm-8 list-unstyled"> |
| <li> |
| <p><strong>Community</strong></p> |
| </li> |
| <li><a href="http://marketplace.eclipse.org">Marketplace</a></li> |
| <li><a href="http://events.eclipse.org">Events</a></li> |
| <li><a href="http://www.planeteclipse.org/">Planet Eclipse</a></li> |
| <li><a href="https://www.eclipse.org/community/eclipse_newsletter/">Newsletter</a></li> |
| <li><a href="https://www.youtube.com/user/EclipseFdn">Videos</a></li> |
| <li><a href="https://blogs.eclipse.org">Blogs</a></li> |
| </ul> |
| <ul class="col-sm-8 list-unstyled"> |
| <li> |
| <p><strong>Participate</strong></p> |
| </li> |
| <li><a href="https://bugs.eclipse.org/bugs/">Report a Bug</a></li> |
| <li><a href="https://www.eclipse.org/forums/">Forums</a></li> |
| <li><a href="https://www.eclipse.org/mail/">Mailing Lists</a></li> |
| <li><a href="https://wiki.eclipse.org/">Wiki</a></li> |
| <li><a href="https://wiki.eclipse.org/IRC">IRC</a></li> |
| </ul> |
| <ul class="col-sm-8 list-unstyled"> |
| <li> |
| <p><strong>Eclipse IDE</strong></p> |
| </li> |
| <li><a href="https://www.eclipse.org/downloads">Download</a></li> |
| <li><a href="https://help.eclipse.org">Documentation</a></li> |
| <li><a href="https://www.eclipse.org/getting_started">Getting Started / Support</a></li> |
| <li><a href="https://www.eclipse.org/contribute/">How to Contribute</a></li> |
| <li><a href="https://www.eclipse.org/ide/">IDE and Tools</a></li> |
| <li><a href="https://www.eclipse.org/forums/index.php/f/89/">Newcomer Forum</a></li> |
| </ul> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </li> |
| |
| |
| |
| <li style="min-width: 100px; padding-top: 12px; padding-left: 50px; margin-left:-35px"> |
| <a href="https://twitter.com/cognicrypt?ref_src=twsrc%5Etfw" class="twitter-follow-button" data-show-count="false" data-show-screen-name="false"></a><script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script> |
| </li> |
| </ul> |
| </div> |
| |
| </div> |
| |
| </nav> |
| <section class="container"> |
| <div class="row"> |
| <div class="col-md-8 col-sm-12"> |
| <h1><span class="green">Eclipse</span> <span class="green">CogniCrypt</span></h1> |
| <p>Eclipse CogniCrypt is an intelligent open-source platform ensuring the secure usage of crypto components.</p> |
| </div> |
| </div> |
| </section> |
| |
| </header> |
| |
| |
| |
| <main class="main"> |
| <section class="first"> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-10"> |
| <h3><span class="green">Static Code Analysis</span></h3> |
| </div> |
| </div> |
| </div> |
| </section> |
| <section class="second"> |
| <div class="container"> |
| <div class="col-md-10"> |
| |
| |
| <p>CogniCrypt’s static analysis CogniCrypt<sub>SAST</sub> automatically runs on the code within Eclipse. The static analysis is based on <code>CrySL rules</code> that specify the <em>correct</em> use of an application programming interface (API). <code>CrySL</code> is a domain-specific language that allows to specify usage patterns of APIs. The static analysis reports any deviations from the usage pattern defined within the rules.</p> |
| |
| <p>While the <code>CrySL</code> rules are adjustable, a user of CogniCrypt is not expected to change the rules of CogniCrypt.</p> |
| |
| <h2 id="eclipse-error-markers-and-their-meanings">Eclipse Error Markers and their Meanings</h2> |
| |
| <p>CogniCrypt generates errors markes when the analysis detects incorrect and insecure parts of code. CogniCrypt displays error markers within the Eclipse IDE to warn the developer about insecure code. The error markers are associated to the respective line in the editor the errors is located at.</p> |
| |
| <p>There are various different error types that CogniCrypt reports. Below, we distinguish the error types based on the warning the error marker reports.</p> |
| |
| <ul> |
| <li><p><code>"MD5 should be any of {SHA-256, SHA-384, SHA-512}"</code> is a <strong>Constraint Error</strong>: the static analysis detects an incorrect <code>String</code> (or <code>int</code>) to flow as argument to a method call. CogniCrypt automatically suggest alternatives to fix the issue. The error message describes that <code>MD5</code> should be replaced by and of the other <code>String</code> elements.</p></li> |
| |
| <li><p><code>"Unexpected call to method reset. Expect a call to one of the following methods digest,update"</code> marks a <strong>Typestate Error</strong>. The sequence of object calls made on an object is not according to its <code>CrySL</code> specification.</p></li> |
| |
| <li><p><code>"Operation with Cipher object not completed. Expected call to update, doFinal."</code> marks an <strong>Incomplete Operation Error</strong>. An incomplete operation errors appears, when a call on an object is missing and the object is garbage collected without having properly used. A typically example for such an error is a missing call to <code>close</code> on a <code>FileWriter</code>.</p></li> |
| |
| <li><p><code>"Variable keyBytes was not properly randomized"</code> is called a <strong>Required Predicate Error</strong>. Such an error is reported when the analysis infers that the combination of using <em>several</em> object is incorrect. The error message reports that the developer uses a variable <code>keyBytes</code> (containing some <code>byte[]</code>) for some cryptographic operation. The correct specification of the API requires that the <code>byte</code> array has been previously <code>randomized</code> (wich means correctly generate by some API).</p></li> |
| </ul> |
| |
| </div> |
| </div> |
| </section> |
| </main> |
| |
| |
| |
| <footer id="solstice-footer"> |
| <div class="container"> |
| <div class="row"> |
| <section class="col-sm-3 hidden-print" id="footer-eclipse-foundation"> |
| <h2 class="section-title" style="color:#fff;">Eclipse Foundation</h2> |
| <ul class="nav"> |
| <li><a href="https://www.eclipse.org/org/">About Us</a></li> |
| <li><a href="https://www.eclipse.org/org/foundation/contact.php">Contact |
| Us</a></li> |
| <li><a href="https://www.eclipse.org/donate">Donate</a></li> |
| <li><a href="https://www.eclipse.org/org/documents/">Governance</a></li> |
| <li><a href="https://www.eclipse.org/artwork/">Logo and |
| Artwork</a></li> |
| <li><a |
| href="https://www.eclipse.org/org/foundation/directors.php" |
| >Board of Directors</a></li> |
| </ul> |
| </section> |
| <section class="col-sm-3 hidden-print" id="footer-legal"> |
| <h2 class="section-title" style="color:#fff;">Legal</h2> |
| <ul class="nav"> |
| <li><a href="https://www.eclipse.org/legal/privacy.php">Privacy |
| Policy</a></li> |
| <li><a href="https://www.eclipse.org/legal/termsofuse.php">Terms |
| of Use</a></li> |
| <li><a href="https://www.eclipse.org/legal/copyright.php">Copyright |
| Agent</a></li> |
| <li><a href="https://www.eclipse.org/legal/epl-2.0/">Eclipse |
| Public License</a></li> |
| <li><a href="https://www.eclipse.org/legal/">Legal Resources |
| </a></li> |
| </ul> |
| </section> |
| <section class="col-sm-3 hidden-print" id="footer-useful-links"> |
| <h2 class="section-title" style="color:#fff;">Useful Links</h2> |
| <ul class="nav"> |
| <li><a href="https://bugs.eclipse.org/bugs/">Report a Bug</a></li> |
| <li><a href="//help.eclipse.org/">Documentation</a></li> |
| <li><a href="https://www.eclipse.org/contribute/">How to |
| Contribute</a></li> |
| <li><a href="https://www.eclipse.org/mail/">Mailing Lists</a></li> |
| <li><a href="https://www.eclipse.org/forums/">Forums</a></li> |
| <li><a href="//marketplace.eclipse.org">Marketplace</a></li> |
| </ul> |
| </section> |
| <section class="col-sm-3 hidden-print" id="footer-other"> |
| <h2 class="section-title" style="color:#fff;">Other</h2> |
| <ul class="nav"> |
| <li><a href="https://www.eclipse.org/ide/">IDE and Tools</a></li> |
| <li><a href="https://www.eclipse.org/projects">Community of |
| Projects</a></li> |
| <li><a href="https://www.eclipse.org/org/workinggroups/">Working |
| Groups</a></li> |
| <li><a href="https://www.eclipse.org/org/research/">Research@Eclipse</a></li> |
| <li><a href="https://status.eclipse.org">Service Status</a></li> |
| </ul> |
| </section> |
| <div class="col-sm-12 margin-top-20"> |
| <div class="row"> |
| <div id="copyright" class="col-md-8"> |
| <p id="copyright-text" style="color:#fff;">Copyright © Eclipse Foundation, Inc. All |
| Rights Reserved.</p> |
| </div> |
| <div class="col-md-4 social-media"> |
| <ul class="list-inline text-right"> |
| <li><a class="social-media-link fa-stack fa-lg" |
| href="https://twitter.com/cognicrypt" |
| > <i class="fa fa-circle-thin fa-stack-2x"></i> <i |
| class="fa fa-twitter fa-stack-1x" |
| ></i> |
| </a></li> |
| <li><a class="social-media-link fa-stack fa-lg" |
| href="https://www.youtube.com/channel/UCNKzeZzhIMOhWm9eqlP15kw" |
| > <i class="fa fa-circle-thin fa-stack-2x"></i> <i |
| class="fa fa-youtube fa-stack-1x" |
| ></i> |
| </a></li> |
| <li><a class="social-media-link fa-stack fa-lg" |
| href="https://www.linkedin.com/company/eclipse-foundation" |
| > <i class="fa fa-circle-thin fa-stack-2x"></i> <i |
| class="fa fa-linkedin fa-stack-1x" |
| ></i> |
| </a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| |
| |
| <script src="https://www.eclipse.org/cognicrypt/assets/js/main.js"></script> |
| |
| |
| |
| <script src="js/shuffle.js"></script> |
| <script src="js/index.js"></script> |
| |
| </body> |
| </html> |
| |
