Skip to content

Commit 34e375c

Browse files
committed
Adding a new highlights section and improving the Introduction
1 parent f189dea commit 34e375c

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

src/gitxray/include/html_report/template_main.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,19 @@ <h1 class="text-center">Gitxray Report</h1>
9797
<div class="col-md-4">
9898
<img src="https://raw.githubusercontent.com/kulkansecurity/gitxray/refs/heads/main/docs/images/logo_gitxray.png" class="img-fluid" alt="Gitxray Logo" style="max-width: 350px"/>
9999
</div>
100-
<div class="col-md-8 py-4">
100+
<div class="col-md-8 py-0">
101101
<h5 class="card-title">About this HTML report generated by Gitxray</h5>
102102
<p class="card-text">The report was generated as a result of using the HTML output format of Gitxray. Other output formats are available and documented at <a href='https://github.com/kulkansecurity/gitxray/'>https://github.com/kulkansecurity/gitxray</a> and <a href='https://www.gitxray.com'>www.gitxray.com</a>.</p>
103-
<p class="card-text">The information contained in this HTML report is exactly the same information displayed in other formats (eg. text and json). Additional processing was implemented to create the "By Category" option on the sidemenu, which merges all Contributor result categories, making it easier to navigate through specific categories across a given repository.</p>
104103

105-
<h5 class="card-title">About Gitxray</h5>
106-
<p class="card-text">Gitxray (short for Git X-Ray) is a multifaceted security tool designed for use on GitHub repositories. It can serve many purposes, including OSINT and Forensics. gitxray leverages public GitHub REST APIs to gather information that would otherwise be very time-consuming to obtain manually. Additionally, it seeks out information in unconventional places.</p>
104+
<h5 class="card-title">Use-cases and potential scenarios</h5>
105+
<p class="card-text">Gitxray extracts so much data from a repository and its contributors that it can be overwhelming. You may already be looking into a specific contributor or scenario, but if you need ideas, here are some sample use cases Gitxray covers by default:</p>
106+
<ul>
107+
<li><a href='https://gitxray.com/features/#unintended-disclosures-in-contributor-profiles' target='_blank'>Unintended disclosures in contributor profiles</a></li>
108+
<li><a href='https://gitxray.com/features/#spotting-shared-co-owned-or-fake-contributors' target='_blank'>Spotting shared, co-owned or fake contributors</a></li>
109+
<li><a href='https://gitxray.com/features/#duplicate-repository-name-check' target='_blank'>Duplicate repository name checks</a></li>
110+
<li><a href='https://gitxray.com/features/#the-pr-rejection-awards' target='_blank'>Top 3 of Users with rejected Pull Requests</a></li>
111+
<li><a href='https://gitxray.com/features/#looking-out-for-malicious-releases-and-assets' target='_blank'>Finding Releases and Assets updated post-release</a></li>
112+
</ul>
107113

108114
</div> <!-- md-8-->
109115
</div> <!-- row -->
@@ -113,6 +119,15 @@ <h5 class="card-title">About Gitxray</h5>
113119
</div>
114120
</div>
115121

122+
<div class="card">
123+
<h5 class="card-header">&#9888; Highlighted Findings</h5>
124+
<div class="card-body">
125+
<div class="col-md-12"><strong>IMPORTANT:</strong> This section groups all findings flagged with "WARNING" by Gitxray to help you focus and prioritize your investigation. Please remember that Gitxray is an information-extraction tool, not a security scanner. Do not rely solely on these highlighted entries—take the time to review all of the data thoroughly.</div>
126+
{{highlights_section}}
127+
</div>
128+
</div>
129+
<br/>
130+
116131
<div class="card">
117132
<h5 class="card-header">Findings specific to the repository</h5>
118133
<div class="card-body">

0 commit comments

Comments
 (0)