Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions appknox/mapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ def mapper_drf_api(model: type, resource: dict) -> object:
"hipaa",
"cwe",
"mstg",
"owaspapi2023",
"asvs",
"gdpr",
"computed_risk",
Expand Down
Binary file modified docs/.doctrees/client.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/mapper.doctree
Binary file not shown.
62 changes: 19 additions & 43 deletions docs/_modules/appknox/client.html

Large diffs are not rendered by default.

237 changes: 157 additions & 80 deletions docs/_modules/appknox/mapper.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -165,16 +165,16 @@ Get the analyses for this new file:

.. code-block:: python

>>> client.get_analyses(6)[:3]
[Analysis(id=267, risk=2, status=3, cvss_base=6.8,
findings=[{'title': None, 'description': 'Unprotected service: com.appknox.mfva.ExportedService'}],
updated_on='2017-06-27 08:28:35.166608+00:00', vulnerability_id=1),
Analysis(id=235, risk=3, status=3, cvss_base=7.3,
findings=[{'title': None, 'description': 'pathPrefix=/'}],
updated_on='2017-06-27 08:28:35.240543+00:00', vulnerability_id=2),
Analysis(id=236, risk=3, status=3, cvss_base=7.7,
findings=[{'title': None, 'description': 'Debug enabled within the app'}],
updated_on='2017-06-27 08:28:35.296126+00:00', vulnerability_id=3)]

