-
Notifications
You must be signed in to change notification settings - Fork 4
/
documentation.html
161 lines (159 loc) · 8.4 KB
/
documentation.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
---
layout: default
title: Devknox - Documentation
permalink: /documentation/
---
<div class="static-header light-text clearfix documentation-section" style="min-height: 69px;">
<div class="docs-header" id="content">
<div class="container">
<h1>Documentation</h1>
</div>
</div>
<div class="banner">
<div class="container version-text">
Devknox v2.4.0 is here -
<strong>
<a href="#whats-new">See what's new</a>
</strong>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3 scrollspy-list" id="leftCol">
<ul class="nav nav-stacked" id="sidebar">
<li><a href="#introduction">Introduction</a></li>
<li><a href="#whats-new">What's New</a></li>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#install-devknox">Installing Devknox</a></li>
<li><a href="#update-devknox">Updating Devknox</a></li>
<li><a href="#use-devknox">Using Devknox</a></li>
<li><a href="#change-log">Changelog</a></li>
</ul>
</div>
<div class="col-md-9 docs-section" id="mainCol">
<div id="introduction" class="intro-section">
<h3>Introduction</h3>
Devknox is a developer friendly Android Studio plugin that helps Android developers detect and resolve security issues in their apps, while writing code.
Imagine Devknox to similar to what autocorrect is for English. As you write code, Devknox highlights possible security risks and also gives you a suggested solution which you can select and replace across your code.<br />
Yes, it is truly that simple! Let's build more secure apps!
</div>
<hr class="col-md-12">
<div id="whats-new">
<h3>What's New(v2.4.0)</h3>
<p>
The new roll-out of Devknox contains following improvements and features:
</p>
<ul class="circle">
<li>Finds unused permissions in the project</li>
<li>Addition of 4 more security checks alongwith previous 30 checks</li>
<li>Icons for various levels of security vulnerabilities</li>
<li>Minor improvements and bug fixes</li>
</ul>
</div>
<hr class="col-md-12">
<div id="prerequisites">
<h3>Minimum Requirements</h3>
If you want to run Devknox on your PC, here's what it takes:
<ul class="circle">
<li>Java : 1.7</li>
<li>Android Studio : 2.1.2</li>
</ul>
</div>
<hr class="col-md-12">
<div id="install-devknox">
<h3>Installing Devknox</h3>
<p>
To be able to use Devknox, you should specify the URLs of such Devknox repository in Android Studio. Follow the steps outlined below to add the URL:
</p>
<ul class="circle">
<li>Go to <b>File</b> menu and click <b>Settings</b></li>
<li>In the Settings dialog, click <b>Plugins</b></li>
<li>Click <b>Browse repositories</b></li>
<li>In the Browse Repositories dialog that opens, click <b>Manage repositories</b></li>
<li>Use the Custom Plugin Repositories dialog that opens, to manage the list of URLs
for custom (enterprise) plugin repositories:
<ul class="square">
<li>To add a repository URL, click <img src="/img/icon/add.png" alt="Appknox Devknox" /> (⌘N). In the Add Repository dialog, specify the repository URL and click OK.
(You can use the Check Now button to make sure that the specified URL is correct: IntelliJ IDEA will try to connect
to the repository)</li>
<div class="repo-url">
<pre><b>Repository URL</b> : http://repo.devknox.io</pre>
</div>
<li>To edit a repository URL, select the URL and click <img src="/img/icon/edit.png" alt="Appknox Devknox" /> (⏎). In the Edit Repository dialog, edit the URL and click OK.</li>
<li>To remove a URL from the list, select the URL and click <img src="/img/icon/delete.png" alt="Appknox Devknox" /> (⌘⌦)</li>
Click <b>OK</b> in the Custom Plugin Repositories dialog.
</ul>
</li>
<li>In the Browse repositories window search for <b>Devknox</b></li>
<li>In the right pane click on the green <b>Install</b> button</li>
<li>Restart the IDE to start using Devknox</li>
</ul>
<div class="image-wrapper">
<img src="/img/features/devknox-install.gif" alt="Devknox android application security tool" class="img-responsive image-pos" />
</div>
</div>
<hr class="col-md-12">
<div id="update-devknox">
<h3>Updating Devknox</h3>
Follow the steps if you want to update Devknox from settings or else Devknox can be updated from the notification everytime IDE starts up
<ul class="circle">
<li>Go to <b>File</b> menu and click <b>Settings</b></li>
<li>In the <b>Settings</b> dialog, click <b>Plugins</b></li>
<li>Choose Devknox from the list of plugins installed and click on <b>update</b> in the right pane</li>
<li>Restart the IDE to start using Devknox</li>
</ul>
<img src="/img/features/update-devknox1.png" alt="Devknox android application security tool" class="img-responsive image-pos" />
<img src="/img/features/update-devknox2.png" alt="Devknox android application security tool" class="img-responsive image-pos" />
</div>
<hr class="col-md-12">
<div id="use-devknox" class="usage-section">
<h3>Using Devknox</h3>
<p>
Once installed, you can use Devknox as follows:
</p>
<ul class="circle">
<li>On the menu bar click on <b>Devknox</b> and select <b>Login</b></li>
<li>On the login dialog box provide the credentials and click <b>Login</b></li>
<li>On successful login the plugin starts the scan in background and highlights the issues as red underlined annotation</li>
<li>To quickly jump to various Devknox issues, just point to right end of the editor and check out Devknox issues,
issues will be highlighted as various warning levels like yellow, red lines.
hovering over them will show the piece of code where the issues lie and clicking on them will take you to the corresponding line</li>
<li>On hovering over the issue, a tooltip pops up showing summary of issues and clicking on more shows detailed description of the issues</li>
<li>Click on the issue code and a (intention)bulb icon <img src="/img/icon/bulb.png" alt="Appknox Devknox" /> will appear, clicking on it will provide the option to quick fix</li>
</ul>
<ul class="circle">
<li>On the menu bar click on Devknox and select Devknox scan and choose scan scope(whole project, module, file, custom).
A report window pops up with Devknox issues. Expand as per choice to view particular issue details or expand the tree entirely using expand all icon <img src="/img/icon/expand-all.png" alt="Appknox Devknox" /></li>
<li>Select an issue to view details apply quick fix using problem resolution field</li>
<li>Select ad issue type and right click to get various options like suppress options and disabling inspection options</li>
<li>Use the export icon <img src="/img/icon/export.png" alt="Appknox Devknox" /> to export Devknox issues to XML or HTML</li>
<li>On the menu bar click on Devknox and select <b>About Devknox</b>, <b>Online Help</b> and <b>Feedback</b> to get an overview about Devknox, jump to online help and provide feedback to Devknox team respectively</li>
</ul>
<img src="/img/features/usage.gif" alt="Devknox android application security tool" class="devknox-image" />
</div>
<hr class="col-md-12">
<div id="change-log" class="change-log">
<h3>Change Log</h3>
<p>
Here you can see the updates previous versions:
</p>
<section>
<div class="ak-container">
{% for log in site.data.change_logs %}
<div class="dropdown-region">
<div class="dropdown-quest-area">
<i class="fa fa-caret-right dropdownArrow" aria-hidden="true"></i>
<b><span class="dropdown-quest">v{{log.version}}</span></b>
</div>
<div class="dropdown-answer">
{{log.description}}
</div>
</div>
{% endfor %}
</div>
</section>
</div>
</div>
</div>
</div>