Skip to content

Commit fd145fe

Browse files
author
committed
Deployed b9babba with MkDocs version: 1.6.1
0 parents  commit fd145fe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+8243
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎404.html

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<link rel="shortcut icon" href="/img/favicon.ico" />
8+
<title>Gitxray</title>
9+
<link rel="stylesheet" href="/css/theme.css" />
10+
<link rel="stylesheet" href="/css/theme_extra.css" />
11+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
12+
13+
<!--[if lt IE 9]>
14+
<script src="/js/html5shiv.min.js"></script>
15+
<![endif]-->
16+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
17+
<script>hljs.highlightAll();</script>
18+
</head>
19+
20+
<body class="wy-body-for-nav" role="document">
21+
22+
<div class="wy-grid-for-nav">
23+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
24+
<div class="wy-side-scroll">
25+
<div class="wy-side-nav-search">
26+
<a href="/." class="icon icon-home"> Gitxray
27+
</a><div role="search">
28+
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
29+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
30+
</form>
31+
</div>
32+
</div>
33+
34+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
35+
<ul>
36+
<li class="toctree-l1"><a class="reference internal" href="/installing/">Installing and Updating Gitxray</a>
37+
</li>
38+
</ul>
39+
<ul>
40+
<li class="toctree-l1"><a class="reference internal" href="/features/">Features &#128171;</a>
41+
</li>
42+
</ul>
43+
<ul>
44+
<li class="toctree-l1"><a class="reference internal" href="/vulnerable_workflows/">Vulnerable Workflows</a>
45+
</li>
46+
</ul>
47+
<ul>
48+
<li class="toctree-l1"><a class="reference internal" href="/code_structure/">Code structure</a>
49+
</li>
50+
</ul>
51+
<ul>
52+
<li class="toctree-l1"><a class="reference internal" href="/gitxray_buzz/">Gitxray Buzz</a>
53+
</li>
54+
</ul>
55+
</div>
56+
</div>
57+
</nav>
58+
59+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
60+
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
61+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
62+
<a href="/.">Gitxray</a>
63+
64+
</nav>
65+
<div class="wy-nav-content">
66+
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
67+
<ul class="wy-breadcrumbs">
68+
<li><a href="/." class="icon icon-home" aria-label="Docs"></a></li>
69+
<li class="wy-breadcrumbs-aside">
70+
</li>
71+
</ul>
72+
<hr/>
73+
</div>
74+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
75+
<div class="section" itemprop="articleBody">
76+
77+
78+
<h1 id="404-page-not-found">404</h1>
79+
80+
<p><strong>Page not found</strong></p>
81+
82+
83+
</div>
84+
</div><footer>
85+
86+
<hr/>
87+
88+
<div role="contentinfo">
89+
<!-- Copyright etc -->
90+
<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>.
91+
</p>
92+
</div>
93+
94+
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>.
95+
</footer>
96+
97+
</div>
98+
</div>
99+
100+
</section>
101+
102+
</div>
103+
104+
<div class="rst-versions" role="note" aria-label="Versions">
105+
<span class="rst-current-version" data-toggle="rst-current-version">
106+
107+
<span>
108+
<a href="https://github.com/kulkansecurity/gitxray" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
109+
</span>
110+
111+
112+
113+
</span>
114+
</div>
115+
<script src="/js/jquery-3.6.0.min.js"></script>
116+
<script>var base_url = "/";</script>
117+
<script src="/js/theme_extra.js"></script>
118+
<script src="/js/theme.js"></script>
119+
<script src="/search/main.js"></script>
120+
<script>
121+
jQuery(function () {
122+
SphinxRtdTheme.Navigation.enable(true);
123+
});
124+
</script>
125+
126+
</body>
127+
</html>

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
gitxray.com