>>> client.get_analyses(1)[3]
[Analysis(id=7, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.201515Z', vulnerability=7, owasp=['M3_2016'], pcidss=['4_1'], hipaa=['164_312_e_1'], cwe=['CWE_296'], mstg=['MSTG_3_2', 'MSTG_3_3', 'MSTG_3_3'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None),
Analysis(id=8, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.525211Z', vulnerability=8, owasp=['M3_2016'], pcidss=['4_1'], hipaa=['164_312_e_1'], cwe=['CWE_297'], mstg=['MSTG_5_3'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None),
Analysis(id=9, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.857579Z', vulnerability=9, owasp=['M3_2016'], pcidss=[], hipaa=[], cwe=['CWE_749'], mstg=['MSTG_6_6'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None)]



Note the ``vulnerability_id`` for ``Analysis(id=235)``. To get details about this vulnerability:

Expand Down
1 change: 1 addition & 0 deletions docs/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
20 changes: 2 additions & 18 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,6 @@ <h2 id="D">D</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="client.html#appknox.client.ApiResource.direct_get">direct_get() (appknox.client.ApiResource method)</a>
</li>
<li><a href="client.html#appknox.client.ApiResource.direct_get_http_response">direct_get_http_response() (appknox.client.ApiResource method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.download_report_data">download_report_data() (appknox.client.Appknox method)</a>
Expand Down Expand Up @@ -190,8 +188,6 @@ <h2 id="G">G</h2>
<li><a href="mapper.html#appknox.mapper.Analysis.gdpr">gdpr (appknox.mapper.Analysis attribute)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.generate_access_token">generate_access_token() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.ApiResource.get">get() (appknox.client.ApiResource method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_analyses">get_analyses() (appknox.client.Appknox method)</a>
</li>
Expand All @@ -206,14 +202,10 @@ <h2 id="G">G</h2>
<li><a href="client.html#appknox.client.Appknox.get_organizations">get_organizations() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_owasp">get_owasp() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_owasps">get_owasps() (appknox.client.Appknox method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="client.html#appknox.client.Appknox.get_pcidss">get_pcidss() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_pcidsses">get_pcidsses() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_profile_report_preference">get_profile_report_preference() (appknox.client.Appknox method)</a>
</li>
Expand All @@ -228,8 +220,6 @@ <h2 id="G">G</h2>
<li><a href="client.html#appknox.client.Appknox.get_unselected_report_preference">get_unselected_report_preference() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_user">get_user() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_vulnerabilities">get_vulnerabilities() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.get_vulnerability">get_vulnerability() (appknox.client.Appknox method)</a>
</li>
Expand Down Expand Up @@ -349,6 +339,8 @@ <h2 id="O">O</h2>
<li><a href="mapper.html#appknox.mapper.Analysis.owasp">owasp (appknox.mapper.Analysis attribute)</a>
</li>
<li><a href="mapper.html#appknox.mapper.OWASP">OWASP (class in appknox.mapper)</a>
</li>
<li><a href="mapper.html#appknox.mapper.Analysis.owaspapi2023">owaspapi2023 (appknox.mapper.Analysis attribute)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -362,10 +354,6 @@ <h2 id="P">P</h2>
<li><a href="mapper.html#appknox.mapper.Submission.package_name">(appknox.mapper.Submission attribute)</a>
</li>
</ul></li>
<li><a href="client.html#appknox.client.Appknox.paginated_data">paginated_data() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.paginated_drf_data">paginated_drf_data() (appknox.client.Appknox method)</a>
</li>
<li><a href="mapper.html#appknox.mapper.Analysis.pcidss">pcidss (appknox.mapper.Analysis attribute)</a>
</li>
<li><a href="mapper.html#appknox.mapper.PCIDSS">PCIDSS (class in appknox.mapper)</a>
Expand All @@ -377,8 +365,6 @@ <h2 id="P">P</h2>
<li><a href="mapper.html#appknox.mapper.Project.platform">platform (appknox.mapper.Project attribute)</a>
</li>
<li><a href="client.html#appknox.client.Appknox.poll_for_file_from_submission_id">poll_for_file_from_submission_id() (appknox.client.Appknox method)</a>
</li>
<li><a href="client.html#appknox.client.ApiResource.post">post() (appknox.client.ApiResource method)</a>
</li>
<li><a href="mapper.html#appknox.mapper.File.profile">profile (appknox.mapper.File attribute)</a>
</li>
Expand Down Expand Up @@ -418,8 +404,6 @@ <h2 id="R">R</h2>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="client.html#appknox.client.ApiResource.set_endpoint">set_endpoint() (appknox.client.ApiResource method)</a>
</li>
<li><a href="mapper.html#appknox.mapper.File.static_scan_progress">static_scan_progress (appknox.mapper.File attribute)</a>
</li>
<li><a href="mapper.html#appknox.mapper.Analysis.status">status (appknox.mapper.Analysis attribute)</a>
Expand Down
17 changes: 7 additions & 10 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,13 @@ <h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">client</span><span class="o">.</span><span class="n">get_analyses</span><span class="p">(</span><span class="mi">6</span><span class="p">)[:</span><span class="mi">3</span><span class="p">]</span>
<span class="go">[Analysis(id=267, risk=2, status=3, cvss_base=6.8,</span>
<span class="go"> findings=[{&#39;title&#39;: None, &#39;description&#39;: &#39;Unprotected service: com.appknox.mfva.ExportedService&#39;}],</span>
<span class="go"> updated_on=&#39;2017-06-27 08:28:35.166608+00:00&#39;, vulnerability_id=1),</span>
<span class="go">Analysis(id=235, risk=3, status=3, cvss_base=7.3,</span>
<span class="go"> findings=[{&#39;title&#39;: None, &#39;description&#39;: &#39;pathPrefix=/&#39;}],</span>
<span class="go"> updated_on=&#39;2017-06-27 08:28:35.240543+00:00&#39;, vulnerability_id=2),</span>
<span class="go">Analysis(id=236, risk=3, status=3, cvss_base=7.7,</span>
<span class="go"> findings=[{&#39;title&#39;: None, &#39;description&#39;: &#39;Debug enabled within the app&#39;}],</span>
<span class="go"> updated_on=&#39;2017-06-27 08:28:35.296126+00:00&#39;, vulnerability_id=3)]</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">client</span><span class="o">.</span><span class="n">get_analyses</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">3</span><span class="p">]</span>
<span class="go">[Analysis(id=7, risk=0, status=3, cvss_base=0.0, cvss_vector=&#39;&#39;, cvss_version=3, cvss_metrics_humanized=[],</span>
<span class="go"> findings=[], updated_on=&#39;2023-10-20T07:00:28.201515Z&#39;, vulnerability=7, owasp=[&#39;M3_2016&#39;], pcidss=[&#39;4_1&#39;], hipaa=[&#39;164_312_e_1&#39;], cwe=[&#39;CWE_296&#39;], mstg=[&#39;MSTG_3_2&#39;, &#39;MSTG_3_3&#39;, &#39;MSTG_3_3&#39;], owaspapi2023=[], asvs=[], gdpr=[&#39;gdpr_25&#39;, &#39;gdpr_32&#39;], computed_risk=0, overridden_risk=None),</span>
<span class="go">Analysis(id=8, risk=0, status=3, cvss_base=0.0, cvss_vector=&#39;&#39;, cvss_version=3, cvss_metrics_humanized=[],</span>
<span class="go"> findings=[], updated_on=&#39;2023-10-20T07:00:28.525211Z&#39;, vulnerability=8, owasp=[&#39;M3_2016&#39;], pcidss=[&#39;4_1&#39;], hipaa=[&#39;164_312_e_1&#39;], cwe=[&#39;CWE_297&#39;], mstg=[&#39;MSTG_5_3&#39;], owaspapi2023=[], asvs=[], gdpr=[&#39;gdpr_25&#39;, &#39;gdpr_32&#39;], computed_risk=0, overridden_risk=None),</span>
<span class="go">Analysis(id=9, risk=0, status=3, cvss_base=0.0, cvss_vector=&#39;&#39;, cvss_version=3, cvss_metrics_humanized=[],</span>
<span class="go"> findings=[], updated_on=&#39;2023-10-20T07:00:28.857579Z&#39;, vulnerability=9, owasp=[&#39;M3_2016&#39;], pcidss=[], hipaa=[], cwe=[&#39;CWE_749&#39;], mstg=[&#39;MSTG_6_6&#39;], owaspapi2023=[], asvs=[], gdpr=[&#39;gdpr_25&#39;, &#39;gdpr_32&#39;], computed_risk=0, overridden_risk=None)]</span>
</pre></div>
</div>
<p>Note the <code class="docutils literal notranslate"><span class="pre">vulnerability_id</span></code> for <code class="docutils literal notranslate"><span class="pre">Analysis(id=235)</span></code>. To get details about this vulnerability:</p>
Expand Down
16 changes: 11 additions & 5 deletions docs/mapper.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@
<span id="appknox-mapper"></span><h1>appknox.mapper<a class="headerlink" href="#module-appknox.mapper" title="Permalink to this heading">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="appknox.mapper.Analysis">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">appknox.mapper.</span></span><span class="sig-name descname"><span class="pre">Analysis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">risk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_vector</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_metrics_humanized</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">findings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_on</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vulnerability</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owasp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcidss</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hipaa</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cwe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mstg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asvs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gdpr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">computed_risk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overridden_risk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#appknox.mapper.Analysis" title="Permalink to this definition">¶</a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">appknox.mapper.</span></span><span class="sig-name descname"><span class="pre">Analysis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">risk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_vector</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cvss_metrics_humanized</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">findings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_on</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vulnerability</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owasp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcidss</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hipaa</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cwe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mstg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owaspapi2023</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asvs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gdpr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">computed_risk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overridden_risk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#appknox.mapper.Analysis" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.asvs">
<span class="sig-name descname"><span class="pre">asvs</span></span><a class="headerlink" href="#appknox.mapper.Analysis.asvs" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 15</p>
<dd><p>Alias for field number 16</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.computed_risk">
<span class="sig-name descname"><span class="pre">computed_risk</span></span><a class="headerlink" href="#appknox.mapper.Analysis.computed_risk" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 17</p>
<dd><p>Alias for field number 18</p>
</dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -87,7 +87,7 @@
<dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.gdpr">
<span class="sig-name descname"><span class="pre">gdpr</span></span><a class="headerlink" href="#appknox.mapper.Analysis.gdpr" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 16</p>
<dd><p>Alias for field number 17</p>
</dd></dl>

<dl class="py attribute">
Expand All @@ -111,7 +111,7 @@
<dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.overridden_risk">
<span class="sig-name descname"><span class="pre">overridden_risk</span></span><a class="headerlink" href="#appknox.mapper.Analysis.overridden_risk" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 18</p>
<dd><p>Alias for field number 19</p>
</dd></dl>

<dl class="py attribute">
Expand All @@ -120,6 +120,12 @@
<dd><p>Alias for field number 10</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.owaspapi2023">
<span class="sig-name descname"><span class="pre">owaspapi2023</span></span><a class="headerlink" href="#appknox.mapper.Analysis.owaspapi2023" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 15</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="appknox.mapper.Analysis.pcidss">
<span class="sig-name descname"><span class="pre">pcidss</span></span><a class="headerlink" href="#appknox.mapper.Analysis.pcidss" title="Permalink to this definition">¶</a></dt>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions sphinx-docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,16 +165,16 @@ Get the analyses for this new file:

.. code-block:: python

>>> client.get_analyses(6)[:3]
[Analysis(id=267, risk=2, status=3, cvss_base=6.8,
findings=[{'title': None, 'description': 'Unprotected service: com.appknox.mfva.ExportedService'}],
updated_on='2017-06-27 08:28:35.166608+00:00', vulnerability_id=1),
Analysis(id=235, risk=3, status=3, cvss_base=7.3,
findings=[{'title': None, 'description': 'pathPrefix=/'}],
updated_on='2017-06-27 08:28:35.240543+00:00', vulnerability_id=2),
Analysis(id=236, risk=3, status=3, cvss_base=7.7,
findings=[{'title': None, 'description': 'Debug enabled within the app'}],
updated_on='2017-06-27 08:28:35.296126+00:00', vulnerability_id=3)]

>>> client.get_analyses(1)[3]
[Analysis(id=7, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.201515Z', vulnerability=7, owasp=['M3_2016'], pcidss=['4_1'], hipaa=['164_312_e_1'], cwe=['CWE_296'], mstg=['MSTG_3_2', 'MSTG_3_3', 'MSTG_3_3'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None),
Analysis(id=8, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.525211Z', vulnerability=8, owasp=['M3_2016'], pcidss=['4_1'], hipaa=['164_312_e_1'], cwe=['CWE_297'], mstg=['MSTG_5_3'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None),
Analysis(id=9, risk=0, status=3, cvss_base=0.0, cvss_vector='', cvss_version=3, cvss_metrics_humanized=[],
findings=[], updated_on='2023-10-20T07:00:28.857579Z', vulnerability=9, owasp=['M3_2016'], pcidss=[], hipaa=[], cwe=['CWE_749'], mstg=['MSTG_6_6'], owaspapi2023=[], asvs=[], gdpr=['gdpr_25', 'gdpr_32'], computed_risk=0, overridden_risk=None)]



Note the ``vulnerability_id`` for ``Analysis(id=235)``. To get details about this vulnerability:

Expand Down