Python: module siteinfo

siteinfo | index /home/jim/Files/TekDefense/TekDefense-Automater-Private/siteinfo.py

`The siteinfo.py module provides site lookup and result
storage for those sites based on the sites.xml config
file and the arguments sent in to the Automater.
Class(es):
SiteFacade -- Class used to run the automation necessary to retrieve
site information and store results.
Site -- Parent Class used to store sites and information retrieved.
SingleResultsSite -- Class used to store information from a site that
only has one result requested and discovered.
MultiResultsSite -- Class used to store information from a site that
has multiple results requested and discovered.
PostTransactionPositiveCapableSite -- Class used to store information
from a site that has single or multiple results requested and discovered.
This Class is utilized to post information to web sites if a post is
required and requested via a --p argument utilized when the program is
called. This Class expects to find the first regular expression listed
in the sites.xml config file. If that regex is found, it tells the class
that a post is necessary.
PostTransactionAPIKeySite -- Class used to store information from a
site that has single or multiple results requested and discovered. This
Class is utilized if an API key is provided in the sites.xml
configuration file.
Function(s):
No global exportable functions are defined.
Exception(s):
No exceptions exported.`

Modules
`` |  |
re | time | urllib | urllib2

Classes
`` |  | __builtin__.object Site MultiResultsSite PostTransactionAPIKeySite PostTransactionPositiveCapableSite SingleResultsSite SiteFacade
class MultiResultsSite(Site)
`` | `MultiResultsSite inherits from the Site object and represents a site that is being used that has multiple results returned. Public Method(s): addResults getContentList Instance variable(s): _site _results`
| Method resolution order: MultiResultsSite Site __builtin__.object Methods defined here: __init__(self, site) `Class constructor. Assigns a site from the parameter into the _site instance variable. This is a play on the decorator pattern. Argument(s): site -- the site that we will decorate. Return value(s): Nothing is returned from this Method.` addResults(self, results, index) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. index -- integer value representing the index of the result found. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getContentList(self, webcontent, index) `Retrieves a list of information retrieved from the sites defined in the sites.xml configuration file. Returns the list of found information from the sites being used as resources or returns None if the site cannot be discovered. Argument(s): webcontent -- actual content of the web page that's been returned from a request. index -- the integer representing the index of the regex list. Return value(s): list -- information found from a web site being used as a resource. Restriction(s): The Method has no restrictions.` Methods inherited from Site: getFullURL(self) `Returns the FullURL property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getImportantProperty(self, index) `Gets the property information from the property value listed in the sites.xml file for that specific site in the importantproperty xml tag. This Method allows for the property that will be printed to be changed using the configuration file. Returns the return value listed in the property attribute discovered. Argument(s): index -- integer representing which important property is retrieved if more than one important property value is listed in the config file. Return value(s): Multiple options -- returns the return value of the property listed in the config file. Most likely a string or a list. Restriction(s): The Method has no restrictions.` getResults(self) `Returns the Results property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getTarget(self) `Returns the Target property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getWebScrape(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Requests via proxy if --proxy option was chosen during execution of the Automater. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` postMessage(self, message) `Prints multiple messages to inform the user of progress. Assignes the _messagetopost instance variable to the message. Uses the MessageToPost property. Argument(s): message -- string to be utilized as a message to post. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Class methods inherited from Site: buildDictionaryFromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a dictionary from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a dictionary of those entries if entry XML tags are found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. Dictionary representing all entry keys found within the elementstring. Restriction(s): This Method is tagged as a Class Method` buildSiteFromXML(self, siteelement, webretrievedelay, proxy, targettype, target, useragent) from __builtin__.type `Utilizes the Class Methods within this Class to build the Site object. Returns a Site object that defines results returned during the web retrieval investigations. Argument(s): siteelement -- the siteelement object that will be used as the start element. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- sets a proxy to use in the form of proxy.example.com:8080. targettype -- the targettype as defined. Either ip, md5, or hostname. target -- the target that will be used to gather information on. useragent -- the string utilized to represent the user-agent when web requests or submissions are made. Return value(s): Site object. Restriction(s): This Method is tagged as a Class Method` buildStringOrListfromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a string or list from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a list of those entries if entry XML tags are found or a string of that entry if only one entry XML tag is found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. List representing all entry keys found within the elementstring. string representing an entry key if only one is found within the elementstring. Restriction(s): This Method is tagged as a Class Method` Data descriptors inherited from Site: APIKey `Determines if an APIKey was set for this specific site. Returns the string representing the APIKey using the _apikey instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the APIKey from the _apikey instance variable. Restriction(s): This Method is tagged as a Property.` ErrorMessage `Returns the string representing the Error Message. Argument(s): No arguments are required. Return value(s): string -- representing the error message to print to the standard output. Restriction(s): This Method is tagged as a Property.` FriendlyName `Returns the string representing a friendly string name. Argument(s): No arguments are required. Return value(s): string -- representing friendly name for a tag for reporting. Restriction(s): This Method is tagged as a Property.` FullURL `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` Headers `Determines if Headers were set for this specific site. Returns the string representing the Headers using the _headers instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Headers from the _headers instance variable. Restriction(s): This Method is tagged as a Property.` ImportantPropertyString `Returns the string representing the Important Property that the user wants the site to report. This is set using the sites.xml config file in the importantproperty XML tag. Argument(s): No arguments are required. Return value(s): string -- representing the important property of the site that needs to be reported. Restriction(s): This Method is tagged as a Property.` MessageToPost `Returns the string representing a message to the user. Argument(s): No arguments are required. Return value(s): string -- representing a message to print to the standard output. Restriction(s): This Method is tagged as a Property.` Params `Determines if web Parameters were set for this specific site. Returns the string representing the Parameters using the _params instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Parameters from the _params instance variable. Restriction(s): This Method is tagged as a Property.` Proxy `Returns the string representation of the proxy used. Argument(s): No arguments are required. Return value(s): string -- representation of the proxy used Restriction(s): This Method is tagged as a Property.` RegEx `Returns the string representing a regular expression required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing a regex used to find info on the site. Restriction(s): This Method is tagged as a Property.` ReportStringForResult `Returns the string representing a report string tag that precedes reporting information so the user knows what specifics are being found. Argument(s): No arguments are required. Return value(s): string -- representing a tag for reporting information. Restriction(s): This Method is tagged as a Property.` Results `Checks the instance variable _results is empty or None. Returns _results (the results list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- list of results discovered from the site being investigated. None -- if _results is empty or None. Restriction(s): This Method is tagged as a Property.` Target `Returns string representing the target being investigated. The string may be an IP Address, MD5 hash, or hostname. Argument(s): No arguments are required. Return value(s): string -- representation of the Target from the _target instance variable. Restriction(s): This Method is tagged as a Property.` TargetType `Returns the target type information whether that be ip, md5, or hostname. Argument(s): No arguments are required. Return value(s): string -- defined as ip, md5, or hostname. Restriction(s): This Method is tagged as a Property.` URL `Returns the string representing the Domain URL which is required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the URL of the site. Restriction(s): This Method is tagged as a Property.` UserAgent `Returns string representing the user-agent that will be used when requesting or submitting information to a web site. This is a user-provided string implemented on the command line at execution or provided by default if not added during execution. Argument(s): No arguments are required. Return value(s): string -- representation of the UserAgent from the _userAgent instance variable. Restriction(s): This Method is tagged as a Property.` UserMessage `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` WebRetrieveDelay `Returns the string representation of the number of seconds that will be delayed between site retrievals. Argument(s): No arguments are required. Return value(s): string -- representation of an integer that is the delay in seconds that will be used between each web site retrieval. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class PostTransactionAPIKeySite(Site)
`` | `PostTransactionAPIKeySite inherits from the Site object and represents a site that needs an API Key for discovering information. Public Method(s): addMultiResults getContentList submitPost Instance variable(s): _site`
| Method resolution order: PostTransactionAPIKeySite Site __builtin__.object Methods defined here: __init__(self, site) `Class constructor. Assigns a site from the parameter into the _site instance variable. This is a play on the decorator pattern. Argument(s): site -- the site that we will decorate. Return value(s): Nothing is returned from this Method.` addMultiResults(self, results, index) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. index -- integer value representing the index of the result found. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getContentList(self, content, index=-1) `Retrieves a list of information retrieved from the sites defined in the sites.xml configuration file. Returns the list of found information from the sites being used as resources or returns None if the site cannot be discovered. Argument(s): content -- string representation of the web site being used as a resource. index -- the integer representing the index of the regex list. Return value(s): list -- information found from a web site being used as a resource. Restriction(s): The Method has no restrictions.` submitPost(self, raw_params, headers) `Submits information to a web site being used as a resource that requires a post of information. Submits via proxy if --proxy option was chosen during execution of the Automater. Returns a string that contains entire web site being used as a resource including HTML markup information. Argument(s): raw_params -- string info detailing parameters provided from sites.xml configuration file in the params XML tag. headers -- string info detailing headers provided from sites.xml configuration file in the headers XML tag. Return value(s): string -- contains entire web site being used as a resource including HTML markup information. Restriction(s): The Method has no restrictions.` Methods inherited from Site: addResults(self, results) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getFullURL(self) `Returns the FullURL property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getImportantProperty(self, index) `Gets the property information from the property value listed in the sites.xml file for that specific site in the importantproperty xml tag. This Method allows for the property that will be printed to be changed using the configuration file. Returns the return value listed in the property attribute discovered. Argument(s): index -- integer representing which important property is retrieved if more than one important property value is listed in the config file. Return value(s): Multiple options -- returns the return value of the property listed in the config file. Most likely a string or a list. Restriction(s): The Method has no restrictions.` getResults(self) `Returns the Results property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getTarget(self) `Returns the Target property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getWebScrape(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Requests via proxy if --proxy option was chosen during execution of the Automater. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` postMessage(self, message) `Prints multiple messages to inform the user of progress. Assignes the _messagetopost instance variable to the message. Uses the MessageToPost property. Argument(s): message -- string to be utilized as a message to post. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Class methods inherited from Site: buildDictionaryFromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a dictionary from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a dictionary of those entries if entry XML tags are found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. Dictionary representing all entry keys found within the elementstring. Restriction(s): This Method is tagged as a Class Method` buildSiteFromXML(self, siteelement, webretrievedelay, proxy, targettype, target, useragent) from __builtin__.type `Utilizes the Class Methods within this Class to build the Site object. Returns a Site object that defines results returned during the web retrieval investigations. Argument(s): siteelement -- the siteelement object that will be used as the start element. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- sets a proxy to use in the form of proxy.example.com:8080. targettype -- the targettype as defined. Either ip, md5, or hostname. target -- the target that will be used to gather information on. useragent -- the string utilized to represent the user-agent when web requests or submissions are made. Return value(s): Site object. Restriction(s): This Method is tagged as a Class Method` buildStringOrListfromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a string or list from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a list of those entries if entry XML tags are found or a string of that entry if only one entry XML tag is found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. List representing all entry keys found within the elementstring. string representing an entry key if only one is found within the elementstring. Restriction(s): This Method is tagged as a Class Method` Data descriptors inherited from Site: APIKey `Determines if an APIKey was set for this specific site. Returns the string representing the APIKey using the _apikey instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the APIKey from the _apikey instance variable. Restriction(s): This Method is tagged as a Property.` ErrorMessage `Returns the string representing the Error Message. Argument(s): No arguments are required. Return value(s): string -- representing the error message to print to the standard output. Restriction(s): This Method is tagged as a Property.` FriendlyName `Returns the string representing a friendly string name. Argument(s): No arguments are required. Return value(s): string -- representing friendly name for a tag for reporting. Restriction(s): This Method is tagged as a Property.` FullURL `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` Headers `Determines if Headers were set for this specific site. Returns the string representing the Headers using the _headers instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Headers from the _headers instance variable. Restriction(s): This Method is tagged as a Property.` ImportantPropertyString `Returns the string representing the Important Property that the user wants the site to report. This is set using the sites.xml config file in the importantproperty XML tag. Argument(s): No arguments are required. Return value(s): string -- representing the important property of the site that needs to be reported. Restriction(s): This Method is tagged as a Property.` MessageToPost `Returns the string representing a message to the user. Argument(s): No arguments are required. Return value(s): string -- representing a message to print to the standard output. Restriction(s): This Method is tagged as a Property.` Params `Determines if web Parameters were set for this specific site. Returns the string representing the Parameters using the _params instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Parameters from the _params instance variable. Restriction(s): This Method is tagged as a Property.` Proxy `Returns the string representation of the proxy used. Argument(s): No arguments are required. Return value(s): string -- representation of the proxy used Restriction(s): This Method is tagged as a Property.` RegEx `Returns the string representing a regular expression required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing a regex used to find info on the site. Restriction(s): This Method is tagged as a Property.` ReportStringForResult `Returns the string representing a report string tag that precedes reporting information so the user knows what specifics are being found. Argument(s): No arguments are required. Return value(s): string -- representing a tag for reporting information. Restriction(s): This Method is tagged as a Property.` Results `Checks the instance variable _results is empty or None. Returns _results (the results list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- list of results discovered from the site being investigated. None -- if _results is empty or None. Restriction(s): This Method is tagged as a Property.` Target `Returns string representing the target being investigated. The string may be an IP Address, MD5 hash, or hostname. Argument(s): No arguments are required. Return value(s): string -- representation of the Target from the _target instance variable. Restriction(s): This Method is tagged as a Property.` TargetType `Returns the target type information whether that be ip, md5, or hostname. Argument(s): No arguments are required. Return value(s): string -- defined as ip, md5, or hostname. Restriction(s): This Method is tagged as a Property.` URL `Returns the string representing the Domain URL which is required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the URL of the site. Restriction(s): This Method is tagged as a Property.` UserAgent `Returns string representing the user-agent that will be used when requesting or submitting information to a web site. This is a user-provided string implemented on the command line at execution or provided by default if not added during execution. Argument(s): No arguments are required. Return value(s): string -- representation of the UserAgent from the _userAgent instance variable. Restriction(s): This Method is tagged as a Property.` UserMessage `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` WebRetrieveDelay `Returns the string representation of the number of seconds that will be delayed between site retrievals. Argument(s): No arguments are required. Return value(s): string -- representation of an integer that is the delay in seconds that will be used between each web site retrieval. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class PostTransactionPositiveCapableSite(Site)
`` | `PostTransactionPositiveCapableSite inherits from the Site object and represents a site that may need to post information. Public Method(s): addMultiResults getContentList getContent postIsNecessary submitPost Instance variable(s): _site _postByDefault`
| Method resolution order: PostTransactionPositiveCapableSite Site __builtin__.object Methods defined here: __init__(self, site, postbydefault) `Class constructor. Assigns a site from the parameter into the _site instance variable. This is a play on the decorator pattern. Also assigns the postbydefault parameter to the _postByDefault instance variable to determine if the Automater should post information to a site. By default Automater will NOT post information. Argument(s): site -- the site that we will decorate. postbydefault -- a Boolean representing whether a post will occur. Return value(s): Nothing is returned from this Method.` addMultiResults(self, results, index) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. index -- integer value representing the index of the result found. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getContent(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getContentList(self, content, index=-1) `Retrieves a list of information retrieved from the sites defined in the sites.xml configuration file. Returns the list of found information from the sites being used as resources or returns None if the site cannot be discovered. Argument(s): content -- string representation of the web site being used as a resource. index -- the integer representing the index of the regex list. Return value(s): list -- information found from a web site being used as a resource. Restriction(s): The Method has no restrictions.` postIsNecessary(self, regex, content) `Checks to determine if the user wants the Automater to post information if the site takes a post. The user does this through the argument switch --p. By default this is False. If the regex given is found on the site, and a post is requested, a post will be attempted. Returns True if --p is used and a regex is found on the site, else return False. Argument(s): regex -- string regex that will be searched for on the web site used as a resource. content -- string that contains entire web site being used as a resource including HTML markup information. Return value(s): Boolean. Restriction(s): The Method has no restrictions.` submitPost(self, raw_params, headers) `Submits information to a web site being used as a resource that requires a post of information. Submits via proxy if --proxy option was chosen during execution of the Automater. Returns a string that contains entire web site being used as a resource including HTML markup information. Argument(s): raw_params -- string info detailing parameters provided from sites.xml configuration file in the params XML tag. headers -- string info detailing headers provided from sites.xml configuration file in the headers XML tag. Return value(s): string -- contains entire web site being used as a resource including HTML markup information. Restriction(s): The Method has no restrictions.` Methods inherited from Site: addResults(self, results) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getFullURL(self) `Returns the FullURL property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getImportantProperty(self, index) `Gets the property information from the property value listed in the sites.xml file for that specific site in the importantproperty xml tag. This Method allows for the property that will be printed to be changed using the configuration file. Returns the return value listed in the property attribute discovered. Argument(s): index -- integer representing which important property is retrieved if more than one important property value is listed in the config file. Return value(s): Multiple options -- returns the return value of the property listed in the config file. Most likely a string or a list. Restriction(s): The Method has no restrictions.` getResults(self) `Returns the Results property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getTarget(self) `Returns the Target property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getWebScrape(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Requests via proxy if --proxy option was chosen during execution of the Automater. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` postMessage(self, message) `Prints multiple messages to inform the user of progress. Assignes the _messagetopost instance variable to the message. Uses the MessageToPost property. Argument(s): message -- string to be utilized as a message to post. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Class methods inherited from Site: buildDictionaryFromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a dictionary from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a dictionary of those entries if entry XML tags are found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. Dictionary representing all entry keys found within the elementstring. Restriction(s): This Method is tagged as a Class Method` buildSiteFromXML(self, siteelement, webretrievedelay, proxy, targettype, target, useragent) from __builtin__.type `Utilizes the Class Methods within this Class to build the Site object. Returns a Site object that defines results returned during the web retrieval investigations. Argument(s): siteelement -- the siteelement object that will be used as the start element. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- sets a proxy to use in the form of proxy.example.com:8080. targettype -- the targettype as defined. Either ip, md5, or hostname. target -- the target that will be used to gather information on. useragent -- the string utilized to represent the user-agent when web requests or submissions are made. Return value(s): Site object. Restriction(s): This Method is tagged as a Class Method` buildStringOrListfromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a string or list from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a list of those entries if entry XML tags are found or a string of that entry if only one entry XML tag is found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. List representing all entry keys found within the elementstring. string representing an entry key if only one is found within the elementstring. Restriction(s): This Method is tagged as a Class Method` Data descriptors inherited from Site: APIKey `Determines if an APIKey was set for this specific site. Returns the string representing the APIKey using the _apikey instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the APIKey from the _apikey instance variable. Restriction(s): This Method is tagged as a Property.` ErrorMessage `Returns the string representing the Error Message. Argument(s): No arguments are required. Return value(s): string -- representing the error message to print to the standard output. Restriction(s): This Method is tagged as a Property.` FriendlyName `Returns the string representing a friendly string name. Argument(s): No arguments are required. Return value(s): string -- representing friendly name for a tag for reporting. Restriction(s): This Method is tagged as a Property.` FullURL `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` Headers `Determines if Headers were set for this specific site. Returns the string representing the Headers using the _headers instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Headers from the _headers instance variable. Restriction(s): This Method is tagged as a Property.` ImportantPropertyString `Returns the string representing the Important Property that the user wants the site to report. This is set using the sites.xml config file in the importantproperty XML tag. Argument(s): No arguments are required. Return value(s): string -- representing the important property of the site that needs to be reported. Restriction(s): This Method is tagged as a Property.` MessageToPost `Returns the string representing a message to the user. Argument(s): No arguments are required. Return value(s): string -- representing a message to print to the standard output. Restriction(s): This Method is tagged as a Property.` Params `Determines if web Parameters were set for this specific site. Returns the string representing the Parameters using the _params instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Parameters from the _params instance variable. Restriction(s): This Method is tagged as a Property.` Proxy `Returns the string representation of the proxy used. Argument(s): No arguments are required. Return value(s): string -- representation of the proxy used Restriction(s): This Method is tagged as a Property.` RegEx `Returns the string representing a regular expression required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing a regex used to find info on the site. Restriction(s): This Method is tagged as a Property.` ReportStringForResult `Returns the string representing a report string tag that precedes reporting information so the user knows what specifics are being found. Argument(s): No arguments are required. Return value(s): string -- representing a tag for reporting information. Restriction(s): This Method is tagged as a Property.` Results `Checks the instance variable _results is empty or None. Returns _results (the results list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- list of results discovered from the site being investigated. None -- if _results is empty or None. Restriction(s): This Method is tagged as a Property.` Target `Returns string representing the target being investigated. The string may be an IP Address, MD5 hash, or hostname. Argument(s): No arguments are required. Return value(s): string -- representation of the Target from the _target instance variable. Restriction(s): This Method is tagged as a Property.` TargetType `Returns the target type information whether that be ip, md5, or hostname. Argument(s): No arguments are required. Return value(s): string -- defined as ip, md5, or hostname. Restriction(s): This Method is tagged as a Property.` URL `Returns the string representing the Domain URL which is required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the URL of the site. Restriction(s): This Method is tagged as a Property.` UserAgent `Returns string representing the user-agent that will be used when requesting or submitting information to a web site. This is a user-provided string implemented on the command line at execution or provided by default if not added during execution. Argument(s): No arguments are required. Return value(s): string -- representation of the UserAgent from the _userAgent instance variable. Restriction(s): This Method is tagged as a Property.` UserMessage `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` WebRetrieveDelay `Returns the string representation of the number of seconds that will be delayed between site retrievals. Argument(s): No arguments are required. Return value(s): string -- representation of an integer that is the delay in seconds that will be used between each web site retrieval. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class SingleResultsSite(Site)
`` | `SingleResultsSite inherits from the Site object and represents a site that is being used that has a single result returned. Public Method(s): getContentList Instance variable(s): _site`
| Method resolution order: SingleResultsSite Site __builtin__.object Methods defined here: __init__(self, site) `Class constructor. Assigns a site from the parameter into the _site instance variable. This is a play on the decorator pattern. Argument(s): site -- the site that we will decorate. Return value(s): Nothing is returned from this Method.` getContentList(self, webcontent) `Retrieves a list of information retrieved from the sites defined in the sites.xml configuration file. Returns the list of found information from the sites being used as resources or returns None if the site cannot be discovered. Argument(s): webcontent -- actual content of the web page that's been returned from a request. Return value(s): list -- information found from a web site being used as a resource. Restriction(s): The Method has no restrictions.` Methods inherited from Site: addResults(self, results) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getFullURL(self) `Returns the FullURL property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getImportantProperty(self, index) `Gets the property information from the property value listed in the sites.xml file for that specific site in the importantproperty xml tag. This Method allows for the property that will be printed to be changed using the configuration file. Returns the return value listed in the property attribute discovered. Argument(s): index -- integer representing which important property is retrieved if more than one important property value is listed in the config file. Return value(s): Multiple options -- returns the return value of the property listed in the config file. Most likely a string or a list. Restriction(s): The Method has no restrictions.` getResults(self) `Returns the Results property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getTarget(self) `Returns the Target property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getWebScrape(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Requests via proxy if --proxy option was chosen during execution of the Automater. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` postMessage(self, message) `Prints multiple messages to inform the user of progress. Assignes the _messagetopost instance variable to the message. Uses the MessageToPost property. Argument(s): message -- string to be utilized as a message to post. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Class methods inherited from Site: buildDictionaryFromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a dictionary from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a dictionary of those entries if entry XML tags are found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. Dictionary representing all entry keys found within the elementstring. Restriction(s): This Method is tagged as a Class Method` buildSiteFromXML(self, siteelement, webretrievedelay, proxy, targettype, target, useragent) from __builtin__.type `Utilizes the Class Methods within this Class to build the Site object. Returns a Site object that defines results returned during the web retrieval investigations. Argument(s): siteelement -- the siteelement object that will be used as the start element. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- sets a proxy to use in the form of proxy.example.com:8080. targettype -- the targettype as defined. Either ip, md5, or hostname. target -- the target that will be used to gather information on. useragent -- the string utilized to represent the user-agent when web requests or submissions are made. Return value(s): Site object. Restriction(s): This Method is tagged as a Class Method` buildStringOrListfromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a string or list from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a list of those entries if entry XML tags are found or a string of that entry if only one entry XML tag is found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. List representing all entry keys found within the elementstring. string representing an entry key if only one is found within the elementstring. Restriction(s): This Method is tagged as a Class Method` Data descriptors inherited from Site: APIKey `Determines if an APIKey was set for this specific site. Returns the string representing the APIKey using the _apikey instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the APIKey from the _apikey instance variable. Restriction(s): This Method is tagged as a Property.` ErrorMessage `Returns the string representing the Error Message. Argument(s): No arguments are required. Return value(s): string -- representing the error message to print to the standard output. Restriction(s): This Method is tagged as a Property.` FriendlyName `Returns the string representing a friendly string name. Argument(s): No arguments are required. Return value(s): string -- representing friendly name for a tag for reporting. Restriction(s): This Method is tagged as a Property.` FullURL `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` Headers `Determines if Headers were set for this specific site. Returns the string representing the Headers using the _headers instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Headers from the _headers instance variable. Restriction(s): This Method is tagged as a Property.` ImportantPropertyString `Returns the string representing the Important Property that the user wants the site to report. This is set using the sites.xml config file in the importantproperty XML tag. Argument(s): No arguments are required. Return value(s): string -- representing the important property of the site that needs to be reported. Restriction(s): This Method is tagged as a Property.` MessageToPost `Returns the string representing a message to the user. Argument(s): No arguments are required. Return value(s): string -- representing a message to print to the standard output. Restriction(s): This Method is tagged as a Property.` Params `Determines if web Parameters were set for this specific site. Returns the string representing the Parameters using the _params instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Parameters from the _params instance variable. Restriction(s): This Method is tagged as a Property.` Proxy `Returns the string representation of the proxy used. Argument(s): No arguments are required. Return value(s): string -- representation of the proxy used Restriction(s): This Method is tagged as a Property.` RegEx `Returns the string representing a regular expression required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing a regex used to find info on the site. Restriction(s): This Method is tagged as a Property.` ReportStringForResult `Returns the string representing a report string tag that precedes reporting information so the user knows what specifics are being found. Argument(s): No arguments are required. Return value(s): string -- representing a tag for reporting information. Restriction(s): This Method is tagged as a Property.` Results `Checks the instance variable _results is empty or None. Returns _results (the results list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- list of results discovered from the site being investigated. None -- if _results is empty or None. Restriction(s): This Method is tagged as a Property.` Target `Returns string representing the target being investigated. The string may be an IP Address, MD5 hash, or hostname. Argument(s): No arguments are required. Return value(s): string -- representation of the Target from the _target instance variable. Restriction(s): This Method is tagged as a Property.` TargetType `Returns the target type information whether that be ip, md5, or hostname. Argument(s): No arguments are required. Return value(s): string -- defined as ip, md5, or hostname. Restriction(s): This Method is tagged as a Property.` URL `Returns the string representing the Domain URL which is required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the URL of the site. Restriction(s): This Method is tagged as a Property.` UserAgent `Returns string representing the user-agent that will be used when requesting or submitting information to a web site. This is a user-provided string implemented on the command line at execution or provided by default if not added during execution. Argument(s): No arguments are required. Return value(s): string -- representation of the UserAgent from the _userAgent instance variable. Restriction(s): This Method is tagged as a Property.` UserMessage `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` WebRetrieveDelay `Returns the string representation of the number of seconds that will be delayed between site retrievals. Argument(s): No arguments are required. Return value(s): string -- representation of an integer that is the delay in seconds that will be used between each web site retrieval. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class Site(__builtin__.object)
`` | `Site is the parent object that represents each site used for retrieving information. Site stores the results discovered from each web site discovered when running Automater. Site is the parent object to SingleResultsSite, MultiResultsSite, PostTransactionPositiveCapableSite, and PostTransactionAPIKeySite. Public Method(s): (Class Method) buildSiteFromXML (Class Method) buildStringOrListfromXML (Class Method) buildDictionaryFromXML (Property) WebRetrieveDelay (Property) TargetType (Property) ReportStringForResult (Property) FriendlyName (Property) RegEx (Property) URL (Property) MessageToPost (Property) ErrorMessage (Property) UserMessage (Property) FullURL (Setter) FullURL (Property) ImportantPropertyString (Property) Params (Setter) Params (Property) Headers (Property) APIKey (Property) Target (Property) UserAgent (Property) Results addResults postMessage getImportantProperty getTarget getResults getFullURL getWebScrape Instance variable(s): _sites _sourceurl _webretrievedelay _targetType _reportstringforresult _errormessage _usermessage _target _userAgent _friendlyName _regex _fullURL _importantProperty _params _headers _apikey _results _messagetopost`
| Methods defined here: __init__(self, domainurl, webretrievedelay, proxy, targettype, reportstringforresult, target, useragent, friendlyname, regex, fullurl, importantproperty, params, headers, apikey) `Class constructor. Sets the instance variables based on input from the arguments supplied when Automater is run and what the sites.xml config file stores. Argument(s): domainurl -- string defined in sites.xml in the domainurl XML tag. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- will set a proxy to use (eg. proxy.example.com:8080). targettype -- the targettype as defined. Either ip, md5, or hostname. reportstringforresult -- string or list of strings that are entered in the entry XML tag within the reportstringforresult XML tag in the sites.xml configuration file. target -- the target that will be used to gather information on. useragent -- the user-agent string that will be utilized when submitting information to or requesting information from a website friendlyname -- string or list of strings that are entered in the entry XML tag within the sitefriendlyname XML tag in the sites.xml configuration file. regex -- the regexs defined in the entry XML tag within the regex XML tag in the sites.xml configuration file. fullurl -- string representation of fullurl pulled from the sites.xml file in the fullurl XML tag. importantproperty -- string defined in the the sites.xml config file in the importantproperty XML tag. params -- string or list provided in the entry XML tags within the params XML tag in the sites.xml configuration file. headers -- string or list provided in the entry XML tags within the headers XML tag in the sites.xml configuration file. apikey -- string or list of strings found in the entry XML tags within the apikey XML tag in the sites.xml configuration file. Return value(s): Nothing is returned from this Method.` addResults(self, results) `Assigns the argument to the _results instance variable to build the list or results retrieved from the site. Assign None to the _results instance variable if the argument is empty. Argument(s): results -- list of results retrieved from the site. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` getFullURL(self) `Returns the FullURL property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getImportantProperty(self, index) `Gets the property information from the property value listed in the sites.xml file for that specific site in the importantproperty xml tag. This Method allows for the property that will be printed to be changed using the configuration file. Returns the return value listed in the property attribute discovered. Argument(s): index -- integer representing which important property is retrieved if more than one important property value is listed in the config file. Return value(s): Multiple options -- returns the return value of the property listed in the config file. Most likely a string or a list. Restriction(s): The Method has no restrictions.` getResults(self) `Returns the Results property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getTarget(self) `Returns the Target property information. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` getWebScrape(self) `Attempts to retrieve a string from a web site. String retrieved is the entire web site including HTML markup. Requests via proxy if --proxy option was chosen during execution of the Automater. Returns the string representing the entire web site including the HTML markup retrieved from the site. Argument(s): No arguments are required. Return value(s): string. Restriction(s): The Method has no restrictions.` postMessage(self, message) `Prints multiple messages to inform the user of progress. Assignes the _messagetopost instance variable to the message. Uses the MessageToPost property. Argument(s): message -- string to be utilized as a message to post. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Class methods defined here: buildDictionaryFromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a dictionary from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a dictionary of those entries if entry XML tags are found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. Dictionary representing all entry keys found within the elementstring. Restriction(s): This Method is tagged as a Class Method` buildSiteFromXML(self, siteelement, webretrievedelay, proxy, targettype, target, useragent) from __builtin__.type `Utilizes the Class Methods within this Class to build the Site object. Returns a Site object that defines results returned during the web retrieval investigations. Argument(s): siteelement -- the siteelement object that will be used as the start element. webretrievedelay -- the amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- sets a proxy to use in the form of proxy.example.com:8080. targettype -- the targettype as defined. Either ip, md5, or hostname. target -- the target that will be used to gather information on. useragent -- the string utilized to represent the user-agent when web requests or submissions are made. Return value(s): Site object. Restriction(s): This Method is tagged as a Class Method` buildStringOrListfromXML(self, siteelement, elementstring) from __builtin__.type `Takes in a siteelement and then elementstring and builds a string or list from multiple entry XML tags defined in the sites.xml config file. Returns None if there are no entry XML tags for this specific elementstring. Returns a list of those entries if entry XML tags are found or a string of that entry if only one entry XML tag is found. Argument(s): siteelement -- the siteelement object that will be used as the start element. elementstring -- the string representation within the siteelement that will be utilized to get to the single or multiple entry XML tags. Return value(s): None if no entry XML tags are found. List representing all entry keys found within the elementstring. string representing an entry key if only one is found within the elementstring. Restriction(s): This Method is tagged as a Class Method` Data descriptors defined here: APIKey `Determines if an APIKey was set for this specific site. Returns the string representing the APIKey using the _apikey instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the APIKey from the _apikey instance variable. Restriction(s): This Method is tagged as a Property.` ErrorMessage `Returns the string representing the Error Message. Argument(s): No arguments are required. Return value(s): string -- representing the error message to print to the standard output. Restriction(s): This Method is tagged as a Property.` FriendlyName `Returns the string representing a friendly string name. Argument(s): No arguments are required. Return value(s): string -- representing friendly name for a tag for reporting. Restriction(s): This Method is tagged as a Property.` FullURL `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` Headers `Determines if Headers were set for this specific site. Returns the string representing the Headers using the _headers instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Headers from the _headers instance variable. Restriction(s): This Method is tagged as a Property.` ImportantPropertyString `Returns the string representing the Important Property that the user wants the site to report. This is set using the sites.xml config file in the importantproperty XML tag. Argument(s): No arguments are required. Return value(s): string -- representing the important property of the site that needs to be reported. Restriction(s): This Method is tagged as a Property.` MessageToPost `Returns the string representing a message to the user. Argument(s): No arguments are required. Return value(s): string -- representing a message to print to the standard output. Restriction(s): This Method is tagged as a Property.` Params `Determines if web Parameters were set for this specific site. Returns the string representing the Parameters using the _params instance variable or returns None if the instance variable is empty or not set. Argument(s): No arguments are required. Return value(s): string -- representation of the Parameters from the _params instance variable. Restriction(s): This Method is tagged as a Property.` Proxy `Returns the string representation of the proxy used. Argument(s): No arguments are required. Return value(s): string -- representation of the proxy used Restriction(s): This Method is tagged as a Property.` RegEx `Returns the string representing a regular expression required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing a regex used to find info on the site. Restriction(s): This Method is tagged as a Property.` ReportStringForResult `Returns the string representing a report string tag that precedes reporting information so the user knows what specifics are being found. Argument(s): No arguments are required. Return value(s): string -- representing a tag for reporting information. Restriction(s): This Method is tagged as a Property.` Results `Checks the instance variable _results is empty or None. Returns _results (the results list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- list of results discovered from the site being investigated. None -- if _results is empty or None. Restriction(s): This Method is tagged as a Property.` Target `Returns string representing the target being investigated. The string may be an IP Address, MD5 hash, or hostname. Argument(s): No arguments are required. Return value(s): string -- representation of the Target from the _target instance variable. Restriction(s): This Method is tagged as a Property.` TargetType `Returns the target type information whether that be ip, md5, or hostname. Argument(s): No arguments are required. Return value(s): string -- defined as ip, md5, or hostname. Restriction(s): This Method is tagged as a Property.` URL `Returns the string representing the Domain URL which is required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the URL of the site. Restriction(s): This Method is tagged as a Property.` UserAgent `Returns string representing the user-agent that will be used when requesting or submitting information to a web site. This is a user-provided string implemented on the command line at execution or provided by default if not added during execution. Argument(s): No arguments are required. Return value(s): string -- representation of the UserAgent from the _userAgent instance variable. Restriction(s): This Method is tagged as a Property.` UserMessage `Returns the string representing the Full URL which is the domain URL plus querystrings and other information required to retrieve the information being investigated. Argument(s): No arguments are required. Return value(s): string -- representing the full URL of the site including querystring information and any other info required. Restriction(s): This Method is tagged as a Property.` WebRetrieveDelay `Returns the string representation of the number of seconds that will be delayed between site retrievals. Argument(s): No arguments are required. Return value(s): string -- representation of an integer that is the delay in seconds that will be used between each web site retrieval. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class SiteFacade(__builtin__.object)
`` | `SiteFacade provides a Facade to run the multiple requirements needed to automate the site retrieval and storage processes. Public Method(s): runSiteAutomation (Property) Sites Instance variable(s): _sites`
| Methods defined here: __init__(self) `Class constructor. Simply creates a blank list and assigns it to instance variable _sites that will be filled with retrieved info from sites defined in the sites.xml configuration file. Argument(s): No arguments are required. Return value(s): Nothing is returned from this Method.` identifyTargetType(self, target) `Checks the target information provided to determine if it is a(n) IP Address in standard; CIDR or dash notation, or an MD5 hash, or a string hostname. Returns a string md5 if MD5 hash is identified. Returns the string ip if any IP Address format is found. Returns the string hostname if neither of those two are found. Argument(s): target -- string representing the target provided as the first argument to the program when Automater is run. Return value(s): string. Restriction(s): The Method has no restrictions.` runSiteAutomation(self, webretrievedelay, proxy, targetlist, source, postbydefault, useragent) `Builds site objects representative of each site listed in the sites.xml config file. Appends a Site object or one of it's subordinate objects to the _sites instance variable so retrieved information can be used. Returns nothing. Argument(s): webretrievedelay -- The amount of seconds to wait between site retrieve calls. Default delay is 2 seconds. proxy -- proxy server address as server:port_number targetlist -- list of strings representing targets to be investigated. Targets can be IP Addresses, MD5 hashes, or hostnames. source -- String representing a specific site that should only be used for investigation purposes instead of all sites listed in the sites.xml config file. postbydefault -- Boolean value to tell the program if the user wants to post data to a site if a post is required. Default is to NOT post. useragent -- String representing user-agent that will be utilized when requesting or submitting data to or from a web site. Return value(s): Nothing is returned from this Method. Restriction(s): The Method has no restrictions.` Data descriptors defined here: Sites `Checks the instance variable _sites is empty or None. Returns _sites (the site list) or None if it is empty. Argument(s): No arguments are required. Return value(s): list -- of Site objects or its subordinates. None -- if _sites is empty or None. Restriction(s): This Method is tagged as a Property.` __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`