Parent

Included Modules

Files

Class/Module Index [+]

Quicksearch

Net::SSH::KeyFactory

A factory class for returning new Key classes. It is used for obtaining OpenSSL key instances via their SSH names, and for loading both public and private keys. It used used primarily by Net::SSH itself, internally, and will rarely (if ever) be directly used by consumers of the library.

klass = Net::SSH::KeyFactory.get("rsa")
assert klass.is_a?(OpenSSL::PKey::RSA)

key = Net::SSH::KeyFactory.load_public_key("~/.ssh/id_dsa.pub")

Constants

MAP

Specifies the mapping of SSH names to OpenSSL key classes.

Public Class Methods

get(name) click to toggle source

Fetch an OpenSSL key instance by its SSH name. It will be a new, empty key of the given type.

# File lib/net/ssh/key_factory.rb, line 28
def get(name)
  MAP.fetch(name).new
end
load_data_private_key(data, passphrase=nil, ask_passphrase=true, filename="") click to toggle source

Loads a private key. It will correctly determine whether the file describes an RSA or DSA key, and will load it appropriately. The new key is returned. If the key itself is encrypted (requiring a passphrase to use), the user will be prompted to enter their password unless passphrase works.

# File lib/net/ssh/key_factory.rb, line 47
def load_data_private_key(data, passphrase=nil, ask_passphrase=true, filename="")
  if data.match(/-----BEGIN DSA PRIVATE KEY-----/)
    key_type = OpenSSL::PKey::DSA
  elsif data.match(/-----BEGIN RSA PRIVATE KEY-----/)
    key_type = OpenSSL::PKey::RSA
  elsif data.match(/-----BEGIN (.*) PRIVATE KEY-----/)
    raise OpenSSL::PKey::PKeyError, "not a supported key type '#{$1}'"
  else
    raise OpenSSL::PKey::PKeyError, "not a private key (#{filename})"
  end

  encrypted_key = data.match(/ENCRYPTED/)
  tries = 0

  begin
    return key_type.new(data, passphrase || 'invalid')
  rescue OpenSSL::PKey::RSAError, OpenSSL::PKey::DSAError => e
    if encrypted_key && ask_passphrase
      tries += 1
      if tries <= 3
        passphrase = prompt("Enter passphrase for #{filename}:", false)
        retry
      else
        raise
      end
    else
      raise
    end
  end
end
load_data_public_key(data, filename="") click to toggle source

Loads a public key. It will correctly determine whether the file describes an RSA or DSA key, and will load it appropriately. The new public key is returned.

# File lib/net/ssh/key_factory.rb, line 89
def load_data_public_key(data, filename="")
  type, blob = data.split(/ /)

  raise Net::SSH::Exception, "public key at #{filename} is not valid" if blob.nil?

  blob = blob.unpack("m*").first
  reader = Net::SSH::Buffer.new(blob)
  reader.read_key or raise OpenSSL::PKey::PKeyError, "not a public key #{filename.inspect}"
end
load_private_key(filename, passphrase=nil, ask_passphrase=true) click to toggle source

Loads a private key from a file. It will correctly determine whether the file describes an RSA or DSA key, and will load it appropriately. The new key is returned. If the key itself is encrypted (requiring a passphrase to use), the user will be prompted to enter their password unless passphrase works.

# File lib/net/ssh/key_factory.rb, line 37
def load_private_key(filename, passphrase=nil, ask_passphrase=true)
  data = File.read(File.expand_path(filename))
  load_data_private_key(data, passphrase, ask_passphrase, filename)
end
load_public_key(filename) click to toggle source

Loads a public key from a file. It will correctly determine whether the file describes an RSA or DSA key, and will load it appropriately. The new public key is returned.

# File lib/net/ssh/key_factory.rb, line 81
def load_public_key(filename)
  data = File.read(File.expand_path(filename))
  load_data_public_key(data, filename)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.