Commits

Tim Tomes committed 52e8a86

Edited online

  • Participants
  • Parent commits 4631fcb

Comments (0)

Files changed (1)

 === API Key Management Methods:
 Some Recon-ng modules may require an API key. To prevent having to continually input API keys, Recon-ng provides methods which assist in the key management process. When the user runs a module that requires an API key, the module should use the available methods to achieve the following flow:
 
-# Check the local key storage database for a matching key and return the key.
+> 1. Check the local key storage database for a matching key and return the key.
 ** //key_name// is the unique name for the key when stored in the database.
 {{{
 #!python
 self.get_key_from_db(key_name)
 }}}
 
-# If a key does not exist, prompt the user for an API key.
+> 2. If a key does not exist, prompt the user for an API key.
 ** //key_text// is optional text to be used to describe the key when prompting the user.
 {{{
 #!python
 self.get_key_from_user([key_text='API Key'])
 }}}
 
-# Store the API key for use with all future requests.
+> 3. Store the API key for use with all future requests.
 ** //key_name// is the unique name for the key when stored in the database.
 ** //key_value// is the key string to store in the database.
 {{{
 }}}
 > Adds an API key to the API key storage database. 
 
-* ALL - Condensed flow.
+> ALL - Condensed flow.
 {{{
 #!python
 self.manage_key(key_name, key_text)