Commits

Tim Tomes  committed b88dc8e

Edited online

  • Participants
  • Parent commits 084029e

Comments (0)

Files changed (1)

 
 * Add a host to the database and return the affected row count:
 ** //host// is the FQDN of the host as a string.
-** //address// is the optional IP address of the host as a string.
+** //address// (optional) is the IP address of the host as a string.
 {{{
 #!python
 self.add_host(host[, address=None])
 ** //fname// is the first name of the contact.
 ** //lname// is the last name of the contact.
 ** //title// is the job title of the contact.
-** //email// is the optional email address of the contact.
+** //email// (optional) is the email address of the contact.
 {{{
 #!python
 self.add_contact(fname, lname, title[, email=None])
 
 * Add a credential to the database and return the affected row count.
 ** //username// is the username portion of the credential.
-** //password// is the optional password portion of the credential.
-** //hash type// is the optional hash type of the password, if the password is in the form of a hash.
-** //leak// is optional information about the leaked credential.
+** //password// (optional)is the password portion of the credential.
+** //hash type// (optional) is the hash type of the password, if the password is in the form of a hash.
+** //leak// (optional) is information about the leaked credential.
 {{{
 #!python
 self.add_cred(username[, password=None][, hashtype=None][, leak=None])
 }}}
 
 * 2. If a key does not exist, prompt the user for the key.
-** //key_text// is optional text to be used to describe the key when prompting the user.
+** //key_text// (optional) is text to be used to describe the key when prompting the user.
 {{{
 #!python
 self.get_key_from_user([key_text='API Key'])
 #!python
 self.add_key_to_db(key_name, key_value)
 }}}
-> Adds an API key to the API key storage database. 
 
-> ALL - Condensed flow.
+* ALL - Condensed flow. Automate the key retrieval and storage process. Combines the above methods into the proper flow.
+** //key_name// is the unique name for the key when stored in the database.
+** //key_text// is text to be used to describe the key when prompting the user.
 {{{
 #!python
 self.manage_key(key_name, key_text)
 }}}
-> Automates the API key retrieval and storage process by combining the above methods into the proper flow. //key_name// is the unique name for the key when stored in the database. //key_text// is text to be used to describe the key when prompting the user.
 
-### Web Requests Methods:
+=== Web Requests Methods:
 The most important capability of a tool which specializes in web based reconnaissance is the ability to make web requests. Recon-ng relieves the burden of complicated request building logic by providing a custom method for handling web requests.
 
+* Make a web request and return a response object.
+** //url// is the base URL of the request.
+** //method// is the method of the request. Currently, only "GET" or "POST" are available.
+** //payload// is a dictionary of name:value pairs to be encoded as request parameters. //payload// should be used for "GET" and "POST" methods as the request method will encode and build the request as needed per method.
+** //headers// is a dictionary of name:value pairs to be added as request headers.
+** //cookies// is a dictionary of name:value pairs to be used as request cookies. No cookie jar currently available.
 {{{
 #!python
 self.request(url[, method='GET'], payload={}, headers={}, cookies={}[, redirect=True])
 }}}
-> Makes a web request and returns a response object. //url// is the base URL of the request. //method// is the method of the request. Currently, only "GET" or "POST" are available. //payload// is a dictionary of name:value pairs to be encoded as request parameters. //payload// should be used for "GET" and "POST" methods as the request method will encode and build the request as needed per method. //headers// is a dictionary of name:value pairs to be added as request headers. //cookies// is a dictionary of name:value pairs to be used as request cookies. No cookie jar currently available.
 
 The resulting response object after a successful request allows quick access to all of the information required for further action.
 
-Ex.
-
+Example:
 {{{
 #!python
 resp = self.request(...)