Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Checkmarx - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="checkmarx-jupiterone-integration-benefits">Checkmarx + JupiterOne Integration Benefits</h2> <ul><li><p>Visualize Checkmarx scan assessments and findings on projects in the<br> JupiterOne graph.</p></li> <li><p>Visualize Checkmarx teams in the JupiterOne graph.</p></li> <li>Map a Checkmarx team to connected users in JupiterOne.</li> <li>Monitor Checkmarx findings within the alerts app.</li> <li>Monitor changes to Checkmarx projects using JupiterOne alerts.</li> </ul><p><strong>NOTE</strong>: The Checkmarx integration currently ingests the <em>latest</em> project scan<br> information. If the <em>latest</em> project scan has status "Failed," then the<br> integration will also fetch the last <em>successful</em> Checkmarx project scan.</p> <h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches teams, assessments, and new findings from<br> Checkmarx to update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph.</p></li> <li>Configure alerts to reduce the noise of findings.</li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires the hostname of the Checkmarx instance along with a user's<br> username and password.</p></li> <li><p>You must have permission in JupiterOne to install new integrations.</p></li> </ul><h2 data-id="support">Support</h2> <p>If you need help with this integration, please contact<br><a rel="nofollow" href="https://support.jupiterone.io">JupiterOne Support</a>.</p> <h2 data-id="integration-walkthrough">Integration Walkthrough</h2> <p>The integration connects directly to Checkmarx SAST API.</p> <h3 data-id="in-checkmarx">In Checkmarx</h3> <ol><li>Capture the <strong>Hostname</strong> of the Checkmarx instance.</li> <li>Create a new service account user or leverage an existing user that has read<br> access to your Checkmarx account.</li> </ol><h3 data-id="in-jupiterone">In JupiterOne</h3> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Checkmarx</strong> integration tile and click it.</li> <li>Click the <strong>Add Configuration</strong> button and configure the following settings:</li> </ol><ul><li><p>Enter the <strong>Account Name</strong> by which you'd like to identify this Checkmarx<br> account in JupiterOne. Ingested entities will have this value stored in<br><code class="code codeInline" spellcheck="false" tabindex="0">tag.AccountName</code> when <strong>Tag with Account Name</strong> is checked.</p></li> <li><p>Enter a <strong>Description</strong> that will further assist your team when identifying<br> the integration instance.</p></li> <li><p>Select a <strong>Polling Interval</strong> that you feel is sufficient for your monitoring<br> needs. You may leave this as <code class="code codeInline" spellcheck="false" tabindex="0">DISABLED</code> and manually execute the integration.</p></li> <li><p>Enter the <strong>Client Username</strong> of the Checkmarx user to authenticate with.</p></li> <li>Enter the <strong>Client Password</strong> of the Checkmarx user to authenticate with.</li> <li>Enter the <strong>Client Hostname</strong> of the Checkmarx instance.</li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h2 data-id="how-to-uninstall">How to Uninstall</h2> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Checkmarx</strong> integration tile and click it.</li> <li>Identify and click the <strong>integration to delete</strong>.</li> <li>Click the <strong>trash can</strong> icon.</li> <li>Click the <strong>Remove</strong> button to delete the integration.</li> </ol><p><br></p> <h2 data-id="data-model">Data Model</h2> <h3 data-id="entities">Entities</h3> <p>The following entities are created:</p> <table><thead><tr><th>Resources</th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> </tr></thead><tbody><tr><td>Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_account</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>Assessment</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_scan</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Assessment</code></td> </tr><tr><td>Finding</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_finding</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Finding</code></td> </tr><tr><td>Project</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_project</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Project</code></td> </tr><tr><td>Service</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_dast_scanner</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Service</code></td> </tr><tr><td>Team</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_team</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Team</code></td> </tr></tbody></table><h3 data-id="relationships">Relationships</h3> <p>The following relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_dast_scanner</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_team</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_dast_scanner</code></td> <td><strong>PERFORMED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_scan</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_project</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_scan</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_scan</code></td> <td><strong>IDENTIFIED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_finding</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_team</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_project</code></td> </tr></tbody></table><h3 data-id="mapped-relationships">Mapped Relationships</h3> <p>The following mapped relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Direction</th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">checkmarx_project</code></td> <td><strong>SCANS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">*CodeRepo*</code></td> <td>FORWARD</td> </tr></tbody></table><p><br></p> </article> </main>
.png)