owtf.api.handlers package¶
Submodules¶
owtf.api.handlers.base module¶
owtf.api.handlers.base¶
-
class
owtf.api.handlers.base.
APIRequestHandler
(application, request, **kwargs)[source]¶ Bases:
tornado.web.RequestHandler
-
error
(message, data=None, code=None)[source]¶ An error occurred in processing the request, i.e. an exception was thrown.
Parameters: - data (A JSON-serializable object) – A generic container for any other information about the error, i.e. the conditions that caused the error, stack traces, etc.
- message (A JSON-serializable object) – A meaningful, end-user-readable (or at the least log-worthy) message, explaining what went wrong
- code (int) – A numeric code corresponding to the error, if applicable
-
fail
(data)[source]¶ There was a problem with the data submitted, or some pre-condition of the API call wasn’t satisfied.
Parameters: data (A JSON-serializable object) – Provides the wrapper for the details of why the request failed. If the reasons for failure correspond to POST values, the response object’s keys SHOULD correspond to those POST values.
-
success
(data)[source]¶ When an API call is successful, the JSend object is used as a simple envelope for the results, using the data key.
Parameters: data (A JSON-serializable object) – Acts as the wrapper for any data returned by the API call. If the call returns no data, data should be set to null.
-
owtf.api.handlers.config module¶
owtf.api.handlers.config¶
-
class
owtf.api.handlers.config.
ConfigurationHandler
(application, request, **kwargs)[source]¶ Bases:
owtf.api.handlers.base.APIRequestHandler
Update framework settings and tool paths.
-
SUPPORTED_METHODS
= ['GET', 'PATCH']¶
-
get
()[source]¶ Return all configuration items.
Example request:
GET /api/v1/configuration HTTP/1.1 Accept: application/json
Example response:
HTTP/1.1 200 OK Vary: Accept-Encoding [ { "dirty":false, "section":"AUX_PLUGIN_DATA", "value":"report", "descrip":"Filename for the attachment to be sent", "key":"ATTACHMENT_NAME" }, { "dirty":false, "section":"DICTIONARIES", "value":"hydra", "descrip":"", "key":"BRUTEFORCER" } ]
-
patch
()[source]¶ Update configuration item
Example request:
PATCH /api/v1/configuration/ HTTP/1.1 Accept: */* Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-Requested-With: XMLHttpRequest
Example response:
HTTP/1.1 200 OK Vary: Accept-Encoding Content-Length: 0 Content-Type: text/html; charset=UTF-8
-
owtf.api.handlers.health module¶
owtf.api.handlers.health¶
-
class
owtf.api.handlers.health.
HealthCheckHandler
(application, request, **kwargs)[source]¶ Bases:
owtf.api.handlers.base.APIRequestHandler
API server health check
-
SUPPORTED_METHODS
= ['GET']¶
-
owtf.api.handlers.index module¶
owtf.api.handlers.index¶
-
class
owtf.api.handlers.index.
IndexHandler
(application, request, **kwargs)[source]¶ Bases:
owtf.api.handlers.base.UIRequestHandler
Serves the main webapp
-
SUPPORTED_METHODS
= ['GET']¶
-
get
(path)[source]¶ Render the homepage with all JavaScript and context.
Example request:
GET / HTTP/1.1 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Example response:
HTTP/1.1 200 OK Content-Encoding: gzip Vary: Accept-Encoding Server: TornadoServer/5.0.1 Content-Type: text/html; charset=UTF-8
-