Very rough+small start, demoed a few weeks ago with VoiceOver.

[pbarry-r7]

EDIT: this is in reference to this Metasploit Framework discussion.

This was a hackathon project I did in early 2020 (also explains why this fork+branch is WAY behind current Framework) where I used the built-in macOS screen reader. With limited time (hackathon!), I looked at improving three problems I noticed right away:

1. Reading useless stuff
2. Reading without appropriate pause
3. No indication of missing data

I put my work behind a new msfconsole commandline option: -s. Then I made some improvements (hopefully), such as adding commas/punctuation to create pauses and NIL to convey that a field was empty. Then I juxstaposed some common commands with "before" and "after" video clips, where "before" would be how VoiceOver currently (or in early 2020, anyway) would read msfconsole output, and "after" would be running the same command but in a session of msfconsole -s where I had tried to make it better. Here's some of those clips (MAKE SURE TO UNMUTE EACH CLIP! :P ):

starting the console up (wanted to still read the data around module counts, but skip the ASCII banner stuff)

BEFORE

h-start-before.mp4

AFTER

h-start-after.mp4

hosts command

BEFORE

h-hosts-before.mp4

AFTER

h-hosts-after.mp4

listing a handler's advanced options

BEFORE

h-advopts-before.mp4

AFTER

h-advopts-after.mp4

[adfoster-r7]

Looks/sounds awesome. I wonder if we could make the screen reader changes directly to rex-text's table generation directly instead of modifying all of the tables directly in framework - that might reduce the effort of getting an MVP released 🤔

[jmartin-tech]

A suggestion, table additions for punctuation may be reasonable to implement as an option passed to the Rex::Text::Table base on a if screen reading is enabled.

[pbarry-r7]

Indeed, exactly where I was thinking made the most sense to put this capability.

[adfoster-r7]

Closing this for now until there's more feedback in the Metasploit Framework discussion 👍

[github-actions]

Thanks for your contribution to Metasploit Framework! We've looked at this pull request, and we agree that it seems like a good addition to Metasploit, but it looks like it is not quite ready to land. We've labeled it attic and closed it for now.

What does this generally mean? It could be one or more of several things:

• It doesn't look like there has been any activity on this pull request in a while
• We may not have the proper access or equipment to test this pull request, or the contributor doesn't have time to work on it right now.
• Sometimes the implementation isn't quite right and a different approach is necessary.

We would love to land this pull request when it's ready. If you have a chance to address all comments, we would be happy to reopen and discuss how to merge this!

[bcoles]

Replacing print_ method progress indicators with words may also be a good idea.

I get mixed results running these through TTS programs:

[+] Something good happened
[-] Something bad happened
[*] Something notable happened