Skip to content

Commit

Permalink
Deployed 7dd8446 with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Feb 17, 2025
0 parents commit 054d50c
Show file tree
Hide file tree
Showing 44 changed files with 8,243 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
127 changes: 127 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!DOCTYPE html>
<html class="writer-html5" 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.0" />
<link rel="shortcut icon" href="/img/favicon.ico" />
<title>Gitxray</title>
<link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<!--[if lt IE 9]>
<script src="/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> Gitxray
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/installing/">Installing and Updating Gitxray</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/features/">Features &#128171;</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/vulnerable_workflows/">Vulnerable Workflows</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/code_structure/">Code structure</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/gitxray_buzz/">Gitxray Buzz</a>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">Gitxray</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/." class="icon icon-home" aria-label="Docs"></a></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">


<h1 id="404-page-not-found">404</h1>

<p><strong>Page not found</strong></p>


</div>
</div><footer>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
<p>Made with &hearts; by <a href="https://www.kulkan.com" target="_blank">Kulkan Security</a> - your favorite <a href="https://www.kulkan.com" target="_blank">Penetration Testing Partner</a>.
</p>
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">

<span>
<a href="https://github.com/kulkansecurity/gitxray" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>



</span>
</div>
<script src="/js/jquery-3.6.0.min.js"></script>
<script>var base_url = "/";</script>
<script src="/js/theme_extra.js"></script>
<script src="/js/theme.js"></script>
<script src="/search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
gitxray.com
168 changes: 168 additions & 0 deletions code_structure/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
<!DOCTYPE html>
<html class="writer-html5" 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.0" /><link rel="canonical" href="https://www.gitxray.com/code_structure/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Code structure - Gitxray</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<script>
// Current page data
var mkdocs_page_name = "Code structure";
var mkdocs_page_input_path = "code_structure.md";
var mkdocs_page_url = "/code_structure/";
</script>

<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Gitxray
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing and Updating Gitxray</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../features/">Features &#128171;</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../vulnerable_workflows/">Vulnerable Workflows</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">Code structure</a>
<ul class="current">
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gitxray_buzz/">Gitxray Buzz</a>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Gitxray</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Code structure</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/kulkansecurity/gitxray/edit/master/docs/code_structure.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<h1 id="code-structure">Code structure<a class="headerlink" href="#code-structure" title="Permanent link"></a></h1>
<p>A few pointers on how the Gitxray codebase is structured:</p>
<ul>
<li><code>gitxray.py</code> - The main script, creates a gx_context, gx_output and calls X-Ray modules.</li>
</ul>
<p>The include directory has files split in two naming conventions:</p>
<ul>
<li>Suffix: <code>gh_</code> - Files that handle GitHub API responses or talk to the GitHub API</li>
<li>Suffix: <code>gx_</code> - Files with more Gitxray-specific logic</li>
</ul>
<p>Some of the supporting files in the include directory:</p>
<ul>
<li><code>gx_context.py</code> - Holds a context of data that is shared across different X-Ray modules and through out execution.</li>
<li><code>gx_output.py</code> - Takes care of any console printing, as well as text and json output.</li>
</ul>
<p>For parsing SSH and PGP signatures, we wrote our own code and placed it in:</p>
<ul>
<li><code>gx_ugly_openpgp_parser.py</code> - Parses Armors and BLOBs based on RFC4880</li>
<li><code>gx_ugly_ssh_parser.py</code> - Parses (if you can call that Parsing) SSH Armors and BLOBs</li>
</ul>
<p>Finally, last but not least important, the X-Rays under the xrays directory:</p>
<ul>
<li><code>contributors_xray.py</code> - Handles all Contributor-related data and decides what to log.</li>
<li><code>repository_xray.py</code> - Handles all Repository-related data and decides what to log.</li>
<li><code>workflows_xray.py</code> - Handles all Workflow-related analysis and decides what to log.</li>
<li><code>associations_xray.py</code> - Analyzes and reports all associations carried from prior X-Ray modules.</li>
</ul>

</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../vulnerable_workflows/" class="btn btn-neutral float-left" title="Vulnerable Workflows"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../gitxray_buzz/" class="btn btn-neutral float-right" title="Gitxray Buzz">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
<p>Made with &hearts; by <a href="https://www.kulkan.com" target="_blank">Kulkan Security</a> - your favorite <a href="https://www.kulkan.com" target="_blank">Penetration Testing Partner</a>.
</p>
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">

<span>
<a href="https://github.com/kulkansecurity/gitxray" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>


<span><a href="../vulnerable_workflows/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../gitxray_buzz/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "..";</script>
<script src="../js/theme_extra.js"></script>
<script src="../js/theme.js"></script>
<script src="../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Binary file added css/fonts/Roboto-Slab-Bold.woff
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Bold.woff2
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Regular.woff
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Regular.woff2
Binary file not shown.
Binary file added css/fonts/fontawesome-webfont.eot
Binary file not shown.
Loading

0 comments on commit 054d50c

Please sign in to comment.