Improve options display optional session types

[dwelch-r7]

Merge after #18770

This PR splits up the output of the options command for modules that support either an rhost or a session connection to show that only one or the other is required as this was ambiguous before

Before:

msf6 auxiliary(scanner/smb/smb_enumshares) > options

Module options (auxiliary/scanner/smb/smb_enumshares):

   Name                    Current Setting                         Required  Description
   ----                    ---------------                         --------  -----------
   HIGHLIGHT_NAME_PATTERN  username|password|user|pass|Groups.xml  yes       PCRE regex of resource names to highlight
   LogSpider               3                                       no        0 = disabled, 1 = CSV, 2 = table (txt), 3 = one liner (txt) (Accepted: 0, 1, 2, 3)
   MaxDepth                999                                     yes       Max number of subdirectories to spider
   RHOSTS                  172.16.158.159                          no        The target host(s), see https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html
   SESSION                 1                                       no        The session to run this module on
   SMBDomain               .                                       no        The Windows domain to use for authentication
   SMBPass                 vagrant                                 no        The password for the specified username
   SMBUser                 vagrant                                 no        The username to authenticate as
   Share                                                           no        Show only the specified share
   ShowFiles               false                                   yes       Show detailed information when spidering
   SpiderProfiles          true                                    no        Spider only user profiles when share is a disk share
   SpiderShares            false                                   no        Spider shares recursively
   THREADS                 1                                       yes       The number of concurrent threads (max one per host)

After:

msf6 auxiliary(scanner/smb/smb_enumshares) > options

Module options (auxiliary/scanner/smb/smb_enumshares):

   Name                    Current Setting                         Required  Description
   ----                    ---------------                         --------  -----------
   HIGHLIGHT_NAME_PATTERN  username|password|user|pass|Groups.xml  yes       PCRE regex of resource names to highlight
   LogSpider               3                                       no        0 = disabled, 1 = CSV, 2 = table (txt), 3 = one liner (txt) (Accepted: 0, 1, 2, 3)
   MaxDepth                999                                     yes       Max number of subdirectories to spider
   Share                                                           no        Show only the specified share
   ShowFiles               false                                   yes       Show detailed information when spidering
   SpiderProfiles          true                                    no        Spider only user profiles when share is a disk share
   SpiderShares            false                                   no        Spider shares recursively


   Used when making a new connection via RHOSTS:

   Name       Current Setting  Required  Description
   ----       ---------------  --------  -----------
   RHOSTS     172.16.158.159   no        The target host(s), see https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html
   SMBDomain  .                no        The Windows domain to use for authentication
   SMBPass    vagrant          no        The password for the specified username
   SMBUser    vagrant          no        The username to authenticate as
   THREADS    1                yes       The number of concurrent threads (max one per host)


   Used when connecting via an existing SESSION:

   Name     Current Setting  Required  Description
   ----     ---------------  --------  -----------
   SESSION  1                no        The session to run this module on

Verification Steps

• CI passes
• Check that modules with new session type support have their relevant options grouped in the output of options
• Check other modules look as they did before

[adfoster-r7]

Could we add tests to spec/lib/msf/base/serializer/readable_text_spec.rb for this? I think that makes sense to me 👀

[adfoster-r7]

Not a blocker; Looks like we should be updating info -d to support displaying this new functionality - but it looks like we'd need to clean this up as a pre-requisite step so not a blocker

[adfoster-r7]

Not a blocker; This existing class extending Hash is odd. It's probably something we should remove in the future if the API surface area is small :+1;

[adfoster-r7]

@dwelch-r7 Can we squash the commits down here? 🎉

[cgranleese-r7]

Ran through all the new session types modules and everything is working as expected. I think this is much better now in terms off making it clear what is required in order for a user to know what needs to be set depending on what method they use for modules. Great change 📈

[cgranleese-r7]

Release Notes

This PR adds support to now bucket module options that are output after running the options command. This will be for modules that support either an RHOST or a SESSION connection to show that only one or the other is required when using the new session type features for SMB/MSSQL/MYSQL/PostgreSQL sessions.