Add the fuzzy-use plugin

[zeroSteiner]

This adds a plugin that offers the fzuse command to offer a different UI for the selection of modules. It requires fzf to be present.

Verification

List the steps needed to make sure this thing works

• Install fzf
• Load the fzuse plugin
• Run the fzuse command to select modules

[adfoster-r7]

Could we update the docs for this 🤞

https://docs.metasploit.com/docs/using-metasploit/intermediate/how-to-use-plugins.html#available-plugins

[github-actions]

Thanks for your pull request! Before this can be merged, we need the following documentation for your module:

• Writing Module Documentation
• Template
• Examples

[adfoster-r7]

Just a question; Why is it called fzuse instead of fzfuse 👀

[adfoster-r7]

I'm guessing the rationale is the fzf is considered an implementation detail, and in the future fzuse could technically be powered by anything? 🤔

[zeroSteiner]

I went with fzuse because it's fuzzy-user. fzf is named as it is because it's fuzzy-finder.

[adfoster-r7]

Not a blocker; it'd be interesting to add actions here potentially

[adfoster-r7]

What are your thoughts on using Ruby's tmp file API and creating the file in the ~/.msf4/tmp/local directory with a slightly different naming convention:

>> Tempfile.create(['msf-fsuse-', '.sock'], Msf::Config.local_directory) { |socket_file| puts socket_file.path }
/home/vagrant/.msf4/local/msf-fsuse-20240927-2373170-2tm1kk.sock

Which I think should allow us to drop the wrapper mktmpdir call here too

[zeroSteiner]

That doesn't work:

[6] pry(main)> Tempfile.create(['msf-fsuse-', '.sock']) { |sf| UNIXServer.new(sf) }
Errno::EADDRINUSE: Address already in use - connect(2) for /tmp/msf-fsuse-20240927-98954-b5sojv.sock
from (pry):6:in `initialize'
[7] pry(main)> Tempfile.create(['msf-fsuse-', '.sock']) { |sf| UNIXServer.new(sf.path + '.new') }
=> #<UNIXServer:/tmp/msf-fsuse-20240927-98954-of8yja.sock.new>
[8] pry(main)> 

[adfoster-r7]

Ah that makes sense 👍

So I guess this would be enough to move the file into the ~/.msf4 folder

>> Dir.mktmpdir('msf-fzuse-', Msf::Config.local_directory) { |dir| socket_path = File.join(dir, "msf-fzuse.sock"); UNIXServer.new(socket_path) }
=> #<UNIXServer:/home/vagrant/.msf4/local/msf-fzuse-20240927-2373170-wkyt2n/msf-fzuse.sock>
>> Dir.mktmpdir('msf-fzuse-', Msf::Config.local_directory) { |dir| socket_path = File.join(dir, "msf-fzuse.sock"); UNIXServer.new(socket_path) }
=> #<UNIXServer:/home/vagrant/.msf4/local/msf-fzuse-20240927-2373170-n3ya92/msf-fzuse.sock>

[zeroSteiner]

Is it necessary to put it in the config directory? The file only lasts a couple of seconds while the user is picking their module and I wasn't aware there was a precedent of placing temp files in the config directory.

[adfoster-r7]

We've had PRs that put wordlists etc into places outside of ~/.msf4 which I think we've tried to avoid in the past, and for Metasploit Pro it's unexpected for files to appear in random places IMO instead of being self-contained. It's not a strong blocker for me 👍

[adfoster-r7]

Looks good to me; merge away 📈

[jheysel-r7]

Works great, thanks for the addition @zeroSteiner!

[jheysel-r7]

Release Notes

This adds a plugin that offers the fzuse command to offer a different UI for the selection of modules. It requires fzf to be present.