Add datastore option for Jenkins home directory

[MegaManSec]

This patch adds a new option to the jenkins_gather.rb script, allowing a
user to specify the "jenkins home" directory, instead of running a potentially
time-and-resource-consuming "find /" command. Default directories are
now also included.

This patch is inspired by an environment where the "find /" command was
taking too long, and there was no way to set a configuration, despite
the correct directory being known. This patch also now allows for
alternative Jenkins directories to be gathered, not just the first one
found by `find'.

[MegaManSec]

Also: performing find / continues even after the first directory is found. It could be improved by adding the -print -quit flags tot he search I suppose, which would make it stop after the first result (although this is not compatible with netbsd apparently)

[bcoles]

There seems to be a lot of unrelated style changes introduced in this PR. Please run rubocop.

[github-actions]

Thanks for your pull request! Before this pull request can be merged, it must pass the checks of our automated linting tools.

We use Rubocop and msftidy to ensure the quality of our code. This can be ran from the root directory of Metasploit:

rubocop <directory or file>
tools/dev/msftidy.rb <directory or file>

You can automate most of these changes with the -a flag:

rubocop -a <directory or file>

Please update your branch after these have been made, and reach out if you have any problems.

[MegaManSec]

I am unsure why the commit contains styling changes at all, and I did not change anything other than the find_home function and the top of the file.. I think that rubocop may have run but without parsing .rubocop.yaml.

[bcoles]

I am unsure why the commit contains styling changes at all, and I did not change anything other than the find_home function and the top of the file.. I think that rubocop may have run but without parsing .rubocop.yaml.

rubocop was run over the modules a couple of weeks ago:

• https://github.com/rapid7/metasploit-framework/commits/master/modules/post/multi/gather/jenkins_gather.rb

You've likely forked and performed modifications before these changes were applied, which resulted in the rubocop changes being reverted.

[gwillcox-r7]

Overall looks good but had one concern that might not be related to this PR per say.

[cgranleese-r7]

Tested against Windows 10 and Jenkins Docker image version 2.414.

Windows

msf6 post(multi/gather/jenkins_gather) > set jenkins_home C:\\ProgramData\\Jenkins\\.jenkins
jenkins_home => C:\ProgramData\Jenkins\.jenkins
msf6 post(multi/gather/jenkins_gather) > time run

[-] Cannot read master.key or hudson.util.Secret...
[-] Encrypted strings will not be able to be decrypted...
[-] Could not read credentials.xml...
[*] Post module execution completed
[+] Command "run" completed in 0.8574719999996887 seconds
msf6 post(multi/gather/jenkins_gather) > unset JENKINS_HOME
Unsetting JENKINS_HOME...
msf6 post(multi/gather/jenkins_gather) > time run

[*] Searching for Jenkins directory... This could take some time...
[*] Found Jenkins installation at C:\ProgramData\Jenkins\.jenkins\
[-] Cannot read master.key or hudson.util.Secret...
[-] Encrypted strings will not be able to be decrypted...
[-] Could not read credentials.xml...
[*] Post module execution completed
[+] Command "run" completed in 0.7100030000001425 seconds

Docker

msf6 post(multi/gather/jenkins_gather) > set jenkins_home C:\\ProgramData\\Jenkins\\.jenkins
jenkins_home => C:\ProgramData\Jenkins\.jenkins
msf6 post(multi/gather/jenkins_gather) > time run

[-] Cannot read master.key or hudson.util.Secret...
[-] Encrypted strings will not be able to be decrypted...
[-] Could not read credentials.xml...
[*] Post module execution completed
[+] Command "run" completed in 0.712282999999843 seconds
msf6 post(multi/gather/jenkins_gather) > unset JENKINS_HOME
Unsetting JENKINS_HOME...
msf6 post(multi/gather/jenkins_gather) > time run

[*] Searching for Jenkins directory... This could take some time...
[*] Found Jenkins installation at C:\ProgramData\Jenkins\.jenkins\
[-] Cannot read master.key or hudson.util.Secret...
[-] Encrypted strings will not be able to be decrypted...
[-] Could not read credentials.xml...
[*] Post module execution completed
[+] Command "run" completed in 0.7935689999994793 seconds

[cgranleese-r7]

Release Notes

This PR adds a new datastore option for Jenkins home directory to the jenkins_gather module.