[docs] class Appknox ( object ):
"""
+
Client to interact with API server
"""
def __init__ (
@@ -292,9 +293,7 @@
Source code for appknox.client
whoami = self . drf_api . me () . get ()
return mapper_drf_api ( Whoami , whoami )
-
[docs] def paginated_data ( self , response , mapper_class ):
-
"""
-
"""
+
def paginated_data ( self , response , mapper_class ):
initial_data = [
mapper_json_api ( mapper_class , dict ( data = value ))
for value in response [ "data" ]
@@ -313,11 +312,9 @@
Source code for appknox.client
for value in resp [ "data" ]
]
- return initial_data
+
return initial_data
-
[docs] def paginated_drf_data ( self , response , mapper_class ):
-
"""
-
"""
+
def paginated_drf_data ( self , response , mapper_class ):
initial_data = [
mapper_drf_api ( mapper_class , value ) for value in response [ "results" ]
]
@@ -331,7 +328,7 @@
Source code for appknox.client
initial_data += [
mapper_drf_api ( mapper_class , value ) for value in resp [ "results" ]
]
- return initial_data
+
return initial_data
[docs] def get_organizations ( self ) -> List [ Organization ]:
"""
@@ -404,10 +401,8 @@
Source code for appknox.client
analyses = self . drf_api [ "v2/files/ {} /analyses" . format ( file_id )]() . get ()
return self . paginated_drf_data ( analyses , Analysis )
-
[docs] @lru_cache ( maxsize = 1 )
+
@lru_cache ( maxsize = 1 )
def get_vulnerabilities ( self ) -> List [ Vulnerability ]:
-
"""
-
"""
total_vulnerabilities = self . drf_api [ "v2/vulnerabilities" ]() . get ( limit = 1 )[
"count"
] # limit is 1 just to get total count
@@ -415,7 +410,7 @@
Source code for appknox.client
limit = total_vulnerabilities + 1
)
vulnerabilities = self . paginated_drf_data ( vulnerabilities_raw , Vulnerability )
- return vulnerabilities
+
return vulnerabilities
[docs] def get_vulnerability ( self , vulnerability_id : int ) -> Vulnerability :
"""
@@ -433,13 +428,11 @@
Source code for appknox.client
vulnerability = self . drf_api [ "v2/vulnerabilities" ]( vulnerability_id ) . get ()
return mapper_drf_api ( Vulnerability , vulnerability )
-
[docs] @lru_cache ( maxsize = 1 )
+
@lru_cache ( maxsize = 1 )
def get_owasps ( self ) -> List [ OWASP ]:
-
"""
-
"""
owasps_raw = self . drf_api [ "v2/owasps" ]() . get ()
owasps = self . paginated_drf_data ( owasps_raw , OWASP )
-
return owasps
+
return owasps
[docs] def get_owasp ( self , owasp_id : str ) -> OWASP :
"""
@@ -455,13 +448,11 @@
Source code for appknox.client
owasp = self . drf_api [ "v2/owasps" ]( owasp_id ) . get ()
return mapper_drf_api ( OWASP , owasp )
-
[docs] @lru_cache ( maxsize = 1 )
+
@lru_cache ( maxsize = 1 )
def get_pcidsses ( self ) -> List [ PCIDSS ]:
-
"""
-
"""
pcidsss_raw = self . drf_api [ "v2/pcidsses" ]() . get ()
pcidsss = self . paginated_drf_data ( pcidsss_raw , PCIDSS )
-
return pcidsss
+
return pcidsss
[docs] def get_pcidss ( self , pcidss_id : str ) -> PCIDSS :
"""
@@ -670,9 +661,6 @@
Source code for appknox.client
headers : object = None ,
auth : Dict [ str , str ] = None ,
):
- """
- Initialise APIResource object
- """
self . host = host
self . headers = { ** headers }
self . headers [ "User-Agent" ] = f "appknox-python/ { __version__ } "
@@ -682,37 +670,27 @@ Source code for appknox.client
self . endpoint = urljoin ( host , API_BASE )
def __getitem__ ( self , resource ):
- """
- """
return partial ( self . set_endpoint , resource )
def __getattr__ ( self , resource ):
- """
- """
return partial ( self . set_endpoint , resource )
-[docs] def set_endpoint ( self , resource , resource_id = None ):
-
"""
-
"""
+
def set_endpoint ( self , resource , resource_id = None ):
self . endpoint = " {} / {} " . format ( urljoin ( self . host , API_BASE ), resource )
if resource_id :
self . endpoint += "/ {} " . format ( str ( resource_id ))
-
return self return self
-[docs] def get ( self , ** kwargs ):
-
"""
-
"""
+
def get ( self , ** kwargs ):
resp = self . request_session . get (
self . endpoint ,
headers = self . headers ,
auth = self . auth ,
params = kwargs ,
)
-
return resp . json () return resp . json ()
-[docs] def post ( self , data , content_type = None , ** kwargs ):
-
"""
-
"""
+
def post ( self , data , content_type = None , ** kwargs ):
resp = self . request_session . post (
self . endpoint ,
headers = self . headers ,
@@ -720,18 +698,16 @@
Source code for appknox.client
params = kwargs ,
data = data ,
)
- return resp . json ()
+
return resp . json ()
-
[docs] def direct_get ( self , url , ** kwargs ):
-
"""
-
"""
+
def direct_get ( self , url , ** kwargs ):
resp = self . request_session . get (
url ,
headers = self . headers ,
auth = self . auth ,
params = kwargs ,
)
-
return resp . json ()
+
return resp . json ()
[docs] def direct_get_http_response ( self , url : str , ** kwargs ) -> "Response" :
"""
diff --git a/docs/_modules/appknox/mapper.html b/docs/_modules/appknox/mapper.html
index 90dd90a..5eb72d7 100644
--- a/docs/_modules/appknox/mapper.html
+++ b/docs/_modules/appknox/mapper.html
@@ -1,29 +1,16 @@
-
+
-
+
-
-
+
+
appknox.mapper — appknox-python 3.0.0 documentation
-
-
-
-
-
-
-
-
+
+
+
+
+
@@ -32,8 +19,7 @@
-
-
+
@@ -48,23 +34,25 @@
Source code for appknox.mapper
from collections import namedtuple
from dataclasses import dataclass
+import datetime
+import typing
+
[docs] def mapper_json_api ( model : type , resource : dict ) -> object :
-
"""
+
"""
Returns an obj of type `model` from dictified JSON `resource` for JSON APIs
"""
attr = dict ()
for field in model . _fields :
-
if field == 'id' :
-
attr [ field ] = resource [ 'data' ][ 'id' ]
+
if field == "id" :
+
attr [ field ] = resource [ "data" ][ "id" ]
else :
-
attr [ field ] = resource [ 'data' ][ 'attributes' ][
-
field . replace ( '_' , '-' )]
+
attr [ field ] = resource [ "data" ][ "attributes" ][ field . replace ( "_" , "-" )]
return model ( ** attr ) [docs] def mapper_drf_api ( model : type , resource : dict ) -> object :
-
"""
+
"""
Returns an obj of type `model` from dictified JSON `resource` for DRF APIs
"""
accepted_params = { k : resource [ k ] for k in model . _fields }
@@ -72,73 +60,85 @@
Source code for appknox.mapper
User = namedtuple (
- 'User' ,
- [ 'id' , 'email' , 'first_name' , 'lang' , 'last_name' , 'username' ]
+ "User" , [ "id" , "email" , "first_name" , "lang" , "last_name" , "username" ]
)
-Whoami = namedtuple (
- 'Whoami' ,
- [ 'id' , 'email' , 'username' , 'default_organization' ]
-)
+Whoami = namedtuple ( "Whoami" , [ "id" , "email" , "username" , "default_organization" ])
-Organization = namedtuple (
- 'Organization' ,
- [ 'id' , 'name' ]
-)
+Organization = namedtuple ( "Organization" , [ "id" , "name" ])
Project = namedtuple (
- 'Project' ,
- [ 'id' , 'created_on' , 'file_count' , 'package_name' , 'platform' ,
- 'updated_on' ]
+ "Project" ,
+ [ "id" , "created_on" , "file_count" , "package_name" , "platform" , "updated_on" ],
)
File = namedtuple (
- 'File' ,
- [ 'id' , 'name' , 'version' , 'version_code' , 'static_scan_progress' , 'profile' ]
+ "File" , [ "id" , "name" , "version" , "version_code" , "static_scan_progress" , "profile" ]
)
Submission = namedtuple (
- 'Submission' ,
- [ 'id' , 'status' , 'file' , 'package_name' , 'created_on' , 'reason' ]
+ "Submission" , [ "id" , "status" , "file" , "package_name" , "created_on" , "reason" ]
)
Analysis = namedtuple (
- 'Analysis' ,
- [ 'id' , 'risk' , 'status' , 'cvss_base' , 'cvss_vector' , 'cvss_version' ,
- 'cvss_metrics_humanized' , 'findings' , 'updated_on' , 'vulnerability' ,
- 'owasp' , 'pcidss' , 'hipaa' , 'cwe' , 'mstg' , 'asvs' , 'gdpr' , 'computed_risk' , 'overridden_risk' ]
+ "Analysis" ,
+ [
+ "id" ,
+ "risk" ,
+ "status" ,
+ "cvss_base" ,
+ "cvss_vector" ,
+ "cvss_version" ,
+ "cvss_metrics_humanized" ,
+ "findings" ,
+ "updated_on" ,
+ "vulnerability" ,
+ "owasp" ,
+ "pcidss" ,
+ "hipaa" ,
+ "cwe" ,
+ "mstg" ,
+ "owaspapi2023" ,
+ "asvs" ,
+ "gdpr" ,
+ "computed_risk" ,
+ "overridden_risk" ,
+ ],
)
Vulnerability = namedtuple (
- 'Vulnerability' ,
- [ 'id' , 'name' , 'description' , 'intro' , 'related_to' ,
- 'business_implication' , 'compliant' , 'non_compliant' , 'types' ]
+ "Vulnerability" ,
+ [
+ "id" ,
+ "name" ,
+ "description" ,
+ "intro" ,
+ "related_to" ,
+ "business_implication" ,
+ "compliant" ,
+ "non_compliant" ,
+ "types" ,
+ ],
)
-OWASP = namedtuple (
- 'OWASP' ,
- [ 'id' , 'code' , 'title' , 'description' , 'year' ]
-)
+OWASP = namedtuple ( "OWASP" , [ "id" , "code" , "title" , "description" , "year" ])
-PCIDSS = namedtuple (
- 'PCIDSS' ,
- [ 'id' , 'code' , 'title' , 'description' ]
-)
+PCIDSS = namedtuple ( "PCIDSS" , [ "id" , "code" , "title" , "description" ])
-PersonalToken = namedtuple (
- 'AccessToken' ,
- [ 'name' , 'key' ]
-)
+PersonalToken = namedtuple ( "AccessToken" , [ "name" , "key" ])
ReportPreferenceMapper = {
- 'show_pcidss' : 'pcidss' ,
- 'show_hipaa' : 'hipaa' ,
- 'show_gdpr' : 'gdpr' }
+ "show_pcidss" : "pcidss" ,
+ "show_hipaa" : "hipaa" ,
+ "show_gdpr" : "gdpr" ,
+}
+
[docs] @dataclass
class ProfileReportPreferenceConfig :
value : bool [docs] @dataclass
class ProfileReportPreference :
show_gdpr : ProfileReportPreferenceConfig
@@ -148,9 +148,86 @@
Source code for appknox.mapper
@classmethod
def from_json ( cls , data ):
return cls (
- show_gdpr = ProfileReportPreferenceConfig ( value = data [ 'show_gdpr' ][ 'value' ]),
- show_hipaa = ProfileReportPreferenceConfig ( value = data [ 'show_hipaa' ][ 'value' ]),
- show_pcidss = ProfileReportPreferenceConfig ( value = data [ 'show_pcidss' ][ 'value' ])
+ show_gdpr = ProfileReportPreferenceConfig ( value = data [ "show_gdpr" ][ "value" ]),
+ show_hipaa = ProfileReportPreferenceConfig ( value = data [ "show_hipaa" ][ "value" ]),
+ show_pcidss = ProfileReportPreferenceConfig (
+ value = data [ "show_pcidss" ][ "value" ]
+ ),
+ )
+
+
+
[docs] @dataclass
+
class InheritedPreference :
+
_fields = [ "value" , "is_inherited" ]
+
+
value : bool
+
is_inherited : bool
+
+
@classmethod
+
def from_json ( cls , data : typing . Dict [ str , bool ]) -> "InheritedPreference" :
+
return cls ( value = data [ "value" ], is_inherited = data [ "is_inherited" ])
+
+
+
[docs] @dataclass
+
class ReportPreference :
+
_fields = [
+
"show_api_scan" ,
+
"show_manual_scan" ,
+
"show_static_scan" ,
+
"show_dynamic_scan" ,
+
"show_ignored_analyses" ,
+
"show_hipaa" ,
+
"show_pcidss" ,
+
]
+
+
show_api_scan : bool
+
show_manual_scan : bool
+
show_static_scan : bool
+
show_dynamic_scan : bool
+
show_ignored_analyses : bool
+
show_hipaa : InheritedPreference
+
show_pcidss : InheritedPreference
+
+
@classmethod
+
def from_json ( cls , data : typing . Dict [ str , typing . Any ]) -> "ReportPreference" :
+
return cls (
+
show_api_scan = data [ "show_api_scan" ],
+
show_manual_scan = data [ "show_manual_scan" ],
+
show_static_scan = data [ "show_static_scan" ],
+
show_dynamic_scan = data [ "show_dynamic_scan" ],
+
show_ignored_analyses = data [ "show_ignored_analyses" ],
+
show_hipaa = InheritedPreference . from_json ( data [ "show_hipaa" ]),
+
show_pcidss = InheritedPreference . from_json ( data [ "show_pcidss" ]),
+
)
+
+
+
[docs] @dataclass
+
class Report :
+
_fields = [
+
"id" ,
+
"language" ,
+
"generated_on" ,
+
"progress" ,
+
"rating" ,
+
"preferences" ,
+
]
+
+
id : int
+
language : str
+
generated_on : datetime . datetime
+
progress : int
+
rating : str
+
preferences : ReportPreference
+
+
@classmethod
+
def from_json ( cls , data : typing . Dict [ str , typing . Any ]) -> "Report" :
+
return cls (
+
id = data [ "id" ],
+
language = data [ "language" ],
+
generated_on = data [ "generated_on" ],
+
progress = data [ "progress" ],
+
rating = data [ "rating" ],
+
preferences = ReportPreference . from_json ( data [ "preferences" ]),
) Related Topics
-
Quick search
+
Quick search
+
-
+
@@ -236,8 +313,8 @@
Quick search
©2017, XYSec Labs Pte. Ltd..
|
- Powered by
Sphinx 1.6.2
- &
Alabaster 0.7.12
+ Powered by
Sphinx 6.1.3
+ &
Alabaster 0.7.13
D
P
(appknox.mapper.Submission attribute)
-
paginated_data() (appknox.client.Appknox method)
-
-
paginated_drf_data() (appknox.client.Appknox method)
-pcidss (appknox.mapper.Analysis attribute)
PCIDSS (class in appknox.mapper)
@@ -377,8 +365,6 @@ P
platform (appknox.mapper.Project attribute)
poll_for_file_from_submission_id() (appknox.client.Appknox method)
-
-
post() (appknox.client.ApiResource method)
profile (appknox.mapper.File attribute)
@@ -418,8 +404,6 @@
R
S