owtf.api package

Subpackages

• owtf.api.handlers package
  • Submodules
  • owtf.api.handlers.auth module
    • owtf.api.handlers.auth
    • AccountActivationGenerateHandler
      • AccountActivationGenerateHandler.SUPPORTED_METHODS
      • AccountActivationGenerateHandler.post()
    • AccountActivationValidateHandler
      • AccountActivationValidateHandler.SUPPORTED_METHODS
      • AccountActivationValidateHandler.get()
    • LogInHandler
      • LogInHandler.SUPPORTED_METHODS
      • LogInHandler.post()
    • LogOutHandler
      • LogOutHandler.get()
    • OtpGenerateHandler
      • OtpGenerateHandler.SUPPORTED_METHODS
      • OtpGenerateHandler.post()
    • OtpVerifyHandler
      • OtpVerifyHandler.SUPPORTED_METHODS
      • OtpVerifyHandler.post()
    • PasswordChangeHandler
      • PasswordChangeHandler.SUPPORTED_METHODS
      • PasswordChangeHandler.post()
    • RegisterHandler
      • RegisterHandler.SUPPORTED_METHODS
      • RegisterHandler.post()
    • send_email_using_smtp()
  • owtf.api.handlers.base module
    • owtf.api.handlers.base
    • APIRequestHandler
      • APIRequestHandler.error()
      • APIRequestHandler.fail()
      • APIRequestHandler.get_auth_token()
      • APIRequestHandler.initialize()
      • APIRequestHandler.on_finish()
      • APIRequestHandler.success()
      • APIRequestHandler.write()
      • APIRequestHandler.write_error()
    • FileRedirectHandler
      • FileRedirectHandler.SUPPORTED_METHODS
      • FileRedirectHandler.get()
    • UIRequestHandler
      • UIRequestHandler.get_session_cookie()
      • UIRequestHandler.reverse_url()
      • UIRequestHandler.set_session_cookie()
      • UIRequestHandler.template_context
  • owtf.api.handlers.config module
    • owtf.api.handlers.config
    • ConfigurationHandler
      • ConfigurationHandler.SUPPORTED_METHODS
      • ConfigurationHandler.get()
      • ConfigurationHandler.patch()
  • owtf.api.handlers.health module
    • owtf.api.handlers.health
    • HealthCheckHandler
      • HealthCheckHandler.SUPPORTED_METHODS
      • HealthCheckHandler.get()
  • owtf.api.handlers.index module
    • owtf.api.handlers.index
    • IndexHandler
      • IndexHandler.SUPPORTED_METHODS
      • IndexHandler.get()
  • owtf.api.handlers.jwtauth module
    • jwtauth()
  • owtf.api.handlers.misc module
  • owtf.api.handlers.plugin module
  • owtf.api.handlers.report module
  • owtf.api.handlers.session module
    • owtf.api.handlers.session
    • OWTFSessionHandler
      • OWTFSessionHandler.SUPPORTED_METHODS
      • OWTFSessionHandler.delete()
      • OWTFSessionHandler.get()
      • OWTFSessionHandler.patch()
      • OWTFSessionHandler.post()
  • owtf.api.handlers.targets module
  • owtf.api.handlers.transactions module
  • owtf.api.handlers.work module
  • Module contents

Submodules

owtf.api.main module

owtf.api.reporter module

owtf.api.routes module

owtf.api.utils module

owtf.api.utils

class owtf.api.utils.VersionMatches(api_version)

Bases: Matcher

Matches path by version regex.

match(request)

Matches current instance against the request.

Parameters:

request (httputil.HTTPServerRequest) – current HTTP request

Returns:

a dict of parameters to be passed to the target handler (for example, handler_kwargs, path_args, path_kwargs can be passed for proper ~.web.RequestHandler instantiation). An empty dict is a valid (and common) return value to indicate a match when the argument-passing features are not used. None must be returned to indicate that there is no match.

Module contents