Package plugins :: Package output :: Module htmlFile :: Class htmlFile

[frames] | no frames]

Class htmlFile

This plugin prints all messages to a HTML file.

Author: Juan Pablo Perez Etchegoyen ( jppereze@cybsec.com )

Instance Methods

[hide private]

__init__(self)

_init(self)

__del__(self)

debug(self, message, newLine=True)
This method is called from the output object.

information(self, message, newLine=True)
This method is called from the output object.

error(self, message, newLine=True)
This method is called from the output object.

vulnerability(self, message, newLine=True)
This method is called from the output object.

console(self, message, newLine=True)
This method is used by the w3af console to print messages to the outside.

_flush(self)
textfile.flush is called every time a message is sent to this plugin.

setOptions(self, OptionList)
Sets the Options given on the OptionList to self.

getOptionsXML(self)
This method returns a XML containing the Options that the plugin has.

logHttp(self, request, response)
log the http req / res to file.

end(self)
This method is called when the plugin aint going to be used anymore.

getLongDesc(self)

Inherited from core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin: getMessageCache, getPluginDeps, getType

Inherited from core.controllers.basePlugin.basePlugin.basePlugin: __eq__, getDesc, getName, printUniq, setUrlOpener

Inherited from core.controllers.basePlugin.basePlugin.basePlugin (private): _sendMutant

Method Details

[hide private]

init(self)
(Constructor)

None

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.__init__

_init(self)

None

del(self)
(Destructor)

None

debug(self, message, newLine=True)

This method is called from the output object. The output object was called from a plugin or from the framework. This method should take an action for debug messages.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.debug

information(self, message, newLine=True)

This method is called from the output object. The output object was called from a plugin or from the framework. This method should take an action for informational messages.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.information

error(self, message, newLine=True)

This method is called from the output object. The output object was called from a plugin or from the framework. This method should take an action for error messages.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.error

vulnerability(self, message, newLine=True)

This method is called from the output object. The output object was called from a plugin or from the framework. This method should take an action when a vulnerability is found.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.vulnerability

console(self, message, newLine=True)

This method is used by the w3af console to print messages to the outside.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.console

_flush(self)

textfile.flush is called every time a message is sent to this plugin. self._file.flush() is called every self._flushNumber

setOptions(self, OptionList)

Sets the Options given on the OptionList to self. The options are the result of a user entering some data on a window that was constructed using the XML Options that was retrieved from the plugin using getOptionsXML()

This method MUST be implemented on every plugin.

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.setOptions

getOptionsXML(self)

This method returns a XML containing the Options that the plugin has. Using this XML the framework will build a window, a menu, or some other input method to retrieve the info from the user. The XML has to validate against the xml schema file located at : w3af/core/display.xsd

This method MUST be implemented on every plugin.

Returns:: XML String

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.getOptionsXML

See Also: core/display.xsd

logHttp(self, request, response)

log the http req / res to file.

Parameters:

request - A fuzzable request object
response - A httpResponse object

Returns:: No value is returned.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.logHttp

end(self)

This method is called when the plugin aint going to be used anymore.

Overrides: core.controllers.basePlugin.baseOutputPlugin.baseOutputPlugin.end: (inherited documentation)

getLongDesc(self)

Returns:: A DETAILED description of the plugin functions and features.

Overrides: core.controllers.basePlugin.basePlugin.basePlugin.getLongDesc

Class htmlFile

__init__(self) (Constructor)

_init(self)

__del__(self) (Destructor)

debug(self, message, newLine=True)

information(self, message, newLine=True)

error(self, message, newLine=True)

vulnerability(self, message, newLine=True)

console(self, message, newLine=True)

_flush(self)

setOptions(self, OptionList)

getOptionsXML(self)

logHttp(self, request, response)

end(self)

getLongDesc(self)

init(self)
(Constructor)

del(self)
(Destructor)