Command-line interface & Python wrapper for the Appknox API
Project description
appknox-python
Command-line interface & Python wrapper for the Appknox API.
Python API documentation is available here.
Installation
appknox-python is officially supported on python 3.5 & 3.6. pip is the recommended way to install appknox-python.
pip install appknox
Usage
$ appknox
Usage: appknox [OPTIONS] COMMAND [ARGS]...
Command line wrapper for the Appknox API
Options:
-v, --verbose Specify log verbosity.
--help Show this message and exit.
Commands:
analyses List analyses for file
files List files for project
login Log in and save session credentials
logout Delete session credentials
organizations List organizations
projects List projects
recent_uploads List recent file uploads by the user
report Download report for file
upload Upload and scan package
switch_organization Switch organization in CLI instance
vulnerability Get vulnerability
whoami Show session info
Authentication
Log in to appknox CLI using your secure.appknox.com credentials.
$ appknox login
Username: viren
Password:
Logged in to https://api.appknox.com
Using Environment Variables
Instead of login
we can use environment variables for authentication. This will be useful for scenarios such as CI/CD setup.
$ export APPKNOX_ACCESS_TOKEN=aaaabbbbbcccddeeeffgghhh
$ export APPKNOX_ORGANIZATION_ID=2
Supported variables are:
Environment variable | Value |
---|---|
APPKNOX_ACCESS_TOKEN |
Access token can be generated from Appknox dashboard (Settings → Developer Settings → Generate token). |
APPKNOX_HOST |
Defaults to https://api.appknox.com |
APPKNOX_ORGANIZATION_ID |
Your Appknox organization id |
Data fetch & actions
Available commands | Use |
---|---|
organizations |
List organizations of user |
projects |
List projects user has access to |
files <project_id> |
List files for a project |
analyses <file_id> |
List analyses for a file |
vulnerability <vulnerability_id> |
Get vulnerability detail |
owasp <owasp_id> |
Get OWASP detail |
upload <path_to_app_package> |
Upload app file from given path and get the file_id |
rescan <file_id> |
Rescan a file (this will create a new file under the same project.) |
Example:
$ appknox organizations
id name
---- -------
2 MyOrganization
$ appknox projects
id created_on file_count package_name platform updated_on
---- ------------------- ------------ ----------------------------- ---------- -------------------
3 2017-06-23 07:19:26 3 org.owasp.goatdroid.fourgoats 0 2017-06-23 07:26:55
4 2017-06-27 08:27:54 2 com.appknox.mfva 0 2017-06-27 08:30:04
$ appknox files 4
id name version version_code
---- ------ --------- --------------
6 MFVA 1 6
7 MFVA 1 6
Development
Update docs
Install sphinx-autobuild:
pip install sphinx-autobuild
Build docs:
sphinx-autobuild -p 9009 -b html sphinx-docs docs
License: MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
appknox-3.2.1.tar.gz
(12.5 kB
view hashes)
Built Distribution
Close
Hashes for appknox-3.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 699cc289214313fcd9faca88f6df1a616f5dc9f2d88d3c56af3250440f1c2aac |
|
MD5 | 5796b2d7f8077d20e3f605edaf071978 |
|
BLAKE2b-256 | 0ecefcb89d9c8e35cf0623ecbda3e76bb7ad5b236221b6c4a19b5fbc71e5261c |