[STSK20] Framework Configuration & Behavior enhancements

[vexance]

Initial discussion and opinions on framework gave rise to the following recommendations for framework enhancements:

• Full Option Value Display: It could be beneficial to display the entirety of an option's set value rather than always truncating the value to fit within a certain number of characters. This could help with sanity checks for what the value is set to.

  • Add (boolean) framework configuration option TRUNCATE_PARAMS to indicate whether module options should have their entire or truncated values shown by default (default: True)
  • Update InterativeInterpreter.do_options(self, args) to retrieve the TRUNCATE_PARAMS configuration options and pass this to the module's show_options() call
  • Update StratustrykeModule.show_options(self, mask: bool) => show_options(self, mask: bool, truncate: bool) to pass the truncate configuration option to Option.show_options()
  • Update Option.show_options(self, mask: bool) => show_options(self, mask: bool, truncate: bool) to return either the full or truncated value of the option value.

• Additional Alternative to Set Command: Paste: Implement a new framework command 'paste' which serves as an alternative way to set a string option's value. This will allow for some options to avoid use a files and allow for direct copy / paste into the terminal

  • Implement InteractiveInterpreter.do_paste(self, args). This will behave similarly to do_set() in that it will update a module's option value. However, the command will ONLY be 'paste OPTION_NAME', and will initiate a prompt for the user to paste text into the terminal until a specific keystroke is entered (e.g., CTRL-C / ^C). All input received prior to the escape sequence will be formated into a single string that can be used by a module and re-seperated into lines by inserting newline characters where necessary
  • Add a (string) framework configuration option PASTE_ESC_SEQ to indicate the escape character for the paste command (default: CTRL-C / ^C). This config option will only support a certain set of characters (^C, ^D, etc.)
  • do_paste() should read user input while in a try / except loop and wait for a KeyboardInterrupt exception to be thrown. Within the except block the input could then be parsed into a string and the option updated.

• Credential Import Command: Current use where a module must be leveraged to import a credential is quite cumbersome and annoying. A command should be implemented (e.g., mkcred) which allows for credential creation without using a separate module.

  • Support at a minimum the following subcommands: mkcred aws, mkcred azure, mkcred gcp, mkcred generic (AWS / AZURE / GCP / GENERIC are auto-completed)
    • Only mkcred aws needs to be implemented until AzureCredential and GCPCredential classes are fully implemented
  • The following behavior should be observed for mkcred aws

    stratustryke > mkcred AWS
    ALIAS: <typed / pasted>
    AWS_ACCESS_KEY_ID: <pasted>
    AWS_SECRET_ACCESS_KEY: <pasted>
    AWS_SESSION_TOKEN [None]: <pasted or just enter>
    DEFAULT_REGION [stratustryke.settings.AWS_DEFAULT_REGION]: <pasted>
    [*] message showing credential has been added

  • Potential behavior for future azure / gcp could simply involve pasting the GCP JSON or other prompts for azure

[vexance]

Alternative implementation to command 'paste' could be to dump contents of a paste into a temp file and then perform a do_set() call to set the option to file:/path/to/tmp/file (this would only work for options supporting file: prefix)

A bit janky, but it could work.

[vexance]

Resolved via #23. Closing!