‎code_structure/index.html

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://www.gitxray.com/code_structure/" />
7+
<link rel="shortcut icon" href="../img/favicon.ico" />
8+
<title>Code structure - Gitxray</title>
9+
<link rel="stylesheet" href="../css/theme.css" />
10+
<link rel="stylesheet" href="../css/theme_extra.css" />
11+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
12+
13+
<script>
14+
// Current page data
15+
var mkdocs_page_name = "Code structure";
16+
var mkdocs_page_input_path = "code_structure.md";
17+
var mkdocs_page_url = "/code_structure/";
18+
</script>
19+
20+
<!--[if lt IE 9]>
21+
<script src="../js/html5shiv.min.js"></script>
22+
<![endif]-->
23+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
24+
<script>hljs.highlightAll();</script>
25+
</head>
26+
27+
<body class="wy-body-for-nav" role="document">
28+
29+
<div class="wy-grid-for-nav">
30+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
31+
<div class="wy-side-scroll">
32+
<div class="wy-side-nav-search">
33+
<a href=".." class="icon icon-home"> Gitxray
34+
</a><div role="search">
35+
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
36+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
37+
</form>
38+
</div>
39+
</div>
40+
41+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
42+
<ul>
43+
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing and Updating Gitxray</a>
44+
</li>
45+
</ul>
46+
<ul>
47+
<li class="toctree-l1"><a class="reference internal" href="../features/">Features &#128171;</a>
48+
</li>
49+
</ul>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../vulnerable_workflows/">Vulnerable Workflows</a>
52+
</li>
53+
</ul>
54+
<ul class="current">
55+
<li class="toctree-l1 current"><a class="reference internal current" href="#">Code structure</a>
56+
<ul class="current">
57+
</ul>
58+
</li>
59+
</ul>
60+
<ul>
61+
<li class="toctree-l1"><a class="reference internal" href="../gitxray_buzz/">Gitxray Buzz</a>
62+
</li>
63+
</ul>
64+
</div>
65+
</div>
66+
</nav>
67+
68+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
69+
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
70+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
71+
<a href="..">Gitxray</a>
72+
73+
</nav>
74+
<div class="wy-nav-content">
75+
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
76+
<ul class="wy-breadcrumbs">
77+
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
78+
<li class="breadcrumb-item active">Code structure</li>
79+
<li class="wy-breadcrumbs-aside">
80+
<a href="https://github.com/kulkansecurity/gitxray/edit/master/docs/code_structure.md" class="icon icon-github"> Edit on GitHub</a>
81+
</li>
82+
</ul>
83+
<hr/>
84+
</div>
85+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
86+
<div class="section" itemprop="articleBody">
87+
88+
<h1 id="code-structure">Code structure<a class="headerlink" href="#code-structure" title="Permanent link"></a></h1>
89+
<p>A few pointers on how the Gitxray codebase is structured:</p>
90+
<ul>
91+
<li><code>gitxray.py</code> - The main script, creates a gx_context, gx_output and calls X-Ray modules.</li>
92+
</ul>
93+
<p>The include directory has files split in two naming conventions:</p>
94+
<ul>
95+
<li>Suffix: <code>gh_</code> - Files that handle GitHub API responses or talk to the GitHub API</li>
96+
<li>Suffix: <code>gx_</code> - Files with more Gitxray-specific logic</li>
97+
</ul>
98+
<p>Some of the supporting files in the include directory:</p>
99+
<ul>
100+
<li><code>gx_context.py</code> - Holds a context of data that is shared across different X-Ray modules and through out execution.</li>
101+
<li><code>gx_output.py</code> - Takes care of any console printing, as well as text and json output.</li>
102+
</ul>
103+
<p>For parsing SSH and PGP signatures, we wrote our own code and placed it in:</p>
104+
<ul>
105+
<li><code>gx_ugly_openpgp_parser.py</code> - Parses Armors and BLOBs based on RFC4880</li>
106+
<li><code>gx_ugly_ssh_parser.py</code> - Parses (if you can call that Parsing) SSH Armors and BLOBs</li>
107+
</ul>
108+
<p>Finally, last but not least important, the X-Rays under the xrays directory:</p>
109+
<ul>
110+
<li><code>contributors_xray.py</code> - Handles all Contributor-related data and decides what to log.</li>
111+
<li><code>repository_xray.py</code> - Handles all Repository-related data and decides what to log.</li>
112+
<li><code>workflows_xray.py</code> - Handles all Workflow-related analysis and decides what to log.</li>
113+
<li><code>associations_xray.py</code> - Analyzes and reports all associations carried from prior X-Ray modules.</li>
114+
</ul>
115+
116+
</div>
117+
</div><footer>
118+
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
119+
<a href="../vulnerable_workflows/" class="btn btn-neutral float-left" title="Vulnerable Workflows"><span class="icon icon-circle-arrow-left"></span> Previous</a>
120+
<a href="../gitxray_buzz/" class="btn btn-neutral float-right" title="Gitxray Buzz">Next <span class="icon icon-circle-arrow-right"></span></a>
121+
</div>
122+
123+
<hr/>
124+
125+
<div role="contentinfo">
126+
<!-- Copyright etc -->
127+
<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>.
128+
</p>
129+
</div>
130+
131+
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>.
132+
</footer>
133+
134+
</div>
135+
</div>
136+
137+
</section>
138+
139+
</div>
140+
141+
<div class="rst-versions" role="note" aria-label="Versions">
142+
<span class="rst-current-version" data-toggle="rst-current-version">
143+
144+
<span>
145+
<a href="https://github.com/kulkansecurity/gitxray" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
146+
</span>
147+
148+
149+
<span><a href="../vulnerable_workflows/" style="color: #fcfcfc">&laquo; Previous</a></span>
150+
151+
152+
<span><a href="../gitxray_buzz/" style="color: #fcfcfc">Next &raquo;</a></span>
153+
154+
</span>
155+
</div>
156+
<script src="../js/jquery-3.6.0.min.js"></script>
157+
<script>var base_url = "..";</script>
158+
<script src="../js/theme_extra.js"></script>
159+
<script src="../js/theme.js"></script>
160+
<script src="../search/main.js"></script>
161+
<script>
162+
jQuery(function () {
163+
SphinxRtdTheme.Navigation.enable(true);
164+
});
165+
</script>
166+
167+
</body>
168+
</html>

‎css/fonts/Roboto-Slab-Bold.woff

85.6 KB
Binary file not shown.

‎css/fonts/Roboto-Slab-Bold.woff2

65.7 KB
Binary file not shown.

‎css/fonts/Roboto-Slab-Regular.woff

84.3 KB
Binary file not shown.

‎css/fonts/Roboto-Slab-Regular.woff2

64.9 KB
Binary file not shown.

‎css/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)