-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathindex.html
515 lines (467 loc) · 38.3 KB
/
index.html
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>appknox-python — appknox-python 3.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="appknox.client" href="client.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="appknox-python">
<h1>appknox-python<a class="headerlink" href="#appknox-python" title="Permalink to this heading">¶</a></h1>
<p><strong>Documentation for Version 3.x.x</strong></p>
<p>appknox-python provides command-line interface and Python wrapper for the
Appknox API.</p>
<section id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this heading">¶</a></h2>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#install">Install</a></p></li>
<li><p><a class="reference internal" href="#creating-client-instance">Creating client instance</a></p></li>
<li><p><a class="reference internal" href="#get-organizations-list">Get organizations list</a></p></li>
<li><p><a class="reference internal" href="#get-projects-list">Get projects list</a></p></li>
<li><p><a class="reference internal" href="#get-files-list">Get files list</a></p></li>
<li><p><a class="reference internal" href="#get-analysis-list">Get analysis list</a></p></li>
<li><p><a class="reference internal" href="#get-vulnerability-details">Get vulnerability details</a></p></li>
<li><p><a class="reference internal" href="#upload-app">Upload app</a></p></li>
<li><p><a class="reference internal" href="#recent-uploads">Recent Uploads</a></p></li>
<li><p><a class="reference internal" href="#rescan">Rescan</a></p></li>
<li><p><a class="reference internal" href="#switch-organization">Switch organization</a></p></li>
<li><p><a class="reference internal" href="#list-reports">List Reports</a></p></li>
<li><p><a class="reference internal" href="#create-report">Create Report</a></p></li>
<li><p><a class="reference internal" href="#get-report-summary-csv-url">Get Report Summary CSV URL</a></p></li>
<li><p><a class="reference internal" href="#get-report-summary-excel-url">Get Report Summary Excel URL</a></p></li>
<li><p><a class="reference internal" href="#download-report-data-from-url">Download Report Data from URL</a></p></li>
<li><p><a class="reference internal" href="#complete-reference">Complete Reference</a></p></li>
</ol>
</section>
<section id="install">
<span id="id1"></span><h2>Install:<a class="headerlink" href="#install" title="Permalink to this heading">¶</a></h2>
<p><cite>appknox</cite> is available via <a class="reference external" href="https://pypi.org/project/appknox/">PyPI</a>. It is officially supported on python 3.5 & 3.6.</p>
<p><strong>Install with pip:</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>appknox
</pre></div>
</div>
</section>
<section id="creating-client-instance">
<span id="id2"></span><h2>Creating client instance:<a class="headerlink" href="#creating-client-instance" title="Permalink to this heading">¶</a></h2>
<p>Appknox class provides an easy access to the Appknox API.</p>
<p>Instances of this class can be used to interact with the Appknox scanner.</p>
<p>An instance for Appknox class can be obtained in two ways:</p>
<dl>
<dt><strong>1. Using personal access tokens:</strong></dt><dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">appknox</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">appknox</span><span class="o">.</span><span class="n">Appknox</span><span class="p">(</span>
<span class="n">access_token</span><span class="o">=</span><span class="s1">'PERSONAL_ACCESS_TOKEN'</span><span class="p">,</span>
<span class="n">host</span><span class="o">=</span><span class="s1">'API_HOST'</span>
<span class="p">)</span>
</pre></div>
</div>
<p><em>Personal access token can be generated from Appknox dashboard
(Settings → Developer Settings → Generate token)</em></p>
</dd>
</dl>
<p><strong>2. Using login credentials: (This is not recommended)</strong></p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">appknox</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">appknox</span><span class="o">.</span><span class="n">Appknox</span><span class="p">(</span>
<span class="n">username</span><span class="o">=</span><span class="s1">'USERNAME'</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s1">'PASSWORD'</span><span class="p">,</span>
<span class="n">host</span><span class="o">=</span><span class="s1">'API_HOST'</span>
<span class="p">)</span>
<span class="n">client</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="n">otp</span><span class="o">=</span><span class="mi">013370</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">otp</span></code> is required only for accounts with multi-factor authentication.</p>
</div></blockquote>
</section>
<section id="get-organizations-list">
<span id="id3"></span><h2>Get organizations list:<a class="headerlink" href="#get-organizations-list" title="Permalink to this heading">¶</a></h2>
<p>To list organizations for an authenticated user</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">get_organizations</span><span class="p">()</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_organizations</span><span class="p">()</span>
<span class="go">[Organization(id=2, name='MyOrganization')]</span>
</pre></div>
</div>
<p>All results are Python objects, with its respective attributes.</p>
</section>
<section id="get-projects-list">
<span id="id4"></span><h2>Get projects list:<a class="headerlink" href="#get-projects-list" title="Permalink to this heading">¶</a></h2>
<p>To list projects for which the authenticated user has access to in default organization.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">get_projects</span><span class="p">()</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_projects</span><span class="p">()</span>
<span class="go">[Project(id=3, created_on='2017-06-23 07:19:26.720829+00:00', file_count=3,</span>
<span class="go"> package_name='org.owasp.goatdroid.fourgoats', platform=0,</span>
<span class="go"> updated_on='2017-06-23 07:26:55.456744+00:00'),</span>
<span class="go">Project(id=4, created_on='2017-06-27 08:27:54.486226+00:00', file_count=1,</span>
<span class="go"> package_name='com.appknox.mfva', platform=0,</span>
<span class="go"> updated_on='2017-06-27 08:27:54.637432+00:00')]</span>
</pre></div>
</div>
<p>All results are Python objects, with its respective attributes.</p>
</section>
<section id="get-files-list">
<span id="id5"></span><h2>Get files list:<a class="headerlink" href="#get-files-list" title="Permalink to this heading">¶</a></h2>
<p>For listing files within a project:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">get_files</span><span class="p">(</span><span class="o"><</span><span class="n">project_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_files</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
<span class="go">[File(id=6, name='MFVA', version='1.0', version_code='5', static_scan_progress=100),]</span>
</pre></div>
</div>
</section>
<section id="get-analysis-list">
<span id="id6"></span><h2>Get analysis list:<a class="headerlink" href="#get-analysis-list" title="Permalink to this heading">¶</a></h2>
<p>Get the analyses for this new file:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">get_analyses</span><span class="p">(</span><span class="o"><</span><span class="n">file_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_analyses</span><span class="p">(</span><span class="mi">273</span><span class="p">)[:</span><span class="mi">3</span><span class="p">]</span>
<span class="go"> [Analysis(id = 22248, risk = 2, status = 3, cvss_base = 6.6, cvss_vector = 'CVSS:3.0/AV:A/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H', cvss_version = 3, cvss_metrics_humanized = [{</span>
<span class="go"> 'key': 'Attack Vector',</span>
<span class="go"> 'value': 'Adjacent'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Attack Complexity',</span>
<span class="go"> 'value': 'Low'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Privileges Required',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'User Interaction',</span>
<span class="go"> 'value': 'Required'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Scope',</span>
<span class="go"> 'value': 'Unchanged'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Confidentiality Impact',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Integrity Impact',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Availability Impact',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }],</span>
<span class="go"> findings = [{</span>
<span class="go"> 'title': 'ssLA5o60a398i7TM5RkofIA1J',</span>
<span class="go"> 'description': 'MfmnwBwK2HsWqnZMOJoDvWnhIFdVMn'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'p9TPfBKLqtlExLklJYnifHO72',</span>
<span class="go"> 'description': '0rppCThV5ybdROVlizmG5ryoWd7S7r'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'DpqNGv4q8ZhrYgyobSpEuqiq7',</span>
<span class="go"> 'description': 'BmQkMywysefELpWcG1OGYN9N98PdSi'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'pcqd88I0ZLpRqKYD7lTrbGEEY',</span>
<span class="go"> 'description': '7PYqk3Gg9J3Zr7nu8PKhv1tHH1NhdA'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'TGdwRQOaFBQ9J046BRB2DJXn4',</span>
<span class="go"> 'description': 'skEJq90yDVC5y0zmSD09f1rQyK8KNZ'</span>
<span class="go"> }],</span>
<span class="go"> updated_on = '2023-09-13T06:08:18.384903Z', vulnerability = 1, owasp = ['M1_2016'], pcidss = ['3_2', '3_3', '3_4'], hipaa = ['164_312_a_1'], cwe = ['CWE_926'], mstg = ['MSTG_6_3', 'MSTG_6_4'], masvs = ['MASVS_6_1'], asvs = [], gdpr = ['gdpr_25', 'gdpr_32'], computed_risk = 2, overridden_risk = None),</span>
<span class="go"> Analysis(id = 22247, risk = 2, status = 3, cvss_base = 5.7, cvss_vector = 'CVSS:3.0/AV:P/AC:L/PR:H/UI:N/S:C/C:L/I:H/A:N', cvss_version = 3, cvss_metrics_humanized = [{</span>
<span class="go"> 'key': 'Attack Vector',</span>
<span class="go"> 'value': 'Physical'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Attack Complexity',</span>
<span class="go"> 'value': 'Low'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Privileges Required',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'User Interaction',</span>
<span class="go"> 'value': 'Not Required'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Scope',</span>
<span class="go"> 'value': 'Changed'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Confidentiality Impact',</span>
<span class="go"> 'value': 'Low'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Integrity Impact',</span>
<span class="go"> 'value': 'High'</span>
<span class="go"> }, {</span>
<span class="go"> 'key': 'Availability Impact',</span>
<span class="go"> 'value': 'None'</span>
<span class="go"> }],</span>
<span class="go"> findings = [{</span>
<span class="go"> 'title': 'y4iutu3KCWb7shg6BsZqu867Y',</span>
<span class="go"> 'description': 'cqB9EcXpGrvQbsrGNMProR3J1cbmxw'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'kPLH7e9juz1wq2JCBJrVR9fnb',</span>
<span class="go"> 'description': '2rSLRxGXZbeSZ437l5bzKTTwwSB7il'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'qUObDBfoIvOSbVgyhQwxBWOY6',</span>
<span class="go"> 'description': 'iHdHrlq0dCA1gxjWyo4wnGZ3flmr70'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'l1i4LxUXU3PaMv1wsYaN7zzLu',</span>
<span class="go"> 'description': '5g4ml46nrfndL7M4V43ZbkEXVX0bVn'</span>
<span class="go"> }, {</span>
<span class="go"> 'title': 'OgZY2lNjHTPqvNl75bupA3tNH',</span>
<span class="go"> 'description': 'IiwQX1xQDjX5t4W6Y9KyWIrMdeREtw'</span>
<span class="go"> }],</span>
<span class="go"> updated_on = '2023-09-13T06:08:21.540225Z', vulnerability = 2, owasp = ['M1_2016'], pcidss = ['3_2', '3_3', '3_4'], hipaa = ['164_312_a_1'], cwe = ['CWE_926'], mstg = ['MSTG_6_1'], masvs = ['MASVS_6_1'], asvs = [], gdpr = ['gdpr_25', 'gdpr_32'], computed_risk = 2, 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>
</section>
<section id="get-vulnerability-details">
<span id="id7"></span><h2>Get vulnerability details:<a class="headerlink" href="#get-vulnerability-details" title="Permalink to this heading">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">get_vulnerability</span><span class="p">(</span><span class="o"><</span><span class="n">vulnerability_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_vulnerability</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="go">Vulnerability(name='Improper Content Provider Permissions',</span>
<span class="go"> description='A content provider permission was set to allow access from any other app on the device.</span>
<span class="go"> Content providers may contain sensitive information about an app and therefore should not be shared.',</span>
<span class="go"> intro="The `ContentProvider` class provides a mechanism for managing and sharing data with other applications.</span>
<span class="go"> When sharing a provider's data with other apps, access control should be carefully implemented to prohibit unauthorized access to sensitive data.")</span>
</pre></div>
</div>
</section>
<section id="upload-app">
<span id="id8"></span><h2>Upload app:<a class="headerlink" href="#upload-app" title="Permalink to this heading">¶</a></h2>
<p>To upload and scan a new package:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">file_id</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">upload_file</span><span class="p">(</span><span class="o"><</span><span class="n">binary_data</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'/home/username/apk/mfva_1.0.apk'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">file_data</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">file_id</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">upload_file</span><span class="p">(</span><span class="n">file_data</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span><span class="n">file_id</span><span class="p">)</span>
<span class="go">File(id=11469, name='MFVA', version='1.0', version_code='6', static_scan_progress=100)</span>
</pre></div>
</div>
</section>
<section id="recent-uploads">
<span id="id9"></span><h2>Recent Uploads:<a class="headerlink" href="#recent-uploads" title="Permalink to this heading">¶</a></h2>
<p>Get recent file uploads by the user:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">recent_uploads</span><span class="p">()</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">recent_uploads</span><span class="p">()</span>
<span class="go">[Submission(id=15506, status=7, file=11469, package_name='com.appknox.mfva', created_on='2019-05-06T16:04:50.094503Z', reason=''),</span>
<span class="go"> Submission(id=15438, status=7, file=11405, package_name='com.appknox.mfva', created_on='2019-05-02T17:36:38.374191Z', reason=''),</span>
<span class="go"> Submission(id=15437, status=7, file=11404, package_name='com.appknox.mfva', created_on='2019-05-02T17:35:29.245553Z', reason=''),</span>
<span class="go"> Submission(id=15436, status=7, file=11403, package_name='com.appknox.mfva', created_on='2019-05-02T17:33:36.399803Z', reason=''),]</span>
</pre></div>
</div>
</section>
<section id="rescan">
<span id="id10"></span><h2>Rescan:<a class="headerlink" href="#rescan" title="Permalink to this heading">¶</a></h2>
<p>To rescan a file:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">rescan</span><span class="p">(</span><span class="o"><</span><span class="n">file_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p>This will create a new file under the same project. Once the file has been started, list files to get the latest file id.</p>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">rescan</span><span class="p">(</span><span class="mi">7</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_files</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
<span class="go">[File(id=8, name='MFVA', version='1.0', version_code='6', static_scan_progress=100),</span>
<span class="go"> File(id=7, name='MFVA', version='1.0', version_code='6', static_scan_progress=100),,</span>
<span class="go"> File(id=6, name='MFVA', version='1.0', version_code='5', static_scan_progress=100),]</span>
</pre></div>
</div>
</section>
<section id="switch-organization">
<span id="id11"></span><h2>Switch organization:<a class="headerlink" href="#switch-organization" title="Permalink to this heading">¶</a></h2>
<p>Change default organization for client instance.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">switch_organization</span><span class="p">(</span><span class="o"><</span><span class="n">organization_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">switch_organization</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</section>
<section id="list-reports">
<span id="id12"></span><h2>List Reports:<a class="headerlink" href="#list-reports" title="Permalink to this heading">¶</a></h2>
<p>List all reports for a given File ID.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">list_reports</span><span class="p">(</span><span class="o"><</span><span class="n">file_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">list_reports</span><span class="p">(</span><span class="mi">95</span><span class="p">)</span>
<span class="go">[Report(id=105, language='en', generated_on='2023-01-24T06:37:05.565031Z', progress=100, rating='21.62', preferences=ReportPreference(show_api_scan=True, show_manual_scan=True, show_static_scan=True, show_dynamic_scan=True, show_ignored_analyses=False, show_hipaa=InheritedPreference(value=True, is_inherited=True), show_pcidss=InheritedPreference(value=True, is_inherited=True)))]</span>
</pre></div>
</div>
</section>
<section id="create-report">
<span id="id13"></span><h2>Create Report:<a class="headerlink" href="#create-report" title="Permalink to this heading">¶</a></h2>
<p>Creates a new report for given file ID</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">create_report</span><span class="p">(</span><span class="o"><</span><span class="n">file_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">create_report</span><span class="p">(</span><span class="mi">94</span><span class="p">)</span>
<span class="go">Report(id=110, language='en', generated_on='2023-01-25T11:52:35.253614Z', progress=0, rating='6.76', preferences=ReportPreference(show_api_scan=True, show_manual_scan=True, show_static_scan=True, show_dynamic_scan=True, show_ignored_analyses=False, show_hipaa=InheritedPreference(value=True, is_inherited=True), show_pcidss=InheritedPreference(value=True, is_inherited=True)))</span>
</pre></div>
</div>
</section>
<section id="get-report-summary-csv-url">
<span id="id14"></span><h2>Get Report Summary CSV URL:<a class="headerlink" href="#get-report-summary-csv-url" title="Permalink to this heading">¶</a></h2>
<p>Returns a absolute URL to download report summary in CSV format for given report ID</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_summary_csv_report_url</span><span class="p">(</span><span class="o"><</span><span class="n">report_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_summary_csv_report_url</span><span class="p">(</span><span class="mi">110</span><span class="p">)</span>
<span class="go">'https://api.appknox.com/api/v2/reports/110/summary_csv_download?sig=eyJ1c2VyX2lkIjoyLCJ1c2VybmFtZSI6InJhamFuIn0:1pKeRU:U4qF1EQ3QJDFRCf33nvcZiLzmI4jZNlcR4sDqAW2_IM:1pKeRU:70aBOcQY8-Lm75IT4E41wr7oRkyHabZX6a9lO_tdTZk'</span>
</pre></div>
</div>
</section>
<section id="get-report-summary-excel-url">
<span id="id15"></span><h2>Get Report Summary Excel URL<a class="headerlink" href="#get-report-summary-excel-url" title="Permalink to this heading">¶</a></h2>
<p>Returns a absolute URL to download report summary in Excel format for given report ID</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_summary_excel_report_url</span><span class="p">(</span><span class="o"><</span><span class="n">report_id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Example:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">get_summary_excel_report_url</span><span class="p">(</span><span class="mi">110</span><span class="p">)</span>
<span class="go">'https://api.appknox.com/api/v2/reports/110/summary_excel_download?sig=eyJ1c2VyX2lkIjoyLCJ1c2VybmFtZSI6InJhamFuIn0:1pKeTf:skTH0btBf6IWT8TfBZYszT2ymXnT2CJRatKzf_kZwLE:1pKeTf:1Nf1z-lU6V7EMdtnBk0nKKcFH0clrdthBRa1DIbbVFU'</span>
</pre></div>
</div>
</section>
<section id="download-report-data-from-url">
<span id="id16"></span><h2>Download Report Data from URL<a class="headerlink" href="#download-report-data-from-url" title="Permalink to this heading">¶</a></h2>
<p>Returns full HTTP response body from a given absolute URL</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">download_report_data</span><span class="p">(</span><span class="o"><</span><span class="n">url</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p><em>Examples:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">download_report_data</span><span class="p">(</span><span class="s1">'https://api.appknox.com/api/v2/reports/110/summary_excel_download?sig=eyJ1c2VyX2lkIjoyLCJ1c2VybmFtZSI6InJhamFuIn0:1pKeTf:skTH0btBf6IWT8TfBZYszT2ymXnT2CJRatKzf_kZwLE:1pKeTf:1Nf1z-lU6V7EMdtnBk0nKKcFH0clrdthBRa1DIbbVFU'</span><span class="p">)</span>
<span class="go">b'PK\x03\x04\x14\x00\x00\x00\x08\x00\x00\x00?\x008\x9d\x86\xd8>\x01\x00\x00\x07\x04\x00\x00\x13\x00\x00\x00[Content_Types].xml\xad\x93\xcbn\xc3 \x10E\xf7\xfd\n\xc4\xb62$]TU\x15\'\x8b>\x96m\x16\xe9\x07P\x18\xc7(\x18\x103I\x93\xbf/\xb6\x93H\xad\xd2<\x94n\x8c\xcc\xdc...(Truncated)</span>
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">download_report_data</span><span class="p">(</span><span class="s1">'https://api.appknox.com/api/v2/reports/110/summary_csv_download?sig=eyJ1c2VyX2lkIjoyLCJ1c2VybmFtZSI6InJhamFuIn0:1pKeZL:Rr8IyficPV19ik0GYBX7caY-qCswKCOEecFYbuCuo_w:1pKeZL:D0i-AzRv5IuFy1MhGINuxCQW41zgHiuC1DKsgsfGG8Y'</span><span class="p">)</span>
<span class="go">b'Project ID,Application Name,Application Namespace,Platform,Version,Version Code,File ID,Test Case,Scan Type,Severity,Risk Override,CVSS Score,Findings,Description,Noncompliant Code Example,Compliant Solution,Business Implication,OWASP...(Truncated)</span>
</pre></div>
</div>
</section>
<section id="complete-reference">
<span id="id17"></span><h2>Complete Reference<a class="headerlink" href="#complete-reference" title="Permalink to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">appknox.client</a><ul>
<li class="toctree-l2"><a class="reference internal" href="client.html#appknox.client.ApiResource"><code class="docutils literal notranslate"><span class="pre">ApiResource</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#appknox.client.Appknox"><code class="docutils literal notranslate"><span class="pre">Appknox</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mapper.html">appknox.mapper</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Analysis"><code class="docutils literal notranslate"><span class="pre">Analysis</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.File"><code class="docutils literal notranslate"><span class="pre">File</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.InheritedPreference"><code class="docutils literal notranslate"><span class="pre">InheritedPreference</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.OWASP"><code class="docutils literal notranslate"><span class="pre">OWASP</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Organization"><code class="docutils literal notranslate"><span class="pre">Organization</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.PCIDSS"><code class="docutils literal notranslate"><span class="pre">PCIDSS</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.PersonalToken"><code class="docutils literal notranslate"><span class="pre">PersonalToken</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.ProfileReportPreference"><code class="docutils literal notranslate"><span class="pre">ProfileReportPreference</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.ProfileReportPreferenceConfig"><code class="docutils literal notranslate"><span class="pre">ProfileReportPreferenceConfig</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Project"><code class="docutils literal notranslate"><span class="pre">Project</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Report"><code class="docutils literal notranslate"><span class="pre">Report</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.ReportPreference"><code class="docutils literal notranslate"><span class="pre">ReportPreference</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Submission"><code class="docutils literal notranslate"><span class="pre">Submission</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.User"><code class="docutils literal notranslate"><span class="pre">User</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Vulnerability"><code class="docutils literal notranslate"><span class="pre">Vulnerability</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.Whoami"><code class="docutils literal notranslate"><span class="pre">Whoami</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.mapper_drf_api"><code class="docutils literal notranslate"><span class="pre">mapper_drf_api()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="mapper.html#appknox.mapper.mapper_json_api"><code class="docutils literal notranslate"><span class="pre">mapper_json_api()</span></code></a></li>
</ul>
</li>
</ul>
</div>
<p>–</p>
<section id="indices-and-tables">
<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="#">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a>
</p>
<p class="blurb">Command-line interface and Python wrapper for Appknox</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=appknox&repo=appknox-python&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<p>
<a class="badge" href="https://travis-ci.org/appknox/appknox-python">
<img
alt="https://secure.travis-ci.org/appknox/appknox-python.svg?branch=master"
src="https://secure.travis-ci.org/appknox/appknox-python.svg?branch=master"
/>
</a>
</p>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">appknox.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapper.html">appknox.mapper</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="client.html" title="next chapter">appknox.client</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, XYSec Labs Pte. Ltd..
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>