Class: Net::SSH::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/tpkg/thirdparty/net-ssh-2.1.0/lib/net/ssh/config.rb

Overview

The Net::SSH::Config class is used to parse OpenSSH configuration files, and translates that syntax into the configuration syntax that Net::SSH understands. This lets Net::SSH scripts read their configuration (to some extent) from OpenSSH configuration files (~/.ssh/config, /etc/ssh_config, and so forth).

Only a subset of OpenSSH configuration options are understood:

  • Ciphers => maps to the :encryption option

  • Compression => :compression

  • CompressionLevel => :compression_level

  • ConnectTimeout => maps to the :timeout option

  • ForwardAgent => :forward_agent

  • GlobalKnownHostsFile => :global_known_hosts_file

  • HostBasedAuthentication => maps to the :auth_methods option

  • HostKeyAlgorithms => maps to :host_key option

  • HostKeyAlias => :host_key_alias

  • HostName => :host_name

  • IdentityFile => maps to the :keys option

  • IdentitiesOnly => :keys_only

  • Macs => maps to the :hmac option

  • PasswordAuthentication => maps to the :auth_methods option

  • Port => :port

  • PreferredAuthentications => maps to the :auth_methods option

  • ProxyCommand => maps to the :proxy option

  • RekeyLimit => :rekey_limit

  • User => :user

  • UserKnownHostsFile => :user_known_hosts_file

Note that you will never need to use this class directly–you can control whether the OpenSSH configuration files are read by passing the :config option to Net::SSH.start. (They are, by default.)

Constant Summary collapse

@@default_files = 
%w(~/.ssh/config /etc/ssh_config /etc/ssh/ssh_config)

Class Method Summary collapse

Class Method Details

.default_files ⇒ Object

Returns an array of locations of OpenSSH configuration files to parse by default.



41
42
43
 
# File 'lib/tpkg/thirdparty/net-ssh-2.1.0/lib/net/ssh/config.rb', line 41

def default_files
  @@default_files
end

.for(host, files = default_files) ⇒ Object

Loads the configuration data for the given host from all of the given files (defaulting to the list of files returned by #default_files), translates the resulting hash into the options recognized by Net::SSH, and returns them.



49
50
51
 
# File 'lib/tpkg/thirdparty/net-ssh-2.1.0/lib/net/ssh/config.rb', line 49

def for(host, files=default_files)
  translate(files.inject({}) { |settings, file| load(file, host, settings) })
end

.load(path, host, settings = {}) ⇒ Object

Load the OpenSSH configuration settings in the given file for the given host. If settings is given, the options are merged into that hash, with existing values taking precedence over newly parsed ones. Returns a hash containing the OpenSSH options. (See #translate for how to convert the OpenSSH options into Net::SSH options.)



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/tpkg/thirdparty/net-ssh-2.1.0/lib/net/ssh/config.rb', line 59

def load(path, host, settings={})
  file = File.expand_path(path)
  return settings unless File.readable?(file)
  
  globals = {}
  matched_host = nil
  multi_host = []
  seen_host = false
  IO.foreach(file) do |line|
    next if line =~ /^\s*(?:#.*)?$/
    
    if line =~ /^\s*(\S+)\s*=(.*)$/
      key, value = $1, $2
    else
      key, value = line.strip.split(/\s+/, 2)
    end

    # silently ignore malformed entries
    next if value.nil?

    key.downcase!
    value = $1 if value =~ /^"(.*)"$/
    
    value = case value.strip
      when /^\d+$/ then value.to_i
      when /^no$/i then false
      when /^yes$/i then true
      else value
      end
    
    if key == 'host'
      # Support "Host host1 host2 hostN".
      # See http://github.com/net-ssh/net-ssh/issues#issue/6
      multi_host = value.to_s.split(/\s+/)
      matched_host = multi_host.select { |h| host =~ pattern2regex(h) }.first
      seen_host = true
    elsif !seen_host
      if key == 'identityfile'
        (globals[key] ||= []) << value
      else
        globals[key] = value unless settings.key?(key)
      end
    elsif !matched_host.nil?
      if key == 'identityfile'
        (settings[key] ||= []) << value
      else
        settings[key] = value unless settings.key?(key)
      end
    end
  end
  
  settings = globals.merge(settings) if globals
  
  return settings
end

.translate(settings) ⇒ Object

Given a hash of OpenSSH configuration options, converts them into a hash of Net::SSH options. Unrecognized options are ignored. The settings hash must have Strings for keys, all downcased, and the returned hash will have Symbols for keys.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/tpkg/thirdparty/net-ssh-2.1.0/lib/net/ssh/config.rb', line 119

def translate(settings)
  settings.inject({}) do |hash, (key, value)|
    case key
    when 'ciphers' then
      hash[:encryption] = value.split(/,/)
    when 'compression' then
      hash[:compression] = value
    when 'compressionlevel' then
      hash[:compression_level] = value
    when 'connecttimeout' then
      hash[:timeout] = value
    when 'forwardagent' then
      hash[:forward_agent] = value
    when 'identitiesonly' then
      hash[:keys_only] = value
    when 'globalknownhostsfile'
      hash[:global_known_hosts_file] = value
    when 'hostbasedauthentication' then
      if value
        hash[:auth_methods] ||= []
        hash[:auth_methods] << "hostbased"
      end
    when 'hostkeyalgorithms' then
      hash[:host_key] = value.split(/,/)
    when 'hostkeyalias' then
      hash[:host_key_alias] = value
    when 'hostname' then
      hash[:host_name] = value
    when 'identityfile' then
      hash[:keys] = value
    when 'macs' then
      hash[:hmac] = value.split(/,/)
    when 'passwordauthentication'
      if value
        hash[:auth_methods] ||= []
        hash[:auth_methods] << "password"
      end
    when 'port'
      hash[:port] = value
    when 'preferredauthentications'
      hash[:auth_methods] = value.split(/,/)
    when 'proxycommand'
      if value and !(value =~ /^none$/)
        require 'net/ssh/proxy/command'
        hash[:proxy] = Net::SSH::Proxy::Command.new(value)
      end
	  when 'pubkeyauthentication'
      if value
        hash[:auth_methods] ||= []
        hash[:auth_methods] << "publickey"
      end
    when 'rekeylimit'
      hash[:rekey_limit] = interpret_size(value)
    when 'user'
      hash[:user] = value
    when 'userknownhostsfile'
      hash[:user_known_hosts_file] = value
    end
    hash
  end
end