-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwork.html
More file actions
271 lines (169 loc) · 11.4 KB
/
work.html
File metadata and controls
271 lines (169 loc) · 11.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Summary — GSoC Rumal 1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="GSoC Rumal 1.0 documentation" href="index.html"/>
<link rel="next" title="Commits" href="commits.html"/>
<link rel="prev" title="GSoC Rumal’s Work Product" href="index.html"/>
<script src="_static/js/modernizr.min.js"></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">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> GSoC Rumal
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Summary</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#rumal-docker">Rumal Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="#docker-python-api-to-replace-subprocces">Docker Python API to Replace Subprocces</a></li>
<li class="toctree-l2"><a class="reference internal" href="#rabbitmq-communication-system">RabbitMQ Communication System</a></li>
<li class="toctree-l2"><a class="reference internal" href="#issues-fixed">Issues Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#advanced-search">Advanced Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="#rumal-social">Rumal Social</a></li>
<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commits.html">Commits</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.html">Future Developments</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="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">GSoC Rumal</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="index.html">Docs</a> »</li>
<li>Summary</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="summary">
<h1>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h1>
<div class="section" id="rumal-docker">
<h2>Rumal Docker<a class="headerlink" href="#rumal-docker" title="Permalink to this headline">¶</a></h2>
<p>A working version of rumal_docker can now be easily installed to test the platform. This only requires you to have Docker installed on your system. Documentation on installing Rumal Docker can be found <a class="reference external" href="http://thugs-rumal.github.io">here</a>.</p>
</div>
<div class="section" id="docker-python-api-to-replace-subprocces">
<h2>Docker Python API to Replace Subprocces<a class="headerlink" href="#docker-python-api-to-replace-subprocces" title="Permalink to this headline">¶</a></h2>
<p>Subproccess popen module that was originally used for launching docker scans is currently the most viable option. Docker-py has limitations in controlling docker containers as certain options cannot be used such as –rm.</p>
<p>It is not officially supported by docker and lacks clear and up to date documentations. Error messages can sometimes be very vague. More information about docker-py’s limitation can be found <a class="reference external" href="http://blog.bordage.pro/avoid-docker-py/">this</a> link.</p>
</div>
<div class="section" id="rabbitmq-communication-system">
<h2>RabbitMQ Communication System<a class="headerlink" href="#rabbitmq-communication-system" title="Permalink to this headline">¶</a></h2>
<p>The previous REST API has been replaced with RabbitMQ queue messaging system using the pika python library. This communication system has been developed to handle the issues with distributed multiple backend/frontends, and specifically these problems:</p>
<ul class="simple">
<li>Is it possible to have multiple consumers (backends) and a single frontend?</li>
<li>Is it possible to choose what backend you want to use?</li>
<li>Would it be possible to have multiple publishers (frontends) as well?</li>
</ul>
<p>When running a new scan you can now select which backend you want to run the scan on, which will send this scan via a private queue to the backend you specified. If you have no preference on which backend to runs the scan you can select ANY option which will place it on a public queue and to be picked up by the 1st available backend.</p>
<p>A list of backends and the location of the public ANY queue is specified on the frontend backend.conf file.</p>
<p>You can find more information on the communication architecture used including diagrams and explanations in our <a class="reference external" href="http://thugs-rumal.github.io/architecture.html">Rumal documentation</a>.</p>
</div>
<div class="section" id="issues-fixed">
<h2>Issues Fixed<a class="headerlink" href="#issues-fixed" title="Permalink to this headline">¶</a></h2>
<p><strong>Front-end:</strong></p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/30">No connection adapters were found for http://backend:8000”/api/v1/task/</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/29">Myscans maximum showed scans limited to 20 results</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/26">My Scans page: Incorrect href values in table of starred scans</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/22">Auto-scroll Up in Panels</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/17">fdaemon: fix urljoin() to be more robust</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal/issues/13">Results page: Change default behavior of panels/boxes</a></li>
</ul>
<p><strong>Back-end:</strong></p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal_back/issues/12">Moving Task Status Constants to Utils</a></li>
<li><a class="reference external" href="https://github.com/thugs-rumal/rumal_back/issues/7">Missing Exception Handling for Hostname Resolution Failure</a></li>
</ul>
</div>
<div class="section" id="advanced-search">
<h2>Advanced Search<a class="headerlink" href="#advanced-search" title="Permalink to this headline">¶</a></h2>
<p>This feature was proposed later on. Its idea was to provide an easy way to build complex search queries for locating specific scans.</p>
<p>It is used to search within the document returned by Thug. It uses pyparsing to build a abstract syntax tree from the grammar and build the corresponding mongo dB query. Queries are built by providing a field to query from, an operator and a value, or just a value. In the latter case all text fields will be searched. Associating them with and/or’s and parentheses will create complex queries. Currently the mongo fields that are allowed to query from are url, urls, tags, timestamp and id. Operators supported are = (contains), == (exact match), ~ (regex), >, >=, <, <=.</p>
</div>
<div class="section" id="rumal-social">
<h2>Rumal Social<a class="headerlink" href="#rumal-social" title="Permalink to this headline">¶</a></h2>
<p>A couple of elements have been integrated for proving the social network in Rumal. This is where Rumal becomes a really powerful tool.</p>
<p>Thug’s analysis may be complex to understand and the elements that we provide can be used to show the most important information out of a scan without the effort of going deep within Thugs output.</p>
<p>You can create groups and share scans within them, keep scans to yourself or release the scan publicly so anyone can contribute.</p>
<p>The collaborative tools built during this year’s GSoC are:</p>
<ul class="simple">
<li>Functional public, private and group scans</li>
<li>Creating and managing groups</li>
<li>Commenting on analysis tree nodes</li>
<li>Creating tags for scans.</li>
</ul>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<p>To support Rumal’s development, a GitHub page was created for reference on Rumals architecture, installation and use. This documentation can be found <a class="reference external" href="https://thugs-rumal.github.io">on this link</a>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="commits.html" class="btn btn-neutral float-right" title="Commits" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="GSoC Rumal’s Work Product" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, Dennis Parchkov.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>