Class: Net::SSH::KnownHosts

Class | Net::SSH::KnownHosts
In: | lib/net/ssh/known_hosts.rb
Parent: | Object

Searches an OpenSSH-style known-host file for a given host, and returns all matching keys. This is used to implement host-key verification, as well as to determine what key a user prefers to use for a given host.

This is used internally by Net::SSH, and will never need to be used directly by consumers of the library.

### Methods

add add hostfiles keys_for new search_for search_in

### Attributes

source | [R] | The host-key file name that this KnownHosts instance will use to search for keys.

### Public Class methods

add(host, key, options={})

Looks in all user known host files (see KnownHosts.hostfiles) and tries to add an entry for the given host and key to the first file it is able to.

hostfiles(options, which=:all)

Looks in the given `options` hash for the :user_known_hosts_file and :global_known_hosts_file keys, and returns an array of all known hosts files. If the :user_known_hosts_file key is not set, the default is returned (~/.ssh/known_hosts and ~/.ssh/known_hosts2). If :global_known_hosts_file is not set, the default is used (/etc/ssh/known_hosts and /etc/ssh/known_hosts2).

If you only want the user known host files, you can pass :user as the second option.

new(source)

Instantiate a new KnownHosts instance that will search the given known-hosts file. The path is expanded file File.expand_path.

search_for(host, options={})

Searches all known host files (see KnownHosts.hostfiles) for all keys of the given host. Returns an array of keys found.

search_in(files, host)

Search for all known keys for the given host, in every file given in the `files` array. Returns the list of keys.

### Public Instance methods

add(host, key)

Tries to append an entry to the current source file for the given host and key. If it is unable to (because the file is not writable, for instance), an exception will be raised.

keys_for(host)

Returns an array of all keys that are known to be associatd with the given host. The `host` parameter is either the domain name or ip address of the host, or both (comma-separated). Additionally, if a non-standard port is being used, it may be specified by putting the host (or ip, or both) in square brackets, and appending the port outside the brackets after a colon. Possible formats for `host`, then, are;

      "net.ssh.test"
      "1.2.3.4"
      "net.ssh.test,1.2.3.4"
      "[net.ssh.test]:5555"
      "[1,2,3,4]:5555"
      "[net.ssh.test]:5555,[1.2.3.4]:5555

[Validate]